grants
Grants
Bases: ListableApiResource
, FindableApiResource
, UpdatableApiResource
, DestroyableApiResource
Nylas Grants API
The Grants API allows you to find and manage existing grants for your Nylas application.
Grants represent a specific set of permissions ("scopes") that a specific end user granted Nylas for a specific service provider
Source code in nylas/resources/grants.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 |
|
destroy(grant_id, overrides=None)
Delete a Grant.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
grant_id |
str
|
The ID of the Grant to delete. |
required |
overrides |
RequestOverrides
|
The request overrides to use. |
None
|
Returns:
Type | Description |
---|---|
DeleteResponse
|
The deletion response. |
Source code in nylas/resources/grants.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
|
find(grant_id, overrides=None)
Return a Grant.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
grant_id |
str
|
The ID of the Grant to retrieve. |
required |
overrides |
RequestOverrides
|
The request overrides to use. |
None
|
Returns:
Type | Description |
---|---|
Response[Grant]
|
The Grant. |
Source code in nylas/resources/grants.py
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
|
list(query_params=None, overrides=None)
Return all Grants.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
query_params |
ListGrantsQueryParams
|
The query parameters to include in the request. |
None
|
overrides |
RequestOverrides
|
The request overrides to use. |
None
|
Returns:
Type | Description |
---|---|
ListResponse[Grant]
|
A list of Grants. |
Source code in nylas/resources/grants.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
|
update(grant_id, request_body, overrides=None)
Update a Grant.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
grant_id |
str
|
The ID of the Grant to update. |
required |
request_body |
UpdateGrantRequest
|
The values to update the Grant with. |
required |
overrides |
RequestOverrides
|
The request overrides to use. |
None
|
Returns:
Type | Description |
---|---|
Response[Grant]
|
The updated Grant. |
Source code in nylas/resources/grants.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
|