Skip to content

client

Client

Bases: object

API client for the Nylas API.

Attributes:

Name Type Description
api_key

The Nylas API key to use for authentication
api_uri

The URL to use for communicating with the Nylas API
http_client

The HTTP client to use for requests to the Nylas API
Source code in nylas/client.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
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
class Client(object):
    """
    API client for the Nylas API.

    Attributes:
        api_key: The Nylas API key to use for authentication
        api_uri: The URL to use for communicating with the Nylas API
        http_client: The HTTP client to use for requests to the Nylas API
    """

    def __init__(
        self, api_key: str, api_uri: str = DEFAULT_SERVER_URL, timeout: int = 30
    ):
        """
        Initialize the Nylas API client.

        Args:
            api_key: The Nylas API key to use for authentication
            api_uri: The URL to use for communicating with the Nylas API
            timeout: The timeout for requests to the Nylas API, in seconds
        """
        self.api_key = api_key
        self.api_uri = api_uri
        self.http_client = HttpClient(self.api_uri, self.api_key, timeout)

    @property
    def auth(self) -> Auth:
        """
        Access the Auth API.

        Returns:
            The Auth API.
        """
        return Auth(self.http_client)

    @property
    def grants(self) -> Grants:
        """
        Access the Grants API.

        Returns:
            The Grants API.
        """
        return Grants(self.http_client)

    @property
    def applications(self) -> Applications:
        """
        Access the Applications API.

        Returns:
            The Applications API.
        """
        return Applications(self.http_client)

    @property
    def calendars(self) -> Calendars:
        """
        Access the Calendars API.

        Returns:
            The Calendars API.
        """
        return Calendars(self.http_client)

    @property
    def events(self) -> Events:
        """
        Access the Events API.

        Returns:
            The Events API.
        """
        return Events(self.http_client)

    @property
    def webhooks(self) -> Webhooks:
        """
        Access the Webhooks API.

        Returns:
            The Webhooks API.
        """
        return Webhooks(self.http_client)

applications: Applications property

Access the Applications API.

Returns:

Type Description
Applications

The Applications API.

auth: Auth property

Access the Auth API.

Returns:

Type Description
Auth

The Auth API.

calendars: Calendars property

Access the Calendars API.

Returns:

Type Description
Calendars

The Calendars API.

events: Events property

Access the Events API.

Returns:

Type Description
Events

The Events API.

grants: Grants property

Access the Grants API.

Returns:

Type Description
Grants

The Grants API.

webhooks: Webhooks property

Access the Webhooks API.

Returns:

Type Description
Webhooks

The Webhooks API.

__init__(api_key, api_uri=DEFAULT_SERVER_URL, timeout=30)

Initialize the Nylas API client.

Parameters:

Name Type Description Default
api_key str

The Nylas API key to use for authentication

 required
api_uri str

The URL to use for communicating with the Nylas API

 DEFAULT_SERVER_URL
timeout int

The timeout for requests to the Nylas API, in seconds

 30
Source code in nylas/client.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def __init__(
    self, api_key: str, api_uri: str = DEFAULT_SERVER_URL, timeout: int = 30
):
    """
    Initialize the Nylas API client.

    Args:
        api_key: The Nylas API key to use for authentication
        api_uri: The URL to use for communicating with the Nylas API
        timeout: The timeout for requests to the Nylas API, in seconds
    """
    self.api_key = api_key
    self.api_uri = api_uri
    self.http_client = HttpClient(self.api_uri, self.api_key, timeout)