Skip to content

redirect_uris

RedirectUris

Bases: ListableApiResource, FindableApiResource, CreatableApiResource, UpdatableApiResource, DestroyableApiResource

Source code in nylas/resources/redirect_uris.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
class RedirectUris(
    ListableApiResource,
    FindableApiResource,
    CreatableApiResource,
    UpdatableApiResource,
    DestroyableApiResource,
):
    def list(self) -> ListResponse[RedirectUri]:
        """
        Return all Redirect URIs.

        Returns:
            The list of Redirect URIs.
        """

        return super(RedirectUris, self).list(
            path=f"/v3/redirect-uris", response_type=RedirectUri
        )

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

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

        Returns:
            The Redirect URI.
        """

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

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

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

        Returns:
            The created Redirect URI.
        """

        return super(RedirectUris, self).create(
            path=f"/v3/redirect-uris",
            request_body=request_body,
            response_type=RedirectUri,
        )

    def update(
        self, redirect_uri_id: str, request_body: UpdateRedirectUriRequest
    ) -> 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.

        Returns:
            The updated Redirect URI.
        """

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

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

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

        Returns:
            The deletion response.
        """

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

create(request_body)

Create a Redirect URI.

Parameters:

Name Type Description Default
request_body CreateRedirectUriRequest

The values to create the Redirect URI with.

 required

Returns:

Type Description
Response[RedirectUri]

The created Redirect URI.
Source code in nylas/resources/redirect_uris.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def create(self, request_body: CreateRedirectUriRequest) -> Response[RedirectUri]:
    """
    Create a Redirect URI.

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

    Returns:
        The created Redirect URI.
    """

    return super(RedirectUris, self).create(
        path=f"/v3/redirect-uris",
        request_body=request_body,
        response_type=RedirectUri,
    )

destroy(redirect_uri_id)

Delete a Redirect URI.

Parameters:

Name Type Description Default
redirect_uri_id str

The ID of the Redirect URI to delete.

 required

Returns:

Type Description
DeleteResponse

The deletion response.
Source code in nylas/resources/redirect_uris.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def destroy(self, redirect_uri_id: str) -> DeleteResponse:
    """
    Delete a Redirect URI.

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

    Returns:
        The deletion response.
    """

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

find(redirect_uri_id)

Return a Redirect URI.

Parameters:

Name Type Description Default
redirect_uri_id str

The ID of the Redirect URI to retrieve.

 required

Returns:

Type Description
Response[RedirectUri]

The Redirect URI.
Source code in nylas/resources/redirect_uris.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def find(self, redirect_uri_id: str) -> Response[RedirectUri]:
    """
    Return a Redirect URI.

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

    Returns:
        The Redirect URI.
    """

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

list()

Return all Redirect URIs.

Returns:

Type Description
ListResponse[RedirectUri]

The list of Redirect URIs.
Source code in nylas/resources/redirect_uris.py 
23
24
25
26
27
28
29
30
31
32
33
def list(self) -> ListResponse[RedirectUri]:
    """
    Return all Redirect URIs.

    Returns:
        The list of Redirect URIs.
    """

    return super(RedirectUris, self).list(
        path=f"/v3/redirect-uris", response_type=RedirectUri
    )

update(redirect_uri_id, request_body)

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

Returns:

Type Description
Response[RedirectUri]

The updated Redirect URI.
Source code in nylas/resources/redirect_uris.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def update(
    self, redirect_uri_id: str, request_body: UpdateRedirectUriRequest
) -> 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.

    Returns:
        The updated Redirect URI.
    """

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