Skip to content

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 
15
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
class Grants(
    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
    """

    def list(self, query_params: ListGrantsQueryParams = None) -> ListResponse[Grant]:
        """
        Return all Grants.

        Args:
            query_params: The query parameters to include in the request.

        Returns:
            A list of Grants.
        """

        return super().list(
            path="/v3/grants", response_type=Grant, query_params=query_params
        )

    def find(self, grant_id: str) -> Response[Grant]:
        """
        Return a Grant.

        Args:
            grant_id: The ID of the Grant to retrieve.

        Returns:
            The Grant.
        """

        return super().find(path=f"/v3/grants/{grant_id}", response_type=Grant)

    def update(
        self, grant_id: str, request_body: UpdateGrantRequest
    ) -> Response[Grant]:
        """
        Update a Grant.

        Args:
            grant_id: The ID of the Grant to update.
            request_body: The values to update the Grant with.

        Returns:
            The updated Grant.
        """

        return super().update(
            path=f"/v3/grants/{grant_id}",
            response_type=Grant,
            request_body=request_body,
        )

    def destroy(self, grant_id: str) -> DeleteResponse:
        """
        Delete a Grant.

        Args:
            grant_id: The ID of the Grant to delete.

        Returns:
            The deletion response.
        """

        return super().destroy(path=f"/v3/grants/{grant_id}")

destroy(grant_id)

Delete a Grant.

Parameters:

Name Type Description Default
grant_id str

The ID of the Grant to delete.

 required

Returns:

Type Description
DeleteResponse

The deletion response.
Source code in nylas/resources/grants.py 
78
79
80
81
82
83
84
85
86
87
88
89
def destroy(self, grant_id: str) -> DeleteResponse:
    """
    Delete a Grant.

    Args:
        grant_id: The ID of the Grant to delete.

    Returns:
        The deletion response.
    """

    return super().destroy(path=f"/v3/grants/{grant_id}")

find(grant_id)

Return a Grant.

Parameters:

Name Type Description Default
grant_id str

The ID of the Grant to retrieve.

 required

Returns:

Type Description
Response[Grant]

The Grant.
Source code in nylas/resources/grants.py 
45
46
47
48
49
50
51
52
53
54
55
56
def find(self, grant_id: str) -> Response[Grant]:
    """
    Return a Grant.

    Args:
        grant_id: The ID of the Grant to retrieve.

    Returns:
        The Grant.
    """

    return super().find(path=f"/v3/grants/{grant_id}", response_type=Grant)

list(query_params=None)

Return all Grants.

Parameters:

Name Type Description Default
query_params ListGrantsQueryParams

The query parameters to include in the request.

 None

Returns:

Type Description
ListResponse[Grant]

A list of Grants.
Source code in nylas/resources/grants.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def list(self, query_params: ListGrantsQueryParams = None) -> ListResponse[Grant]:
    """
    Return all Grants.

    Args:
        query_params: The query parameters to include in the request.

    Returns:
        A list of Grants.
    """

    return super().list(
        path="/v3/grants", response_type=Grant, query_params=query_params
    )

update(grant_id, request_body)

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

Returns:

Type Description
Response[Grant]

The updated Grant.
Source code in nylas/resources/grants.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def update(
    self, grant_id: str, request_body: UpdateGrantRequest
) -> Response[Grant]:
    """
    Update a Grant.

    Args:
        grant_id: The ID of the Grant to update.
        request_body: The values to update the Grant with.

    Returns:
        The updated Grant.
    """

    return super().update(
        path=f"/v3/grants/{grant_id}",
        response_type=Grant,
        request_body=request_body,
    )