Skip to content

applications

Applications

Bases: UpdatablePatchApiResource

Nylas Applications API

The Nylas Applications API allows you to get information about your Nylas application. You can also manage the redirect URIs associated with your application.

Source code in nylas/resources/applications.py 
11
12
13
14
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
class Applications(UpdatablePatchApiResource):
    """
    Nylas Applications API

    The Nylas Applications API allows you to get information about your Nylas application.
    You can also manage the redirect URIs associated with your application.
    """

    @property
    def redirect_uris(self) -> RedirectUris:
        """
        Manage Redirect URIs for your Nylas Application.

        Returns:
            RedirectUris: The redirect URIs associated with your Nylas Application.
        """
        return RedirectUris(self._http_client)

    def info(self, overrides: RequestOverrides = None) -> Response[ApplicationDetails]:
        """
        Get the application information.

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

        Returns:
            Response: The application information.
        """

        json_response, headers = self._http_client._execute(
            method="GET", path="/v3/applications", overrides=overrides
        )
        return Response.from_dict(json_response, ApplicationDetails, headers)

    def update(
        self,
        request_body: UpdateApplicationRequest,
        overrides: RequestOverrides = None,
    ) -> Response[ApplicationDetails]:
        """
        Update the application information.

        Note:
            ``additional_settings`` is write-only and is stripped from the response.

        Args:
            request_body: The values to update the application with.
            overrides: The request overrides to apply to the request.

        Returns:
            Response: The updated application information.
        """

        return super().patch(
            path="/v3/applications",
            request_body=request_body,
            response_type=ApplicationDetails,
            overrides=overrides,
        )

redirect_uris: RedirectUris property

Manage Redirect URIs for your Nylas Application.

Returns:

Name Type Description
RedirectUris RedirectUris

The redirect URIs associated with your Nylas Application.

info(overrides=None)

Get the application information.

Parameters:

Name Type Description Default
overrides RequestOverrides

The query parameters to include in the request.

 None

Returns:

Name Type Description
Response Response[ApplicationDetails]

The application information.
Source code in nylas/resources/applications.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def info(self, overrides: RequestOverrides = None) -> Response[ApplicationDetails]:
    """
    Get the application information.

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

    Returns:
        Response: The application information.
    """

    json_response, headers = self._http_client._execute(
        method="GET", path="/v3/applications", overrides=overrides
    )
    return Response.from_dict(json_response, ApplicationDetails, headers)

update(request_body, overrides=None)

Update the application information.

Note

additional_settings is write-only and is stripped from the response.

Parameters:

Name Type Description Default
request_body UpdateApplicationRequest

The values to update the application with.

 required
overrides RequestOverrides

The request overrides to apply to the request.

 None

Returns:

Name Type Description
Response Response[ApplicationDetails]

The updated application information.
Source code in nylas/resources/applications.py 
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
def update(
    self,
    request_body: UpdateApplicationRequest,
    overrides: RequestOverrides = None,
) -> Response[ApplicationDetails]:
    """
    Update the application information.

    Note:
        ``additional_settings`` is write-only and is stripped from the response.

    Args:
        request_body: The values to update the application with.
        overrides: The request overrides to apply to the request.

    Returns:
        Response: The updated application information.
    """

    return super().patch(
        path="/v3/applications",
        request_body=request_body,
        response_type=ApplicationDetails,
        overrides=overrides,
    )