Skip to content

domains

Domains

Bases: ListableApiResource, FindableApiResource, CreatableApiResource, UpdatableApiResource, DestroyableApiResource

Nylas Manage Domains API (/v3/admin/domains).

Organization admin endpoints for registering and verifying email domains used with Transactional Send and Nylas Inbound. Optional :class:ServiceAccountSigner adds the required X-Nylas-* headers; you can also supply those headers via RequestOverrides.

Source code in nylas/resources/domains.py 
 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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
class Domains(
    ListableApiResource,
    FindableApiResource,
    CreatableApiResource,
    UpdatableApiResource,
    DestroyableApiResource,
):
    """
    Nylas Manage Domains API (``/v3/admin/domains``).

    Organization admin endpoints for registering and verifying email domains used with
    Transactional Send and Nylas Inbound. Optional :class:`ServiceAccountSigner` adds the
    required ``X-Nylas-*`` headers; you can also supply those headers via ``RequestOverrides``.
    """

    def list(
        self,
        query_params: Optional[ListDomainsQueryParams] = None,
        signer: Optional[ServiceAccountSigner] = None,
        overrides: RequestOverrides = None,
    ) -> ListResponse[Domain]:
        path = "/v3/admin/domains"
        merged = overrides
        if signer:
            hdrs, _ = signer.build_headers("GET", path, None)
            merged = _merge_signer_headers(overrides, hdrs)
        return super().list(
            path=path,
            response_type=Domain,
            query_params=query_params,
            overrides=merged,
        )

    def create(
        self,
        request_body: CreateDomainRequest,
        signer: Optional[ServiceAccountSigner] = None,
        overrides: RequestOverrides = None,
    ) -> Response[Domain]:
        path = "/v3/admin/domains"
        merged = overrides
        serialized = None
        body_arg = request_body
        if signer:
            hdrs, serialized = signer.build_headers("POST", path, dict(request_body))
            merged = _merge_signer_headers(overrides, hdrs)
            if serialized is not None:
                body_arg = None
        return super().create(
            path=path,
            request_body=body_arg,
            response_type=Domain,
            overrides=merged,
            serialized_json_body=serialized,
        )

    def find(
        self,
        domain_id: str,
        signer: Optional[ServiceAccountSigner] = None,
        overrides: RequestOverrides = None,
    ) -> Response[Domain]:
        path = f"/v3/admin/domains/{domain_id}"
        merged = overrides
        if signer:
            hdrs, _ = signer.build_headers("GET", path, None)
            merged = _merge_signer_headers(overrides, hdrs)
        return super().find(
            path=path,
            response_type=Domain,
            overrides=merged,
        )

    def update(
        self,
        domain_id: str,
        request_body: UpdateDomainRequest,
        signer: Optional[ServiceAccountSigner] = None,
        overrides: RequestOverrides = None,
    ) -> Response[Domain]:
        path = f"/v3/admin/domains/{domain_id}"
        merged = overrides
        serialized = None
        body_arg = request_body
        if signer:
            hdrs, serialized = signer.build_headers("PUT", path, dict(request_body))
            merged = _merge_signer_headers(overrides, hdrs)
            if serialized is not None:
                body_arg = None
        return super().update(
            path=path,
            request_body=body_arg,
            response_type=Domain,
            overrides=merged,
            serialized_json_body=serialized,
        )

    def destroy(
        self,
        domain_id: str,
        signer: Optional[ServiceAccountSigner] = None,
        overrides: RequestOverrides = None,
    ) -> DeleteResponse:
        path = f"/v3/admin/domains/{domain_id}"
        merged = overrides
        if signer:
            hdrs, _ = signer.build_headers("DELETE", path, None)
            merged = _merge_signer_headers(overrides, hdrs)
        return super().destroy(path=path, overrides=merged)

    def get_info(
        self,
        domain_id: str,
        request_body: GetDomainInfoRequest,
        signer: Optional[ServiceAccountSigner] = None,
        overrides: RequestOverrides = None,
    ) -> Response[DomainVerificationDetails]:
        """
        Return DNS record information and verification status for the given verification type.

        Args:
            domain_id: The domain ID.
            request_body: Body with ``type`` (for example ``ownership`` or ``dkim``).
            signer: Optional service account signer for ``X-Nylas-*`` headers.
            overrides: Request overrides (for example extra headers).

        Returns:
            Verification details including required DNS records.
        """
        path = f"/v3/admin/domains/{domain_id}/info"
        body = dict(request_body)
        merged = overrides
        serialized = None
        if signer:
            hdrs, serialized = signer.build_headers("POST", path, body)
            merged = _merge_signer_headers(overrides, hdrs)
        exec_kwargs = {"overrides": merged}
        if serialized is not None:
            exec_kwargs["serialized_json_body"] = serialized
        res, headers = self._http_client._execute(
            "POST",
            path,
            None,
            None,
            None if serialized is not None else body,
            **exec_kwargs,
        )
        return Response.from_dict(res, DomainVerificationDetails, headers)

    def verify(
        self,
        domain_id: str,
        request_body: VerifyDomainRequest,
        signer: Optional[ServiceAccountSigner] = None,
        overrides: RequestOverrides = None,
    ) -> Response[DomainVerificationDetails]:
        """
        Trigger a verification check for the specified DNS record type.

        Args:
            domain_id: The domain ID.
            request_body: Body with ``type`` of verification to run.
            signer: Optional service account signer for ``X-Nylas-*`` headers.
            overrides: Request overrides (for example extra headers).

        Returns:
            Verification attempt details and status.
        """
        path = f"/v3/admin/domains/{domain_id}/verify"
        body = dict(request_body)
        merged = overrides
        serialized = None
        if signer:
            hdrs, serialized = signer.build_headers("POST", path, body)
            merged = _merge_signer_headers(overrides, hdrs)
        exec_kwargs = {"overrides": merged}
        if serialized is not None:
            exec_kwargs["serialized_json_body"] = serialized
        res, headers = self._http_client._execute(
            "POST",
            path,
            None,
            None,
            None if serialized is not None else body,
            **exec_kwargs,
        )
        return Response.from_dict(res, DomainVerificationDetails, headers)

