Repository navigation
Expand file tree
/
Copy pathdomains.py
More file actions
442 lines (372 loc) · 16.9 KB
/
Copy pathdomains.py
File metadata and controls
442 lines (372 loc) · 16.9 KB
1
2
3
4
5
6
7
8
9
10
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
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
import httpx
from .verify import (
VerifyResource,
AsyncVerifyResource,
VerifyResourceWithRawResponse,
AsyncVerifyResourceWithRawResponse,
VerifyResourceWithStreamingResponse,
AsyncVerifyResourceWithStreamingResponse,
)
from ...types import domain_create_params
from ..._types import Body, Query, Headers, NotGiven, not_given
from ..._utils import path_template, maybe_transform, async_maybe_transform
from ..._compat import cached_property
from ..._resource import SyncAPIResource, AsyncAPIResource
from ..._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from ..._base_client import make_request_options
from ...types.domain_list_response import DomainListResponse
from ...types.domain_create_response import DomainCreateResponse
from ...types.domain_delete_response import DomainDeleteResponse
from ...types.domain_retrieve_response import DomainRetrieveResponse
__all__ = ["DomainsResource", "AsyncDomainsResource"]
class DomainsResource(SyncAPIResource):
"""Manage verified sender domains."""
@cached_property
def verify(self) -> VerifyResource:
"""Manage verified sender domains."""
return VerifyResource(self._client)
@cached_property
def with_raw_response(self) -> DomainsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers
"""
return DomainsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> DomainsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response
"""
return DomainsResourceWithStreamingResponse(self)
def create(
self,
*,
domain: str,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DomainCreateResponse:
"""
Register a sender domain shared by every Developer Email API project in the
workspace. Requires a personal access token belonging to a workspace owner or
admin. Verification requires the workspace-specific TXT record and the returned
SES DKIM records.
Args:
domain: Domain name to register, such as example.com.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/v3/domains",
body=maybe_transform({"domain": domain}, domain_create_params.DomainCreateParams),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DomainCreateResponse,
)
def retrieve(
self,
id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DomainRetrieveResponse:
"""
Get the ownership TXT challenge and SES DKIM records for a sender domain shared
by every Developer Email API project in the workspace. Requires a personal
access token belonging to a workspace owner or admin.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not id:
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
return self._get(
path_template("/v3/domains/{id}", id=id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DomainRetrieveResponse,
)
def list(
self,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DomainListResponse:
"""List sender domains shared by every Developer Email API project in the
workspace.
Requires a personal access token belonging to a workspace owner or
admin; project API keys cannot manage domains.
"""
return self._get(
"/v3/domains",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DomainListResponse,
)
def delete(
self,
id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DomainDeleteResponse:
"""
Delete a sender domain shared by every Developer Email API project in the
workspace. Requires a personal access token belonging to a workspace owner or
admin. The SES identity remains so a later reconciler can clean it up safely.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not id:
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
return self._delete(
path_template("/v3/domains/{id}", id=id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DomainDeleteResponse,
)
class AsyncDomainsResource(AsyncAPIResource):
"""Manage verified sender domains."""
@cached_property
def verify(self) -> AsyncVerifyResource:
"""Manage verified sender domains."""
return AsyncVerifyResource(self._client)
@cached_property
def with_raw_response(self) -> AsyncDomainsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers
"""
return AsyncDomainsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncDomainsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response
"""
return AsyncDomainsResourceWithStreamingResponse(self)
async def create(
self,
*,
domain: str,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DomainCreateResponse:
"""
Register a sender domain shared by every Developer Email API project in the
workspace. Requires a personal access token belonging to a workspace owner or
admin. Verification requires the workspace-specific TXT record and the returned
SES DKIM records.
Args:
domain: Domain name to register, such as example.com.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return await self._post(
"/v3/domains",
body=await async_maybe_transform({"domain": domain}, domain_create_params.DomainCreateParams),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DomainCreateResponse,
)
async def retrieve(
self,
id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DomainRetrieveResponse:
"""
Get the ownership TXT challenge and SES DKIM records for a sender domain shared
by every Developer Email API project in the workspace. Requires a personal
access token belonging to a workspace owner or admin.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not id:
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
return await self._get(
path_template("/v3/domains/{id}", id=id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DomainRetrieveResponse,
)
async def list(
self,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DomainListResponse:
"""List sender domains shared by every Developer Email API project in the
workspace.
Requires a personal access token belonging to a workspace owner or
admin; project API keys cannot manage domains.
"""
return await self._get(
"/v3/domains",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DomainListResponse,
)
async def delete(
self,
id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DomainDeleteResponse:
"""
Delete a sender domain shared by every Developer Email API project in the
workspace. Requires a personal access token belonging to a workspace owner or
admin. The SES identity remains so a later reconciler can clean it up safely.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not id:
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
return await self._delete(
path_template("/v3/domains/{id}", id=id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DomainDeleteResponse,
)
class DomainsResourceWithRawResponse:
def __init__(self, domains: DomainsResource) -> None:
self._domains = domains
self.create = to_raw_response_wrapper(
domains.create,
)
self.retrieve = to_raw_response_wrapper(
domains.retrieve,
)
self.list = to_raw_response_wrapper(
domains.list,
)
self.delete = to_raw_response_wrapper(
domains.delete,
)
@cached_property
def verify(self) -> VerifyResourceWithRawResponse:
"""Manage verified sender domains."""
return VerifyResourceWithRawResponse(self._domains.verify)
class AsyncDomainsResourceWithRawResponse:
def __init__(self, domains: AsyncDomainsResource) -> None:
self._domains = domains
self.create = async_to_raw_response_wrapper(
domains.create,
)
self.retrieve = async_to_raw_response_wrapper(
domains.retrieve,
)
self.list = async_to_raw_response_wrapper(
domains.list,
)
self.delete = async_to_raw_response_wrapper(
domains.delete,
)
@cached_property
def verify(self) -> AsyncVerifyResourceWithRawResponse:
"""Manage verified sender domains."""
return AsyncVerifyResourceWithRawResponse(self._domains.verify)
class DomainsResourceWithStreamingResponse:
def __init__(self, domains: DomainsResource) -> None:
self._domains = domains
self.create = to_streamed_response_wrapper(
domains.create,
)
self.retrieve = to_streamed_response_wrapper(
domains.retrieve,
)
self.list = to_streamed_response_wrapper(
domains.list,
)
self.delete = to_streamed_response_wrapper(
domains.delete,
)
@cached_property
def verify(self) -> VerifyResourceWithStreamingResponse:
"""Manage verified sender domains."""
return VerifyResourceWithStreamingResponse(self._domains.verify)
class AsyncDomainsResourceWithStreamingResponse:
def __init__(self, domains: AsyncDomainsResource) -> None:
self._domains = domains
self.create = async_to_streamed_response_wrapper(
domains.create,
)
self.retrieve = async_to_streamed_response_wrapper(
domains.retrieve,
)
self.list = async_to_streamed_response_wrapper(
domains.list,
)
self.delete = async_to_streamed_response_wrapper(
domains.delete,
)
@cached_property
def verify(self) -> AsyncVerifyResourceWithStreamingResponse:
"""Manage verified sender domains."""
return AsyncVerifyResourceWithStreamingResponse(self._domains.verify)