Skip to content

folders

Folders

Bases: ListableApiResource, FindableApiResource, CreatableApiResource, UpdatableApiResource, DestroyableApiResource

Nylas Folders API

The Nylas folders API allows you to create new folders or manage existing ones.

Source code in nylas/resources/folders.py 
 20
 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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
class Folders(
    ListableApiResource,
    FindableApiResource,
    CreatableApiResource,
    UpdatableApiResource,
    DestroyableApiResource,
):
    """
    Nylas Folders API

    The Nylas folders API allows you to create new folders or manage existing ones.
    """

    def list(
        self,
        identifier: str,
        query_params: Optional[ListFolderQueryParams] = None,
        overrides: RequestOverrides = None,
    ) -> ListResponse[Folder]:
        """
        Return all Folders.

        Args:
            identifier: The identifier of the Grant to act upon.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use.

        Returns:
            The list of Folders.
        """

        return super().list(
            path=f"/v3/grants/{identifier}/folders",
            response_type=Folder,
            query_params=query_params,
            overrides=overrides,
        )

    def find(
        self,
        identifier: str,
        folder_id: str,
        overrides: RequestOverrides = None,
    ) -> Response[Folder]:
        """
        Return a Folder.

        Args:
            identifier: The identifier of the Grant to act upon.
            folder_id: The ID of the Folder to retrieve.
            overrides: The request overrides to use.

        Returns:
            The Folder.
        """
        return super().find(
            path=f"/v3/grants/{identifier}/folders/{folder_id}",
            response_type=Folder,
            overrides=overrides,
        )

    def create(
        self,
        identifier: str,
        request_body: CreateFolderRequest,
        overrides: RequestOverrides = None,
    ) -> Response[Folder]:
        """
        Create a Folder.

        Args:
            identifier: The identifier of the Grant to act upon.
            request_body: The values to create the Folder with.
            overrides: The request overrides to use.

        Returns:
            The created Folder.
        """
        return super().create(
            path=f"/v3/grants/{identifier}/folders",
            response_type=Folder,
            request_body=request_body,
            overrides=overrides,
        )

    def update(
        self,
        identifier: str,
        folder_id: str,
        request_body: UpdateFolderRequest,
        overrides: RequestOverrides = None,
    ) -> Response[Folder]:
        """
        Update a Folder.

        Args:
            identifier: The identifier of the Grant to act upon.
            folder_id: The ID of the Folder to update.
            request_body: The values to update the Folder with.
            overrides: The request overrides to use.

        Returns:
            The updated Folder.
        """
        return super().update(
            path=f"/v3/grants/{identifier}/folders/{folder_id}",
            response_type=Folder,
            request_body=request_body,
            overrides=overrides,
        )

    def destroy(
        self,
        identifier: str,
        folder_id: str,
        overrides: RequestOverrides = None,
    ) -> DeleteResponse:
        """
        Delete a Folder.

        Args:
            identifier: The identifier of the Grant to act upon.
            folder_id: The ID of the Folder to delete.
            overrides: The request overrides to use.

        Returns:
            The deletion response.
        """
        return super().destroy(
            path=f"/v3/grants/{identifier}/folders/{folder_id}", overrides=overrides
        )

create(identifier, request_body, overrides=None)

Create a Folder.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
request_body CreateFolderRequest

The values to create the Folder with.

 required
overrides RequestOverrides

The request overrides to use.

 None

Returns:

Type Description
Response[Folder]

The created Folder.
Source code in nylas/resources/folders.py 
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def create(
    self,
    identifier: str,
    request_body: CreateFolderRequest,
    overrides: RequestOverrides = None,
) -> Response[Folder]:
    """
    Create a Folder.

    Args:
        identifier: The identifier of the Grant to act upon.
        request_body: The values to create the Folder with.
        overrides: The request overrides to use.

    Returns:
        The created Folder.
    """
    return super().create(
        path=f"/v3/grants/{identifier}/folders",
        response_type=Folder,
        request_body=request_body,
        overrides=overrides,
    )

destroy(identifier, folder_id, overrides=None)

Delete a Folder.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
folder_id str

The ID of the Folder to delete.

 required
overrides RequestOverrides

The request overrides to use.

 None

Returns:

Type Description
DeleteResponse

The deletion response.
Source code in nylas/resources/folders.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def destroy(
    self,
    identifier: str,
    folder_id: str,
    overrides: RequestOverrides = None,
) -> DeleteResponse:
    """
    Delete a Folder.

    Args:
        identifier: The identifier of the Grant to act upon.
        folder_id: The ID of the Folder to delete.
        overrides: The request overrides to use.

    Returns:
        The deletion response.
    """
    return super().destroy(
        path=f"/v3/grants/{identifier}/folders/{folder_id}", overrides=overrides
    )

find(identifier, folder_id, overrides=None)

Return a Folder.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
folder_id str

The ID of the Folder to retrieve.

 required
overrides RequestOverrides

The request overrides to use.

 None

Returns:

Type Description
Response[Folder]

The Folder.
Source code in nylas/resources/folders.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def find(
    self,
    identifier: str,
    folder_id: str,
    overrides: RequestOverrides = None,
) -> Response[Folder]:
    """
    Return a Folder.

    Args:
        identifier: The identifier of the Grant to act upon.
        folder_id: The ID of the Folder to retrieve.
        overrides: The request overrides to use.

    Returns:
        The Folder.
    """
    return super().find(
        path=f"/v3/grants/{identifier}/folders/{folder_id}",
        response_type=Folder,
        overrides=overrides,
    )

list(identifier, query_params=None, overrides=None)

Return all Folders.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
query_params Optional[ListFolderQueryParams]

The query parameters to include in the request.

 None
overrides RequestOverrides

The request overrides to use.

 None

Returns:

Type Description
ListResponse[Folder]

The list of Folders.
Source code in nylas/resources/folders.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def list(
    self,
    identifier: str,
    query_params: Optional[ListFolderQueryParams] = None,
    overrides: RequestOverrides = None,
) -> ListResponse[Folder]:
    """
    Return all Folders.

    Args:
        identifier: The identifier of the Grant to act upon.
        query_params: The query parameters to include in the request.
        overrides: The request overrides to use.

    Returns:
        The list of Folders.
    """

    return super().list(
        path=f"/v3/grants/{identifier}/folders",
        response_type=Folder,
        query_params=query_params,
        overrides=overrides,
    )

update(identifier, folder_id, request_body, overrides=None)

Update a Folder.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
folder_id str

The ID of the Folder to update.

 required
request_body UpdateFolderRequest

The values to update the Folder with.

 required
overrides RequestOverrides

The request overrides to use.

 None

Returns:

Type Description
Response[Folder]

The updated Folder.
Source code in nylas/resources/folders.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def update(
    self,
    identifier: str,
    folder_id: str,
    request_body: UpdateFolderRequest,
    overrides: RequestOverrides = None,
) -> Response[Folder]:
    """
    Update a Folder.

    Args:
        identifier: The identifier of the Grant to act upon.
        folder_id: The ID of the Folder to update.
        request_body: The values to update the Folder with.
        overrides: The request overrides to use.

    Returns:
        The updated Folder.
    """
    return super().update(
        path=f"/v3/grants/{identifier}/folders/{folder_id}",
        response_type=Folder,
        request_body=request_body,
        overrides=overrides,
    )