get_info(domain_id, request_body, signer=None, overrides=None)

Return DNS record information and verification status for the given verification type.

Parameters:

Name Type Description Default
domain_id str

The domain ID.

 required
request_body GetDomainInfoRequest

Body with type (for example ownership or dkim).

 required
signer Optional[ServiceAccountSigner]

Optional service account signer for X-Nylas-* headers.

 None
overrides RequestOverrides

Request overrides (for example extra headers).

 None

Returns:

Type Description
Response[DomainVerificationDetails]

Verification details including required DNS records.
Source code in nylas/resources/domains.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
def get_info(
    self,
    domain_id: str,
    request_body: GetDomainInfoRequest,
    signer: Optional[ServiceAccountSigner] = None,
    overrides: RequestOverrides = None,
) -> Response[DomainVerificationDetails]:
    """
    Return DNS record information and verification status for the given verification type.

    Args:
        domain_id: The domain ID.
        request_body: Body with ``type`` (for example ``ownership`` or ``dkim``).
        signer: Optional service account signer for ``X-Nylas-*`` headers.
        overrides: Request overrides (for example extra headers).

    Returns:
        Verification details including required DNS records.
    """
    path = f"/v3/admin/domains/{domain_id}/info"
    body = dict(request_body)
    merged = overrides
    serialized = None
    if signer:
        hdrs, serialized = signer.build_headers("POST", path, body)
        merged = _merge_signer_headers(overrides, hdrs)
    exec_kwargs = {"overrides": merged}
    if serialized is not None:
        exec_kwargs["serialized_json_body"] = serialized
    res, headers = self._http_client._execute(
        "POST",
        path,
        None,
        None,
        None if serialized is not None else body,
        **exec_kwargs,
    )
    return Response.from_dict(res, DomainVerificationDetails, headers)

verify(domain_id, request_body, signer=None, overrides=None)

Trigger a verification check for the specified DNS record type.

Parameters:

Name Type Description Default
domain_id str

The domain ID.

 required
request_body VerifyDomainRequest

Body with type of verification to run.

 required
signer Optional[ServiceAccountSigner]

Optional service account signer for X-Nylas-* headers.

 None
overrides RequestOverrides

Request overrides (for example extra headers).

 None

Returns:

Type Description
Response[DomainVerificationDetails]

Verification attempt details and status.
Source code in nylas/resources/domains.py 
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
def verify(
    self,
    domain_id: str,
    request_body: VerifyDomainRequest,
    signer: Optional[ServiceAccountSigner] = None,
    overrides: RequestOverrides = None,
) -> Response[DomainVerificationDetails]:
    """
    Trigger a verification check for the specified DNS record type.

    Args:
        domain_id: The domain ID.
        request_body: Body with ``type`` of verification to run.
        signer: Optional service account signer for ``X-Nylas-*`` headers.
        overrides: Request overrides (for example extra headers).

    Returns:
        Verification attempt details and status.
    """
    path = f"/v3/admin/domains/{domain_id}/verify"
    body = dict(request_body)
    merged = overrides
    serialized = None
    if signer:
        hdrs, serialized = signer.build_headers("POST", path, body)
        merged = _merge_signer_headers(overrides, hdrs)
    exec_kwargs = {"overrides": merged}
    if serialized is not None:
        exec_kwargs["serialized_json_body"] = serialized
    res, headers = self._http_client._execute(
        "POST",
        path,
        None,
        None,
        None if serialized is not None else body,
        **exec_kwargs,
    )
    return Response.from_dict(res, DomainVerificationDetails, headers)