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 
 16
 17
 18
 19
 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
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) -> ListResponse[Folder]:
        """
        Return all Folders.

        Args:
            identifier: The identifier of the Grant to act upon.

        Returns:
            The list of Folders.
        """

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

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

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

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

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

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

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

    def update(
        self, identifier: str, folder_id: str, request_body: UpdateFolderRequest
    ) -> 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.

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

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

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

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

create(identifier, request_body)

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

Returns:

Type Description
Response[Folder]

The created Folder.
Source code in nylas/resources/folders.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def create(
    self, identifier: str, request_body: CreateFolderRequest
) -> Response[Folder]:
    """
    Create a Folder.

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

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

destroy(identifier, folder_id)

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

Returns:

Type Description
DeleteResponse

The deletion response.
Source code in nylas/resources/folders.py 
100
101
102
103
104
105
106
107
108
109
110
111
def destroy(self, identifier: str, folder_id: str) -> DeleteResponse:
    """
    Delete a Folder.

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

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

find(identifier, folder_id)

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

Returns:

Type Description
Response[Folder]

The Folder.
Source code in nylas/resources/folders.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def find(self, identifier: str, folder_id: str) -> Response[Folder]:
    """
    Return a Folder.

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

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

list(identifier)

Return all Folders.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required

Returns:

Type Description
ListResponse[Folder]

The list of Folders.
Source code in nylas/resources/folders.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def list(self, identifier: str) -> ListResponse[Folder]:
    """
    Return all Folders.

    Args:
        identifier: The identifier of the Grant to act upon.

    Returns:
        The list of Folders.
    """

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

update(identifier, folder_id, request_body)

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

Returns:

Type Description
Response[Folder]

The updated Folder.
Source code in nylas/resources/folders.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def update(
    self, identifier: str, folder_id: str, request_body: UpdateFolderRequest
) -> 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.

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