lists

CreateListRequest

Bases: TypedDict

Request body for creating a list.

Source code in nylas/models/lists.py

class CreateListRequest(TypedDict):
    """Request body for creating a list."""

    name: str
    type: ListType
    description: NotRequired[str]

ListItem dataclass

A single value belonging to a Nylas list.

Source code in nylas/models/lists.py

@dataclass_json
@dataclass
class ListItem:
    """A single value belonging to a Nylas list."""

    id: Optional[str] = None
    list_id: Optional[str] = None
    value: Optional[str] = None
    created_at: Optional[int] = None

ListListItemsQueryParams

Bases: ListQueryParams

Query parameters for listing items in a list.

Source code in nylas/models/lists.py

class ListListItemsQueryParams(ListQueryParams):
    """Query parameters for listing items in a list."""

    pass

ListListsQueryParams

Bases: ListQueryParams

Query parameters for listing lists.

Source code in nylas/models/lists.py

class ListListsQueryParams(ListQueryParams):
    """Query parameters for listing lists."""

    pass

NylasList dataclass

A typed collection used in in_list rule conditions.

Source code in nylas/models/lists.py

@dataclass_json
@dataclass
class NylasList:
    """A typed collection used in `in_list` rule conditions."""

    id: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    type: Optional[str] = None
    items_count: Optional[int] = None
    application_id: Optional[str] = None
    organization_id: Optional[str] = None
    created_at: Optional[int] = None
    updated_at: Optional[int] = None

UpdateListItemsRequest

Bases: TypedDict

Request body for adding/removing list items.

Source code in nylas/models/lists.py

class UpdateListItemsRequest(TypedDict):
    """Request body for adding/removing list items."""

    items: TypingList[str]

UpdateListRequest

Bases: TypedDict

Request body for updating a list.

Source code in nylas/models/lists.py

class UpdateListRequest(TypedDict, total=False):
    """Request body for updating a list."""

    name: NotRequired[str]
    description: NotRequired[str]