@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,337 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../core/resource';
|
|
4
|
+
import { APIPromise } from '../core/api-promise';
|
|
5
|
+
import { buildHeaders } from '../internal/headers';
|
|
6
|
+
import { RequestOptions } from '../internal/request-options';
|
|
7
|
+
import { path } from '../internal/utils/path';
|
|
8
|
+
|
|
9
|
+
export class EmailDomains extends APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* Add a domain to send email from. Returns the DNS records to publish (DKIM CNAMEs
|
|
12
|
+
* are required; SPF, DMARC, and MAIL FROM are recommended). Publish them at your
|
|
13
|
+
* DNS provider, then verify.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const emailDomain = await client.emailDomains.create({
|
|
18
|
+
* domain: 'example.com',
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
create(body: EmailDomainCreateParams, options?: RequestOptions): APIPromise<EmailDomainCreateResponse> {
|
|
23
|
+
return this._client.post('/v1/email-domains', { body, ...options });
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Fetch a domain with its DNS records and current status.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const emailDomain = await client.emailDomains.retrieve(
|
|
32
|
+
* 'domainId',
|
|
33
|
+
* );
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
retrieve(domainID: string, options?: RequestOptions): APIPromise<EmailDomainRetrieveResponse> {
|
|
37
|
+
return this._client.get(path`/v1/email-domains/${domainID}`, options);
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* List email domains
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```ts
|
|
45
|
+
* const emailDomains = await client.emailDomains.list();
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
list(options?: RequestOptions): APIPromise<EmailDomainListResponse> {
|
|
49
|
+
return this._client.get('/v1/email-domains', options);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Remove an email domain
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* await client.emailDomains.delete('domainId');
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
delete(domainID: string, options?: RequestOptions): APIPromise<void> {
|
|
61
|
+
return this._client.delete(path`/v1/email-domains/${domainID}`, {
|
|
62
|
+
...options,
|
|
63
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* Re-check the domain's published DNS records and refresh its status.
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* const response = await client.emailDomains.verify(
|
|
73
|
+
* 'domainId',
|
|
74
|
+
* );
|
|
75
|
+
* ```
|
|
76
|
+
*/
|
|
77
|
+
verify(domainID: string, options?: RequestOptions): APIPromise<EmailDomainVerifyResponse> {
|
|
78
|
+
return this._client.post(path`/v1/email-domains/${domainID}/verify`, options);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
export interface EmailDomainCreateResponse {
|
|
83
|
+
domain: EmailDomainCreateResponse.Domain;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
export namespace EmailDomainCreateResponse {
|
|
87
|
+
export interface Domain {
|
|
88
|
+
id: string;
|
|
89
|
+
|
|
90
|
+
dkimStatus: string;
|
|
91
|
+
|
|
92
|
+
domain: string;
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Overall verification status.
|
|
96
|
+
*/
|
|
97
|
+
status: string;
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
101
|
+
* one.
|
|
102
|
+
*/
|
|
103
|
+
dnsRecords?: Array<Domain.DNSRecord>;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
export namespace Domain {
|
|
107
|
+
export interface DNSRecord {
|
|
108
|
+
/**
|
|
109
|
+
* Record host/name to create.
|
|
110
|
+
*/
|
|
111
|
+
name: string;
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
* What the record is for.
|
|
115
|
+
*/
|
|
116
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
120
|
+
* deliverability.
|
|
121
|
+
*/
|
|
122
|
+
required: boolean;
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* DNS record type.
|
|
126
|
+
*/
|
|
127
|
+
type: string;
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* Record value.
|
|
131
|
+
*/
|
|
132
|
+
value: string;
|
|
133
|
+
|
|
134
|
+
/**
|
|
135
|
+
* Priority (MX records only).
|
|
136
|
+
*/
|
|
137
|
+
priority?: number;
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
export interface EmailDomainRetrieveResponse {
|
|
143
|
+
domain: EmailDomainRetrieveResponse.Domain;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
export namespace EmailDomainRetrieveResponse {
|
|
147
|
+
export interface Domain {
|
|
148
|
+
id: string;
|
|
149
|
+
|
|
150
|
+
dkimStatus: string;
|
|
151
|
+
|
|
152
|
+
domain: string;
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* Overall verification status.
|
|
156
|
+
*/
|
|
157
|
+
status: string;
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
161
|
+
* one.
|
|
162
|
+
*/
|
|
163
|
+
dnsRecords?: Array<Domain.DNSRecord>;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
export namespace Domain {
|
|
167
|
+
export interface DNSRecord {
|
|
168
|
+
/**
|
|
169
|
+
* Record host/name to create.
|
|
170
|
+
*/
|
|
171
|
+
name: string;
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* What the record is for.
|
|
175
|
+
*/
|
|
176
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
180
|
+
* deliverability.
|
|
181
|
+
*/
|
|
182
|
+
required: boolean;
|
|
183
|
+
|
|
184
|
+
/**
|
|
185
|
+
* DNS record type.
|
|
186
|
+
*/
|
|
187
|
+
type: string;
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* Record value.
|
|
191
|
+
*/
|
|
192
|
+
value: string;
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* Priority (MX records only).
|
|
196
|
+
*/
|
|
197
|
+
priority?: number;
|
|
198
|
+
}
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
export interface EmailDomainListResponse {
|
|
203
|
+
items: Array<EmailDomainListResponse.Item>;
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
export namespace EmailDomainListResponse {
|
|
207
|
+
export interface Item {
|
|
208
|
+
id: string;
|
|
209
|
+
|
|
210
|
+
dkimStatus: string;
|
|
211
|
+
|
|
212
|
+
domain: string;
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* Overall verification status.
|
|
216
|
+
*/
|
|
217
|
+
status: string;
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
221
|
+
* one.
|
|
222
|
+
*/
|
|
223
|
+
dnsRecords?: Array<Item.DNSRecord>;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
export namespace Item {
|
|
227
|
+
export interface DNSRecord {
|
|
228
|
+
/**
|
|
229
|
+
* Record host/name to create.
|
|
230
|
+
*/
|
|
231
|
+
name: string;
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* What the record is for.
|
|
235
|
+
*/
|
|
236
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
240
|
+
* deliverability.
|
|
241
|
+
*/
|
|
242
|
+
required: boolean;
|
|
243
|
+
|
|
244
|
+
/**
|
|
245
|
+
* DNS record type.
|
|
246
|
+
*/
|
|
247
|
+
type: string;
|
|
248
|
+
|
|
249
|
+
/**
|
|
250
|
+
* Record value.
|
|
251
|
+
*/
|
|
252
|
+
value: string;
|
|
253
|
+
|
|
254
|
+
/**
|
|
255
|
+
* Priority (MX records only).
|
|
256
|
+
*/
|
|
257
|
+
priority?: number;
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
export interface EmailDomainVerifyResponse {
|
|
263
|
+
domain: EmailDomainVerifyResponse.Domain;
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
export namespace EmailDomainVerifyResponse {
|
|
267
|
+
export interface Domain {
|
|
268
|
+
id: string;
|
|
269
|
+
|
|
270
|
+
dkimStatus: string;
|
|
271
|
+
|
|
272
|
+
domain: string;
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* Overall verification status.
|
|
276
|
+
*/
|
|
277
|
+
status: string;
|
|
278
|
+
|
|
279
|
+
/**
|
|
280
|
+
* DNS records to publish. Present when fetching a single domain or after adding
|
|
281
|
+
* one.
|
|
282
|
+
*/
|
|
283
|
+
dnsRecords?: Array<Domain.DNSRecord>;
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
export namespace Domain {
|
|
287
|
+
export interface DNSRecord {
|
|
288
|
+
/**
|
|
289
|
+
* Record host/name to create.
|
|
290
|
+
*/
|
|
291
|
+
name: string;
|
|
292
|
+
|
|
293
|
+
/**
|
|
294
|
+
* What the record is for.
|
|
295
|
+
*/
|
|
296
|
+
purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
|
|
297
|
+
|
|
298
|
+
/**
|
|
299
|
+
* Whether the record is required to verify + send (DKIM) or recommended for
|
|
300
|
+
* deliverability.
|
|
301
|
+
*/
|
|
302
|
+
required: boolean;
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* DNS record type.
|
|
306
|
+
*/
|
|
307
|
+
type: string;
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* Record value.
|
|
311
|
+
*/
|
|
312
|
+
value: string;
|
|
313
|
+
|
|
314
|
+
/**
|
|
315
|
+
* Priority (MX records only).
|
|
316
|
+
*/
|
|
317
|
+
priority?: number;
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
export interface EmailDomainCreateParams {
|
|
323
|
+
/**
|
|
324
|
+
* Bare domain, e.g. example.com.
|
|
325
|
+
*/
|
|
326
|
+
domain: string;
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
export declare namespace EmailDomains {
|
|
330
|
+
export {
|
|
331
|
+
type EmailDomainCreateResponse as EmailDomainCreateResponse,
|
|
332
|
+
type EmailDomainRetrieveResponse as EmailDomainRetrieveResponse,
|
|
333
|
+
type EmailDomainListResponse as EmailDomainListResponse,
|
|
334
|
+
type EmailDomainVerifyResponse as EmailDomainVerifyResponse,
|
|
335
|
+
type EmailDomainCreateParams as EmailDomainCreateParams,
|
|
336
|
+
};
|
|
337
|
+
}
|
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
3
|
import { APIResource } from '../../core/resource';
|
|
4
|
+
import * as GitLinkAPI from './git-link';
|
|
5
|
+
import {
|
|
6
|
+
GitLink,
|
|
7
|
+
GitLinkDeployNowResponse,
|
|
8
|
+
GitLinkLinkParams,
|
|
9
|
+
GitLinkLinkResponse,
|
|
10
|
+
GitLinkRetrieveResponse,
|
|
11
|
+
GitLinkUpdateParams,
|
|
12
|
+
GitLinkUpdateResponse,
|
|
13
|
+
} from './git-link';
|
|
4
14
|
import * as SecretsAPI from './secrets';
|
|
5
15
|
import {
|
|
6
16
|
SecretListResponse,
|
|
@@ -9,12 +19,23 @@ import {
|
|
|
9
19
|
SecretUnsetParams,
|
|
10
20
|
Secrets,
|
|
11
21
|
} from './secrets';
|
|
22
|
+
import * as TriggersAPI from './triggers';
|
|
23
|
+
import {
|
|
24
|
+
TriggerCreateParams,
|
|
25
|
+
TriggerCreateResponse,
|
|
26
|
+
TriggerListResponse,
|
|
27
|
+
TriggerUpdateParams,
|
|
28
|
+
TriggerUpdateResponse,
|
|
29
|
+
Triggers,
|
|
30
|
+
} from './triggers';
|
|
12
31
|
import { APIPromise } from '../../core/api-promise';
|
|
13
32
|
import { RequestOptions } from '../../internal/request-options';
|
|
14
33
|
import { path } from '../../internal/utils/path';
|
|
15
34
|
|
|
16
35
|
export class Functions extends APIResource {
|
|
17
36
|
secrets: SecretsAPI.Secrets = new SecretsAPI.Secrets(this._client);
|
|
37
|
+
triggers: TriggersAPI.Triggers = new TriggersAPI.Triggers(this._client);
|
|
38
|
+
gitLink: GitLinkAPI.GitLink = new GitLinkAPI.GitLink(this._client);
|
|
18
39
|
|
|
19
40
|
/**
|
|
20
41
|
* Create a new Zavu Function. The function starts in `draft` status. A dedicated
|
|
@@ -128,6 +149,62 @@ export class Functions extends APIResource {
|
|
|
128
149
|
return this._client.get(path`/v1/functions/deployments/${deploymentID}`, options);
|
|
129
150
|
}
|
|
130
151
|
|
|
152
|
+
/**
|
|
153
|
+
* List a function's deployment history, newest first. Source code is omitted;
|
|
154
|
+
* fetch a single deployment via GET /v1/functions/deployments/{deploymentId} for
|
|
155
|
+
* full details.
|
|
156
|
+
*
|
|
157
|
+
* @example
|
|
158
|
+
* ```ts
|
|
159
|
+
* const response = await client.functions.listDeployments(
|
|
160
|
+
* 'functionId',
|
|
161
|
+
* );
|
|
162
|
+
* ```
|
|
163
|
+
*/
|
|
164
|
+
listDeployments(
|
|
165
|
+
functionID: string,
|
|
166
|
+
query: FunctionListDeploymentsParams | null | undefined = {},
|
|
167
|
+
options?: RequestOptions,
|
|
168
|
+
): APIPromise<FunctionListDeploymentsResponse> {
|
|
169
|
+
return this._client.get(path`/v1/functions/${functionID}/deployments`, { query, ...options });
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* List the event types a function trigger can subscribe to. Includes the special
|
|
174
|
+
* type `cron`, which fires on a schedule (see POST
|
|
175
|
+
* /v1/functions/{functionId}/triggers) rather than on a messaging event.
|
|
176
|
+
*
|
|
177
|
+
* @example
|
|
178
|
+
* ```ts
|
|
179
|
+
* const response = await client.functions.listEventTypes();
|
|
180
|
+
* ```
|
|
181
|
+
*/
|
|
182
|
+
listEventTypes(options?: RequestOptions): APIPromise<FunctionListEventTypesResponse> {
|
|
183
|
+
return this._client.get('/v1/functions/event-types', options);
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
/**
|
|
187
|
+
* Re-deploy a previous version by copying its source, dependencies, and runtime
|
|
188
|
+
* pin onto the function's draft, then deploying. Returns immediately with a
|
|
189
|
+
* deployment ID — poll GET /v1/functions/deployments/{deploymentId} until status
|
|
190
|
+
* is active or failed. Secrets are not rolled back.
|
|
191
|
+
*
|
|
192
|
+
* @example
|
|
193
|
+
* ```ts
|
|
194
|
+
* const response = await client.functions.rollbackDeployment(
|
|
195
|
+
* 'functionId',
|
|
196
|
+
* { deploymentId: 'fnd_abc123' },
|
|
197
|
+
* );
|
|
198
|
+
* ```
|
|
199
|
+
*/
|
|
200
|
+
rollbackDeployment(
|
|
201
|
+
functionID: string,
|
|
202
|
+
body: FunctionRollbackDeploymentParams,
|
|
203
|
+
options?: RequestOptions,
|
|
204
|
+
): APIPromise<FunctionRollbackDeploymentResponse> {
|
|
205
|
+
return this._client.post(path`/v1/functions/${functionID}/rollback`, { body, ...options });
|
|
206
|
+
}
|
|
207
|
+
|
|
131
208
|
/**
|
|
132
209
|
* Fetch invocation logs for a function. Logs are paginated via `nextToken`. Pass
|
|
133
210
|
* `startTime` / `endTime` (Unix epoch milliseconds) to bound the window, or
|
|
@@ -479,6 +556,94 @@ export namespace FunctionGetDeploymentResponse {
|
|
|
479
556
|
}
|
|
480
557
|
}
|
|
481
558
|
|
|
559
|
+
export interface FunctionListDeploymentsResponse {
|
|
560
|
+
deployments: Array<FunctionListDeploymentsResponse.Deployment>;
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
export namespace FunctionListDeploymentsResponse {
|
|
564
|
+
export interface Deployment {
|
|
565
|
+
id?: string;
|
|
566
|
+
|
|
567
|
+
bundleSizeBytes?: number | null;
|
|
568
|
+
|
|
569
|
+
createdAt?: string;
|
|
570
|
+
|
|
571
|
+
deployedAt?: string | null;
|
|
572
|
+
|
|
573
|
+
errorMessage?: string | null;
|
|
574
|
+
|
|
575
|
+
isActive?: boolean;
|
|
576
|
+
|
|
577
|
+
/**
|
|
578
|
+
* Stage of a function deployment.
|
|
579
|
+
*/
|
|
580
|
+
status?: 'pending' | 'bundling' | 'uploading' | 'publishing' | 'active' | 'failed' | 'superseded';
|
|
581
|
+
|
|
582
|
+
version?: number;
|
|
583
|
+
}
|
|
584
|
+
}
|
|
585
|
+
|
|
586
|
+
export interface FunctionListEventTypesResponse {
|
|
587
|
+
events: Array<string>;
|
|
588
|
+
}
|
|
589
|
+
|
|
590
|
+
export interface FunctionRollbackDeploymentResponse {
|
|
591
|
+
deployment: FunctionRollbackDeploymentResponse.Deployment;
|
|
592
|
+
|
|
593
|
+
/**
|
|
594
|
+
* The draft that was replaced, so a UI can offer to restore it.
|
|
595
|
+
*/
|
|
596
|
+
previousDraft?: unknown | null;
|
|
597
|
+
|
|
598
|
+
rolledBackToVersion?: number;
|
|
599
|
+
}
|
|
600
|
+
|
|
601
|
+
export namespace FunctionRollbackDeploymentResponse {
|
|
602
|
+
export interface Deployment {
|
|
603
|
+
id: string;
|
|
604
|
+
|
|
605
|
+
createdAt: string;
|
|
606
|
+
|
|
607
|
+
functionId: string;
|
|
608
|
+
|
|
609
|
+
/**
|
|
610
|
+
* Stage of a function deployment.
|
|
611
|
+
*/
|
|
612
|
+
status: 'pending' | 'bundling' | 'uploading' | 'publishing' | 'active' | 'failed' | 'superseded';
|
|
613
|
+
|
|
614
|
+
/**
|
|
615
|
+
* Monotonically increasing deployment version, starting at 1.
|
|
616
|
+
*/
|
|
617
|
+
version: number;
|
|
618
|
+
|
|
619
|
+
/**
|
|
620
|
+
* What the build printed: dependency installation, the bundler's output, and the
|
|
621
|
+
* compiler's message when it failed. Returned when fetching a single deployment,
|
|
622
|
+
* omitted from the list. Read this first when a deploy fails — `errorMessage` is
|
|
623
|
+
* often the outer wrapper's summary, and the line that names the broken import or
|
|
624
|
+
* the syntax error is here.
|
|
625
|
+
*/
|
|
626
|
+
buildLogs?: string | null;
|
|
627
|
+
|
|
628
|
+
/**
|
|
629
|
+
* Size of the built bundle in bytes. Null until the build finishes.
|
|
630
|
+
*/
|
|
631
|
+
bundleBytes?: number | null;
|
|
632
|
+
|
|
633
|
+
deployedAt?: string | null;
|
|
634
|
+
|
|
635
|
+
/**
|
|
636
|
+
* Failure reason when status is 'failed'.
|
|
637
|
+
*/
|
|
638
|
+
errorMessage?: string | null;
|
|
639
|
+
|
|
640
|
+
/**
|
|
641
|
+
* Total size of the deployed source tree in bytes.
|
|
642
|
+
*/
|
|
643
|
+
sourceCodeBytes?: number | null;
|
|
644
|
+
}
|
|
645
|
+
}
|
|
646
|
+
|
|
482
647
|
export interface FunctionTailLogsResponse {
|
|
483
648
|
events: Array<FunctionTailLogsResponse.Event>;
|
|
484
649
|
|
|
@@ -625,6 +790,17 @@ export interface FunctionDeployParams {
|
|
|
625
790
|
sourceCode?: string;
|
|
626
791
|
}
|
|
627
792
|
|
|
793
|
+
export interface FunctionListDeploymentsParams {
|
|
794
|
+
limit?: number;
|
|
795
|
+
}
|
|
796
|
+
|
|
797
|
+
export interface FunctionRollbackDeploymentParams {
|
|
798
|
+
/**
|
|
799
|
+
* ID of the deployment to roll back to.
|
|
800
|
+
*/
|
|
801
|
+
deploymentId: string;
|
|
802
|
+
}
|
|
803
|
+
|
|
628
804
|
export interface FunctionTailLogsParams {
|
|
629
805
|
/**
|
|
630
806
|
* End of the log window in Unix epoch milliseconds.
|
|
@@ -644,6 +820,8 @@ export interface FunctionTailLogsParams {
|
|
|
644
820
|
}
|
|
645
821
|
|
|
646
822
|
Functions.Secrets = Secrets;
|
|
823
|
+
Functions.Triggers = Triggers;
|
|
824
|
+
Functions.GitLink = GitLink;
|
|
647
825
|
|
|
648
826
|
export declare namespace Functions {
|
|
649
827
|
export {
|
|
@@ -653,10 +831,15 @@ export declare namespace Functions {
|
|
|
653
831
|
type FunctionDeleteResponse as FunctionDeleteResponse,
|
|
654
832
|
type FunctionDeployResponse as FunctionDeployResponse,
|
|
655
833
|
type FunctionGetDeploymentResponse as FunctionGetDeploymentResponse,
|
|
834
|
+
type FunctionListDeploymentsResponse as FunctionListDeploymentsResponse,
|
|
835
|
+
type FunctionListEventTypesResponse as FunctionListEventTypesResponse,
|
|
836
|
+
type FunctionRollbackDeploymentResponse as FunctionRollbackDeploymentResponse,
|
|
656
837
|
type FunctionTailLogsResponse as FunctionTailLogsResponse,
|
|
657
838
|
type FunctionCreateParams as FunctionCreateParams,
|
|
658
839
|
type FunctionUpdateParams as FunctionUpdateParams,
|
|
659
840
|
type FunctionDeployParams as FunctionDeployParams,
|
|
841
|
+
type FunctionListDeploymentsParams as FunctionListDeploymentsParams,
|
|
842
|
+
type FunctionRollbackDeploymentParams as FunctionRollbackDeploymentParams,
|
|
660
843
|
type FunctionTailLogsParams as FunctionTailLogsParams,
|
|
661
844
|
};
|
|
662
845
|
|
|
@@ -667,4 +850,23 @@ export declare namespace Functions {
|
|
|
667
850
|
type SecretSetParams as SecretSetParams,
|
|
668
851
|
type SecretUnsetParams as SecretUnsetParams,
|
|
669
852
|
};
|
|
853
|
+
|
|
854
|
+
export {
|
|
855
|
+
Triggers as Triggers,
|
|
856
|
+
type TriggerCreateResponse as TriggerCreateResponse,
|
|
857
|
+
type TriggerUpdateResponse as TriggerUpdateResponse,
|
|
858
|
+
type TriggerListResponse as TriggerListResponse,
|
|
859
|
+
type TriggerCreateParams as TriggerCreateParams,
|
|
860
|
+
type TriggerUpdateParams as TriggerUpdateParams,
|
|
861
|
+
};
|
|
862
|
+
|
|
863
|
+
export {
|
|
864
|
+
GitLink as GitLink,
|
|
865
|
+
type GitLinkRetrieveResponse as GitLinkRetrieveResponse,
|
|
866
|
+
type GitLinkUpdateResponse as GitLinkUpdateResponse,
|
|
867
|
+
type GitLinkDeployNowResponse as GitLinkDeployNowResponse,
|
|
868
|
+
type GitLinkLinkResponse as GitLinkLinkResponse,
|
|
869
|
+
type GitLinkUpdateParams as GitLinkUpdateParams,
|
|
870
|
+
type GitLinkLinkParams as GitLinkLinkParams,
|
|
871
|
+
};
|
|
670
872
|
}
|