Skip to content

connectors

Connectors

Bases: ListableApiResource, FindableApiResource, CreatableApiResource, UpdatableApiResource, DestroyableApiResource

Source code in nylas/resources/connectors.py 
 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
class Connectors(
    ListableApiResource,
    FindableApiResource,
    CreatableApiResource,
    UpdatableApiResource,
    DestroyableApiResource,
):
    @property
    def credentials(self) -> Credentials:
        """
        Access the Credentials API.

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

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

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

        Returns:
            The list of Connectors.
        """

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

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

        Args:
            provider: The provider associated to the connector to retrieve.

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

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

        Args:
            request_body: The values to create the connector with.

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

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

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

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

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

        Args:
            provider: The provider associated to the connector to delete.

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

credentials: Credentials property

Access the Credentials API.

Returns:

Type Description
Credentials

The Credentials API.

create(request_body)

Create a connector.

Parameters:

Name Type Description Default
request_body CreateConnectorRequest

The values to create the connector with.

 required

Returns:

Type Description
Response[Connector]

The created connector.
Source code in nylas/resources/connectors.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def create(self, request_body: CreateConnectorRequest) -> Response[Connector]:
    """
    Create a connector.

    Args:
        request_body: The values to create the connector with.

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

destroy(provider)

Delete a connector.

Parameters:

Name Type Description Default
provider Provider

The provider associated to the connector to delete.

 required

Returns:

Type Description
DeleteResponse

The deleted connector.
Source code in nylas/resources/connectors.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
def destroy(self, provider: Provider) -> DeleteResponse:
    """
    Delete a connector.

    Args:
        provider: The provider associated to the connector to delete.

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

find(provider)

Return a connector associated with the provider.

Parameters:

Name Type Description Default
provider Provider

The provider associated to the connector to retrieve.

 required

Returns:

Type Description
Response[Connector]

The Connector.
Source code in nylas/resources/connectors.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def find(self, provider: Provider) -> Response[Connector]:
    """
    Return a connector associated with the provider.

    Args:
        provider: The provider associated to the connector to retrieve.

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

list(query_params)

Return all Connectors.

Parameters:

Name Type Description Default
query_params ListConnectorQueryParams

The query parameters to include in the request.

 required

Returns:

Type Description
ListResponse[Connector]

The list of Connectors.
Source code in nylas/resources/connectors.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def list(self, query_params: ListConnectorQueryParams) -> ListResponse[Connector]:
    """
    Return all Connectors.

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

    Returns:
        The list of Connectors.
    """

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

update(provider, request_body)

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

Returns:

Type Description
Response[Connector]

The created connector.
Source code in nylas/resources/connectors.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def update(
    self, provider: Provider, request_body: UpdateConnectorRequest
) -> Response[Connector]:
    """
    Create a connector.

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

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