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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|