Skip to content

lists

Lists

Bases: ListableApiResource, FindableApiResource, CreatableApiResource, UpdatableApiResource, DestroyableApiResource

Nylas Lists API.

Source code in nylas/resources/lists.py 
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
class Lists(
    ListableApiResource,
    FindableApiResource,
    CreatableApiResource,
    UpdatableApiResource,
    DestroyableApiResource,
):
    """Nylas Lists API."""

    def list(
        self,
        query_params: ListListsQueryParams = None,
        overrides: RequestOverrides = None,
    ) -> ListResponse[NylasList]:
        """Return all lists for the application."""
        return super().list(
            path="/v3/lists",
            response_type=NylasList,
            query_params=query_params,
            overrides=overrides,
        )

    def create(
        self,
        request_body: CreateListRequest,
        overrides: RequestOverrides = None,
    ) -> Response[NylasList]:
        """Create a new list."""
        return super().create(
            path="/v3/lists",
            request_body=request_body,
            response_type=NylasList,
            overrides=overrides,
        )

    def find(self, list_id: str, overrides: RequestOverrides = None) -> Response[NylasList]:
        """Return a specific list by ID."""
        return super().find(
            path=f"/v3/lists/{list_id}",
            response_type=NylasList,
            overrides=overrides,
        )

    def update(
        self,
        list_id: str,
        request_body: UpdateListRequest,
        overrides: RequestOverrides = None,
    ) -> Response[NylasList]:
        """Update a list by ID."""
        return super().update(
            path=f"/v3/lists/{list_id}",
            response_type=NylasList,
            request_body=request_body,
            method="PUT",
            overrides=overrides,
        )

    def destroy(self, list_id: str, overrides: RequestOverrides = None) -> DeleteResponse:
        """Delete a list by ID."""
        return super().destroy(path=f"/v3/lists/{list_id}", overrides=overrides)

    def list_items(
        self,
        list_id: str,
        query_params: ListListItemsQueryParams = None,
        overrides: RequestOverrides = None,
    ) -> ListResponse[ListItem]:
        """Return all items in a list."""
        return super().list(
            path=f"/v3/lists/{list_id}/items",
            response_type=ListItem,
            query_params=query_params,
            overrides=overrides,
        )

    def add_items(
        self,
        list_id: str,
        request_body: UpdateListItemsRequest,
        overrides: RequestOverrides = None,
    ) -> Response[NylasList]:
        """Add items to a list."""
        return super().create(
            path=f"/v3/lists/{list_id}/items",
            request_body=request_body,
            response_type=NylasList,
            overrides=overrides,
        )

    def remove_items(
        self,
        list_id: str,
        request_body: UpdateListItemsRequest,
        overrides: RequestOverrides = None,
    ) -> Response[NylasList]:
        """Remove items from a list."""
        json_response, headers = self._http_client._execute(
            "DELETE",
            f"/v3/lists/{list_id}/items",
            None,
            None,
            request_body,
            overrides=overrides,
        )
        return Response.from_dict(json_response, NylasList, headers)

add_items(list_id, request_body, overrides=None)

Add items to a list.

Source code in nylas/resources/lists.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def add_items(
    self,
    list_id: str,
    request_body: UpdateListItemsRequest,
    overrides: RequestOverrides = None,
) -> Response[NylasList]:
    """Add items to a list."""
    return super().create(
        path=f"/v3/lists/{list_id}/items",
        request_body=request_body,
        response_type=NylasList,
        overrides=overrides,
    )

create(request_body, overrides=None)

Create a new list.

Source code in nylas/resources/lists.py 
43
44
45
46
47
48
49
50
51
52
53
54
def create(
    self,
    request_body: CreateListRequest,
    overrides: RequestOverrides = None,
) -> Response[NylasList]:
    """Create a new list."""
    return super().create(
        path="/v3/lists",
        request_body=request_body,
        response_type=NylasList,
        overrides=overrides,
    )

destroy(list_id, overrides=None)

Delete a list by ID.

Source code in nylas/resources/lists.py 
79
80
81
def destroy(self, list_id: str, overrides: RequestOverrides = None) -> DeleteResponse:
    """Delete a list by ID."""
    return super().destroy(path=f"/v3/lists/{list_id}", overrides=overrides)

find(list_id, overrides=None)

Return a specific list by ID.

Source code in nylas/resources/lists.py 
56
57
58
59
60
61
62
def find(self, list_id: str, overrides: RequestOverrides = None) -> Response[NylasList]:
    """Return a specific list by ID."""
    return super().find(
        path=f"/v3/lists/{list_id}",
        response_type=NylasList,
        overrides=overrides,
    )

list(query_params=None, overrides=None)

Return all lists for the application.

Source code in nylas/resources/lists.py 
30
31
32
33
34
35
36
37
38
39
40
41
def list(
    self,
    query_params: ListListsQueryParams = None,
    overrides: RequestOverrides = None,
) -> ListResponse[NylasList]:
    """Return all lists for the application."""
    return super().list(
        path="/v3/lists",
        response_type=NylasList,
        query_params=query_params,
        overrides=overrides,
    )

list_items(list_id, query_params=None, overrides=None)

Return all items in a list.

Source code in nylas/resources/lists.py 
83
84
85
86
87
88
89
90
91
92
93
94
95
def list_items(
    self,
    list_id: str,
    query_params: ListListItemsQueryParams = None,
    overrides: RequestOverrides = None,
) -> ListResponse[ListItem]:
    """Return all items in a list."""
    return super().list(
        path=f"/v3/lists/{list_id}/items",
        response_type=ListItem,
        query_params=query_params,
        overrides=overrides,
    )

remove_items(list_id, request_body, overrides=None)

Remove items from a list.

Source code in nylas/resources/lists.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def remove_items(
    self,
    list_id: str,
    request_body: UpdateListItemsRequest,
    overrides: RequestOverrides = None,
) -> Response[NylasList]:
    """Remove items from a list."""
    json_response, headers = self._http_client._execute(
        "DELETE",
        f"/v3/lists/{list_id}/items",
        None,
        None,
        request_body,
        overrides=overrides,
    )
    return Response.from_dict(json_response, NylasList, headers)

update(list_id, request_body, overrides=None)

Update a list by ID.

Source code in nylas/resources/lists.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def update(
    self,
    list_id: str,
    request_body: UpdateListRequest,
    overrides: RequestOverrides = None,
) -> Response[NylasList]:
    """Update a list by ID."""
    return super().update(
        path=f"/v3/lists/{list_id}",
        response_type=NylasList,
        request_body=request_body,
        method="PUT",
        overrides=overrides,
    )