@zavudev/sdk 0.55.0 → 0.57.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -0
- package/client.d.mts +25 -13
- package/client.d.mts.map +1 -1
- package/client.d.ts +25 -13
- package/client.d.ts.map +1 -1
- package/client.js +15 -3
- package/client.js.map +1 -1
- package/client.mjs +15 -3
- package/client.mjs.map +1 -1
- package/internal/qs/formats.d.mts +7 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +7 -0
- package/internal/qs/formats.d.ts.map +1 -0
- package/internal/qs/formats.js +13 -0
- package/internal/qs/formats.js.map +1 -0
- package/internal/qs/formats.mjs +9 -0
- package/internal/qs/formats.mjs.map +1 -0
- package/internal/qs/index.d.mts +10 -0
- package/internal/qs/index.d.mts.map +1 -0
- package/internal/qs/index.d.ts +10 -0
- package/internal/qs/index.d.ts.map +1 -0
- package/internal/qs/index.js +14 -0
- package/internal/qs/index.js.map +1 -0
- package/internal/qs/index.mjs +10 -0
- package/internal/qs/index.mjs.map +1 -0
- package/internal/qs/stringify.d.mts +3 -0
- package/internal/qs/stringify.d.mts.map +1 -0
- package/internal/qs/stringify.d.ts +3 -0
- package/internal/qs/stringify.d.ts.map +1 -0
- package/internal/qs/stringify.js +277 -0
- package/internal/qs/stringify.js.map +1 -0
- package/internal/qs/stringify.mjs +274 -0
- package/internal/qs/stringify.mjs.map +1 -0
- package/internal/qs/types.d.mts +57 -0
- package/internal/qs/types.d.mts.map +1 -0
- package/internal/qs/types.d.ts +57 -0
- package/internal/qs/types.d.ts.map +1 -0
- package/internal/qs/types.js +3 -0
- package/internal/qs/types.js.map +1 -0
- package/internal/qs/types.mjs +2 -0
- package/internal/qs/types.mjs.map +1 -0
- package/internal/qs/utils.d.mts +15 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +15 -0
- package/internal/qs/utils.d.ts.map +1 -0
- package/internal/qs/utils.js +230 -0
- package/internal/qs/utils.js.map +1 -0
- package/internal/qs/utils.mjs +217 -0
- package/internal/qs/utils.mjs.map +1 -0
- package/internal/tslib.js +17 -17
- package/internal/utils/query.d.mts +0 -3
- package/internal/utils/query.d.mts.map +1 -1
- package/internal/utils/query.d.ts +0 -3
- package/internal/utils/query.d.ts.map +1 -1
- package/internal/utils/query.js +3 -16
- package/internal/utils/query.js.map +1 -1
- package/internal/utils/query.mjs +2 -16
- package/internal/utils/query.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/agent-templates.d.mts +97 -0
- package/resources/agent-templates.d.mts.map +1 -0
- package/resources/agent-templates.d.ts +97 -0
- package/resources/agent-templates.d.ts.map +1 -0
- package/resources/agent-templates.js +39 -0
- package/resources/agent-templates.js.map +1 -0
- package/resources/agent-templates.mjs +35 -0
- package/resources/agent-templates.mjs.map +1 -0
- package/resources/agents/agents.d.mts +462 -0
- package/resources/agents/agents.d.mts.map +1 -0
- package/resources/agents/agents.d.ts +462 -0
- package/resources/agents/agents.d.ts.map +1 -0
- package/resources/agents/agents.js +129 -0
- package/resources/agents/agents.js.map +1 -0
- package/resources/agents/agents.mjs +124 -0
- package/resources/agents/agents.mjs.map +1 -0
- package/resources/agents/index.d.mts +3 -0
- package/resources/agents/index.d.mts.map +1 -0
- package/resources/agents/index.d.ts +3 -0
- package/resources/agents/index.d.ts.map +1 -0
- package/resources/agents/index.js +9 -0
- package/resources/agents/index.js.map +1 -0
- package/resources/agents/index.mjs +4 -0
- package/resources/agents/index.mjs.map +1 -0
- package/resources/agents/senders.d.mts +54 -0
- package/resources/agents/senders.d.mts.map +1 -0
- package/resources/agents/senders.d.ts +54 -0
- package/resources/agents/senders.d.ts.map +1 -0
- package/resources/agents/senders.js +45 -0
- package/resources/agents/senders.js.map +1 -0
- package/resources/agents/senders.mjs +41 -0
- package/resources/agents/senders.mjs.map +1 -0
- package/resources/agents.d.mts +2 -0
- package/resources/agents.d.mts.map +1 -0
- package/resources/agents.d.ts +2 -0
- package/resources/agents.d.ts.map +1 -0
- package/resources/agents.js +6 -0
- package/resources/agents.js.map +1 -0
- package/resources/agents.mjs +3 -0
- package/resources/agents.mjs.map +1 -0
- package/resources/broadcasts/broadcasts.d.mts +16 -9
- package/resources/broadcasts/broadcasts.d.mts.map +1 -1
- package/resources/broadcasts/broadcasts.d.ts +16 -9
- package/resources/broadcasts/broadcasts.d.ts.map +1 -1
- package/resources/broadcasts/broadcasts.js +16 -9
- package/resources/broadcasts/broadcasts.js.map +1 -1
- package/resources/broadcasts/broadcasts.mjs +16 -9
- package/resources/broadcasts/broadcasts.mjs.map +1 -1
- package/resources/calls.d.mts +539 -0
- package/resources/calls.d.mts.map +1 -0
- package/resources/calls.d.ts +539 -0
- package/resources/calls.d.ts.map +1 -0
- package/resources/calls.js +85 -0
- package/resources/calls.js.map +1 -0
- package/resources/calls.mjs +81 -0
- package/resources/calls.mjs.map +1 -0
- package/resources/contacts/contacts.d.mts +32 -13
- package/resources/contacts/contacts.d.mts.map +1 -1
- package/resources/contacts/contacts.d.ts +32 -13
- package/resources/contacts/contacts.d.ts.map +1 -1
- package/resources/contacts/contacts.js +0 -14
- package/resources/contacts/contacts.js.map +1 -1
- package/resources/contacts/contacts.mjs +0 -14
- package/resources/contacts/contacts.mjs.map +1 -1
- package/resources/conversations.d.mts +360 -0
- package/resources/conversations.d.mts.map +1 -0
- package/resources/conversations.d.ts +360 -0
- package/resources/conversations.d.ts.map +1 -0
- package/resources/conversations.js +47 -0
- package/resources/conversations.js.map +1 -0
- package/resources/conversations.mjs +43 -0
- package/resources/conversations.mjs.map +1 -0
- package/resources/email-domains.d.mts +260 -0
- package/resources/email-domains.d.mts.map +1 -0
- package/resources/email-domains.d.ts +260 -0
- package/resources/email-domains.d.ts.map +1 -0
- package/resources/email-domains.js +77 -0
- package/resources/email-domains.js.map +1 -0
- package/resources/email-domains.mjs +73 -0
- package/resources/email-domains.mjs.map +1 -0
- package/resources/functions/functions.d.mts +122 -1
- package/resources/functions/functions.d.mts.map +1 -1
- package/resources/functions/functions.d.ts +122 -1
- package/resources/functions/functions.d.ts.map +1 -1
- package/resources/functions/functions.js +53 -0
- package/resources/functions/functions.js.map +1 -1
- package/resources/functions/functions.mjs +53 -0
- package/resources/functions/functions.mjs.map +1 -1
- package/resources/functions/git-link.d.mts +295 -0
- package/resources/functions/git-link.d.mts.map +1 -0
- package/resources/functions/git-link.d.ts +295 -0
- package/resources/functions/git-link.d.ts.map +1 -0
- package/resources/functions/git-link.js +97 -0
- package/resources/functions/git-link.js.map +1 -0
- package/resources/functions/git-link.mjs +93 -0
- package/resources/functions/git-link.mjs.map +1 -0
- package/resources/functions/index.d.mts +3 -1
- package/resources/functions/index.d.mts.map +1 -1
- package/resources/functions/index.d.ts +3 -1
- package/resources/functions/index.d.ts.map +1 -1
- package/resources/functions/index.js +5 -1
- package/resources/functions/index.js.map +1 -1
- package/resources/functions/index.mjs +2 -0
- package/resources/functions/index.mjs.map +1 -1
- package/resources/functions/triggers.d.mts +164 -0
- package/resources/functions/triggers.d.mts.map +1 -0
- package/resources/functions/triggers.d.ts +164 -0
- package/resources/functions/triggers.d.ts.map +1 -0
- package/resources/functions/triggers.js +74 -0
- package/resources/functions/triggers.js.map +1 -0
- package/resources/functions/triggers.mjs +70 -0
- package/resources/functions/triggers.mjs.map +1 -0
- package/resources/index.d.mts +10 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +10 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +11 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +5 -0
- package/resources/index.mjs.map +1 -1
- package/resources/introspect.d.mts +74 -1
- package/resources/introspect.d.mts.map +1 -1
- package/resources/introspect.d.ts +74 -1
- package/resources/introspect.d.ts.map +1 -1
- package/resources/introspect.js +22 -0
- package/resources/introspect.js.map +1 -1
- package/resources/introspect.mjs +22 -0
- package/resources/introspect.mjs.map +1 -1
- package/resources/messages.d.mts +89 -1
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +89 -1
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +48 -0
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +48 -0
- package/resources/messages.mjs.map +1 -1
- package/resources/number-10dlc/brands.d.mts +10 -5
- package/resources/number-10dlc/brands.d.mts.map +1 -1
- package/resources/number-10dlc/brands.d.ts +10 -5
- package/resources/number-10dlc/brands.d.ts.map +1 -1
- package/resources/number-10dlc/brands.js +10 -5
- package/resources/number-10dlc/brands.js.map +1 -1
- package/resources/number-10dlc/brands.mjs +10 -5
- package/resources/number-10dlc/brands.mjs.map +1 -1
- package/resources/number-10dlc/campaigns/campaigns.d.mts +8 -7
- package/resources/number-10dlc/campaigns/campaigns.d.mts.map +1 -1
- package/resources/number-10dlc/campaigns/campaigns.d.ts +8 -7
- package/resources/number-10dlc/campaigns/campaigns.d.ts.map +1 -1
- package/resources/number-10dlc/campaigns/campaigns.js +8 -7
- package/resources/number-10dlc/campaigns/campaigns.js.map +1 -1
- package/resources/number-10dlc/campaigns/campaigns.mjs +8 -7
- package/resources/number-10dlc/campaigns/campaigns.mjs.map +1 -1
- package/resources/phone-numbers.d.mts +6 -1
- package/resources/phone-numbers.d.mts.map +1 -1
- package/resources/phone-numbers.d.ts +6 -1
- package/resources/phone-numbers.d.ts.map +1 -1
- package/resources/senders/agent/agent.d.mts +4 -3
- package/resources/senders/agent/agent.d.mts.map +1 -1
- package/resources/senders/agent/agent.d.ts +4 -3
- package/resources/senders/agent/agent.d.ts.map +1 -1
- package/resources/senders/agent/agent.js +2 -2
- package/resources/senders/agent/agent.js.map +1 -1
- package/resources/senders/agent/agent.mjs +2 -2
- package/resources/senders/agent/agent.mjs.map +1 -1
- package/resources/senders/agent/index.d.mts +2 -2
- package/resources/senders/agent/index.d.mts.map +1 -1
- package/resources/senders/agent/index.d.ts +2 -2
- package/resources/senders/agent/index.d.ts.map +1 -1
- package/resources/senders/agent/index.js +2 -2
- package/resources/senders/agent/index.js.map +1 -1
- package/resources/senders/agent/index.mjs +1 -1
- package/resources/senders/agent/index.mjs.map +1 -1
- package/resources/senders/agent/knowledge-bases/documents.d.mts +56 -1
- package/resources/senders/agent/knowledge-bases/documents.d.mts.map +1 -1
- package/resources/senders/agent/knowledge-bases/documents.d.ts +56 -1
- package/resources/senders/agent/knowledge-bases/documents.d.ts.map +1 -1
- package/resources/senders/agent/knowledge-bases/documents.js +33 -0
- package/resources/senders/agent/knowledge-bases/documents.js.map +1 -1
- package/resources/senders/agent/knowledge-bases/documents.mjs +33 -0
- package/resources/senders/agent/knowledge-bases/documents.mjs.map +1 -1
- package/resources/senders/agent/knowledge-bases/index.d.mts +1 -1
- package/resources/senders/agent/knowledge-bases/index.d.mts.map +1 -1
- package/resources/senders/agent/knowledge-bases/index.d.ts +1 -1
- package/resources/senders/agent/knowledge-bases/index.d.ts.map +1 -1
- package/resources/senders/agent/knowledge-bases/index.js.map +1 -1
- package/resources/senders/agent/knowledge-bases/index.mjs.map +1 -1
- package/resources/senders/agent/knowledge-bases/knowledge-bases.d.mts +2 -2
- package/resources/senders/agent/knowledge-bases/knowledge-bases.d.mts.map +1 -1
- package/resources/senders/agent/knowledge-bases/knowledge-bases.d.ts +2 -2
- package/resources/senders/agent/knowledge-bases/knowledge-bases.d.ts.map +1 -1
- package/resources/senders/agent/knowledge-bases/knowledge-bases.js.map +1 -1
- package/resources/senders/agent/knowledge-bases/knowledge-bases.mjs.map +1 -1
- package/resources/senders/agent/tools/index.d.mts +3 -0
- package/resources/senders/agent/tools/index.d.mts.map +1 -0
- package/resources/senders/agent/tools/index.d.ts +3 -0
- package/resources/senders/agent/tools/index.d.ts.map +1 -0
- package/resources/senders/agent/tools/index.js +9 -0
- package/resources/senders/agent/tools/index.js.map +1 -0
- package/resources/senders/agent/tools/index.mjs +4 -0
- package/resources/senders/agent/tools/index.mjs.map +1 -0
- package/resources/senders/agent/tools/tools.d.mts +338 -0
- package/resources/senders/agent/tools/tools.d.mts.map +1 -0
- package/resources/senders/agent/tools/tools.d.ts +338 -0
- package/resources/senders/agent/tools/tools.d.ts.map +1 -0
- package/resources/senders/agent/tools/tools.js +163 -0
- package/resources/senders/agent/tools/tools.js.map +1 -0
- package/resources/senders/agent/tools/tools.mjs +158 -0
- package/resources/senders/agent/tools/tools.mjs.map +1 -0
- package/resources/senders/agent/tools/webhook.d.mts +28 -0
- package/resources/senders/agent/tools/webhook.d.mts.map +1 -0
- package/resources/senders/agent/tools/webhook.d.ts +28 -0
- package/resources/senders/agent/tools/webhook.d.ts.map +1 -0
- package/resources/senders/agent/tools/webhook.js +28 -0
- package/resources/senders/agent/tools/webhook.js.map +1 -0
- package/resources/senders/agent/tools/webhook.mjs +24 -0
- package/resources/senders/agent/tools/webhook.mjs.map +1 -0
- package/resources/senders/agent/tools.d.mts +1 -270
- package/resources/senders/agent/tools.d.mts.map +1 -1
- package/resources/senders/agent/tools.d.ts +1 -270
- package/resources/senders/agent/tools.d.ts.map +1 -1
- package/resources/senders/agent/tools.js +2 -131
- package/resources/senders/agent/tools.js.map +1 -1
- package/resources/senders/agent/tools.mjs +1 -129
- package/resources/senders/agent/tools.mjs.map +1 -1
- package/resources/senders/index.d.mts +2 -1
- package/resources/senders/index.d.mts.map +1 -1
- package/resources/senders/index.d.ts +2 -1
- package/resources/senders/index.d.ts.map +1 -1
- package/resources/senders/index.js +3 -1
- package/resources/senders/index.js.map +1 -1
- package/resources/senders/index.mjs +1 -0
- package/resources/senders/index.mjs.map +1 -1
- package/resources/senders/senders.d.mts +4 -0
- package/resources/senders/senders.d.mts.map +1 -1
- package/resources/senders/senders.d.ts +4 -0
- package/resources/senders/senders.d.ts.map +1 -1
- package/resources/senders/senders.js +4 -0
- package/resources/senders/senders.js.map +1 -1
- package/resources/senders/senders.mjs +4 -0
- package/resources/senders/senders.mjs.map +1 -1
- package/resources/senders/telegram.d.mts +48 -0
- package/resources/senders/telegram.d.mts.map +1 -0
- package/resources/senders/telegram.d.ts +48 -0
- package/resources/senders/telegram.d.ts.map +1 -0
- package/resources/senders/telegram.js +41 -0
- package/resources/senders/telegram.js.map +1 -0
- package/resources/senders/telegram.mjs +37 -0
- package/resources/senders/telegram.mjs.map +1 -0
- package/resources/templates.d.mts +66 -1
- package/resources/templates.d.mts.map +1 -1
- package/resources/templates.d.ts +66 -1
- package/resources/templates.d.ts.map +1 -1
- package/resources/templates.js +31 -0
- package/resources/templates.js.map +1 -1
- package/resources/templates.mjs +31 -0
- package/resources/templates.mjs.map +1 -1
- package/resources/urls.d.mts +24 -1
- package/resources/urls.d.mts.map +1 -1
- package/resources/urls.d.ts +24 -1
- package/resources/urls.d.ts.map +1 -1
- package/resources/urls.js +15 -0
- package/resources/urls.js.map +1 -1
- package/resources/urls.mjs +15 -0
- package/resources/urls.mjs.map +1 -1
- package/src/client.ts +129 -3
- package/src/internal/qs/LICENSE.md +13 -0
- package/src/internal/qs/README.md +3 -0
- package/src/internal/qs/formats.ts +10 -0
- package/src/internal/qs/index.ts +13 -0
- package/src/internal/qs/stringify.ts +385 -0
- package/src/internal/qs/types.ts +71 -0
- package/src/internal/qs/utils.ts +265 -0
- package/src/internal/utils/query.ts +2 -18
- package/src/resources/agent-templates.ts +128 -0
- package/src/resources/agents/agents.ts +603 -0
- package/src/resources/agents/index.ts +21 -0
- package/src/resources/agents/senders.ts +79 -0
- package/src/resources/agents.ts +3 -0
- package/src/resources/broadcasts/broadcasts.ts +16 -9
- package/src/resources/calls.ts +647 -0
- package/src/resources/contacts/contacts.ts +35 -20
- package/src/resources/conversations.ts +472 -0
- package/src/resources/email-domains.ts +337 -0
- package/src/resources/functions/functions.ts +202 -0
- package/src/resources/functions/git-link.ts +398 -0
- package/src/resources/functions/index.ts +22 -0
- package/src/resources/functions/triggers.ts +227 -0
- package/src/resources/index.ts +57 -0
- package/src/resources/introspect.ts +105 -0
- package/src/resources/messages.ts +102 -0
- package/src/resources/number-10dlc/brands.ts +10 -5
- package/src/resources/number-10dlc/campaigns/campaigns.ts +8 -7
- package/src/resources/phone-numbers.ts +6 -1
- package/src/resources/senders/agent/agent.ts +23 -17
- package/src/resources/senders/agent/index.ts +4 -1
- package/src/resources/senders/agent/knowledge-bases/documents.ts +89 -0
- package/src/resources/senders/agent/knowledge-bases/index.ts +4 -0
- package/src/resources/senders/agent/knowledge-bases/knowledge-bases.ts +8 -0
- package/src/resources/senders/agent/tools/index.ts +21 -0
- package/src/resources/senders/agent/tools/tools.ts +460 -0
- package/src/resources/senders/agent/tools/webhook.ts +40 -0
- package/src/resources/senders/agent/tools.ts +1 -364
- package/src/resources/senders/index.ts +2 -0
- package/src/resources/senders/senders.ts +10 -0
- package/src/resources/senders/telegram.ts +73 -0
- package/src/resources/templates.ts +80 -0
- package/src/resources/urls.ts +35 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -0,0 +1,260 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
export declare class EmailDomains extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Add a domain to send email from. Returns the DNS records to publish (DKIM CNAMEs
|
|
7
|
+
* are required; SPF, DMARC, and MAIL FROM are recommended). Publish them at your
|
|
8
|
+
* DNS provider, then verify.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const emailDomain = await client.emailDomains.create({
|
|
13
|
+
* domain: 'example.com',
|
|
14
|
+
* });
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
create(body: EmailDomainCreateParams, options?: RequestOptions): APIPromise<EmailDomainCreateResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* Fetch a domain with its DNS records and current status.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const emailDomain = await client.emailDomains.retrieve(
|
|
24
|
+
* 'domainId',
|
|
25
|
+
* );
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
retrieve(domainID: string, options?: RequestOptions): APIPromise<EmailDomainRetrieveResponse>;
|
|
29
|
+
/**
|
|
30
|
+
* List email domains
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const emailDomains = await client.emailDomains.list();
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
list(options?: RequestOptions): APIPromise<EmailDomainListResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* Remove an email domain
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```ts
|
|
43
|
+
* await client.emailDomains.delete('domainId');
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
delete(domainID: string, options?: RequestOptions): APIPromise<void>;
|
|
47
|
+
/**
|
|
48
|
+
* Re-check the domain's published DNS records and refresh its status.
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```ts
|
|
52
|
+
* const response = await client.emailDomains.verify(
|
|
53
|
+
* 'domainId',
|
|
54
|
+
* );
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
verify(domainID: string, options?: RequestOptions): APIPromise<EmailDomainVerifyResponse>;
|
|
58
|
+
}
|
|
59
|
+
export interface EmailDomainCreateResponse {
|
|
60
|
+
domain: EmailDomainCreateResponse.Domain;
|
|
61
|
+
}
|
|
62
|
+
export declare namespace EmailDomainCreateResponse {
|
|
63
|
+
interface Domain {
|
|
64
|
+
id: string;
|
|
65
|
+
dkimStatus: string;
|
|
66
|
+
domain: string;
|
|
67
|
+
/**
|
|
68
|
+
* Overall verification status.
|
|
69
|
+
*/
|
|
70
|
+
status: string;
|
|
71
|
+
/**
|
|
72
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
73
|
+
* one.
|
|
74
|
+
*/
|
|
75
|
+
dnsRecords?: Array<Domain.DNSRecord>;
|
|
76
|
+
}
|
|
77
|
+
namespace Domain {
|
|
78
|
+
interface DNSRecord {
|
|
79
|
+
/**
|
|
80
|
+
* Record host/name to create.
|
|
81
|
+
*/
|
|
82
|
+
name: string;
|
|
83
|
+
/**
|
|
84
|
+
* What the record is for.
|
|
85
|
+
*/
|
|
86
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
87
|
+
/**
|
|
88
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
89
|
+
* deliverability.
|
|
90
|
+
*/
|
|
91
|
+
required: boolean;
|
|
92
|
+
/**
|
|
93
|
+
* DNS record type.
|
|
94
|
+
*/
|
|
95
|
+
type: string;
|
|
96
|
+
/**
|
|
97
|
+
* Record value.
|
|
98
|
+
*/
|
|
99
|
+
value: string;
|
|
100
|
+
/**
|
|
101
|
+
* Priority (MX records only).
|
|
102
|
+
*/
|
|
103
|
+
priority?: number;
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
export interface EmailDomainRetrieveResponse {
|
|
108
|
+
domain: EmailDomainRetrieveResponse.Domain;
|
|
109
|
+
}
|
|
110
|
+
export declare namespace EmailDomainRetrieveResponse {
|
|
111
|
+
interface Domain {
|
|
112
|
+
id: string;
|
|
113
|
+
dkimStatus: string;
|
|
114
|
+
domain: string;
|
|
115
|
+
/**
|
|
116
|
+
* Overall verification status.
|
|
117
|
+
*/
|
|
118
|
+
status: string;
|
|
119
|
+
/**
|
|
120
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
121
|
+
* one.
|
|
122
|
+
*/
|
|
123
|
+
dnsRecords?: Array<Domain.DNSRecord>;
|
|
124
|
+
}
|
|
125
|
+
namespace Domain {
|
|
126
|
+
interface DNSRecord {
|
|
127
|
+
/**
|
|
128
|
+
* Record host/name to create.
|
|
129
|
+
*/
|
|
130
|
+
name: string;
|
|
131
|
+
/**
|
|
132
|
+
* What the record is for.
|
|
133
|
+
*/
|
|
134
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
135
|
+
/**
|
|
136
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
137
|
+
* deliverability.
|
|
138
|
+
*/
|
|
139
|
+
required: boolean;
|
|
140
|
+
/**
|
|
141
|
+
* DNS record type.
|
|
142
|
+
*/
|
|
143
|
+
type: string;
|
|
144
|
+
/**
|
|
145
|
+
* Record value.
|
|
146
|
+
*/
|
|
147
|
+
value: string;
|
|
148
|
+
/**
|
|
149
|
+
* Priority (MX records only).
|
|
150
|
+
*/
|
|
151
|
+
priority?: number;
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
export interface EmailDomainListResponse {
|
|
156
|
+
items: Array<EmailDomainListResponse.Item>;
|
|
157
|
+
}
|
|
158
|
+
export declare namespace EmailDomainListResponse {
|
|
159
|
+
interface Item {
|
|
160
|
+
id: string;
|
|
161
|
+
dkimStatus: string;
|
|
162
|
+
domain: string;
|
|
163
|
+
/**
|
|
164
|
+
* Overall verification status.
|
|
165
|
+
*/
|
|
166
|
+
status: string;
|
|
167
|
+
/**
|
|
168
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
169
|
+
* one.
|
|
170
|
+
*/
|
|
171
|
+
dnsRecords?: Array<Item.DNSRecord>;
|
|
172
|
+
}
|
|
173
|
+
namespace Item {
|
|
174
|
+
interface DNSRecord {
|
|
175
|
+
/**
|
|
176
|
+
* Record host/name to create.
|
|
177
|
+
*/
|
|
178
|
+
name: string;
|
|
179
|
+
/**
|
|
180
|
+
* What the record is for.
|
|
181
|
+
*/
|
|
182
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
183
|
+
/**
|
|
184
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
185
|
+
* deliverability.
|
|
186
|
+
*/
|
|
187
|
+
required: boolean;
|
|
188
|
+
/**
|
|
189
|
+
* DNS record type.
|
|
190
|
+
*/
|
|
191
|
+
type: string;
|
|
192
|
+
/**
|
|
193
|
+
* Record value.
|
|
194
|
+
*/
|
|
195
|
+
value: string;
|
|
196
|
+
/**
|
|
197
|
+
* Priority (MX records only).
|
|
198
|
+
*/
|
|
199
|
+
priority?: number;
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
export interface EmailDomainVerifyResponse {
|
|
204
|
+
domain: EmailDomainVerifyResponse.Domain;
|
|
205
|
+
}
|
|
206
|
+
export declare namespace EmailDomainVerifyResponse {
|
|
207
|
+
interface Domain {
|
|
208
|
+
id: string;
|
|
209
|
+
dkimStatus: string;
|
|
210
|
+
domain: string;
|
|
211
|
+
/**
|
|
212
|
+
* Overall verification status.
|
|
213
|
+
*/
|
|
214
|
+
status: string;
|
|
215
|
+
/**
|
|
216
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
217
|
+
* one.
|
|
218
|
+
*/
|
|
219
|
+
dnsRecords?: Array<Domain.DNSRecord>;
|
|
220
|
+
}
|
|
221
|
+
namespace Domain {
|
|
222
|
+
interface DNSRecord {
|
|
223
|
+
/**
|
|
224
|
+
* Record host/name to create.
|
|
225
|
+
*/
|
|
226
|
+
name: string;
|
|
227
|
+
/**
|
|
228
|
+
* What the record is for.
|
|
229
|
+
*/
|
|
230
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
231
|
+
/**
|
|
232
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
233
|
+
* deliverability.
|
|
234
|
+
*/
|
|
235
|
+
required: boolean;
|
|
236
|
+
/**
|
|
237
|
+
* DNS record type.
|
|
238
|
+
*/
|
|
239
|
+
type: string;
|
|
240
|
+
/**
|
|
241
|
+
* Record value.
|
|
242
|
+
*/
|
|
243
|
+
value: string;
|
|
244
|
+
/**
|
|
245
|
+
* Priority (MX records only).
|
|
246
|
+
*/
|
|
247
|
+
priority?: number;
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
export interface EmailDomainCreateParams {
|
|
252
|
+
/**
|
|
253
|
+
* Bare domain, e.g. example.com.
|
|
254
|
+
*/
|
|
255
|
+
domain: string;
|
|
256
|
+
}
|
|
257
|
+
export declare namespace EmailDomains {
|
|
258
|
+
export { type EmailDomainCreateResponse as EmailDomainCreateResponse, type EmailDomainRetrieveResponse as EmailDomainRetrieveResponse, type EmailDomainListResponse as EmailDomainListResponse, type EmailDomainVerifyResponse as EmailDomainVerifyResponse, type EmailDomainCreateParams as EmailDomainCreateParams, };
|
|
259
|
+
}
|
|
260
|
+
//# sourceMappingURL=email-domains.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-domains.d.mts","sourceRoot":"","sources":["../src/resources/email-domains.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAItG;;;;;;;;;OASG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAI7F;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInE;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAG1F;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CAC1C;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;KACtC;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,SAAS;YACxB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,WAAW,CAAC;YAEhD;;;eAGG;YACH,QAAQ,EAAE,OAAO,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,2BAA2B,CAAC,MAAM,CAAC;CAC5C;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;KACtC;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,SAAS;YACxB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,WAAW,CAAC;YAEhD;;;eAGG;YACH,QAAQ,EAAE,OAAO,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;CAC5C;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KACpC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,SAAS;YACxB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,WAAW,CAAC;YAEhD;;;eAGG;YACH,QAAQ,EAAE,OAAO,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CAC1C;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;KACtC;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,SAAS;YACxB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,WAAW,CAAC;YAEhD;;;eAGG;YACH,QAAQ,EAAE,OAAO,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
|
@@ -0,0 +1,260 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
export declare class EmailDomains extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Add a domain to send email from. Returns the DNS records to publish (DKIM CNAMEs
|
|
7
|
+
* are required; SPF, DMARC, and MAIL FROM are recommended). Publish them at your
|
|
8
|
+
* DNS provider, then verify.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const emailDomain = await client.emailDomains.create({
|
|
13
|
+
* domain: 'example.com',
|
|
14
|
+
* });
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
create(body: EmailDomainCreateParams, options?: RequestOptions): APIPromise<EmailDomainCreateResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* Fetch a domain with its DNS records and current status.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const emailDomain = await client.emailDomains.retrieve(
|
|
24
|
+
* 'domainId',
|
|
25
|
+
* );
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
retrieve(domainID: string, options?: RequestOptions): APIPromise<EmailDomainRetrieveResponse>;
|
|
29
|
+
/**
|
|
30
|
+
* List email domains
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const emailDomains = await client.emailDomains.list();
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
list(options?: RequestOptions): APIPromise<EmailDomainListResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* Remove an email domain
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```ts
|
|
43
|
+
* await client.emailDomains.delete('domainId');
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
delete(domainID: string, options?: RequestOptions): APIPromise<void>;
|
|
47
|
+
/**
|
|
48
|
+
* Re-check the domain's published DNS records and refresh its status.
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```ts
|
|
52
|
+
* const response = await client.emailDomains.verify(
|
|
53
|
+
* 'domainId',
|
|
54
|
+
* );
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
verify(domainID: string, options?: RequestOptions): APIPromise<EmailDomainVerifyResponse>;
|
|
58
|
+
}
|
|
59
|
+
export interface EmailDomainCreateResponse {
|
|
60
|
+
domain: EmailDomainCreateResponse.Domain;
|
|
61
|
+
}
|
|
62
|
+
export declare namespace EmailDomainCreateResponse {
|
|
63
|
+
interface Domain {
|
|
64
|
+
id: string;
|
|
65
|
+
dkimStatus: string;
|
|
66
|
+
domain: string;
|
|
67
|
+
/**
|
|
68
|
+
* Overall verification status.
|
|
69
|
+
*/
|
|
70
|
+
status: string;
|
|
71
|
+
/**
|
|
72
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
73
|
+
* one.
|
|
74
|
+
*/
|
|
75
|
+
dnsRecords?: Array<Domain.DNSRecord>;
|
|
76
|
+
}
|
|
77
|
+
namespace Domain {
|
|
78
|
+
interface DNSRecord {
|
|
79
|
+
/**
|
|
80
|
+
* Record host/name to create.
|
|
81
|
+
*/
|
|
82
|
+
name: string;
|
|
83
|
+
/**
|
|
84
|
+
* What the record is for.
|
|
85
|
+
*/
|
|
86
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
87
|
+
/**
|
|
88
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
89
|
+
* deliverability.
|
|
90
|
+
*/
|
|
91
|
+
required: boolean;
|
|
92
|
+
/**
|
|
93
|
+
* DNS record type.
|
|
94
|
+
*/
|
|
95
|
+
type: string;
|
|
96
|
+
/**
|
|
97
|
+
* Record value.
|
|
98
|
+
*/
|
|
99
|
+
value: string;
|
|
100
|
+
/**
|
|
101
|
+
* Priority (MX records only).
|
|
102
|
+
*/
|
|
103
|
+
priority?: number;
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
export interface EmailDomainRetrieveResponse {
|
|
108
|
+
domain: EmailDomainRetrieveResponse.Domain;
|
|
109
|
+
}
|
|
110
|
+
export declare namespace EmailDomainRetrieveResponse {
|
|
111
|
+
interface Domain {
|
|
112
|
+
id: string;
|
|
113
|
+
dkimStatus: string;
|
|
114
|
+
domain: string;
|
|
115
|
+
/**
|
|
116
|
+
* Overall verification status.
|
|
117
|
+
*/
|
|
118
|
+
status: string;
|
|
119
|
+
/**
|
|
120
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
121
|
+
* one.
|
|
122
|
+
*/
|
|
123
|
+
dnsRecords?: Array<Domain.DNSRecord>;
|
|
124
|
+
}
|
|
125
|
+
namespace Domain {
|
|
126
|
+
interface DNSRecord {
|
|
127
|
+
/**
|
|
128
|
+
* Record host/name to create.
|
|
129
|
+
*/
|
|
130
|
+
name: string;
|
|
131
|
+
/**
|
|
132
|
+
* What the record is for.
|
|
133
|
+
*/
|
|
134
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
135
|
+
/**
|
|
136
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
137
|
+
* deliverability.
|
|
138
|
+
*/
|
|
139
|
+
required: boolean;
|
|
140
|
+
/**
|
|
141
|
+
* DNS record type.
|
|
142
|
+
*/
|
|
143
|
+
type: string;
|
|
144
|
+
/**
|
|
145
|
+
* Record value.
|
|
146
|
+
*/
|
|
147
|
+
value: string;
|
|
148
|
+
/**
|
|
149
|
+
* Priority (MX records only).
|
|
150
|
+
*/
|
|
151
|
+
priority?: number;
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
export interface EmailDomainListResponse {
|
|
156
|
+
items: Array<EmailDomainListResponse.Item>;
|
|
157
|
+
}
|
|
158
|
+
export declare namespace EmailDomainListResponse {
|
|
159
|
+
interface Item {
|
|
160
|
+
id: string;
|
|
161
|
+
dkimStatus: string;
|
|
162
|
+
domain: string;
|
|
163
|
+
/**
|
|
164
|
+
* Overall verification status.
|
|
165
|
+
*/
|
|
166
|
+
status: string;
|
|
167
|
+
/**
|
|
168
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
169
|
+
* one.
|
|
170
|
+
*/
|
|
171
|
+
dnsRecords?: Array<Item.DNSRecord>;
|
|
172
|
+
}
|
|
173
|
+
namespace Item {
|
|
174
|
+
interface DNSRecord {
|
|
175
|
+
/**
|
|
176
|
+
* Record host/name to create.
|
|
177
|
+
*/
|
|
178
|
+
name: string;
|
|
179
|
+
/**
|
|
180
|
+
* What the record is for.
|
|
181
|
+
*/
|
|
182
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
183
|
+
/**
|
|
184
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
185
|
+
* deliverability.
|
|
186
|
+
*/
|
|
187
|
+
required: boolean;
|
|
188
|
+
/**
|
|
189
|
+
* DNS record type.
|
|
190
|
+
*/
|
|
191
|
+
type: string;
|
|
192
|
+
/**
|
|
193
|
+
* Record value.
|
|
194
|
+
*/
|
|
195
|
+
value: string;
|
|
196
|
+
/**
|
|
197
|
+
* Priority (MX records only).
|
|
198
|
+
*/
|
|
199
|
+
priority?: number;
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
export interface EmailDomainVerifyResponse {
|
|
204
|
+
domain: EmailDomainVerifyResponse.Domain;
|
|
205
|
+
}
|
|
206
|
+
export declare namespace EmailDomainVerifyResponse {
|
|
207
|
+
interface Domain {
|
|
208
|
+
id: string;
|
|
209
|
+
dkimStatus: string;
|
|
210
|
+
domain: string;
|
|
211
|
+
/**
|
|
212
|
+
* Overall verification status.
|
|
213
|
+
*/
|
|
214
|
+
status: string;
|
|
215
|
+
/**
|
|
216
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
217
|
+
* one.
|
|
218
|
+
*/
|
|
219
|
+
dnsRecords?: Array<Domain.DNSRecord>;
|
|
220
|
+
}
|
|
221
|
+
namespace Domain {
|
|
222
|
+
interface DNSRecord {
|
|
223
|
+
/**
|
|
224
|
+
* Record host/name to create.
|
|
225
|
+
*/
|
|
226
|
+
name: string;
|
|
227
|
+
/**
|
|
228
|
+
* What the record is for.
|
|
229
|
+
*/
|
|
230
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
231
|
+
/**
|
|
232
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
233
|
+
* deliverability.
|
|
234
|
+
*/
|
|
235
|
+
required: boolean;
|
|
236
|
+
/**
|
|
237
|
+
* DNS record type.
|
|
238
|
+
*/
|
|
239
|
+
type: string;
|
|
240
|
+
/**
|
|
241
|
+
* Record value.
|
|
242
|
+
*/
|
|
243
|
+
value: string;
|
|
244
|
+
/**
|
|
245
|
+
* Priority (MX records only).
|
|
246
|
+
*/
|
|
247
|
+
priority?: number;
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
export interface EmailDomainCreateParams {
|
|
252
|
+
/**
|
|
253
|
+
* Bare domain, e.g. example.com.
|
|
254
|
+
*/
|
|
255
|
+
domain: string;
|
|
256
|
+
}
|
|
257
|
+
export declare namespace EmailDomains {
|
|
258
|
+
export { type EmailDomainCreateResponse as EmailDomainCreateResponse, type EmailDomainRetrieveResponse as EmailDomainRetrieveResponse, type EmailDomainListResponse as EmailDomainListResponse, type EmailDomainVerifyResponse as EmailDomainVerifyResponse, type EmailDomainCreateParams as EmailDomainCreateParams, };
|
|
259
|
+
}
|
|
260
|
+
//# sourceMappingURL=email-domains.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-domains.d.ts","sourceRoot":"","sources":["../src/resources/email-domains.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAItG;;;;;;;;;OASG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAI7F;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInE;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAG1F;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CAC1C;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;KACtC;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,SAAS;YACxB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,WAAW,CAAC;YAEhD;;;eAGG;YACH,QAAQ,EAAE,OAAO,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,2BAA2B,CAAC,MAAM,CAAC;CAC5C;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;KACtC;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,SAAS;YACxB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,WAAW,CAAC;YAEhD;;;eAGG;YACH,QAAQ,EAAE,OAAO,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;CAC5C;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KACpC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,SAAS;YACxB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,WAAW,CAAC;YAEhD;;;eAGG;YACH,QAAQ,EAAE,OAAO,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CAC1C;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;KACtC;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,SAAS;YACxB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,WAAW,CAAC;YAEhD;;;eAGG;YACH,QAAQ,EAAE,OAAO,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.EmailDomains = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const headers_1 = require("../internal/headers.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
class EmailDomains extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Add a domain to send email from. Returns the DNS records to publish (DKIM CNAMEs
|
|
11
|
+
* are required; SPF, DMARC, and MAIL FROM are recommended). Publish them at your
|
|
12
|
+
* DNS provider, then verify.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const emailDomain = await client.emailDomains.create({
|
|
17
|
+
* domain: 'example.com',
|
|
18
|
+
* });
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
create(body, options) {
|
|
22
|
+
return this._client.post('/v1/email-domains', { body, ...options });
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Fetch a domain with its DNS records and current status.
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```ts
|
|
29
|
+
* const emailDomain = await client.emailDomains.retrieve(
|
|
30
|
+
* 'domainId',
|
|
31
|
+
* );
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
retrieve(domainID, options) {
|
|
35
|
+
return this._client.get((0, path_1.path) `/v1/email-domains/${domainID}`, options);
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* List email domains
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const emailDomains = await client.emailDomains.list();
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
list(options) {
|
|
46
|
+
return this._client.get('/v1/email-domains', options);
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Remove an email domain
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* ```ts
|
|
53
|
+
* await client.emailDomains.delete('domainId');
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
delete(domainID, options) {
|
|
57
|
+
return this._client.delete((0, path_1.path) `/v1/email-domains/${domainID}`, {
|
|
58
|
+
...options,
|
|
59
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Re-check the domain's published DNS records and refresh its status.
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* ```ts
|
|
67
|
+
* const response = await client.emailDomains.verify(
|
|
68
|
+
* 'domainId',
|
|
69
|
+
* );
|
|
70
|
+
* ```
|
|
71
|
+
*/
|
|
72
|
+
verify(domainID, options) {
|
|
73
|
+
return this._client.post((0, path_1.path) `/v1/email-domains/${domainID}/verify`, options);
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
exports.EmailDomains = EmailDomains;
|
|
77
|
+
//# sourceMappingURL=email-domains.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-domains.js","sourceRoot":"","sources":["../src/resources/email-domains.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,QAAQ,EAAE,EAAE;YAC9D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,QAAQ,SAAS,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF;AAvED,oCAuEC"}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { buildHeaders } from "../internal/headers.mjs";
|
|
4
|
+
import { path } from "../internal/utils/path.mjs";
|
|
5
|
+
export class EmailDomains extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Add a domain to send email from. Returns the DNS records to publish (DKIM CNAMEs
|
|
8
|
+
* are required; SPF, DMARC, and MAIL FROM are recommended). Publish them at your
|
|
9
|
+
* DNS provider, then verify.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const emailDomain = await client.emailDomains.create({
|
|
14
|
+
* domain: 'example.com',
|
|
15
|
+
* });
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
18
|
+
create(body, options) {
|
|
19
|
+
return this._client.post('/v1/email-domains', { body, ...options });
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Fetch a domain with its DNS records and current status.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const emailDomain = await client.emailDomains.retrieve(
|
|
27
|
+
* 'domainId',
|
|
28
|
+
* );
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
retrieve(domainID, options) {
|
|
32
|
+
return this._client.get(path `/v1/email-domains/${domainID}`, options);
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* List email domains
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const emailDomains = await client.emailDomains.list();
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
list(options) {
|
|
43
|
+
return this._client.get('/v1/email-domains', options);
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Remove an email domain
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* await client.emailDomains.delete('domainId');
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
delete(domainID, options) {
|
|
54
|
+
return this._client.delete(path `/v1/email-domains/${domainID}`, {
|
|
55
|
+
...options,
|
|
56
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Re-check the domain's published DNS records and refresh its status.
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```ts
|
|
64
|
+
* const response = await client.emailDomains.verify(
|
|
65
|
+
* 'domainId',
|
|
66
|
+
* );
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
69
|
+
verify(domainID, options) {
|
|
70
|
+
return this._client.post(path `/v1/email-domains/${domainID}/verify`, options);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
//# sourceMappingURL=email-domains.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-domains.mjs","sourceRoot":"","sources":["../src/resources/email-domains.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,QAAQ,EAAE,EAAE;YAC9D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,QAAQ,SAAS,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF"}
|