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,186 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as EmailEventsAPI from "./email-events.mjs";
|
|
3
|
+
import * as DraftsAPI from "./email-inboxes/drafts.mjs";
|
|
4
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
|
+
/**
|
|
7
|
+
* Retrieve account-level email events and event statistics.
|
|
8
|
+
*/
|
|
9
|
+
export declare class EmailEvents extends APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* Lists account-level email events sorted oldest first by
|
|
12
|
+
* `occurred_at asc, id asc`.
|
|
13
|
+
*/
|
|
14
|
+
list(query?: EmailEventListParams | null | undefined, options?: RequestOptions): APIPromise<EmailEventListResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* Returns counts and rates for email events over a time range. The default start
|
|
17
|
+
* time is 30 days ago.
|
|
18
|
+
*/
|
|
19
|
+
retrieveStats(query?: EmailEventRetrieveStatsParams | null | undefined, options?: RequestOptions): APIPromise<EmailEventRetrieveStatsResponse>;
|
|
20
|
+
}
|
|
21
|
+
export type EmailEventType = 'queued' | 'deferred' | 'scheduled' | 'cancelled' | 'sandbox' | 'sending' | 'sent' | 'failed' | 'delivered' | 'bounced' | 'complained' | 'rejected' | 'opened' | 'clicked' | 'unsubscribed' | 'daily_limit_exceeded';
|
|
22
|
+
export interface TimeRange {
|
|
23
|
+
from: string | null;
|
|
24
|
+
to: string | null;
|
|
25
|
+
}
|
|
26
|
+
export interface EmailEventListResponse {
|
|
27
|
+
data: Array<EmailEventListResponse.Data>;
|
|
28
|
+
meta: EmailEventListResponse.Meta;
|
|
29
|
+
}
|
|
30
|
+
export declare namespace EmailEventListResponse {
|
|
31
|
+
interface Data {
|
|
32
|
+
id: string;
|
|
33
|
+
email_id: string;
|
|
34
|
+
occurred_at: string;
|
|
35
|
+
record_type: 'email_event';
|
|
36
|
+
type: EmailEventsAPI.EmailEventType;
|
|
37
|
+
/**
|
|
38
|
+
* Summary of the associated email message. Present when the email_message preload
|
|
39
|
+
* is available.
|
|
40
|
+
*/
|
|
41
|
+
email?: Data.Email;
|
|
42
|
+
payload?: {
|
|
43
|
+
[key: string]: unknown;
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
namespace Data {
|
|
47
|
+
/**
|
|
48
|
+
* Summary of the associated email message. Present when the email_message preload
|
|
49
|
+
* is available.
|
|
50
|
+
*/
|
|
51
|
+
interface Email {
|
|
52
|
+
cc: Array<DraftsAPI.EmailAddress>;
|
|
53
|
+
from: DraftsAPI.EmailAddress;
|
|
54
|
+
subject: string;
|
|
55
|
+
to: Array<DraftsAPI.EmailAddress>;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
interface Meta {
|
|
59
|
+
page_size: number;
|
|
60
|
+
time_range: EmailEventsAPI.TimeRange;
|
|
61
|
+
/**
|
|
62
|
+
* Cursor for the next page, when more results are available.
|
|
63
|
+
*/
|
|
64
|
+
page_cursor?: string;
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
export interface EmailEventRetrieveStatsResponse {
|
|
68
|
+
data: EmailEventRetrieveStatsResponse.Data;
|
|
69
|
+
}
|
|
70
|
+
export declare namespace EmailEventRetrieveStatsResponse {
|
|
71
|
+
interface Data {
|
|
72
|
+
/**
|
|
73
|
+
* Recipient-level outcome counts for the queried time range. Each to, cc, and bcc
|
|
74
|
+
* recipient counts separately; repeated events of the same type for the same
|
|
75
|
+
* message and recipient count once. Partial MTA injection results count successful
|
|
76
|
+
* recipients as sent and unsuccessful recipients as failed. Only the ten listed
|
|
77
|
+
* event types are counted; other valid event types (scheduled, cancelled, sandbox,
|
|
78
|
+
* sending, rejected) are not included in stats.
|
|
79
|
+
*/
|
|
80
|
+
counts: Data.Counts;
|
|
81
|
+
/**
|
|
82
|
+
* Recipient-level event rates as percentages, rounded to 2 decimal places.
|
|
83
|
+
*/
|
|
84
|
+
rates: Data.Rates;
|
|
85
|
+
record_type: 'email_event_stats';
|
|
86
|
+
time_range: EmailEventsAPI.TimeRange;
|
|
87
|
+
}
|
|
88
|
+
namespace Data {
|
|
89
|
+
/**
|
|
90
|
+
* Recipient-level outcome counts for the queried time range. Each to, cc, and bcc
|
|
91
|
+
* recipient counts separately; repeated events of the same type for the same
|
|
92
|
+
* message and recipient count once. Partial MTA injection results count successful
|
|
93
|
+
* recipients as sent and unsuccessful recipients as failed. Only the ten listed
|
|
94
|
+
* event types are counted; other valid event types (scheduled, cancelled, sandbox,
|
|
95
|
+
* sending, rejected) are not included in stats.
|
|
96
|
+
*/
|
|
97
|
+
interface Counts {
|
|
98
|
+
bounced: number;
|
|
99
|
+
clicked: number;
|
|
100
|
+
complained: number;
|
|
101
|
+
deferred: number;
|
|
102
|
+
delivered: number;
|
|
103
|
+
failed: number;
|
|
104
|
+
opened: number;
|
|
105
|
+
queued: number;
|
|
106
|
+
sent: number;
|
|
107
|
+
unsubscribed: number;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Recipient-level event rates as percentages, rounded to 2 decimal places.
|
|
111
|
+
*/
|
|
112
|
+
interface Rates {
|
|
113
|
+
/**
|
|
114
|
+
* Bounced recipients / queued recipients as a percentage.
|
|
115
|
+
*/
|
|
116
|
+
bounce_rate: number;
|
|
117
|
+
/**
|
|
118
|
+
* Recipients clicked / recipients opened as a percentage.
|
|
119
|
+
*/
|
|
120
|
+
click_rate: number;
|
|
121
|
+
/**
|
|
122
|
+
* Recipients with a complaint feedback report / delivered recipients as a
|
|
123
|
+
* percentage.
|
|
124
|
+
*/
|
|
125
|
+
complaint_rate: number;
|
|
126
|
+
/**
|
|
127
|
+
* Deferred recipients / queued recipients as a percentage.
|
|
128
|
+
*/
|
|
129
|
+
deferred_rate: number;
|
|
130
|
+
/**
|
|
131
|
+
* Delivered recipients / queued recipients as a percentage.
|
|
132
|
+
*/
|
|
133
|
+
delivery_rate: number;
|
|
134
|
+
/**
|
|
135
|
+
* Recipients opened / recipients delivered as a percentage.
|
|
136
|
+
*/
|
|
137
|
+
open_rate: number;
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
export interface EmailEventListParams {
|
|
142
|
+
/**
|
|
143
|
+
* Filter events for a specific email message UUID. Invalid UUID values are
|
|
144
|
+
* silently ignored (no filter applied).
|
|
145
|
+
*/
|
|
146
|
+
email_id?: string;
|
|
147
|
+
/**
|
|
148
|
+
* Comma-separated list of event types to include. Also accepts repeated query
|
|
149
|
+
* parameters (e.g. event_type=delivered&event_type=bounced). Unknown values return
|
|
150
|
+
* no matches.
|
|
151
|
+
*/
|
|
152
|
+
event_type?: string | Array<string>;
|
|
153
|
+
/**
|
|
154
|
+
* Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
|
|
155
|
+
*/
|
|
156
|
+
from?: string;
|
|
157
|
+
/**
|
|
158
|
+
* Opaque URL-safe Base64 cursor returned by a previous list response.
|
|
159
|
+
*/
|
|
160
|
+
page_cursor?: string;
|
|
161
|
+
/**
|
|
162
|
+
* Number of results to return. Defaults to 25; maximum is 100. Invalid values are
|
|
163
|
+
* clamped to the valid range.
|
|
164
|
+
*/
|
|
165
|
+
page_size?: number;
|
|
166
|
+
/**
|
|
167
|
+
* Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
|
|
168
|
+
* to `from + 30 days`.
|
|
169
|
+
*/
|
|
170
|
+
to?: string;
|
|
171
|
+
}
|
|
172
|
+
export interface EmailEventRetrieveStatsParams {
|
|
173
|
+
/**
|
|
174
|
+
* Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
|
|
175
|
+
*/
|
|
176
|
+
from?: string;
|
|
177
|
+
/**
|
|
178
|
+
* Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
|
|
179
|
+
* to `from + 30 days`.
|
|
180
|
+
*/
|
|
181
|
+
to?: string;
|
|
182
|
+
}
|
|
183
|
+
export declare namespace EmailEvents {
|
|
184
|
+
export { type EmailEventType as EmailEventType, type TimeRange as TimeRange, type EmailEventListResponse as EmailEventListResponse, type EmailEventRetrieveStatsResponse as EmailEventRetrieveStatsResponse, type EmailEventListParams as EmailEventListParams, type EmailEventRetrieveStatsParams as EmailEventRetrieveStatsParams, };
|
|
185
|
+
}
|
|
186
|
+
//# sourceMappingURL=email-events.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-events.d.mts","sourceRoot":"","sources":["../src/resources/email-events.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,cAAc,2BAAuB;AACjD,OAAO,KAAK,SAAS,mCAA+B;AACpD,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;OAGG;IACH,aAAa,CACX,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;CAG/C;AAED,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,UAAU,GACV,WAAW,GACX,WAAW,GACX,SAAS,GACT,SAAS,GACT,MAAM,GACN,QAAQ,GACR,WAAW,GACX,SAAS,GACT,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,SAAS,GACT,cAAc,GACd,sBAAsB,CAAC;AAE3B,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAEzC,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,QAAQ,EAAE,MAAM,CAAC;QAEjB,WAAW,EAAE,MAAM,CAAC;QAEpB,WAAW,EAAE,aAAa,CAAC;QAE3B,IAAI,EAAE,cAAc,CAAC,cAAc,CAAC;QAEpC;;;WAGG;QACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;QAEnB,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KACtC;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,KAAK;YACpB,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAElC,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC;YAE7B,OAAO,EAAE,MAAM,CAAC;YAEhB,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;SACnC;KACF;IAED,UAAiB,IAAI;QACnB,SAAS,EAAE,MAAM,CAAC;QAElB,UAAU,EAAE,cAAc,CAAC,SAAS,CAAC;QAErC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,+BAA+B,CAAC,IAAI,CAAC;CAC5C;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,IAAI;QACnB;;;;;;;WAOG;QACH,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC;QAElB,WAAW,EAAE,mBAAmB,CAAC;QAEjC,UAAU,EAAE,cAAc,CAAC,SAAS,CAAC;KACtC;IAED,UAAiB,IAAI,CAAC;QACpB;;;;;;;WAOG;QACH,UAAiB,MAAM;YACrB,OAAO,EAAE,MAAM,CAAC;YAEhB,OAAO,EAAE,MAAM,CAAC;YAEhB,UAAU,EAAE,MAAM,CAAC;YAEnB,QAAQ,EAAE,MAAM,CAAC;YAEjB,SAAS,EAAE,MAAM,CAAC;YAElB,MAAM,EAAE,MAAM,CAAC;YAEf,MAAM,EAAE,MAAM,CAAC;YAEf,MAAM,EAAE,MAAM,CAAC;YAEf,IAAI,EAAE,MAAM,CAAC;YAEb,YAAY,EAAE,MAAM,CAAC;SACtB;QAED;;WAEG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,cAAc,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as EmailEventsAPI from "./email-events.js";
|
|
3
|
+
import * as DraftsAPI from "./email-inboxes/drafts.js";
|
|
4
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
6
|
+
/**
|
|
7
|
+
* Retrieve account-level email events and event statistics.
|
|
8
|
+
*/
|
|
9
|
+
export declare class EmailEvents extends APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* Lists account-level email events sorted oldest first by
|
|
12
|
+
* `occurred_at asc, id asc`.
|
|
13
|
+
*/
|
|
14
|
+
list(query?: EmailEventListParams | null | undefined, options?: RequestOptions): APIPromise<EmailEventListResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* Returns counts and rates for email events over a time range. The default start
|
|
17
|
+
* time is 30 days ago.
|
|
18
|
+
*/
|
|
19
|
+
retrieveStats(query?: EmailEventRetrieveStatsParams | null | undefined, options?: RequestOptions): APIPromise<EmailEventRetrieveStatsResponse>;
|
|
20
|
+
}
|
|
21
|
+
export type EmailEventType = 'queued' | 'deferred' | 'scheduled' | 'cancelled' | 'sandbox' | 'sending' | 'sent' | 'failed' | 'delivered' | 'bounced' | 'complained' | 'rejected' | 'opened' | 'clicked' | 'unsubscribed' | 'daily_limit_exceeded';
|
|
22
|
+
export interface TimeRange {
|
|
23
|
+
from: string | null;
|
|
24
|
+
to: string | null;
|
|
25
|
+
}
|
|
26
|
+
export interface EmailEventListResponse {
|
|
27
|
+
data: Array<EmailEventListResponse.Data>;
|
|
28
|
+
meta: EmailEventListResponse.Meta;
|
|
29
|
+
}
|
|
30
|
+
export declare namespace EmailEventListResponse {
|
|
31
|
+
interface Data {
|
|
32
|
+
id: string;
|
|
33
|
+
email_id: string;
|
|
34
|
+
occurred_at: string;
|
|
35
|
+
record_type: 'email_event';
|
|
36
|
+
type: EmailEventsAPI.EmailEventType;
|
|
37
|
+
/**
|
|
38
|
+
* Summary of the associated email message. Present when the email_message preload
|
|
39
|
+
* is available.
|
|
40
|
+
*/
|
|
41
|
+
email?: Data.Email;
|
|
42
|
+
payload?: {
|
|
43
|
+
[key: string]: unknown;
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
namespace Data {
|
|
47
|
+
/**
|
|
48
|
+
* Summary of the associated email message. Present when the email_message preload
|
|
49
|
+
* is available.
|
|
50
|
+
*/
|
|
51
|
+
interface Email {
|
|
52
|
+
cc: Array<DraftsAPI.EmailAddress>;
|
|
53
|
+
from: DraftsAPI.EmailAddress;
|
|
54
|
+
subject: string;
|
|
55
|
+
to: Array<DraftsAPI.EmailAddress>;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
interface Meta {
|
|
59
|
+
page_size: number;
|
|
60
|
+
time_range: EmailEventsAPI.TimeRange;
|
|
61
|
+
/**
|
|
62
|
+
* Cursor for the next page, when more results are available.
|
|
63
|
+
*/
|
|
64
|
+
page_cursor?: string;
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
export interface EmailEventRetrieveStatsResponse {
|
|
68
|
+
data: EmailEventRetrieveStatsResponse.Data;
|
|
69
|
+
}
|
|
70
|
+
export declare namespace EmailEventRetrieveStatsResponse {
|
|
71
|
+
interface Data {
|
|
72
|
+
/**
|
|
73
|
+
* Recipient-level outcome counts for the queried time range. Each to, cc, and bcc
|
|
74
|
+
* recipient counts separately; repeated events of the same type for the same
|
|
75
|
+
* message and recipient count once. Partial MTA injection results count successful
|
|
76
|
+
* recipients as sent and unsuccessful recipients as failed. Only the ten listed
|
|
77
|
+
* event types are counted; other valid event types (scheduled, cancelled, sandbox,
|
|
78
|
+
* sending, rejected) are not included in stats.
|
|
79
|
+
*/
|
|
80
|
+
counts: Data.Counts;
|
|
81
|
+
/**
|
|
82
|
+
* Recipient-level event rates as percentages, rounded to 2 decimal places.
|
|
83
|
+
*/
|
|
84
|
+
rates: Data.Rates;
|
|
85
|
+
record_type: 'email_event_stats';
|
|
86
|
+
time_range: EmailEventsAPI.TimeRange;
|
|
87
|
+
}
|
|
88
|
+
namespace Data {
|
|
89
|
+
/**
|
|
90
|
+
* Recipient-level outcome counts for the queried time range. Each to, cc, and bcc
|
|
91
|
+
* recipient counts separately; repeated events of the same type for the same
|
|
92
|
+
* message and recipient count once. Partial MTA injection results count successful
|
|
93
|
+
* recipients as sent and unsuccessful recipients as failed. Only the ten listed
|
|
94
|
+
* event types are counted; other valid event types (scheduled, cancelled, sandbox,
|
|
95
|
+
* sending, rejected) are not included in stats.
|
|
96
|
+
*/
|
|
97
|
+
interface Counts {
|
|
98
|
+
bounced: number;
|
|
99
|
+
clicked: number;
|
|
100
|
+
complained: number;
|
|
101
|
+
deferred: number;
|
|
102
|
+
delivered: number;
|
|
103
|
+
failed: number;
|
|
104
|
+
opened: number;
|
|
105
|
+
queued: number;
|
|
106
|
+
sent: number;
|
|
107
|
+
unsubscribed: number;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Recipient-level event rates as percentages, rounded to 2 decimal places.
|
|
111
|
+
*/
|
|
112
|
+
interface Rates {
|
|
113
|
+
/**
|
|
114
|
+
* Bounced recipients / queued recipients as a percentage.
|
|
115
|
+
*/
|
|
116
|
+
bounce_rate: number;
|
|
117
|
+
/**
|
|
118
|
+
* Recipients clicked / recipients opened as a percentage.
|
|
119
|
+
*/
|
|
120
|
+
click_rate: number;
|
|
121
|
+
/**
|
|
122
|
+
* Recipients with a complaint feedback report / delivered recipients as a
|
|
123
|
+
* percentage.
|
|
124
|
+
*/
|
|
125
|
+
complaint_rate: number;
|
|
126
|
+
/**
|
|
127
|
+
* Deferred recipients / queued recipients as a percentage.
|
|
128
|
+
*/
|
|
129
|
+
deferred_rate: number;
|
|
130
|
+
/**
|
|
131
|
+
* Delivered recipients / queued recipients as a percentage.
|
|
132
|
+
*/
|
|
133
|
+
delivery_rate: number;
|
|
134
|
+
/**
|
|
135
|
+
* Recipients opened / recipients delivered as a percentage.
|
|
136
|
+
*/
|
|
137
|
+
open_rate: number;
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
export interface EmailEventListParams {
|
|
142
|
+
/**
|
|
143
|
+
* Filter events for a specific email message UUID. Invalid UUID values are
|
|
144
|
+
* silently ignored (no filter applied).
|
|
145
|
+
*/
|
|
146
|
+
email_id?: string;
|
|
147
|
+
/**
|
|
148
|
+
* Comma-separated list of event types to include. Also accepts repeated query
|
|
149
|
+
* parameters (e.g. event_type=delivered&event_type=bounced). Unknown values return
|
|
150
|
+
* no matches.
|
|
151
|
+
*/
|
|
152
|
+
event_type?: string | Array<string>;
|
|
153
|
+
/**
|
|
154
|
+
* Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
|
|
155
|
+
*/
|
|
156
|
+
from?: string;
|
|
157
|
+
/**
|
|
158
|
+
* Opaque URL-safe Base64 cursor returned by a previous list response.
|
|
159
|
+
*/
|
|
160
|
+
page_cursor?: string;
|
|
161
|
+
/**
|
|
162
|
+
* Number of results to return. Defaults to 25; maximum is 100. Invalid values are
|
|
163
|
+
* clamped to the valid range.
|
|
164
|
+
*/
|
|
165
|
+
page_size?: number;
|
|
166
|
+
/**
|
|
167
|
+
* Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
|
|
168
|
+
* to `from + 30 days`.
|
|
169
|
+
*/
|
|
170
|
+
to?: string;
|
|
171
|
+
}
|
|
172
|
+
export interface EmailEventRetrieveStatsParams {
|
|
173
|
+
/**
|
|
174
|
+
* Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
|
|
175
|
+
*/
|
|
176
|
+
from?: string;
|
|
177
|
+
/**
|
|
178
|
+
* Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
|
|
179
|
+
* to `from + 30 days`.
|
|
180
|
+
*/
|
|
181
|
+
to?: string;
|
|
182
|
+
}
|
|
183
|
+
export declare namespace EmailEvents {
|
|
184
|
+
export { type EmailEventType as EmailEventType, type TimeRange as TimeRange, type EmailEventListResponse as EmailEventListResponse, type EmailEventRetrieveStatsResponse as EmailEventRetrieveStatsResponse, type EmailEventListParams as EmailEventListParams, type EmailEventRetrieveStatsParams as EmailEventRetrieveStatsParams, };
|
|
185
|
+
}
|
|
186
|
+
//# sourceMappingURL=email-events.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-events.d.ts","sourceRoot":"","sources":["../src/resources/email-events.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,cAAc,0BAAuB;AACjD,OAAO,KAAK,SAAS,kCAA+B;AACpD,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;OAGG;IACH,aAAa,CACX,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;CAG/C;AAED,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,UAAU,GACV,WAAW,GACX,WAAW,GACX,SAAS,GACT,SAAS,GACT,MAAM,GACN,QAAQ,GACR,WAAW,GACX,SAAS,GACT,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,SAAS,GACT,cAAc,GACd,sBAAsB,CAAC;AAE3B,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAEzC,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,QAAQ,EAAE,MAAM,CAAC;QAEjB,WAAW,EAAE,MAAM,CAAC;QAEpB,WAAW,EAAE,aAAa,CAAC;QAE3B,IAAI,EAAE,cAAc,CAAC,cAAc,CAAC;QAEpC;;;WAGG;QACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;QAEnB,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KACtC;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,KAAK;YACpB,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAElC,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC;YAE7B,OAAO,EAAE,MAAM,CAAC;YAEhB,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;SACnC;KACF;IAED,UAAiB,IAAI;QACnB,SAAS,EAAE,MAAM,CAAC;QAElB,UAAU,EAAE,cAAc,CAAC,SAAS,CAAC;QAErC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,+BAA+B,CAAC,IAAI,CAAC;CAC5C;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,IAAI;QACnB;;;;;;;WAOG;QACH,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC;QAElB,WAAW,EAAE,mBAAmB,CAAC;QAEjC,UAAU,EAAE,cAAc,CAAC,SAAS,CAAC;KACtC;IAED,UAAiB,IAAI,CAAC;QACpB;;;;;;;WAOG;QACH,UAAiB,MAAM;YACrB,OAAO,EAAE,MAAM,CAAC;YAEhB,OAAO,EAAE,MAAM,CAAC;YAEhB,UAAU,EAAE,MAAM,CAAC;YAEnB,QAAQ,EAAE,MAAM,CAAC;YAEjB,SAAS,EAAE,MAAM,CAAC;YAElB,MAAM,EAAE,MAAM,CAAC;YAEf,MAAM,EAAE,MAAM,CAAC;YAEf,MAAM,EAAE,MAAM,CAAC;YAEf,IAAI,EAAE,MAAM,CAAC;YAEb,YAAY,EAAE,MAAM,CAAC;SACtB;QAED;;WAEG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,cAAc,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
|
|
@@ -0,0 +1,26 @@
|
|
|
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.EmailEvents = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
/**
|
|
7
|
+
* Retrieve account-level email events and event statistics.
|
|
8
|
+
*/
|
|
9
|
+
class EmailEvents extends resource_1.APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* Lists account-level email events sorted oldest first by
|
|
12
|
+
* `occurred_at asc, id asc`.
|
|
13
|
+
*/
|
|
14
|
+
list(query = {}, options) {
|
|
15
|
+
return this._client.get('/email_events', { query, ...options });
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Returns counts and rates for email events over a time range. The default start
|
|
19
|
+
* time is 30 days ago.
|
|
20
|
+
*/
|
|
21
|
+
retrieveStats(query = {}, options) {
|
|
22
|
+
return this._client.get('/email_events/stats', { query, ...options });
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
exports.EmailEvents = EmailEvents;
|
|
26
|
+
//# sourceMappingURL=email-events.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-events.js","sourceRoot":"","sources":["../src/resources/email-events.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAM/C;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;OAGG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,aAAa,CACX,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AAtBD,kCAsBC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
/**
|
|
4
|
+
* Retrieve account-level email events and event statistics.
|
|
5
|
+
*/
|
|
6
|
+
export class EmailEvents extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Lists account-level email events sorted oldest first by
|
|
9
|
+
* `occurred_at asc, id asc`.
|
|
10
|
+
*/
|
|
11
|
+
list(query = {}, options) {
|
|
12
|
+
return this._client.get('/email_events', { query, ...options });
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Returns counts and rates for email events over a time range. The default start
|
|
16
|
+
* time is 30 days ago.
|
|
17
|
+
*/
|
|
18
|
+
retrieveStats(query = {}, options) {
|
|
19
|
+
return this._client.get('/email_events/stats', { query, ...options });
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=email-events.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-events.mjs","sourceRoot":"","sources":["../src/resources/email-events.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAM/C;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;OAGG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,aAAa,CACX,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}
|