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

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) -> ListResponse[RedirectUri]:
        """
        Return all Redirect URIs.

        Returns:
            The list of Redirect URIs.
        """

        return super().list(
            path="/v3/applications/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().find(
            path=f"/v3/applications/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().create(
            path="/v3/applications/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().update(
            path=f"/v3/applications/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().destroy(path=f"/v3/applications/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

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().create(
        path="/v3/applications/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

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().destroy(path=f"/v3/applications/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

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().find(
        path=f"/v3/applications/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

def list(self) -> ListResponse[RedirectUri]:
    """
    Return all Redirect URIs.

    Returns:
        The list of Redirect URIs.
    """

    return super().list(
        path="/v3/applications/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

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().update(
        path=f"/v3/applications/redirect-uris/{redirect_uri_id}",
        request_body=request_body,
        response_type=RedirectUri,
    )