Skip to content

redirect_uris

RedirectUris

Bases: ListableApiResource, FindableApiResource, CreatableApiResource, UpdatableApiResource, DestroyableApiResource

Manage Redirect URIs for your Nylas Application.

These endpoints allow you to create, update, and delete Redirect URIs for your Nylas Application.

Source code in nylas/resources/redirect_uris.py 
 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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
class RedirectUris(
    ListableApiResource,
    FindableApiResource,
    CreatableApiResource,
    UpdatableApiResource,
    DestroyableApiResource,
):
    """
    Manage Redirect URIs for your Nylas Application.

    These endpoints allow you to create, update, and delete Redirect URIs for your Nylas Application.
    """

    def list(self, overrides: RequestOverrides = None) -> ListResponse[RedirectUri]:
        """
        Return all Redirect URIs.

        Args:
            overrides: The request overrides to apply to the request.

        Returns:
            The list of Redirect URIs.
        """

        return super().list(
            path="/v3/applications/redirect-uris",
            response_type=RedirectUri,
            overrides=overrides,
        )

    def find(
        self, redirect_uri_id: str, overrides: RequestOverrides = None
    ) -> Response[RedirectUri]:
        """
        Return a Redirect URI.

        Args:
            redirect_uri_id: The ID of the Redirect URI to retrieve.
            overrides: The request overrides to apply to the request.

        Returns:
            The Redirect URI.
        """

        return super().find(
            path=f"/v3/applications/redirect-uris/{redirect_uri_id}",
            response_type=RedirectUri,
            overrides=overrides,
        )

    def create(
        self, request_body: CreateRedirectUriRequest, overrides: RequestOverrides = None
    ) -> Response[RedirectUri]:
        """
        Create a Redirect URI.

        Args:
            request_body: The values to create the Redirect URI with.
            overrides: The request overrides to apply to the request.

        Returns:
            The created Redirect URI.
        """

        return super().create(
            path="/v3/applications/redirect-uris",
            request_body=request_body,
            response_type=RedirectUri,
            overrides=overrides,
        )

    def update(
        self,
        redirect_uri_id: str,
        request_body: UpdateRedirectUriRequest,
        overrides: RequestOverrides = None,
    ) -> Response[RedirectUri]:
        """
        Update a Redirect URI.

        Args:
            redirect_uri_id: The ID of the Redirect URI to update.
            request_body: The values to update the Redirect URI with.
            overrides: The request overrides to apply to the request.

        Returns:
            The updated Redirect URI.
        """

        return super().update(
            path=f"/v3/applications/redirect-uris/{redirect_uri_id}",
            request_body=request_body,
            response_type=RedirectUri,
            overrides=overrides,
        )

    def destroy(
        self, redirect_uri_id: str, overrides: RequestOverrides = None
    ) -> DeleteResponse:
        """
        Delete a Redirect URI.

        Args:
            redirect_uri_id: The ID of the Redirect URI to delete.
            overrides: The request overrides to apply to the request.

        Returns:
            The deletion response.
        """

        return super().destroy(
            path=f"/v3/applications/redirect-uris/{redirect_uri_id}",
            overrides=overrides,
        )

create(request_body, overrides=None)

Create a Redirect URI.

Parameters:

Name Type Description Default
request_body CreateRedirectUriRequest

The values to create the Redirect URI with.

 required
overrides RequestOverrides

The request overrides to apply to the request.

 None

Returns:

Type Description
Response[RedirectUri]

The created Redirect URI.
Source code in nylas/resources/redirect_uris.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def create(
    self, request_body: CreateRedirectUriRequest, overrides: RequestOverrides = None
) -> Response[RedirectUri]:
    """
    Create a Redirect URI.

    Args:
        request_body: The values to create the Redirect URI with.
        overrides: The request overrides to apply to the request.

    Returns:
        The created Redirect URI.
    """

    return super().create(
        path="/v3/applications/redirect-uris",
        request_body=request_body,
        response_type=RedirectUri,
        overrides=overrides,
    )

destroy(redirect_uri_id, overrides=None)

Delete a Redirect URI.

Parameters:

Name Type Description Default
redirect_uri_id str

The ID of the Redirect URI to delete.

 required
overrides RequestOverrides

The request overrides to apply to the request.

 None

Returns:

Type Description
DeleteResponse

The deletion response.
Source code in nylas/resources/redirect_uris.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def destroy(
    self, redirect_uri_id: str, overrides: RequestOverrides = None
) -> DeleteResponse:
    """
    Delete a Redirect URI.

    Args:
        redirect_uri_id: The ID of the Redirect URI to delete.
        overrides: The request overrides to apply to the request.

    Returns:
        The deletion response.
    """

    return super().destroy(
        path=f"/v3/applications/redirect-uris/{redirect_uri_id}",
        overrides=overrides,
    )

find(redirect_uri_id, overrides=None)

Return a Redirect URI.

Parameters:

Name Type Description Default
redirect_uri_id str

The ID of the Redirect URI to retrieve.

 required
overrides RequestOverrides

The request overrides to apply to the request.

 None

Returns:

Type Description
Response[RedirectUri]

The Redirect URI.
Source code in nylas/resources/redirect_uris.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def find(
    self, redirect_uri_id: str, overrides: RequestOverrides = None
) -> Response[RedirectUri]:
    """
    Return a Redirect URI.

    Args:
        redirect_uri_id: The ID of the Redirect URI to retrieve.
        overrides: The request overrides to apply to the request.

    Returns:
        The Redirect URI.
    """

    return super().find(
        path=f"/v3/applications/redirect-uris/{redirect_uri_id}",
        response_type=RedirectUri,
        overrides=overrides,
    )

list(overrides=None)

Return all Redirect URIs.

Parameters:

Name Type Description Default
overrides RequestOverrides

The request overrides to apply to the request.

 None

Returns:

Type Description
ListResponse[RedirectUri]

The list of Redirect URIs.
Source code in nylas/resources/redirect_uris.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def list(self, overrides: RequestOverrides = None) -> ListResponse[RedirectUri]:
    """
    Return all Redirect URIs.

    Args:
        overrides: The request overrides to apply to the request.

    Returns:
        The list of Redirect URIs.
    """

    return super().list(
        path="/v3/applications/redirect-uris",
        response_type=RedirectUri,
        overrides=overrides,
    )

update(redirect_uri_id, request_body, overrides=None)

Update a Redirect URI.

Parameters:

Name Type Description Default
redirect_uri_id str

The ID of the Redirect URI to update.

 required
request_body UpdateRedirectUriRequest

The values to update the Redirect URI with.

 required
overrides RequestOverrides

The request overrides to apply to the request.

 None

Returns:

Type Description
Response[RedirectUri]

The updated Redirect URI.
Source code in nylas/resources/redirect_uris.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def update(
    self,
    redirect_uri_id: str,
    request_body: UpdateRedirectUriRequest,
    overrides: RequestOverrides = None,
) -> Response[RedirectUri]:
    """
    Update a Redirect URI.

    Args:
        redirect_uri_id: The ID of the Redirect URI to update.
        request_body: The values to update the Redirect URI with.
        overrides: The request overrides to apply to the request.

    Returns:
        The updated Redirect URI.
    """

    return super().update(
        path=f"/v3/applications/redirect-uris/{redirect_uri_id}",
        request_body=request_body,
        response_type=RedirectUri,
        overrides=overrides,
    )