telnyx 7.12.0 → 7.13.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 +7 -0
- package/client.d.mts +56 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +56 -2
- package/client.d.ts.map +1 -1
- package/client.js +54 -0
- package/client.js.map +1 -1
- package/client.mjs +54 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/ai/ai.d.mts +6 -0
- package/resources/ai/ai.d.mts.map +1 -1
- package/resources/ai/ai.d.ts +6 -0
- package/resources/ai/ai.d.ts.map +1 -1
- package/resources/ai/ai.js.map +1 -1
- package/resources/ai/ai.mjs.map +1 -1
- package/resources/ai/anthropic/v1.d.mts +3 -1
- package/resources/ai/anthropic/v1.d.mts.map +1 -1
- package/resources/ai/anthropic/v1.d.ts +3 -1
- package/resources/ai/anthropic/v1.d.ts.map +1 -1
- package/resources/ai/assistants/assistants.d.mts +6 -2
- package/resources/ai/assistants/assistants.d.mts.map +1 -1
- package/resources/ai/assistants/assistants.d.ts +6 -2
- package/resources/ai/assistants/assistants.d.ts.map +1 -1
- package/resources/ai/assistants/assistants.js.map +1 -1
- package/resources/ai/assistants/assistants.mjs.map +1 -1
- package/resources/ai/chat.d.mts +6 -0
- package/resources/ai/chat.d.mts.map +1 -1
- package/resources/ai/chat.d.ts +6 -0
- package/resources/ai/chat.d.ts.map +1 -1
- package/resources/ai/openai/chat.d.mts +6 -0
- package/resources/ai/openai/chat.d.mts.map +1 -1
- package/resources/ai/openai/chat.d.ts +6 -0
- package/resources/ai/openai/chat.d.ts.map +1 -1
- package/resources/ai/openai/openai.d.mts +6 -0
- package/resources/ai/openai/openai.d.mts.map +1 -1
- package/resources/ai/openai/openai.d.ts +6 -0
- package/resources/ai/openai/openai.d.ts.map +1 -1
- package/resources/ai/openai/openai.js.map +1 -1
- package/resources/ai/openai/openai.mjs.map +1 -1
- package/resources/calls/actions.d.mts +223 -48
- package/resources/calls/actions.d.mts.map +1 -1
- package/resources/calls/actions.d.ts +223 -48
- package/resources/calls/actions.d.ts.map +1 -1
- package/resources/calls/actions.js +31 -0
- package/resources/calls/actions.js.map +1 -1
- package/resources/calls/actions.mjs +31 -0
- package/resources/calls/actions.mjs.map +1 -1
- package/resources/calls/calls.d.mts +3 -2
- package/resources/calls/calls.d.mts.map +1 -1
- package/resources/calls/calls.d.ts +3 -2
- package/resources/calls/calls.d.ts.map +1 -1
- package/resources/calls/calls.js.map +1 -1
- package/resources/calls/calls.mjs.map +1 -1
- package/resources/calls/index.d.mts +1 -1
- package/resources/calls/index.d.mts.map +1 -1
- package/resources/calls/index.d.ts +1 -1
- package/resources/calls/index.d.ts.map +1 -1
- package/resources/calls/index.js.map +1 -1
- package/resources/calls/index.mjs.map +1 -1
- package/resources/custom-storage-credentials.d.mts +110 -14
- package/resources/custom-storage-credentials.d.mts.map +1 -1
- package/resources/custom-storage-credentials.d.ts +110 -14
- package/resources/custom-storage-credentials.d.ts.map +1 -1
- package/resources/dir/dir.d.mts +3 -2
- package/resources/dir/dir.d.mts.map +1 -1
- package/resources/dir/dir.d.ts +3 -2
- package/resources/dir/dir.d.ts.map +1 -1
- package/resources/dir/dir.js +3 -2
- package/resources/dir/dir.js.map +1 -1
- package/resources/dir/dir.mjs +3 -2
- package/resources/dir/dir.mjs.map +1 -1
- package/resources/dir/references.d.mts +41 -11
- package/resources/dir/references.d.mts.map +1 -1
- package/resources/dir/references.d.ts +41 -11
- package/resources/dir/references.d.ts.map +1 -1
- package/resources/dir/references.js +30 -8
- package/resources/dir/references.js.map +1 -1
- package/resources/dir/references.mjs +30 -8
- package/resources/dir/references.mjs.map +1 -1
- package/resources/dir/verify-email.d.mts +10 -0
- package/resources/dir/verify-email.d.mts.map +1 -1
- package/resources/dir/verify-email.d.ts +10 -0
- package/resources/dir/verify-email.d.ts.map +1 -1
- package/resources/email-blocks/email-blocks.d.mts +255 -0
- package/resources/email-blocks/email-blocks.d.mts.map +1 -0
- package/resources/email-blocks/email-blocks.d.ts +255 -0
- package/resources/email-blocks/email-blocks.d.ts.map +1 -0
- package/resources/email-blocks/email-blocks.js +99 -0
- package/resources/email-blocks/email-blocks.js.map +1 -0
- package/resources/email-blocks/email-blocks.mjs +94 -0
- package/resources/email-blocks/email-blocks.mjs.map +1 -0
- package/resources/email-blocks/import.d.mts +111 -0
- package/resources/email-blocks/import.d.mts.map +1 -0
- package/resources/email-blocks/import.d.ts +111 -0
- package/resources/email-blocks/import.d.ts.map +1 -0
- package/resources/email-blocks/import.js +40 -0
- package/resources/email-blocks/import.js.map +1 -0
- package/resources/email-blocks/import.mjs +36 -0
- package/resources/email-blocks/import.mjs.map +1 -0
- package/resources/email-blocks/index.d.mts +3 -0
- package/resources/email-blocks/index.d.mts.map +1 -0
- package/resources/email-blocks/index.d.ts +3 -0
- package/resources/email-blocks/index.d.ts.map +1 -0
- package/resources/email-blocks/index.js +9 -0
- package/resources/email-blocks/index.js.map +1 -0
- package/resources/email-blocks/index.mjs +4 -0
- package/resources/email-blocks/index.mjs.map +1 -0
- package/resources/email-blocks.d.mts +2 -0
- package/resources/email-blocks.d.mts.map +1 -0
- package/resources/email-blocks.d.ts +2 -0
- package/resources/email-blocks.d.ts.map +1 -0
- package/resources/email-blocks.js +6 -0
- package/resources/email-blocks.js.map +1 -0
- package/resources/email-blocks.mjs +3 -0
- package/resources/email-blocks.mjs.map +1 -0
- package/resources/email-domains/email-domains.d.mts +344 -0
- package/resources/email-domains/email-domains.d.mts.map +1 -0
- package/resources/email-domains/email-domains.d.ts +344 -0
- package/resources/email-domains/email-domains.d.ts.map +1 -0
- package/resources/email-domains/email-domains.js +146 -0
- package/resources/email-domains/email-domains.js.map +1 -0
- package/resources/email-domains/email-domains.mjs +141 -0
- package/resources/email-domains/email-domains.mjs.map +1 -0
- package/resources/email-domains/index.d.mts +3 -0
- package/resources/email-domains/index.d.mts.map +1 -0
- package/resources/email-domains/index.d.ts +3 -0
- package/resources/email-domains/index.d.ts.map +1 -0
- package/resources/email-domains/index.js +9 -0
- package/resources/email-domains/index.js.map +1 -0
- package/resources/email-domains/index.mjs +4 -0
- package/resources/email-domains/index.mjs.map +1 -0
- package/resources/email-domains/webhooks.d.mts +170 -0
- package/resources/email-domains/webhooks.d.mts.map +1 -0
- package/resources/email-domains/webhooks.d.ts +170 -0
- package/resources/email-domains/webhooks.d.ts.map +1 -0
- package/resources/email-domains/webhooks.js +110 -0
- package/resources/email-domains/webhooks.js.map +1 -0
- package/resources/email-domains/webhooks.mjs +106 -0
- package/resources/email-domains/webhooks.mjs.map +1 -0
- package/resources/email-domains.d.mts +2 -0
- package/resources/email-domains.d.mts.map +1 -0
- package/resources/email-domains.d.ts +2 -0
- package/resources/email-domains.d.ts.map +1 -0
- package/resources/email-domains.js +6 -0
- package/resources/email-domains.js.map +1 -0
- package/resources/email-domains.mjs +3 -0
- package/resources/email-domains.mjs.map +1 -0
- package/resources/email-events.d.mts +186 -0
- package/resources/email-events.d.mts.map +1 -0
- package/resources/email-events.d.ts +186 -0
- package/resources/email-events.d.ts.map +1 -0
- package/resources/email-events.js +26 -0
- package/resources/email-events.js.map +1 -0
- package/resources/email-events.mjs +22 -0
- package/resources/email-events.mjs.map +1 -0
- package/resources/email-inboxes/drafts.d.mts +549 -0
- package/resources/email-inboxes/drafts.d.mts.map +1 -0
- package/resources/email-inboxes/drafts.d.ts +549 -0
- package/resources/email-inboxes/drafts.d.ts.map +1 -0
- package/resources/email-inboxes/drafts.js +161 -0
- package/resources/email-inboxes/drafts.js.map +1 -0
- package/resources/email-inboxes/drafts.mjs +157 -0
- package/resources/email-inboxes/drafts.mjs.map +1 -0
- package/resources/email-inboxes/email-inboxes.d.mts +131 -0
- package/resources/email-inboxes/email-inboxes.d.mts.map +1 -0
- package/resources/email-inboxes/email-inboxes.d.ts +131 -0
- package/resources/email-inboxes/email-inboxes.d.ts.map +1 -0
- package/resources/email-inboxes/email-inboxes.js +93 -0
- package/resources/email-inboxes/email-inboxes.js.map +1 -0
- package/resources/email-inboxes/email-inboxes.mjs +88 -0
- package/resources/email-inboxes/email-inboxes.mjs.map +1 -0
- package/resources/email-inboxes/filters.d.mts +137 -0
- package/resources/email-inboxes/filters.d.mts.map +1 -0
- package/resources/email-inboxes/filters.d.ts +137 -0
- package/resources/email-inboxes/filters.d.ts.map +1 -0
- package/resources/email-inboxes/filters.js +81 -0
- package/resources/email-inboxes/filters.js.map +1 -0
- package/resources/email-inboxes/filters.mjs +77 -0
- package/resources/email-inboxes/filters.mjs.map +1 -0
- package/resources/email-inboxes/index.d.mts +6 -0
- package/resources/email-inboxes/index.d.mts.map +1 -0
- package/resources/email-inboxes/index.d.ts +6 -0
- package/resources/email-inboxes/index.d.ts.map +1 -0
- package/resources/email-inboxes/index.js +15 -0
- package/resources/email-inboxes/index.js.map +1 -0
- package/resources/email-inboxes/index.mjs +7 -0
- package/resources/email-inboxes/index.mjs.map +1 -0
- package/resources/email-inboxes/messages/actions.d.mts +190 -0
- package/resources/email-inboxes/messages/actions.d.mts.map +1 -0
- package/resources/email-inboxes/messages/actions.d.ts +190 -0
- package/resources/email-inboxes/messages/actions.d.ts.map +1 -0
- package/resources/email-inboxes/messages/actions.js +106 -0
- package/resources/email-inboxes/messages/actions.js.map +1 -0
- package/resources/email-inboxes/messages/actions.mjs +102 -0
- package/resources/email-inboxes/messages/actions.mjs.map +1 -0
- package/resources/email-inboxes/messages/index.d.mts +4 -0
- package/resources/email-inboxes/messages/index.d.mts.map +1 -0
- package/resources/email-inboxes/messages/index.d.ts +4 -0
- package/resources/email-inboxes/messages/index.d.ts.map +1 -0
- package/resources/email-inboxes/messages/index.js +11 -0
- package/resources/email-inboxes/messages/index.js.map +1 -0
- package/resources/email-inboxes/messages/index.mjs +5 -0
- package/resources/email-inboxes/messages/index.mjs.map +1 -0
- package/resources/email-inboxes/messages/labels.d.mts +101 -0
- package/resources/email-inboxes/messages/labels.d.mts.map +1 -0
- package/resources/email-inboxes/messages/labels.d.ts +101 -0
- package/resources/email-inboxes/messages/labels.d.ts.map +1 -0
- package/resources/email-inboxes/messages/labels.js +69 -0
- package/resources/email-inboxes/messages/labels.js.map +1 -0
- package/resources/email-inboxes/messages/labels.mjs +65 -0
- package/resources/email-inboxes/messages/labels.mjs.map +1 -0
- package/resources/email-inboxes/messages/messages.d.mts +212 -0
- package/resources/email-inboxes/messages/messages.d.mts.map +1 -0
- package/resources/email-inboxes/messages/messages.d.ts +212 -0
- package/resources/email-inboxes/messages/messages.d.ts.map +1 -0
- package/resources/email-inboxes/messages/messages.js +89 -0
- package/resources/email-inboxes/messages/messages.js.map +1 -0
- package/resources/email-inboxes/messages/messages.mjs +84 -0
- package/resources/email-inboxes/messages/messages.mjs.map +1 -0
- package/resources/email-inboxes/messages.d.mts +2 -0
- package/resources/email-inboxes/messages.d.mts.map +1 -0
- package/resources/email-inboxes/messages.d.ts +2 -0
- package/resources/email-inboxes/messages.d.ts.map +1 -0
- package/resources/email-inboxes/messages.js +6 -0
- package/resources/email-inboxes/messages.js.map +1 -0
- package/resources/email-inboxes/messages.mjs +3 -0
- package/resources/email-inboxes/messages.mjs.map +1 -0
- package/resources/email-inboxes/threads/index.d.mts +3 -0
- package/resources/email-inboxes/threads/index.d.mts.map +1 -0
- package/resources/email-inboxes/threads/index.d.ts +3 -0
- package/resources/email-inboxes/threads/index.d.ts.map +1 -0
- package/resources/email-inboxes/threads/index.js +9 -0
- package/resources/email-inboxes/threads/index.js.map +1 -0
- package/resources/email-inboxes/threads/index.mjs +4 -0
- package/resources/email-inboxes/threads/index.mjs.map +1 -0
- package/resources/email-inboxes/threads/labels.d.mts +99 -0
- package/resources/email-inboxes/threads/labels.d.mts.map +1 -0
- package/resources/email-inboxes/threads/labels.d.ts +99 -0
- package/resources/email-inboxes/threads/labels.d.ts.map +1 -0
- package/resources/email-inboxes/threads/labels.js +64 -0
- package/resources/email-inboxes/threads/labels.js.map +1 -0
- package/resources/email-inboxes/threads/labels.mjs +60 -0
- package/resources/email-inboxes/threads/labels.mjs.map +1 -0
- package/resources/email-inboxes/threads/threads.d.mts +199 -0
- package/resources/email-inboxes/threads/threads.d.mts.map +1 -0
- package/resources/email-inboxes/threads/threads.d.ts +199 -0
- package/resources/email-inboxes/threads/threads.d.ts.map +1 -0
- package/resources/email-inboxes/threads/threads.js +51 -0
- package/resources/email-inboxes/threads/threads.js.map +1 -0
- package/resources/email-inboxes/threads/threads.mjs +46 -0
- package/resources/email-inboxes/threads/threads.mjs.map +1 -0
- package/resources/email-inboxes/threads.d.mts +2 -0
- package/resources/email-inboxes/threads.d.mts.map +1 -0
- package/resources/email-inboxes/threads.d.ts +2 -0
- package/resources/email-inboxes/threads.d.ts.map +1 -0
- package/resources/email-inboxes/threads.js +6 -0
- package/resources/email-inboxes/threads.js.map +1 -0
- package/resources/email-inboxes/threads.mjs +3 -0
- package/resources/email-inboxes/threads.mjs.map +1 -0
- package/resources/email-inboxes.d.mts +2 -0
- package/resources/email-inboxes.d.mts.map +1 -0
- package/resources/email-inboxes.d.ts +2 -0
- package/resources/email-inboxes.d.ts.map +1 -0
- package/resources/email-inboxes.js +6 -0
- package/resources/email-inboxes.js.map +1 -0
- package/resources/email-inboxes.mjs +3 -0
- package/resources/email-inboxes.mjs.map +1 -0
- package/resources/email-messages/email-messages.d.mts +543 -0
- package/resources/email-messages/email-messages.d.mts.map +1 -0
- package/resources/email-messages/email-messages.d.ts +543 -0
- package/resources/email-messages/email-messages.d.ts.map +1 -0
- package/resources/email-messages/email-messages.js +186 -0
- package/resources/email-messages/email-messages.js.map +1 -0
- package/resources/email-messages/email-messages.mjs +181 -0
- package/resources/email-messages/email-messages.mjs.map +1 -0
- package/resources/email-messages/index.d.mts +3 -0
- package/resources/email-messages/index.d.mts.map +1 -0
- package/resources/email-messages/index.d.ts +3 -0
- package/resources/email-messages/index.d.ts.map +1 -0
- package/resources/email-messages/index.js +9 -0
- package/resources/email-messages/index.js.map +1 -0
- package/resources/email-messages/index.mjs +4 -0
- package/resources/email-messages/index.mjs.map +1 -0
- package/resources/email-messages/recipients.d.mts +118 -0
- package/resources/email-messages/recipients.d.mts.map +1 -0
- package/resources/email-messages/recipients.d.ts +118 -0
- package/resources/email-messages/recipients.d.ts.map +1 -0
- package/resources/email-messages/recipients.js +48 -0
- package/resources/email-messages/recipients.js.map +1 -0
- package/resources/email-messages/recipients.mjs +44 -0
- package/resources/email-messages/recipients.mjs.map +1 -0
- package/resources/email-messages.d.mts +2 -0
- package/resources/email-messages.d.mts.map +1 -0
- package/resources/email-messages.d.ts +2 -0
- package/resources/email-messages.d.ts.map +1 -0
- package/resources/email-messages.js +6 -0
- package/resources/email-messages.js.map +1 -0
- package/resources/email-messages.mjs +3 -0
- package/resources/email-messages.mjs.map +1 -0
- package/resources/email-templates.d.mts +236 -0
- package/resources/email-templates.d.mts.map +1 -0
- package/resources/email-templates.d.ts +236 -0
- package/resources/email-templates.d.ts.map +1 -0
- package/resources/email-templates.js +124 -0
- package/resources/email-templates.js.map +1 -0
- package/resources/email-templates.mjs +120 -0
- package/resources/email-templates.mjs.map +1 -0
- package/resources/email-threads.d.mts +71 -0
- package/resources/email-threads.d.mts.map +1 -0
- package/resources/email-threads.d.ts +71 -0
- package/resources/email-threads.d.ts.map +1 -0
- package/resources/email-threads.js +34 -0
- package/resources/email-threads.js.map +1 -0
- package/resources/email-threads.mjs +30 -0
- package/resources/email-threads.mjs.map +1 -0
- package/resources/email-unsubscribe-groups/email-unsubscribe-groups.d.mts +90 -0
- package/resources/email-unsubscribe-groups/email-unsubscribe-groups.d.mts.map +1 -0
- package/resources/email-unsubscribe-groups/email-unsubscribe-groups.d.ts +90 -0
- package/resources/email-unsubscribe-groups/email-unsubscribe-groups.d.ts.map +1 -0
- package/resources/email-unsubscribe-groups/email-unsubscribe-groups.js +70 -0
- package/resources/email-unsubscribe-groups/email-unsubscribe-groups.js.map +1 -0
- package/resources/email-unsubscribe-groups/email-unsubscribe-groups.mjs +65 -0
- package/resources/email-unsubscribe-groups/email-unsubscribe-groups.mjs.map +1 -0
- package/resources/email-unsubscribe-groups/index.d.mts +3 -0
- package/resources/email-unsubscribe-groups/index.d.mts.map +1 -0
- package/resources/email-unsubscribe-groups/index.d.ts +3 -0
- package/resources/email-unsubscribe-groups/index.d.ts.map +1 -0
- package/resources/email-unsubscribe-groups/index.js +9 -0
- package/resources/email-unsubscribe-groups/index.js.map +1 -0
- package/resources/email-unsubscribe-groups/index.mjs +4 -0
- package/resources/email-unsubscribe-groups/index.mjs.map +1 -0
- package/resources/email-unsubscribe-groups/suppressions.d.mts +54 -0
- package/resources/email-unsubscribe-groups/suppressions.d.mts.map +1 -0
- package/resources/email-unsubscribe-groups/suppressions.d.ts +54 -0
- package/resources/email-unsubscribe-groups/suppressions.d.ts.map +1 -0
- package/resources/email-unsubscribe-groups/suppressions.js +52 -0
- package/resources/email-unsubscribe-groups/suppressions.js.map +1 -0
- package/resources/email-unsubscribe-groups/suppressions.mjs +48 -0
- package/resources/email-unsubscribe-groups/suppressions.mjs.map +1 -0
- package/resources/email-unsubscribe-groups.d.mts +2 -0
- package/resources/email-unsubscribe-groups.d.mts.map +1 -0
- package/resources/email-unsubscribe-groups.d.ts +2 -0
- package/resources/email-unsubscribe-groups.d.ts.map +1 -0
- package/resources/email-unsubscribe-groups.js +6 -0
- package/resources/email-unsubscribe-groups.js.map +1 -0
- package/resources/email-unsubscribe-groups.mjs +3 -0
- package/resources/email-unsubscribe-groups.mjs.map +1 -0
- package/resources/email-validations/batch.d.mts +136 -0
- package/resources/email-validations/batch.d.mts.map +1 -0
- package/resources/email-validations/batch.d.ts +136 -0
- package/resources/email-validations/batch.d.ts.map +1 -0
- package/resources/email-validations/batch.js +51 -0
- package/resources/email-validations/batch.js.map +1 -0
- package/resources/email-validations/batch.mjs +47 -0
- package/resources/email-validations/batch.mjs.map +1 -0
- package/resources/email-validations/email-validations.d.mts +87 -0
- package/resources/email-validations/email-validations.d.mts.map +1 -0
- package/resources/email-validations/email-validations.d.ts +87 -0
- package/resources/email-validations/email-validations.d.ts.map +1 -0
- package/resources/email-validations/email-validations.js +43 -0
- package/resources/email-validations/email-validations.js.map +1 -0
- package/resources/email-validations/email-validations.mjs +38 -0
- package/resources/email-validations/email-validations.mjs.map +1 -0
- package/resources/email-validations/index.d.mts +3 -0
- package/resources/email-validations/index.d.mts.map +1 -0
- package/resources/email-validations/index.d.ts +3 -0
- package/resources/email-validations/index.d.ts.map +1 -0
- package/resources/email-validations/index.js +9 -0
- package/resources/email-validations/index.js.map +1 -0
- package/resources/email-validations/index.mjs +4 -0
- package/resources/email-validations/index.mjs.map +1 -0
- package/resources/email-validations.d.mts +2 -0
- package/resources/email-validations.d.mts.map +1 -0
- package/resources/email-validations.d.ts +2 -0
- package/resources/email-validations.d.ts.map +1 -0
- package/resources/email-validations.js +6 -0
- package/resources/email-validations.js.map +1 -0
- package/resources/email-validations.mjs +3 -0
- package/resources/email-validations.mjs.map +1 -0
- package/resources/index.d.mts +11 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +11 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +24 -4
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +10 -0
- package/resources/index.mjs.map +1 -1
- package/resources/pricing/index.d.mts +3 -0
- package/resources/pricing/index.d.mts.map +1 -0
- package/resources/pricing/index.d.ts +3 -0
- package/resources/pricing/index.d.ts.map +1 -0
- package/resources/pricing/index.js +9 -0
- package/resources/pricing/index.js.map +1 -0
- package/resources/pricing/index.mjs +4 -0
- package/resources/pricing/index.mjs.map +1 -0
- package/resources/pricing/pricing.d.mts +10 -0
- package/resources/pricing/pricing.d.mts.map +1 -0
- package/resources/pricing/pricing.d.ts +10 -0
- package/resources/pricing/pricing.d.ts.map +1 -0
- package/resources/pricing/pricing.js +17 -0
- package/resources/pricing/pricing.js.map +1 -0
- package/resources/pricing/pricing.mjs +12 -0
- package/resources/pricing/pricing.mjs.map +1 -0
- package/resources/pricing/products.d.mts +161 -0
- package/resources/pricing/products.d.mts.map +1 -0
- package/resources/pricing/products.d.ts +161 -0
- package/resources/pricing/products.d.ts.map +1 -0
- package/resources/pricing/products.js +32 -0
- package/resources/pricing/products.js.map +1 -0
- package/resources/pricing/products.mjs +28 -0
- package/resources/pricing/products.mjs.map +1 -0
- package/resources/pricing.d.mts +2 -0
- package/resources/pricing.d.mts.map +1 -0
- package/resources/pricing.d.ts +2 -0
- package/resources/pricing.d.ts.map +1 -0
- package/resources/pricing.js +6 -0
- package/resources/pricing.js.map +1 -0
- package/resources/pricing.mjs +3 -0
- package/resources/pricing.mjs.map +1 -0
- package/resources/speech-to-text/speech-to-text.d.mts +4 -4
- package/resources/speech-to-text/speech-to-text.d.mts.map +1 -1
- package/resources/speech-to-text/speech-to-text.d.ts +4 -4
- package/resources/speech-to-text/speech-to-text.d.ts.map +1 -1
- package/resources/speech-to-text/speech-to-text.js +1 -1
- package/resources/speech-to-text/speech-to-text.mjs +1 -1
- package/resources/uac-connections/uac-connections.d.mts +5 -0
- package/resources/uac-connections/uac-connections.d.mts.map +1 -1
- package/resources/uac-connections/uac-connections.d.ts +5 -0
- package/resources/uac-connections/uac-connections.d.ts.map +1 -1
- package/resources/uac-connections/uac-connections.js.map +1 -1
- package/resources/uac-connections/uac-connections.mjs.map +1 -1
- package/resources/webhooks.d.mts +483 -85
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +483 -85
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +260 -0
- package/src/resources/ai/ai.ts +7 -0
- package/src/resources/ai/anthropic/v1.ts +3 -1
- package/src/resources/ai/assistants/assistants.ts +6 -1
- package/src/resources/ai/chat.ts +7 -0
- package/src/resources/ai/openai/chat.ts +7 -0
- package/src/resources/ai/openai/openai.ts +7 -0
- package/src/resources/calls/actions.ts +269 -51
- package/src/resources/calls/calls.ts +8 -0
- package/src/resources/calls/index.ts +3 -0
- package/src/resources/custom-storage-credentials.ts +140 -14
- package/src/resources/dir/dir.ts +3 -2
- package/src/resources/dir/references.ts +41 -11
- package/src/resources/dir/verify-email.ts +12 -0
- package/src/resources/email-blocks/email-blocks.ts +358 -0
- package/src/resources/email-blocks/import.ts +143 -0
- package/src/resources/email-blocks/index.ts +16 -0
- package/src/resources/email-blocks.ts +3 -0
- package/src/resources/email-domains/email-domains.ts +510 -0
- package/src/resources/email-domains/index.ts +33 -0
- package/src/resources/email-domains/webhooks.ts +267 -0
- package/src/resources/email-domains.ts +3 -0
- package/src/resources/email-events.ts +269 -0
- package/src/resources/email-inboxes/drafts.ts +746 -0
- package/src/resources/email-inboxes/email-inboxes.ts +276 -0
- package/src/resources/email-inboxes/filters.ts +193 -0
- package/src/resources/email-inboxes/index.ts +58 -0
- package/src/resources/email-inboxes/messages/actions.ts +258 -0
- package/src/resources/email-inboxes/messages/index.ts +27 -0
- package/src/resources/email-inboxes/messages/labels.ts +139 -0
- package/src/resources/email-inboxes/messages/messages.ts +313 -0
- package/src/resources/email-inboxes/messages.ts +3 -0
- package/src/resources/email-inboxes/threads/index.ts +21 -0
- package/src/resources/email-inboxes/threads/labels.ts +143 -0
- package/src/resources/email-inboxes/threads/threads.ts +292 -0
- package/src/resources/email-inboxes/threads.ts +3 -0
- package/src/resources/email-inboxes.ts +3 -0
- package/src/resources/email-messages/email-messages.ts +713 -0
- package/src/resources/email-messages/index.ts +26 -0
- package/src/resources/email-messages/recipients.ts +182 -0
- package/src/resources/email-messages.ts +3 -0
- package/src/resources/email-templates.ts +333 -0
- package/src/resources/email-threads.ts +100 -0
- package/src/resources/email-unsubscribe-groups/email-unsubscribe-groups.ts +171 -0
- package/src/resources/email-unsubscribe-groups/index.ts +19 -0
- package/src/resources/email-unsubscribe-groups/suppressions.ts +90 -0
- package/src/resources/email-unsubscribe-groups.ts +3 -0
- package/src/resources/email-validations/batch.ts +187 -0
- package/src/resources/email-validations/email-validations.ts +141 -0
- package/src/resources/email-validations/index.ts +15 -0
- package/src/resources/email-validations.ts +3 -0
- package/src/resources/index.ts +103 -0
- package/src/resources/pricing/index.ts +13 -0
- package/src/resources/pricing/pricing.ts +33 -0
- package/src/resources/pricing/products.ts +226 -0
- package/src/resources/pricing.ts +3 -0
- package/src/resources/speech-to-text/speech-to-text.ts +6 -3
- package/src/resources/uac-connections/uac-connections.ts +6 -0
- package/src/resources/webhooks.ts +636 -110
- 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,9 @@
|
|
|
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.Webhooks = exports.EmailDomains = void 0;
|
|
5
|
+
var email_domains_1 = require("./email-domains.js");
|
|
6
|
+
Object.defineProperty(exports, "EmailDomains", { enumerable: true, get: function () { return email_domains_1.EmailDomains; } });
|
|
7
|
+
var webhooks_1 = require("./webhooks.js");
|
|
8
|
+
Object.defineProperty(exports, "Webhooks", { enumerable: true, get: function () { return webhooks_1.Webhooks; } });
|
|
9
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/email-domains/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oDAiByB;AAhBvB,6GAAA,YAAY,OAAA;AAiBd,0CAYoB;AAXlB,oGAAA,QAAQ,OAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/email-domains/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,YAAY,GAgBb,4BAAwB;AACzB,OAAO,EACL,QAAQ,GAWT,uBAAmB"}
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Per-domain webhook endpoints with event subscriptions
|
|
7
|
+
*/
|
|
8
|
+
export declare class Webhooks extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* List webhooks for an email domain
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* // Automatically fetches more pages as needed.
|
|
15
|
+
* for await (const emailWebhook of client.emailDomains.webhooks.list(
|
|
16
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
17
|
+
* )) {
|
|
18
|
+
* // ...
|
|
19
|
+
* }
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
list(domainID: string, query?: WebhookListParams | null | undefined, options?: RequestOptions): PagePromise<EmailWebhooksDefaultFlatPagination, EmailWebhook>;
|
|
23
|
+
/**
|
|
24
|
+
* Creates a webhook endpoint subscribed to a specific allowlist of event types.
|
|
25
|
+
* Both `email.*` events (published by email-api) and `email_domain.*` events
|
|
26
|
+
* (published by this service) flow through the same webhooks.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const emailWebhookResponse =
|
|
31
|
+
* await client.emailDomains.webhooks.create(
|
|
32
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
33
|
+
* {
|
|
34
|
+
* events: [
|
|
35
|
+
* 'email.sent',
|
|
36
|
+
* 'email.delivered',
|
|
37
|
+
* 'email.bounced',
|
|
38
|
+
* ],
|
|
39
|
+
* url: 'https://example.com/webhooks/email',
|
|
40
|
+
* },
|
|
41
|
+
* );
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
create(domainID: string, body: WebhookCreateParams, options?: RequestOptions): APIPromise<EmailWebhookResponse>;
|
|
45
|
+
/**
|
|
46
|
+
* Delete a webhook
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* const emailWebhookResponse =
|
|
51
|
+
* await client.emailDomains.webhooks.delete(
|
|
52
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
53
|
+
* { domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
|
|
54
|
+
* );
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
delete(id: string, params: WebhookDeleteParams, options?: RequestOptions): APIPromise<EmailWebhookResponse>;
|
|
58
|
+
/**
|
|
59
|
+
* Retrieve a webhook
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const emailWebhookResponse =
|
|
64
|
+
* await client.emailDomains.webhooks.retrieve(
|
|
65
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
66
|
+
* { domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
|
|
67
|
+
* );
|
|
68
|
+
* ```
|
|
69
|
+
*/
|
|
70
|
+
retrieve(id: string, params: WebhookRetrieveParams, options?: RequestOptions): APIPromise<EmailWebhookResponse>;
|
|
71
|
+
/**
|
|
72
|
+
* Update a webhook's URL and/or event subscription. A webhook is bound to its
|
|
73
|
+
* domain — `domain_id` is not mutable.
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```ts
|
|
77
|
+
* const emailWebhookResponse =
|
|
78
|
+
* await client.emailDomains.webhooks.update(
|
|
79
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
80
|
+
* {
|
|
81
|
+
* domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
82
|
+
* events: [
|
|
83
|
+
* 'email.sent',
|
|
84
|
+
* 'email.delivered',
|
|
85
|
+
* 'email.opened',
|
|
86
|
+
* ],
|
|
87
|
+
* },
|
|
88
|
+
* );
|
|
89
|
+
* ```
|
|
90
|
+
*/
|
|
91
|
+
update(id: string, params: WebhookUpdateParams, options?: RequestOptions): APIPromise<EmailWebhookResponse>;
|
|
92
|
+
}
|
|
93
|
+
export type EmailWebhooksDefaultFlatPagination = DefaultFlatPagination<EmailWebhook>;
|
|
94
|
+
export interface EmailWebhook {
|
|
95
|
+
id: string;
|
|
96
|
+
created_at: string;
|
|
97
|
+
domain_id: string;
|
|
98
|
+
/**
|
|
99
|
+
* Allowlist of event types delivered to this webhook. At least one event is
|
|
100
|
+
* required — there is no default-to-all.
|
|
101
|
+
*/
|
|
102
|
+
events: Array<EmailWebhookEvent>;
|
|
103
|
+
record_type: 'email_webhook';
|
|
104
|
+
updated_at: string;
|
|
105
|
+
/**
|
|
106
|
+
* HTTPS endpoint to deliver subscribed events to.
|
|
107
|
+
*/
|
|
108
|
+
url: string;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Event types a webhook may subscribe to. The union of email._ events (published
|
|
112
|
+
* by email-api) and email_domain._ lifecycle events (published by this service).
|
|
113
|
+
* An event not listed here can never be subscribed to and is silently dropped.
|
|
114
|
+
*/
|
|
115
|
+
export type EmailWebhookEvent = 'email.scheduled' | 'email.sandbox' | 'email.queued' | 'email.sending' | 'email.sent' | 'email.delivered' | 'email.deferred' | 'email.bounced' | 'email.failed' | 'email.complained' | 'email.opened' | 'email.clicked' | 'email.unsubscribed' | 'email.received' | 'email_domain.created' | 'email_domain.verified' | 'email_domain.degraded' | 'email_domain.suspended' | 'email_domain.deleted';
|
|
116
|
+
export interface EmailWebhookResponse {
|
|
117
|
+
data: EmailWebhook;
|
|
118
|
+
}
|
|
119
|
+
export interface OffsetPaginationMeta {
|
|
120
|
+
page_number: number;
|
|
121
|
+
page_size: number;
|
|
122
|
+
total_pages: number;
|
|
123
|
+
total_results: number;
|
|
124
|
+
}
|
|
125
|
+
export interface WebhookListParams extends DefaultFlatPaginationParams {
|
|
126
|
+
/**
|
|
127
|
+
* Field to sort by. Prefix with `-` for descending order.
|
|
128
|
+
*/
|
|
129
|
+
sort?: 'created_at' | '-created_at';
|
|
130
|
+
}
|
|
131
|
+
export interface WebhookCreateParams {
|
|
132
|
+
/**
|
|
133
|
+
* At least one event type is required.
|
|
134
|
+
*/
|
|
135
|
+
events: Array<EmailWebhookEvent>;
|
|
136
|
+
/**
|
|
137
|
+
* HTTPS endpoint to deliver subscribed events to.
|
|
138
|
+
*/
|
|
139
|
+
url: string;
|
|
140
|
+
}
|
|
141
|
+
export interface WebhookDeleteParams {
|
|
142
|
+
/**
|
|
143
|
+
* Email domain UUID
|
|
144
|
+
*/
|
|
145
|
+
domain_id: string;
|
|
146
|
+
}
|
|
147
|
+
export interface WebhookRetrieveParams {
|
|
148
|
+
/**
|
|
149
|
+
* Email domain UUID
|
|
150
|
+
*/
|
|
151
|
+
domain_id: string;
|
|
152
|
+
}
|
|
153
|
+
export interface WebhookUpdateParams {
|
|
154
|
+
/**
|
|
155
|
+
* Path param: Email domain UUID
|
|
156
|
+
*/
|
|
157
|
+
domain_id: string;
|
|
158
|
+
/**
|
|
159
|
+
* Body param
|
|
160
|
+
*/
|
|
161
|
+
events?: Array<EmailWebhookEvent>;
|
|
162
|
+
/**
|
|
163
|
+
* Body param
|
|
164
|
+
*/
|
|
165
|
+
url?: string;
|
|
166
|
+
}
|
|
167
|
+
export declare namespace Webhooks {
|
|
168
|
+
export { type EmailWebhook as EmailWebhook, type EmailWebhookEvent as EmailWebhookEvent, type EmailWebhookResponse as EmailWebhookResponse, type OffsetPaginationMeta as OffsetPaginationMeta, type EmailWebhooksDefaultFlatPagination as EmailWebhooksDefaultFlatPagination, type WebhookListParams as WebhookListParams, type WebhookCreateParams as WebhookCreateParams, type WebhookDeleteParams as WebhookDeleteParams, type WebhookRetrieveParams as WebhookRetrieveParams, type WebhookUpdateParams as WebhookUpdateParams, };
|
|
169
|
+
}
|
|
170
|
+
//# sourceMappingURL=webhooks.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webhooks.d.mts","sourceRoot":"","sources":["../../src/resources/email-domains/webhooks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,kCAA8B;AAC7G,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,YAAY,CAAC;IAQhE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAKnC;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAKnC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;CAIpC;AAED,MAAM,MAAM,kCAAkC,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;AAErF,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEjC,WAAW,EAAE,eAAe,CAAC;IAE7B,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACzB,iBAAiB,GACjB,eAAe,GACf,cAAc,GACd,eAAe,GACf,YAAY,GACZ,iBAAiB,GACjB,gBAAgB,GAChB,eAAe,GACf,cAAc,GACd,kBAAkB,GAClB,cAAc,GACd,eAAe,GACf,oBAAoB,GACpB,gBAAgB,GAChB,sBAAsB,GACtB,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,GACxB,sBAAsB,CAAC;AAE3B,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,iBAAkB,SAAQ,2BAA2B;IACpE;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEjC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAElC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
3
|
+
import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../core/pagination.js";
|
|
4
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
5
|
+
/**
|
|
6
|
+
* Per-domain webhook endpoints with event subscriptions
|
|
7
|
+
*/
|
|
8
|
+
export declare class Webhooks extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* List webhooks for an email domain
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* // Automatically fetches more pages as needed.
|
|
15
|
+
* for await (const emailWebhook of client.emailDomains.webhooks.list(
|
|
16
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
17
|
+
* )) {
|
|
18
|
+
* // ...
|
|
19
|
+
* }
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
list(domainID: string, query?: WebhookListParams | null | undefined, options?: RequestOptions): PagePromise<EmailWebhooksDefaultFlatPagination, EmailWebhook>;
|
|
23
|
+
/**
|
|
24
|
+
* Creates a webhook endpoint subscribed to a specific allowlist of event types.
|
|
25
|
+
* Both `email.*` events (published by email-api) and `email_domain.*` events
|
|
26
|
+
* (published by this service) flow through the same webhooks.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const emailWebhookResponse =
|
|
31
|
+
* await client.emailDomains.webhooks.create(
|
|
32
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
33
|
+
* {
|
|
34
|
+
* events: [
|
|
35
|
+
* 'email.sent',
|
|
36
|
+
* 'email.delivered',
|
|
37
|
+
* 'email.bounced',
|
|
38
|
+
* ],
|
|
39
|
+
* url: 'https://example.com/webhooks/email',
|
|
40
|
+
* },
|
|
41
|
+
* );
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
create(domainID: string, body: WebhookCreateParams, options?: RequestOptions): APIPromise<EmailWebhookResponse>;
|
|
45
|
+
/**
|
|
46
|
+
* Delete a webhook
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* const emailWebhookResponse =
|
|
51
|
+
* await client.emailDomains.webhooks.delete(
|
|
52
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
53
|
+
* { domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
|
|
54
|
+
* );
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
delete(id: string, params: WebhookDeleteParams, options?: RequestOptions): APIPromise<EmailWebhookResponse>;
|
|
58
|
+
/**
|
|
59
|
+
* Retrieve a webhook
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const emailWebhookResponse =
|
|
64
|
+
* await client.emailDomains.webhooks.retrieve(
|
|
65
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
66
|
+
* { domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
|
|
67
|
+
* );
|
|
68
|
+
* ```
|
|
69
|
+
*/
|
|
70
|
+
retrieve(id: string, params: WebhookRetrieveParams, options?: RequestOptions): APIPromise<EmailWebhookResponse>;
|
|
71
|
+
/**
|
|
72
|
+
* Update a webhook's URL and/or event subscription. A webhook is bound to its
|
|
73
|
+
* domain — `domain_id` is not mutable.
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```ts
|
|
77
|
+
* const emailWebhookResponse =
|
|
78
|
+
* await client.emailDomains.webhooks.update(
|
|
79
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
80
|
+
* {
|
|
81
|
+
* domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
82
|
+
* events: [
|
|
83
|
+
* 'email.sent',
|
|
84
|
+
* 'email.delivered',
|
|
85
|
+
* 'email.opened',
|
|
86
|
+
* ],
|
|
87
|
+
* },
|
|
88
|
+
* );
|
|
89
|
+
* ```
|
|
90
|
+
*/
|
|
91
|
+
update(id: string, params: WebhookUpdateParams, options?: RequestOptions): APIPromise<EmailWebhookResponse>;
|
|
92
|
+
}
|
|
93
|
+
export type EmailWebhooksDefaultFlatPagination = DefaultFlatPagination<EmailWebhook>;
|
|
94
|
+
export interface EmailWebhook {
|
|
95
|
+
id: string;
|
|
96
|
+
created_at: string;
|
|
97
|
+
domain_id: string;
|
|
98
|
+
/**
|
|
99
|
+
* Allowlist of event types delivered to this webhook. At least one event is
|
|
100
|
+
* required — there is no default-to-all.
|
|
101
|
+
*/
|
|
102
|
+
events: Array<EmailWebhookEvent>;
|
|
103
|
+
record_type: 'email_webhook';
|
|
104
|
+
updated_at: string;
|
|
105
|
+
/**
|
|
106
|
+
* HTTPS endpoint to deliver subscribed events to.
|
|
107
|
+
*/
|
|
108
|
+
url: string;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Event types a webhook may subscribe to. The union of email._ events (published
|
|
112
|
+
* by email-api) and email_domain._ lifecycle events (published by this service).
|
|
113
|
+
* An event not listed here can never be subscribed to and is silently dropped.
|
|
114
|
+
*/
|
|
115
|
+
export type EmailWebhookEvent = 'email.scheduled' | 'email.sandbox' | 'email.queued' | 'email.sending' | 'email.sent' | 'email.delivered' | 'email.deferred' | 'email.bounced' | 'email.failed' | 'email.complained' | 'email.opened' | 'email.clicked' | 'email.unsubscribed' | 'email.received' | 'email_domain.created' | 'email_domain.verified' | 'email_domain.degraded' | 'email_domain.suspended' | 'email_domain.deleted';
|
|
116
|
+
export interface EmailWebhookResponse {
|
|
117
|
+
data: EmailWebhook;
|
|
118
|
+
}
|
|
119
|
+
export interface OffsetPaginationMeta {
|
|
120
|
+
page_number: number;
|
|
121
|
+
page_size: number;
|
|
122
|
+
total_pages: number;
|
|
123
|
+
total_results: number;
|
|
124
|
+
}
|
|
125
|
+
export interface WebhookListParams extends DefaultFlatPaginationParams {
|
|
126
|
+
/**
|
|
127
|
+
* Field to sort by. Prefix with `-` for descending order.
|
|
128
|
+
*/
|
|
129
|
+
sort?: 'created_at' | '-created_at';
|
|
130
|
+
}
|
|
131
|
+
export interface WebhookCreateParams {
|
|
132
|
+
/**
|
|
133
|
+
* At least one event type is required.
|
|
134
|
+
*/
|
|
135
|
+
events: Array<EmailWebhookEvent>;
|
|
136
|
+
/**
|
|
137
|
+
* HTTPS endpoint to deliver subscribed events to.
|
|
138
|
+
*/
|
|
139
|
+
url: string;
|
|
140
|
+
}
|
|
141
|
+
export interface WebhookDeleteParams {
|
|
142
|
+
/**
|
|
143
|
+
* Email domain UUID
|
|
144
|
+
*/
|
|
145
|
+
domain_id: string;
|
|
146
|
+
}
|
|
147
|
+
export interface WebhookRetrieveParams {
|
|
148
|
+
/**
|
|
149
|
+
* Email domain UUID
|
|
150
|
+
*/
|
|
151
|
+
domain_id: string;
|
|
152
|
+
}
|
|
153
|
+
export interface WebhookUpdateParams {
|
|
154
|
+
/**
|
|
155
|
+
* Path param: Email domain UUID
|
|
156
|
+
*/
|
|
157
|
+
domain_id: string;
|
|
158
|
+
/**
|
|
159
|
+
* Body param
|
|
160
|
+
*/
|
|
161
|
+
events?: Array<EmailWebhookEvent>;
|
|
162
|
+
/**
|
|
163
|
+
* Body param
|
|
164
|
+
*/
|
|
165
|
+
url?: string;
|
|
166
|
+
}
|
|
167
|
+
export declare namespace Webhooks {
|
|
168
|
+
export { type EmailWebhook as EmailWebhook, type EmailWebhookEvent as EmailWebhookEvent, type EmailWebhookResponse as EmailWebhookResponse, type OffsetPaginationMeta as OffsetPaginationMeta, type EmailWebhooksDefaultFlatPagination as EmailWebhooksDefaultFlatPagination, type WebhookListParams as WebhookListParams, type WebhookCreateParams as WebhookCreateParams, type WebhookDeleteParams as WebhookDeleteParams, type WebhookRetrieveParams as WebhookRetrieveParams, type WebhookUpdateParams as WebhookUpdateParams, };
|
|
169
|
+
}
|
|
170
|
+
//# sourceMappingURL=webhooks.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../../src/resources/email-domains/webhooks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,iCAA8B;AAC7G,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,YAAY,CAAC;IAQhE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAKnC;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAKnC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;CAIpC;AAED,MAAM,MAAM,kCAAkC,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;AAErF,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEjC,WAAW,EAAE,eAAe,CAAC;IAE7B,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACzB,iBAAiB,GACjB,eAAe,GACf,cAAc,GACd,eAAe,GACf,YAAY,GACZ,iBAAiB,GACjB,gBAAgB,GAChB,eAAe,GACf,cAAc,GACd,kBAAkB,GAClB,cAAc,GACd,eAAe,GACf,oBAAoB,GACpB,gBAAgB,GAChB,sBAAsB,GACtB,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,GACxB,sBAAsB,CAAC;AAE3B,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,iBAAkB,SAAQ,2BAA2B;IACpE;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEjC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAElC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,110 @@
|
|
|
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.Webhooks = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../../core/pagination.js");
|
|
7
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
8
|
+
/**
|
|
9
|
+
* Per-domain webhook endpoints with event subscriptions
|
|
10
|
+
*/
|
|
11
|
+
class Webhooks extends resource_1.APIResource {
|
|
12
|
+
/**
|
|
13
|
+
* List webhooks for an email domain
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* // Automatically fetches more pages as needed.
|
|
18
|
+
* for await (const emailWebhook of client.emailDomains.webhooks.list(
|
|
19
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
20
|
+
* )) {
|
|
21
|
+
* // ...
|
|
22
|
+
* }
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
list(domainID, query = {}, options) {
|
|
26
|
+
return this._client.getAPIList((0, path_1.path) `/email_domains/${domainID}/webhooks`, (pagination_1.DefaultFlatPagination), { query, ...options });
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Creates a webhook endpoint subscribed to a specific allowlist of event types.
|
|
30
|
+
* Both `email.*` events (published by email-api) and `email_domain.*` events
|
|
31
|
+
* (published by this service) flow through the same webhooks.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* const emailWebhookResponse =
|
|
36
|
+
* await client.emailDomains.webhooks.create(
|
|
37
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
38
|
+
* {
|
|
39
|
+
* events: [
|
|
40
|
+
* 'email.sent',
|
|
41
|
+
* 'email.delivered',
|
|
42
|
+
* 'email.bounced',
|
|
43
|
+
* ],
|
|
44
|
+
* url: 'https://example.com/webhooks/email',
|
|
45
|
+
* },
|
|
46
|
+
* );
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
create(domainID, body, options) {
|
|
50
|
+
return this._client.post((0, path_1.path) `/email_domains/${domainID}/webhooks`, { body, ...options });
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Delete a webhook
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* const emailWebhookResponse =
|
|
58
|
+
* await client.emailDomains.webhooks.delete(
|
|
59
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
60
|
+
* { domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
|
|
61
|
+
* );
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
delete(id, params, options) {
|
|
65
|
+
const { domain_id } = params;
|
|
66
|
+
return this._client.delete((0, path_1.path) `/email_domains/${domain_id}/webhooks/${id}`, options);
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Retrieve a webhook
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```ts
|
|
73
|
+
* const emailWebhookResponse =
|
|
74
|
+
* await client.emailDomains.webhooks.retrieve(
|
|
75
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
76
|
+
* { domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
|
|
77
|
+
* );
|
|
78
|
+
* ```
|
|
79
|
+
*/
|
|
80
|
+
retrieve(id, params, options) {
|
|
81
|
+
const { domain_id } = params;
|
|
82
|
+
return this._client.get((0, path_1.path) `/email_domains/${domain_id}/webhooks/${id}`, options);
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Update a webhook's URL and/or event subscription. A webhook is bound to its
|
|
86
|
+
* domain — `domain_id` is not mutable.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```ts
|
|
90
|
+
* const emailWebhookResponse =
|
|
91
|
+
* await client.emailDomains.webhooks.update(
|
|
92
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
93
|
+
* {
|
|
94
|
+
* domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
95
|
+
* events: [
|
|
96
|
+
* 'email.sent',
|
|
97
|
+
* 'email.delivered',
|
|
98
|
+
* 'email.opened',
|
|
99
|
+
* ],
|
|
100
|
+
* },
|
|
101
|
+
* );
|
|
102
|
+
* ```
|
|
103
|
+
*/
|
|
104
|
+
update(id, params, options) {
|
|
105
|
+
const { domain_id, ...body } = params;
|
|
106
|
+
return this._client.patch((0, path_1.path) `/email_domains/${domain_id}/webhooks/${id}`, { body, ...options });
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
exports.Webhooks = Webhooks;
|
|
110
|
+
//# sourceMappingURL=webhooks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/resources/email-domains/webhooks.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAA6G;AAE7G,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAgB,EAChB,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,kBAAkB,QAAQ,WAAW,EACzC,CAAA,kCAAmC,CAAA,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,QAAQ,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,kBAAkB,SAAS,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,SAAS,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kBAAkB,SAAS,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;CACF;AA7HD,4BA6HC"}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { DefaultFlatPagination } from "../../core/pagination.mjs";
|
|
4
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Per-domain webhook endpoints with event subscriptions
|
|
7
|
+
*/
|
|
8
|
+
export class Webhooks extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* List webhooks for an email domain
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* // Automatically fetches more pages as needed.
|
|
15
|
+
* for await (const emailWebhook of client.emailDomains.webhooks.list(
|
|
16
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
17
|
+
* )) {
|
|
18
|
+
* // ...
|
|
19
|
+
* }
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
list(domainID, query = {}, options) {
|
|
23
|
+
return this._client.getAPIList(path `/email_domains/${domainID}/webhooks`, (DefaultFlatPagination), { query, ...options });
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Creates a webhook endpoint subscribed to a specific allowlist of event types.
|
|
27
|
+
* Both `email.*` events (published by email-api) and `email_domain.*` events
|
|
28
|
+
* (published by this service) flow through the same webhooks.
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* ```ts
|
|
32
|
+
* const emailWebhookResponse =
|
|
33
|
+
* await client.emailDomains.webhooks.create(
|
|
34
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
35
|
+
* {
|
|
36
|
+
* events: [
|
|
37
|
+
* 'email.sent',
|
|
38
|
+
* 'email.delivered',
|
|
39
|
+
* 'email.bounced',
|
|
40
|
+
* ],
|
|
41
|
+
* url: 'https://example.com/webhooks/email',
|
|
42
|
+
* },
|
|
43
|
+
* );
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
create(domainID, body, options) {
|
|
47
|
+
return this._client.post(path `/email_domains/${domainID}/webhooks`, { body, ...options });
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Delete a webhook
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```ts
|
|
54
|
+
* const emailWebhookResponse =
|
|
55
|
+
* await client.emailDomains.webhooks.delete(
|
|
56
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
57
|
+
* { domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
|
|
58
|
+
* );
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
delete(id, params, options) {
|
|
62
|
+
const { domain_id } = params;
|
|
63
|
+
return this._client.delete(path `/email_domains/${domain_id}/webhooks/${id}`, options);
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Retrieve a webhook
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```ts
|
|
70
|
+
* const emailWebhookResponse =
|
|
71
|
+
* await client.emailDomains.webhooks.retrieve(
|
|
72
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
73
|
+
* { domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
|
|
74
|
+
* );
|
|
75
|
+
* ```
|
|
76
|
+
*/
|
|
77
|
+
retrieve(id, params, options) {
|
|
78
|
+
const { domain_id } = params;
|
|
79
|
+
return this._client.get(path `/email_domains/${domain_id}/webhooks/${id}`, options);
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Update a webhook's URL and/or event subscription. A webhook is bound to its
|
|
83
|
+
* domain — `domain_id` is not mutable.
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const emailWebhookResponse =
|
|
88
|
+
* await client.emailDomains.webhooks.update(
|
|
89
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
90
|
+
* {
|
|
91
|
+
* domain_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
92
|
+
* events: [
|
|
93
|
+
* 'email.sent',
|
|
94
|
+
* 'email.delivered',
|
|
95
|
+
* 'email.opened',
|
|
96
|
+
* ],
|
|
97
|
+
* },
|
|
98
|
+
* );
|
|
99
|
+
* ```
|
|
100
|
+
*/
|
|
101
|
+
update(id, params, options) {
|
|
102
|
+
const { domain_id, ...body } = params;
|
|
103
|
+
return this._client.patch(path `/email_domains/${domain_id}/webhooks/${id}`, { body, ...options });
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
//# sourceMappingURL=webhooks.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webhooks.mjs","sourceRoot":"","sources":["../../src/resources/email-domains/webhooks.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,qBAAqB,EAAiD,kCAA8B;AAE7G,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAgB,EAChB,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,kBAAkB,QAAQ,WAAW,EACzC,CAAA,qBAAmC,CAAA,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,QAAQ,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,kBAAkB,SAAS,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,SAAS,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kBAAkB,SAAS,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;CACF"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-domains.d.mts","sourceRoot":"","sources":["../src/resources/email-domains.ts"],"names":[],"mappings":"AAEA,0CAAsC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-domains.d.ts","sourceRoot":"","sources":["../src/resources/email-domains.ts"],"names":[],"mappings":"AAEA,yCAAsC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
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
|
+
const tslib_1 = require("../internal/tslib.js");
|
|
5
|
+
tslib_1.__exportStar(require("./email-domains/index.js"), exports);
|
|
6
|
+
//# 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,mEAAsC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-domains.mjs","sourceRoot":"","sources":["../src/resources/email-domains.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,0CAAsC"}
|