Skip to content

connectors

Connectors

Bases: ListableApiResource, FindableApiResource, CreatableApiResource, UpdatableApiResource, DestroyableApiResource

Nylas Connectors API

The Nylas Connectors API allows you to create new connectors or manage existing ones. In Nylas, a connector (formerly called an "integration") stores information that allows your Nylas application to connect to a third party services

Source code in nylas/resources/connectors.py 
 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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
class Connectors(
    ListableApiResource,
    FindableApiResource,
    CreatableApiResource,
    UpdatableApiResource,
    DestroyableApiResource,
):
    """
    Nylas Connectors API

    The Nylas Connectors API allows you to create new connectors or manage existing ones.
    In Nylas, a connector (formerly called an "integration") stores information that allows your Nylas application
    to connect to a third party services
    """

    @property
    def credentials(self) -> Credentials:
        """
        Access the Credentials API.

        Returns:
            The Credentials API.
        """
        return Credentials(self._http_client)

    def list(
        self,
        query_params: ListConnectorQueryParams = None,
        overrides: RequestOverrides = None,
    ) -> ListResponse[Connector]:
        """
        Return all Connectors.

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

        Returns:
            The list of Connectors.
        """

        return super().list(
            path="/v3/connectors",
            response_type=Connector,
            query_params=query_params,
            overrides=overrides,
        )

    def find(
        self, provider: Provider, overrides: RequestOverrides = None
    ) -> Response[Connector]:
        """
        Return a connector associated with the provider.

        Args:
            provider: The provider associated to the connector to retrieve.
            overrides: The request overrides to use.

        Returns:
            The Connector.
        """
        return super().find(
            path=f"/v3/connectors/{provider}",
            response_type=Connector,
            overrides=overrides,
        )

    def create(
        self, request_body: CreateConnectorRequest, overrides: RequestOverrides = None
    ) -> Response[Connector]:
        """
        Create a connector.

        Args:
            request_body: The values to create the connector with.
            overrides: The request overrides to use.

        Returns:
            The created connector.
        """
        return super().create(
            path="/v3/connectors",
            request_body=request_body,
            response_type=Connector,
            overrides=overrides,
        )

    def update(
        self,
        provider: Provider,
        request_body: UpdateConnectorRequest,
        overrides: RequestOverrides = None,
    ) -> Response[Connector]:
        """
        Create a connector.

        Args:
            provider: The provider associated to the connector to update.
            request_body: The values to update the connector with.
            overrides: The request overrides to use.

        Returns:
            The created connector.
        """
        return super().update(
            path=f"/v3/connectors/{provider}",
            request_body=request_body,
            response_type=Connector,
            method="PATCH",
            overrides=overrides,
        )

    def destroy(
        self, provider: Provider, overrides: RequestOverrides = None
    ) -> DeleteResponse:
        """
        Delete a connector.

        Args:
            provider: The provider associated to the connector to delete.
            overrides: The request overrides to use.

        Returns:
            The deleted connector.
        """
        return super().destroy(path=f"/v3/connectors/{provider}", overrides=overrides)

credentials: Credentials property

Access the Credentials API.

Returns:

Type Description
Credentials

The Credentials API.

create(request_body, overrides=None)

Create a connector.

Parameters:

Name Type Description Default
request_body CreateConnectorRequest

The values to create the connector with.

 required
overrides RequestOverrides

The request overrides to use.

 None

Returns:

Type Description
Response[Connector]

The created connector.
Source code in nylas/resources/connectors.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def create(
    self, request_body: CreateConnectorRequest, overrides: RequestOverrides = None
) -> Response[Connector]:
    """
    Create a connector.

    Args:
        request_body: The values to create the connector with.
        overrides: The request overrides to use.

    Returns:
        The created connector.
    """
    return super().create(
        path="/v3/connectors",
        request_body=request_body,
        response_type=Connector,
        overrides=overrides,
    )

destroy(provider, overrides=None)

Delete a connector.

Parameters:

Name Type Description Default
provider Provider

The provider associated to the connector to delete.

 required
overrides RequestOverrides

The request overrides to use.

 None

Returns:

Type Description
DeleteResponse

The deleted connector.
Source code in nylas/resources/connectors.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
def destroy(
    self, provider: Provider, overrides: RequestOverrides = None
) -> DeleteResponse:
    """
    Delete a connector.

    Args:
        provider: The provider associated to the connector to delete.
        overrides: The request overrides to use.

    Returns:
        The deleted connector.
    """
    return super().destroy(path=f"/v3/connectors/{provider}", overrides=overrides)

find(provider, overrides=None)

Return a connector associated with the provider.

Parameters:

Name Type Description Default
provider Provider

The provider associated to the connector to retrieve.

 required
overrides RequestOverrides

The request overrides to use.

 None

Returns:

Type Description
Response[Connector]

The Connector.
Source code in nylas/resources/connectors.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def find(
    self, provider: Provider, overrides: RequestOverrides = None
) -> Response[Connector]:
    """
    Return a connector associated with the provider.

    Args:
        provider: The provider associated to the connector to retrieve.
        overrides: The request overrides to use.

    Returns:
        The Connector.
    """
    return super().find(
        path=f"/v3/connectors/{provider}",
        response_type=Connector,
        overrides=overrides,
    )

list(query_params=None, overrides=None)

Return all Connectors.

Parameters:

Name Type Description Default
query_params ListConnectorQueryParams

The query parameters to include in the request.

 None
overrides RequestOverrides

The request overrides to use.

 None

Returns:

Type Description
ListResponse[Connector]

The list of Connectors.
Source code in nylas/resources/connectors.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def list(
    self,
    query_params: ListConnectorQueryParams = None,
    overrides: RequestOverrides = None,
) -> ListResponse[Connector]:
    """
    Return all Connectors.

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

    Returns:
        The list of Connectors.
    """

    return super().list(
        path="/v3/connectors",
        response_type=Connector,
        query_params=query_params,
        overrides=overrides,
    )

update(provider, request_body, overrides=None)

Create a connector.

Parameters:

Name Type Description Default
provider Provider

The provider associated to the connector to update.

 required
request_body UpdateConnectorRequest

The values to update the connector with.

 required
overrides RequestOverrides

The request overrides to use.

 None

Returns:

Type Description
Response[Connector]

The created connector.
Source code in nylas/resources/connectors.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def update(
    self,
    provider: Provider,
    request_body: UpdateConnectorRequest,
    overrides: RequestOverrides = None,
) -> Response[Connector]:
    """
    Create a connector.

    Args:
        provider: The provider associated to the connector to update.
        request_body: The values to update the connector with.
        overrides: The request overrides to use.

    Returns:
        The created connector.
    """
    return super().update(
        path=f"/v3/connectors/{provider}",
        request_body=request_body,
        response_type=Connector,
        method="PATCH",
        overrides=overrides,
    )