telnyx 7.30.0-beta.0 → 7.30.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 +8 -9
- package/client.d.mts.map +1 -1
- package/client.d.ts +8 -9
- package/client.d.ts.map +1 -1
- package/client.js +0 -3
- package/client.js.map +1 -1
- package/client.mjs +0 -3
- package/client.mjs.map +1 -1
- package/core/pagination.d.mts +20 -0
- package/core/pagination.d.mts.map +1 -1
- package/core/pagination.d.ts +20 -0
- package/core/pagination.d.ts.map +1 -1
- package/core/pagination.js +25 -1
- package/core/pagination.js.map +1 -1
- package/core/pagination.mjs +23 -0
- package/core/pagination.mjs.map +1 -1
- package/lib/login-token.d.mts +7 -3
- package/lib/login-token.d.mts.map +1 -1
- package/lib/login-token.d.ts +7 -3
- package/lib/login-token.d.ts.map +1 -1
- package/lib/login-token.js.map +1 -1
- package/lib/login-token.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/ai/ai.d.mts +9 -4
- package/resources/ai/ai.d.mts.map +1 -1
- package/resources/ai/ai.d.ts +9 -4
- 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/assistants/assistants.d.mts +191 -109
- package/resources/ai/assistants/assistants.d.mts.map +1 -1
- package/resources/ai/assistants/assistants.d.ts +191 -109
- 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/assistants/index.d.mts +1 -1
- package/resources/ai/assistants/index.d.mts.map +1 -1
- package/resources/ai/assistants/index.d.ts +1 -1
- package/resources/ai/assistants/index.d.ts.map +1 -1
- package/resources/ai/assistants/index.js.map +1 -1
- package/resources/ai/assistants/index.mjs.map +1 -1
- package/resources/ai/chat.d.mts +3 -5
- package/resources/ai/chat.d.mts.map +1 -1
- package/resources/ai/chat.d.ts +3 -5
- package/resources/ai/chat.d.ts.map +1 -1
- package/resources/ai/conversations/conversations.d.mts +27 -2
- package/resources/ai/conversations/conversations.d.mts.map +1 -1
- package/resources/ai/conversations/conversations.d.ts +27 -2
- package/resources/ai/conversations/conversations.d.ts.map +1 -1
- package/resources/ai/conversations/conversations.js +23 -1
- package/resources/ai/conversations/conversations.js.map +1 -1
- package/resources/ai/conversations/conversations.mjs +23 -1
- package/resources/ai/conversations/conversations.mjs.map +1 -1
- package/resources/ai/conversations/index.d.mts +1 -1
- package/resources/ai/conversations/index.d.mts.map +1 -1
- package/resources/ai/conversations/index.d.ts +1 -1
- package/resources/ai/conversations/index.d.ts.map +1 -1
- package/resources/ai/conversations/index.js.map +1 -1
- package/resources/ai/conversations/index.mjs.map +1 -1
- package/resources/ai/index.d.mts +2 -2
- package/resources/ai/index.d.mts.map +1 -1
- package/resources/ai/index.d.ts +2 -2
- package/resources/ai/index.d.ts.map +1 -1
- package/resources/ai/index.js.map +1 -1
- package/resources/ai/index.mjs.map +1 -1
- package/resources/ai/memory/namespaces/index.d.mts +1 -1
- package/resources/ai/memory/namespaces/index.d.mts.map +1 -1
- package/resources/ai/memory/namespaces/index.d.ts +1 -1
- package/resources/ai/memory/namespaces/index.d.ts.map +1 -1
- package/resources/ai/memory/namespaces/index.js.map +1 -1
- package/resources/ai/memory/namespaces/index.mjs +1 -1
- package/resources/ai/memory/namespaces/index.mjs.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.d.mts +2 -2
- package/resources/ai/memory/namespaces/namespaces.d.mts.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.d.ts +2 -2
- package/resources/ai/memory/namespaces/namespaces.d.ts.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.js.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.mjs +1 -1
- package/resources/ai/memory/namespaces/namespaces.mjs.map +1 -1
- package/resources/ai/memory/namespaces/profiles/profiles.d.mts +3 -3
- package/resources/ai/memory/namespaces/profiles/profiles.d.mts.map +1 -1
- package/resources/ai/memory/namespaces/profiles/profiles.d.ts +3 -3
- package/resources/ai/memory/namespaces/profiles/profiles.d.ts.map +1 -1
- package/resources/ai/memory/namespaces/profiles/profiles.js.map +1 -1
- package/resources/ai/memory/namespaces/profiles/profiles.mjs.map +1 -1
- package/resources/ai/memory/namespaces/settings.d.mts +23 -27
- package/resources/ai/memory/namespaces/settings.d.mts.map +1 -1
- package/resources/ai/memory/namespaces/settings.d.ts +23 -27
- package/resources/ai/memory/namespaces/settings.d.ts.map +1 -1
- package/resources/ai/openai/chat.d.mts +3 -5
- package/resources/ai/openai/chat.d.mts.map +1 -1
- package/resources/ai/openai/chat.d.ts +3 -5
- package/resources/ai/openai/chat.d.ts.map +1 -1
- package/resources/ai/tests/test-framework/v1/v1.d.mts +15 -5
- package/resources/ai/tests/test-framework/v1/v1.d.mts.map +1 -1
- package/resources/ai/tests/test-framework/v1/v1.d.ts +15 -5
- package/resources/ai/tests/test-framework/v1/v1.d.ts.map +1 -1
- package/resources/ai/tools.d.mts +222 -0
- package/resources/ai/tools.d.mts.map +1 -1
- package/resources/ai/tools.d.ts +222 -0
- package/resources/ai/tools.d.ts.map +1 -1
- package/resources/browser-sessions/actions.d.mts +13 -7
- package/resources/browser-sessions/actions.d.mts.map +1 -1
- package/resources/browser-sessions/actions.d.ts +13 -7
- package/resources/browser-sessions/actions.d.ts.map +1 -1
- package/resources/browser-sessions/browser-sessions.d.mts +6 -2
- package/resources/browser-sessions/browser-sessions.d.mts.map +1 -1
- package/resources/browser-sessions/browser-sessions.d.ts +6 -2
- package/resources/browser-sessions/browser-sessions.d.ts.map +1 -1
- package/resources/compute/funcs/export.d.mts +33 -35
- package/resources/compute/funcs/export.d.mts.map +1 -1
- package/resources/compute/funcs/export.d.ts +33 -35
- package/resources/compute/funcs/export.d.ts.map +1 -1
- package/resources/compute/funcs/funcs.d.mts +2 -2
- package/resources/compute/funcs/funcs.d.mts.map +1 -1
- package/resources/compute/funcs/funcs.d.ts +2 -2
- package/resources/compute/funcs/funcs.d.ts.map +1 -1
- package/resources/compute/funcs/funcs.js.map +1 -1
- package/resources/compute/funcs/funcs.mjs.map +1 -1
- package/resources/compute/funcs/index.d.mts +1 -1
- package/resources/compute/funcs/index.d.mts.map +1 -1
- package/resources/compute/funcs/index.d.ts +1 -1
- package/resources/compute/funcs/index.d.ts.map +1 -1
- package/resources/compute/funcs/index.js.map +1 -1
- package/resources/compute/funcs/index.mjs +1 -1
- package/resources/compute/funcs/index.mjs.map +1 -1
- package/resources/email/dedicated-ips/dedicated-ips.d.mts.map +1 -1
- package/resources/email/dedicated-ips/dedicated-ips.d.ts.map +1 -1
- package/resources/email/dedicated-ips/dedicated-ips.js +2 -2
- package/resources/email/dedicated-ips/dedicated-ips.js.map +1 -1
- package/resources/email/dedicated-ips/dedicated-ips.mjs +2 -2
- package/resources/email/dedicated-ips/dedicated-ips.mjs.map +1 -1
- package/resources/email-events.d.mts +84 -106
- package/resources/email-events.d.mts.map +1 -1
- package/resources/email-events.d.ts +84 -106
- package/resources/email-events.d.ts.map +1 -1
- package/resources/email-events.js +5 -1
- package/resources/email-events.js.map +1 -1
- package/resources/email-events.mjs +5 -1
- package/resources/email-events.mjs.map +1 -1
- package/resources/email-messages/email-messages.d.mts +1 -7
- package/resources/email-messages/email-messages.d.mts.map +1 -1
- package/resources/email-messages/email-messages.d.ts +1 -7
- package/resources/email-messages/email-messages.d.ts.map +1 -1
- package/resources/email-messages/email-messages.js.map +1 -1
- package/resources/email-messages/email-messages.mjs.map +1 -1
- package/resources/email-templates.d.mts +16 -70
- package/resources/email-templates.d.mts.map +1 -1
- package/resources/email-templates.d.ts +16 -70
- package/resources/email-templates.d.ts.map +1 -1
- package/resources/enterprises/enterprises.d.mts +2 -2
- package/resources/enterprises/enterprises.d.mts.map +1 -1
- package/resources/enterprises/enterprises.d.ts +2 -2
- package/resources/enterprises/enterprises.d.ts.map +1 -1
- package/resources/enterprises/enterprises.js.map +1 -1
- package/resources/enterprises/enterprises.mjs.map +1 -1
- package/resources/enterprises/index.d.mts +1 -1
- package/resources/enterprises/index.d.mts.map +1 -1
- package/resources/enterprises/index.d.ts +1 -1
- package/resources/enterprises/index.d.ts.map +1 -1
- package/resources/enterprises/index.js.map +1 -1
- package/resources/enterprises/index.mjs.map +1 -1
- package/resources/enterprises/reputation/external-verification.d.mts +26 -29
- package/resources/enterprises/reputation/external-verification.d.mts.map +1 -1
- package/resources/enterprises/reputation/external-verification.d.ts +26 -29
- package/resources/enterprises/reputation/external-verification.d.ts.map +1 -1
- package/resources/enterprises/reputation/external-verification.js +3 -3
- package/resources/enterprises/reputation/external-verification.js.map +1 -1
- package/resources/enterprises/reputation/external-verification.mjs +1 -1
- package/resources/enterprises/reputation/external-verification.mjs.map +1 -1
- package/resources/enterprises/reputation/index.d.mts +1 -1
- package/resources/enterprises/reputation/index.d.mts.map +1 -1
- package/resources/enterprises/reputation/index.d.ts +1 -1
- package/resources/enterprises/reputation/index.d.ts.map +1 -1
- package/resources/enterprises/reputation/index.js +2 -2
- package/resources/enterprises/reputation/index.js.map +1 -1
- package/resources/enterprises/reputation/index.mjs +1 -1
- package/resources/enterprises/reputation/index.mjs.map +1 -1
- package/resources/enterprises/reputation/reputation.d.mts +3 -3
- package/resources/enterprises/reputation/reputation.d.mts.map +1 -1
- package/resources/enterprises/reputation/reputation.d.ts +3 -3
- package/resources/enterprises/reputation/reputation.d.ts.map +1 -1
- package/resources/enterprises/reputation/reputation.js +2 -2
- package/resources/enterprises/reputation/reputation.js.map +1 -1
- package/resources/enterprises/reputation/reputation.mjs +3 -3
- package/resources/enterprises/reputation/reputation.mjs.map +1 -1
- package/resources/enterprises/verify-email.d.mts +27 -29
- package/resources/enterprises/verify-email.d.mts.map +1 -1
- package/resources/enterprises/verify-email.d.ts +27 -29
- package/resources/enterprises/verify-email.d.ts.map +1 -1
- package/resources/index.d.mts +3 -4
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -4
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +1 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +0 -1
- package/resources/index.mjs.map +1 -1
- package/resources/messages/messages.d.mts +32 -2
- package/resources/messages/messages.d.mts.map +1 -1
- package/resources/messages/messages.d.ts +32 -2
- package/resources/messages/messages.d.ts.map +1 -1
- package/resources/messages/messages.js.map +1 -1
- package/resources/messages/messages.mjs.map +1 -1
- package/resources/messaging-profiles/messaging-profiles.d.mts +11 -0
- package/resources/messaging-profiles/messaging-profiles.d.mts.map +1 -1
- package/resources/messaging-profiles/messaging-profiles.d.ts +11 -0
- package/resources/messaging-profiles/messaging-profiles.d.ts.map +1 -1
- package/resources/messaging-profiles/messaging-profiles.js.map +1 -1
- package/resources/messaging-profiles/messaging-profiles.mjs.map +1 -1
- package/resources/number-lookup.d.mts +5 -0
- package/resources/number-lookup.d.mts.map +1 -1
- package/resources/number-lookup.d.ts +5 -0
- package/resources/number-lookup.d.ts.map +1 -1
- package/resources/pay-connectors.d.mts +7 -7
- package/resources/pay-connectors.d.mts.map +1 -1
- package/resources/pay-connectors.d.ts +7 -7
- package/resources/pay-connectors.d.ts.map +1 -1
- package/resources/phone-numbers/index.d.mts +1 -1
- package/resources/phone-numbers/index.d.mts.map +1 -1
- package/resources/phone-numbers/index.d.ts +1 -1
- package/resources/phone-numbers/index.d.ts.map +1 -1
- package/resources/phone-numbers/index.js.map +1 -1
- package/resources/phone-numbers/index.mjs.map +1 -1
- package/resources/phone-numbers/jobs.d.mts +21 -57
- package/resources/phone-numbers/jobs.d.mts.map +1 -1
- package/resources/phone-numbers/jobs.d.ts +21 -57
- package/resources/phone-numbers/jobs.d.ts.map +1 -1
- package/resources/phone-numbers/phone-numbers.d.mts +2 -2
- package/resources/phone-numbers/phone-numbers.d.mts.map +1 -1
- package/resources/phone-numbers/phone-numbers.d.ts +2 -2
- package/resources/phone-numbers/phone-numbers.d.ts.map +1 -1
- package/resources/phone-numbers/phone-numbers.js.map +1 -1
- package/resources/phone-numbers/phone-numbers.mjs.map +1 -1
- package/resources/portouts/portouts.d.mts +2 -1
- package/resources/portouts/portouts.d.mts.map +1 -1
- package/resources/portouts/portouts.d.ts +2 -1
- package/resources/portouts/portouts.d.ts.map +1 -1
- package/resources/portouts/portouts.js +2 -1
- package/resources/portouts/portouts.js.map +1 -1
- package/resources/portouts/portouts.mjs +2 -1
- package/resources/portouts/portouts.mjs.map +1 -1
- package/resources/telephony-credentials.d.mts +54 -24
- package/resources/telephony-credentials.d.mts.map +1 -1
- package/resources/telephony-credentials.d.ts +54 -24
- package/resources/telephony-credentials.d.ts.map +1 -1
- package/resources/telephony-credentials.js +31 -27
- package/resources/telephony-credentials.js.map +1 -1
- package/resources/telephony-credentials.mjs +31 -27
- package/resources/telephony-credentials.mjs.map +1 -1
- package/resources/voice-clones.d.mts +4 -4
- package/resources/voice-clones.d.mts.map +1 -1
- package/resources/voice-clones.d.ts +4 -4
- package/resources/voice-clones.d.ts.map +1 -1
- package/resources/webhooks.d.mts +10 -20
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +10 -20
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/whatsapp/business-accounts/business-accounts.d.mts +2 -2
- package/resources/whatsapp/business-accounts/business-accounts.d.mts.map +1 -1
- package/resources/whatsapp/business-accounts/business-accounts.d.ts +2 -2
- package/resources/whatsapp/business-accounts/business-accounts.d.ts.map +1 -1
- package/resources/whatsapp/business-accounts/business-accounts.js.map +1 -1
- package/resources/whatsapp/business-accounts/business-accounts.mjs.map +1 -1
- package/resources/whatsapp/business-accounts/index.d.mts +1 -1
- package/resources/whatsapp/business-accounts/index.d.mts.map +1 -1
- package/resources/whatsapp/business-accounts/index.d.ts +1 -1
- package/resources/whatsapp/business-accounts/index.d.ts.map +1 -1
- package/resources/whatsapp/business-accounts/index.js.map +1 -1
- package/resources/whatsapp/business-accounts/index.mjs.map +1 -1
- package/resources/whatsapp/business-accounts/phone-numbers.d.mts +7 -66
- package/resources/whatsapp/business-accounts/phone-numbers.d.mts.map +1 -1
- package/resources/whatsapp/business-accounts/phone-numbers.d.ts +7 -66
- package/resources/whatsapp/business-accounts/phone-numbers.d.ts.map +1 -1
- package/resources/whatsapp/business-accounts/phone-numbers.js +1 -1
- package/resources/whatsapp/business-accounts/phone-numbers.js.map +1 -1
- package/resources/whatsapp/business-accounts/phone-numbers.mjs +1 -1
- package/resources/whatsapp/business-accounts/phone-numbers.mjs.map +1 -1
- package/resources/whatsapp/hosted-signups.d.mts +11 -73
- package/resources/whatsapp/hosted-signups.d.mts.map +1 -1
- package/resources/whatsapp/hosted-signups.d.ts +11 -73
- package/resources/whatsapp/hosted-signups.d.ts.map +1 -1
- package/resources/whatsapp/hosted-signups.js +5 -2
- package/resources/whatsapp/hosted-signups.js.map +1 -1
- package/resources/whatsapp/hosted-signups.mjs +5 -2
- package/resources/whatsapp/hosted-signups.mjs.map +1 -1
- package/resources/whatsapp/index.d.mts +2 -2
- package/resources/whatsapp/index.d.mts.map +1 -1
- package/resources/whatsapp/index.d.ts +2 -2
- package/resources/whatsapp/index.d.ts.map +1 -1
- package/resources/whatsapp/phone-numbers/index.d.mts +1 -1
- package/resources/whatsapp/phone-numbers/index.d.mts.map +1 -1
- package/resources/whatsapp/phone-numbers/index.d.ts +1 -1
- package/resources/whatsapp/phone-numbers/index.d.ts.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.d.mts +9 -135
- package/resources/whatsapp/phone-numbers/phone-numbers.d.mts.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.d.ts +9 -135
- package/resources/whatsapp/phone-numbers/phone-numbers.d.ts.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.js +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.js.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.mjs +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.mjs.map +1 -1
- package/resources/whatsapp/whatsapp.d.mts +4 -4
- package/resources/whatsapp/whatsapp.d.mts.map +1 -1
- package/resources/whatsapp/whatsapp.d.ts +4 -4
- package/resources/whatsapp/whatsapp.d.ts.map +1 -1
- package/resources/whatsapp/whatsapp.mjs.map +1 -1
- package/src/client.ts +13 -6
- package/src/core/pagination.ts +58 -0
- package/src/lib/login-token.ts +8 -4
- package/src/resources/ai/ai.ts +12 -0
- package/src/resources/ai/assistants/assistants.ts +227 -144
- package/src/resources/ai/assistants/index.ts +2 -0
- package/src/resources/ai/chat.ts +3 -5
- package/src/resources/ai/conversations/conversations.ts +39 -1
- package/src/resources/ai/conversations/index.ts +1 -0
- package/src/resources/ai/index.ts +3 -0
- package/src/resources/ai/memory/namespaces/index.ts +7 -1
- package/src/resources/ai/memory/namespaces/namespaces.ts +9 -1
- package/src/resources/ai/memory/namespaces/profiles/profiles.ts +5 -3
- package/src/resources/ai/memory/namespaces/settings.ts +25 -27
- package/src/resources/ai/openai/chat.ts +3 -5
- package/src/resources/ai/tests/test-framework/v1/v1.ts +5 -5
- package/src/resources/ai/tools.ts +366 -0
- package/src/resources/browser-sessions/actions.ts +7 -7
- package/src/resources/browser-sessions/browser-sessions.ts +2 -2
- package/src/resources/compute/funcs/export.ts +41 -42
- package/src/resources/compute/funcs/funcs.ts +2 -1
- package/src/resources/compute/funcs/index.ts +6 -1
- package/src/resources/email/dedicated-ips/dedicated-ips.ts +3 -2
- package/src/resources/email-events.ts +128 -147
- package/src/resources/email-messages/email-messages.ts +1 -7
- package/src/resources/email-templates.ts +17 -78
- package/src/resources/enterprises/enterprises.ts +2 -0
- package/src/resources/enterprises/index.ts +1 -0
- package/src/resources/enterprises/reputation/external-verification.ts +32 -34
- package/src/resources/enterprises/reputation/index.ts +2 -1
- package/src/resources/enterprises/reputation/reputation.ts +6 -4
- package/src/resources/enterprises/verify-email.ts +29 -30
- package/src/resources/index.ts +4 -1
- package/src/resources/messages/messages.ts +32 -2
- package/src/resources/messaging-profiles/messaging-profiles.ts +12 -0
- package/src/resources/number-lookup.ts +6 -0
- package/src/resources/pay-connectors.ts +7 -7
- package/src/resources/phone-numbers/index.ts +2 -0
- package/src/resources/phone-numbers/jobs.ts +22 -60
- package/src/resources/phone-numbers/phone-numbers.ts +4 -0
- package/src/resources/portouts/portouts.ts +2 -1
- package/src/resources/telephony-credentials.ts +74 -41
- package/src/resources/voice-clones.ts +4 -4
- package/src/resources/webhooks.ts +10 -20
- package/src/resources/whatsapp/business-accounts/business-accounts.ts +0 -4
- package/src/resources/whatsapp/business-accounts/index.ts +0 -2
- package/src/resources/whatsapp/business-accounts/phone-numbers.ts +7 -98
- package/src/resources/whatsapp/hosted-signups.ts +18 -97
- package/src/resources/whatsapp/index.ts +4 -4
- package/src/resources/whatsapp/phone-numbers/index.ts +2 -2
- package/src/resources/whatsapp/phone-numbers/phone-numbers.ts +11 -197
- package/src/resources/whatsapp/whatsapp.ts +8 -8
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/resources/tts-integrations/actions.d.mts +0 -4
- package/resources/tts-integrations/actions.d.mts.map +0 -1
- package/resources/tts-integrations/actions.d.ts +0 -4
- package/resources/tts-integrations/actions.d.ts.map +0 -1
- package/resources/tts-integrations/actions.js +0 -9
- package/resources/tts-integrations/actions.js.map +0 -1
- package/resources/tts-integrations/actions.mjs +0 -5
- package/resources/tts-integrations/actions.mjs.map +0 -1
- package/resources/tts-integrations/index.d.mts +0 -3
- package/resources/tts-integrations/index.d.mts.map +0 -1
- package/resources/tts-integrations/index.d.ts +0 -3
- package/resources/tts-integrations/index.d.ts.map +0 -1
- package/resources/tts-integrations/index.js +0 -9
- package/resources/tts-integrations/index.js.map +0 -1
- package/resources/tts-integrations/index.mjs +0 -4
- package/resources/tts-integrations/index.mjs.map +0 -1
- package/resources/tts-integrations/tts-integrations.d.mts +0 -10
- package/resources/tts-integrations/tts-integrations.d.mts.map +0 -1
- package/resources/tts-integrations/tts-integrations.d.ts +0 -10
- package/resources/tts-integrations/tts-integrations.d.ts.map +0 -1
- package/resources/tts-integrations/tts-integrations.js +0 -17
- package/resources/tts-integrations/tts-integrations.js.map +0 -1
- package/resources/tts-integrations/tts-integrations.mjs +0 -12
- package/resources/tts-integrations/tts-integrations.mjs.map +0 -1
- package/resources/tts-integrations.d.mts +0 -2
- package/resources/tts-integrations.d.mts.map +0 -1
- package/resources/tts-integrations.d.ts +0 -2
- package/resources/tts-integrations.d.ts.map +0 -1
- package/resources/tts-integrations.js +0 -6
- package/resources/tts-integrations.js.map +0 -1
- package/resources/tts-integrations.mjs +0 -3
- package/resources/tts-integrations.mjs.map +0 -1
- package/src/resources/tts-integrations/actions.ts +0 -5
- package/src/resources/tts-integrations/index.ts +0 -4
- package/src/resources/tts-integrations/tts-integrations.ts +0 -15
- package/src/resources/tts-integrations.ts +0 -3
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.mjs";
|
|
2
2
|
import * as EmailEventsAPI from "./email-events.mjs";
|
|
3
3
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
4
|
+
import { EmailEventsCursorPagination, type EmailEventsCursorPaginationParams, PagePromise } from "../core/pagination.mjs";
|
|
4
5
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
6
|
/**
|
|
6
7
|
* Retrieve account-level email events and event statistics.
|
|
@@ -23,13 +24,14 @@ export declare class EmailEvents extends APIResource {
|
|
|
23
24
|
* AdminBounce row stored as failed renders email.failed in polling while its
|
|
24
25
|
* webhook retains email.bounced, both with canonical email.failed.
|
|
25
26
|
*/
|
|
26
|
-
list(query?: EmailEventListParams | null | undefined, options?: RequestOptions):
|
|
27
|
+
list(query?: EmailEventListParams | null | undefined, options?: RequestOptions): PagePromise<EmailEventListResponsesEmailEventsCursorPagination, EmailEventListResponse>;
|
|
27
28
|
/**
|
|
28
29
|
* Returns counts and rates for email events over a time range. The default start
|
|
29
30
|
* time is 30 days ago.
|
|
30
31
|
*/
|
|
31
32
|
retrieveStats(query?: EmailEventRetrieveStatsParams | null | undefined, options?: RequestOptions): APIPromise<EmailEventRetrieveStatsResponse>;
|
|
32
33
|
}
|
|
34
|
+
export type EmailEventListResponsesEmailEventsCursorPagination = EmailEventsCursorPagination<EmailEventListResponse>;
|
|
33
35
|
/**
|
|
34
36
|
* Bare stored event names returned by message history. In addition to the normal
|
|
35
37
|
* send and delivery lifecycle, polling can expose suppression, scan, and
|
|
@@ -48,121 +50,107 @@ export interface TimeRange {
|
|
|
48
50
|
from: string | null;
|
|
49
51
|
to: string | null;
|
|
50
52
|
}
|
|
53
|
+
/**
|
|
54
|
+
* An account-polling event. The envelope is webhook-shaped, but polling preserves
|
|
55
|
+
* stored-event cardinality: queued, sending, sandbox, cancelled, and
|
|
56
|
+
* daily_limit_exceeded message events fan out per recipient; scheduled remains one
|
|
57
|
+
* message-scoped row. Payload fields vary among recipient-scoped, message-scoped,
|
|
58
|
+
* and minimal fallback rows.
|
|
59
|
+
*/
|
|
51
60
|
export interface EmailEventListResponse {
|
|
52
|
-
|
|
53
|
-
|
|
61
|
+
/**
|
|
62
|
+
* Event UUID.
|
|
63
|
+
*/
|
|
64
|
+
id: string;
|
|
65
|
+
/**
|
|
66
|
+
* Additive canonical outcome name, prefixed with `email.`. Gateway rejection is
|
|
67
|
+
* `email.gw_reject`, ambiguous injection timeout is `email.injection_timeout`, and
|
|
68
|
+
* MTA expiration is `email.expired`. Unchanged outcomes retain their names.
|
|
69
|
+
* Existing stored rows are translated only when recorded payload evidence proves
|
|
70
|
+
* the outcome; a legacy failed row is not guessed or sharpened.
|
|
71
|
+
*/
|
|
72
|
+
canonical_event_type: string;
|
|
73
|
+
/**
|
|
74
|
+
* Legacy customer-visible event name, prefixed with `email.`. Gateway rejections
|
|
75
|
+
* render `email.failed`; MTA expirations render `email.bounced`. Webhook
|
|
76
|
+
* subscription allowlists match the legacy name.
|
|
77
|
+
*/
|
|
78
|
+
event_type: string;
|
|
79
|
+
occurred_at: string;
|
|
80
|
+
/**
|
|
81
|
+
* Payload returned by GET /email_events. Every row includes id, status, and
|
|
82
|
+
* occurred_at. Recipient-scoped rows also include recipient_id, from, subject, and
|
|
83
|
+
* exactly one object-valued to, cc, or bcc field. Legacy or message-scoped rows
|
|
84
|
+
* can omit recipient_id and use object-valued or string-valued to/cc fields,
|
|
85
|
+
* including an empty string when no address exists; bcc is redacted. If the
|
|
86
|
+
* related message or recipient cannot be loaded, the minimal fallback can omit
|
|
87
|
+
* from, subject, and recipient fields. Additional persisted public evidence can be
|
|
88
|
+
* present.
|
|
89
|
+
*/
|
|
90
|
+
payload: EmailEventListResponse.Payload;
|
|
91
|
+
/**
|
|
92
|
+
* Durable email recipient UUID. Present for recipient-scoped events, including
|
|
93
|
+
* each queued, sending, sandbox, cancelled, and daily_limit_exceeded fan-out
|
|
94
|
+
* event.
|
|
95
|
+
*/
|
|
96
|
+
recipient_id?: string;
|
|
54
97
|
}
|
|
55
98
|
export declare namespace EmailEventListResponse {
|
|
56
99
|
/**
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
100
|
+
* Payload returned by GET /email_events. Every row includes id, status, and
|
|
101
|
+
* occurred_at. Recipient-scoped rows also include recipient_id, from, subject, and
|
|
102
|
+
* exactly one object-valued to, cc, or bcc field. Legacy or message-scoped rows
|
|
103
|
+
* can omit recipient_id and use object-valued or string-valued to/cc fields,
|
|
104
|
+
* including an empty string when no address exists; bcc is redacted. If the
|
|
105
|
+
* related message or recipient cannot be loaded, the minimal fallback can omit
|
|
106
|
+
* from, subject, and recipient fields. Additional persisted public evidence can be
|
|
107
|
+
* present.
|
|
62
108
|
*/
|
|
63
|
-
interface
|
|
109
|
+
interface Payload {
|
|
64
110
|
/**
|
|
65
|
-
*
|
|
111
|
+
* Email message UUID.
|
|
66
112
|
*/
|
|
67
113
|
id: string;
|
|
114
|
+
occurred_at: string;
|
|
68
115
|
/**
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
116
|
+
* Stored event outcome slug, not the authoritative recipient status. Account
|
|
117
|
+
* polling returns the stored name, including suppression, scan, and quarantine
|
|
118
|
+
* lifecycle names. Webhooks retain legacy payload names: gateway rejections use
|
|
119
|
+
* failed and MTA expirations use bounced. New sharp stored rows can expose
|
|
120
|
+
* gw_reject, injection_timeout, or expired. Use the envelope canonical_event_type
|
|
121
|
+
* to identify the outcome across surfaces.
|
|
74
122
|
*/
|
|
75
|
-
|
|
123
|
+
status: 'queued' | 'deferred' | 'scheduled' | 'cancelled' | 'sandbox' | 'sending' | 'sent' | 'failed' | 'delivered' | 'bounced' | 'complained' | 'suppressed' | 'rejected' | 'opened' | 'clicked' | 'unsubscribed' | 'daily_limit_exceeded' | 'scan_deferred' | 'quarantined' | 'quarantine_released' | 'quarantine_release_dispatched' | 'quarantine_rejected' | 'quarantine_expired' | 'gw_reject' | 'injection_timeout' | 'expired';
|
|
124
|
+
bcc?: EmailEventsAPI.EmailWebhookRecipient | 'redacted';
|
|
76
125
|
/**
|
|
77
|
-
* Legacy
|
|
78
|
-
* render `email.failed`; MTA expirations render `email.bounced`. Webhook
|
|
79
|
-
* subscription allowlists match the legacy name.
|
|
126
|
+
* Legacy message-scoped address, or an empty string when absent.
|
|
80
127
|
*/
|
|
81
|
-
|
|
82
|
-
occurred_at: string;
|
|
128
|
+
cc?: EmailEventsAPI.EmailWebhookRecipient | string;
|
|
83
129
|
/**
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
* exactly one object-valued to, cc, or bcc field. Legacy or message-scoped rows
|
|
87
|
-
* can omit recipient_id and use object-valued or string-valued to/cc fields,
|
|
88
|
-
* including an empty string when no address exists; bcc is redacted. If the
|
|
89
|
-
* related message or recipient cannot be loaded, the minimal fallback can omit
|
|
90
|
-
* from, subject, and recipient fields. Additional persisted public evidence can be
|
|
91
|
-
* present.
|
|
130
|
+
* Sender projection in account event polling. The display name is explicitly null
|
|
131
|
+
* when the message has no sender name.
|
|
92
132
|
*/
|
|
93
|
-
|
|
133
|
+
from?: Payload.From;
|
|
94
134
|
/**
|
|
95
|
-
* Durable email recipient UUID. Present for recipient-scoped events
|
|
96
|
-
* each queued, sending, sandbox, cancelled, and daily_limit_exceeded fan-out
|
|
97
|
-
* event.
|
|
135
|
+
* Durable email recipient UUID. Present for recipient-scoped events.
|
|
98
136
|
*/
|
|
99
137
|
recipient_id?: string;
|
|
100
|
-
|
|
101
|
-
namespace Data {
|
|
138
|
+
subject?: string;
|
|
102
139
|
/**
|
|
103
|
-
*
|
|
104
|
-
* occurred_at. Recipient-scoped rows also include recipient_id, from, subject, and
|
|
105
|
-
* exactly one object-valued to, cc, or bcc field. Legacy or message-scoped rows
|
|
106
|
-
* can omit recipient_id and use object-valued or string-valued to/cc fields,
|
|
107
|
-
* including an empty string when no address exists; bcc is redacted. If the
|
|
108
|
-
* related message or recipient cannot be loaded, the minimal fallback can omit
|
|
109
|
-
* from, subject, and recipient fields. Additional persisted public evidence can be
|
|
110
|
-
* present.
|
|
140
|
+
* Legacy message-scoped address, or an empty string when absent.
|
|
111
141
|
*/
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
* Email message UUID.
|
|
115
|
-
*/
|
|
116
|
-
id: string;
|
|
117
|
-
occurred_at: string;
|
|
118
|
-
/**
|
|
119
|
-
* Stored event outcome slug, not the authoritative recipient status. Account
|
|
120
|
-
* polling returns the stored name, including suppression, scan, and quarantine
|
|
121
|
-
* lifecycle names. Webhooks retain legacy payload names: gateway rejections use
|
|
122
|
-
* failed and MTA expirations use bounced. New sharp stored rows can expose
|
|
123
|
-
* gw_reject, injection_timeout, or expired. Use the envelope canonical_event_type
|
|
124
|
-
* to identify the outcome across surfaces.
|
|
125
|
-
*/
|
|
126
|
-
status: 'queued' | 'deferred' | 'scheduled' | 'cancelled' | 'sandbox' | 'sending' | 'sent' | 'failed' | 'delivered' | 'bounced' | 'complained' | 'suppressed' | 'rejected' | 'opened' | 'clicked' | 'unsubscribed' | 'daily_limit_exceeded' | 'scan_deferred' | 'quarantined' | 'quarantine_released' | 'quarantine_release_dispatched' | 'quarantine_rejected' | 'quarantine_expired' | 'gw_reject' | 'injection_timeout' | 'expired';
|
|
127
|
-
bcc?: EmailEventsAPI.EmailWebhookRecipient | 'redacted';
|
|
128
|
-
/**
|
|
129
|
-
* Legacy message-scoped address, or an empty string when absent.
|
|
130
|
-
*/
|
|
131
|
-
cc?: EmailEventsAPI.EmailWebhookRecipient | string;
|
|
132
|
-
/**
|
|
133
|
-
* Sender projection in account event polling. The display name is explicitly null
|
|
134
|
-
* when the message has no sender name.
|
|
135
|
-
*/
|
|
136
|
-
from?: Payload.From;
|
|
137
|
-
/**
|
|
138
|
-
* Durable email recipient UUID. Present for recipient-scoped events.
|
|
139
|
-
*/
|
|
140
|
-
recipient_id?: string;
|
|
141
|
-
subject?: string;
|
|
142
|
-
/**
|
|
143
|
-
* Legacy message-scoped address, or an empty string when absent.
|
|
144
|
-
*/
|
|
145
|
-
to?: EmailEventsAPI.EmailWebhookRecipient | string;
|
|
146
|
-
[k: string]: unknown;
|
|
147
|
-
}
|
|
148
|
-
namespace Payload {
|
|
149
|
-
/**
|
|
150
|
-
* Sender projection in account event polling. The display name is explicitly null
|
|
151
|
-
* when the message has no sender name.
|
|
152
|
-
*/
|
|
153
|
-
interface From {
|
|
154
|
-
email: string;
|
|
155
|
-
name: string | null;
|
|
156
|
-
}
|
|
157
|
-
}
|
|
142
|
+
to?: EmailEventsAPI.EmailWebhookRecipient | string;
|
|
143
|
+
[k: string]: unknown;
|
|
158
144
|
}
|
|
159
|
-
|
|
160
|
-
page_size: number;
|
|
161
|
-
time_range: EmailEventsAPI.TimeRange;
|
|
145
|
+
namespace Payload {
|
|
162
146
|
/**
|
|
163
|
-
*
|
|
147
|
+
* Sender projection in account event polling. The display name is explicitly null
|
|
148
|
+
* when the message has no sender name.
|
|
164
149
|
*/
|
|
165
|
-
|
|
150
|
+
interface From {
|
|
151
|
+
email: string;
|
|
152
|
+
name: string | null;
|
|
153
|
+
}
|
|
166
154
|
}
|
|
167
155
|
}
|
|
168
156
|
export interface EmailEventRetrieveStatsResponse {
|
|
@@ -239,7 +227,7 @@ export declare namespace EmailEventRetrieveStatsResponse {
|
|
|
239
227
|
}
|
|
240
228
|
}
|
|
241
229
|
}
|
|
242
|
-
export interface EmailEventListParams {
|
|
230
|
+
export interface EmailEventListParams extends EmailEventsCursorPaginationParams {
|
|
243
231
|
/**
|
|
244
232
|
* Filter events for a specific email message UUID. Invalid UUID values are
|
|
245
233
|
* silently ignored (no filter applied).
|
|
@@ -266,16 +254,6 @@ export interface EmailEventListParams {
|
|
|
266
254
|
* Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
|
|
267
255
|
*/
|
|
268
256
|
from?: string;
|
|
269
|
-
/**
|
|
270
|
-
* Number of results to return. Defaults to 25; maximum is 100. Invalid values are
|
|
271
|
-
* clamped to the valid range.
|
|
272
|
-
*/
|
|
273
|
-
page_size?: number;
|
|
274
|
-
/**
|
|
275
|
-
* Opaque URL-safe Base64 cursor returned by a previous event list response. The
|
|
276
|
-
* legacy `page[after]` and flat `page_cursor` forms are also accepted.
|
|
277
|
-
*/
|
|
278
|
-
'page[cursor]'?: string;
|
|
279
257
|
/**
|
|
280
258
|
* Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
|
|
281
259
|
* to `from + 30 days`.
|
|
@@ -294,6 +272,6 @@ export interface EmailEventRetrieveStatsParams {
|
|
|
294
272
|
to?: string;
|
|
295
273
|
}
|
|
296
274
|
export declare namespace EmailEvents {
|
|
297
|
-
export { type EmailEventType as EmailEventType, type EmailWebhookRecipient as EmailWebhookRecipient, type TimeRange as TimeRange, type EmailEventListResponse as EmailEventListResponse, type EmailEventRetrieveStatsResponse as EmailEventRetrieveStatsResponse, type EmailEventListParams as EmailEventListParams, type EmailEventRetrieveStatsParams as EmailEventRetrieveStatsParams, };
|
|
275
|
+
export { type EmailEventType as EmailEventType, type EmailWebhookRecipient as EmailWebhookRecipient, type TimeRange as TimeRange, type EmailEventListResponse as EmailEventListResponse, type EmailEventRetrieveStatsResponse as EmailEventRetrieveStatsResponse, type EmailEventListResponsesEmailEventsCursorPagination as EmailEventListResponsesEmailEventsCursorPagination, type EmailEventListParams as EmailEventListParams, type EmailEventRetrieveStatsParams as EmailEventRetrieveStatsParams, };
|
|
298
276
|
}
|
|
299
277
|
//# sourceMappingURL=email-events.d.mts.map
|
|
@@ -1 +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,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,
|
|
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,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,+BAA2B;AAC5B,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kDAAkD,EAAE,sBAAsB,CAAC;IAO1F;;;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,kDAAkD,GAC5D,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;AAEtD;;;;;;;GAOG;AACH,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,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,SAAS,GACT,cAAc,GACd,sBAAsB,GACtB,eAAe,GACf,aAAa,GACb,qBAAqB,GACrB,+BAA+B,GAC/B,qBAAqB,GACrB,oBAAoB,GACpB,WAAW,GACX,mBAAmB,GACnB,SAAS,CAAC;AAEd,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;IAE3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;CACnB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;OAMG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;OASG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;;;;;;;OASG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,MAAM,CAAC;QAEpB;;;;;;;WAOG;QACH,MAAM,EACF,QAAQ,GACR,UAAU,GACV,WAAW,GACX,WAAW,GACX,SAAS,GACT,SAAS,GACT,MAAM,GACN,QAAQ,GACR,WAAW,GACX,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,SAAS,GACT,cAAc,GACd,sBAAsB,GACtB,eAAe,GACf,aAAa,GACb,qBAAqB,GACrB,+BAA+B,GAC/B,qBAAqB,GACrB,oBAAoB,GACpB,WAAW,GACX,mBAAmB,GACnB,SAAS,CAAC;QAEd,GAAG,CAAC,EAAE,cAAc,CAAC,qBAAqB,GAAG,UAAU,CAAC;QAExD;;WAEG;QACH,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,GAAG,MAAM,CAAC;QAEnD;;;WAGG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,GAAG,MAAM,CAAC;QAEnD,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED,UAAiB,OAAO,CAAC;QACvB;;;WAGG;QACH,UAAiB,IAAI;YACnB,KAAK,EAAE,MAAM,CAAC;YAEd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;SACrB;KACF;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,oBAAqB,SAAQ,iCAAiC;IAC7E;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;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,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kDAAkD,IAAI,kDAAkD,EAC7G,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.js";
|
|
2
2
|
import * as EmailEventsAPI from "./email-events.js";
|
|
3
3
|
import { APIPromise } from "../core/api-promise.js";
|
|
4
|
+
import { EmailEventsCursorPagination, type EmailEventsCursorPaginationParams, PagePromise } from "../core/pagination.js";
|
|
4
5
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
6
|
/**
|
|
6
7
|
* Retrieve account-level email events and event statistics.
|
|
@@ -23,13 +24,14 @@ export declare class EmailEvents extends APIResource {
|
|
|
23
24
|
* AdminBounce row stored as failed renders email.failed in polling while its
|
|
24
25
|
* webhook retains email.bounced, both with canonical email.failed.
|
|
25
26
|
*/
|
|
26
|
-
list(query?: EmailEventListParams | null | undefined, options?: RequestOptions):
|
|
27
|
+
list(query?: EmailEventListParams | null | undefined, options?: RequestOptions): PagePromise<EmailEventListResponsesEmailEventsCursorPagination, EmailEventListResponse>;
|
|
27
28
|
/**
|
|
28
29
|
* Returns counts and rates for email events over a time range. The default start
|
|
29
30
|
* time is 30 days ago.
|
|
30
31
|
*/
|
|
31
32
|
retrieveStats(query?: EmailEventRetrieveStatsParams | null | undefined, options?: RequestOptions): APIPromise<EmailEventRetrieveStatsResponse>;
|
|
32
33
|
}
|
|
34
|
+
export type EmailEventListResponsesEmailEventsCursorPagination = EmailEventsCursorPagination<EmailEventListResponse>;
|
|
33
35
|
/**
|
|
34
36
|
* Bare stored event names returned by message history. In addition to the normal
|
|
35
37
|
* send and delivery lifecycle, polling can expose suppression, scan, and
|
|
@@ -48,121 +50,107 @@ export interface TimeRange {
|
|
|
48
50
|
from: string | null;
|
|
49
51
|
to: string | null;
|
|
50
52
|
}
|
|
53
|
+
/**
|
|
54
|
+
* An account-polling event. The envelope is webhook-shaped, but polling preserves
|
|
55
|
+
* stored-event cardinality: queued, sending, sandbox, cancelled, and
|
|
56
|
+
* daily_limit_exceeded message events fan out per recipient; scheduled remains one
|
|
57
|
+
* message-scoped row. Payload fields vary among recipient-scoped, message-scoped,
|
|
58
|
+
* and minimal fallback rows.
|
|
59
|
+
*/
|
|
51
60
|
export interface EmailEventListResponse {
|
|
52
|
-
|
|
53
|
-
|
|
61
|
+
/**
|
|
62
|
+
* Event UUID.
|
|
63
|
+
*/
|
|
64
|
+
id: string;
|
|
65
|
+
/**
|
|
66
|
+
* Additive canonical outcome name, prefixed with `email.`. Gateway rejection is
|
|
67
|
+
* `email.gw_reject`, ambiguous injection timeout is `email.injection_timeout`, and
|
|
68
|
+
* MTA expiration is `email.expired`. Unchanged outcomes retain their names.
|
|
69
|
+
* Existing stored rows are translated only when recorded payload evidence proves
|
|
70
|
+
* the outcome; a legacy failed row is not guessed or sharpened.
|
|
71
|
+
*/
|
|
72
|
+
canonical_event_type: string;
|
|
73
|
+
/**
|
|
74
|
+
* Legacy customer-visible event name, prefixed with `email.`. Gateway rejections
|
|
75
|
+
* render `email.failed`; MTA expirations render `email.bounced`. Webhook
|
|
76
|
+
* subscription allowlists match the legacy name.
|
|
77
|
+
*/
|
|
78
|
+
event_type: string;
|
|
79
|
+
occurred_at: string;
|
|
80
|
+
/**
|
|
81
|
+
* Payload returned by GET /email_events. Every row includes id, status, and
|
|
82
|
+
* occurred_at. Recipient-scoped rows also include recipient_id, from, subject, and
|
|
83
|
+
* exactly one object-valued to, cc, or bcc field. Legacy or message-scoped rows
|
|
84
|
+
* can omit recipient_id and use object-valued or string-valued to/cc fields,
|
|
85
|
+
* including an empty string when no address exists; bcc is redacted. If the
|
|
86
|
+
* related message or recipient cannot be loaded, the minimal fallback can omit
|
|
87
|
+
* from, subject, and recipient fields. Additional persisted public evidence can be
|
|
88
|
+
* present.
|
|
89
|
+
*/
|
|
90
|
+
payload: EmailEventListResponse.Payload;
|
|
91
|
+
/**
|
|
92
|
+
* Durable email recipient UUID. Present for recipient-scoped events, including
|
|
93
|
+
* each queued, sending, sandbox, cancelled, and daily_limit_exceeded fan-out
|
|
94
|
+
* event.
|
|
95
|
+
*/
|
|
96
|
+
recipient_id?: string;
|
|
54
97
|
}
|
|
55
98
|
export declare namespace EmailEventListResponse {
|
|
56
99
|
/**
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
100
|
+
* Payload returned by GET /email_events. Every row includes id, status, and
|
|
101
|
+
* occurred_at. Recipient-scoped rows also include recipient_id, from, subject, and
|
|
102
|
+
* exactly one object-valued to, cc, or bcc field. Legacy or message-scoped rows
|
|
103
|
+
* can omit recipient_id and use object-valued or string-valued to/cc fields,
|
|
104
|
+
* including an empty string when no address exists; bcc is redacted. If the
|
|
105
|
+
* related message or recipient cannot be loaded, the minimal fallback can omit
|
|
106
|
+
* from, subject, and recipient fields. Additional persisted public evidence can be
|
|
107
|
+
* present.
|
|
62
108
|
*/
|
|
63
|
-
interface
|
|
109
|
+
interface Payload {
|
|
64
110
|
/**
|
|
65
|
-
*
|
|
111
|
+
* Email message UUID.
|
|
66
112
|
*/
|
|
67
113
|
id: string;
|
|
114
|
+
occurred_at: string;
|
|
68
115
|
/**
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
116
|
+
* Stored event outcome slug, not the authoritative recipient status. Account
|
|
117
|
+
* polling returns the stored name, including suppression, scan, and quarantine
|
|
118
|
+
* lifecycle names. Webhooks retain legacy payload names: gateway rejections use
|
|
119
|
+
* failed and MTA expirations use bounced. New sharp stored rows can expose
|
|
120
|
+
* gw_reject, injection_timeout, or expired. Use the envelope canonical_event_type
|
|
121
|
+
* to identify the outcome across surfaces.
|
|
74
122
|
*/
|
|
75
|
-
|
|
123
|
+
status: 'queued' | 'deferred' | 'scheduled' | 'cancelled' | 'sandbox' | 'sending' | 'sent' | 'failed' | 'delivered' | 'bounced' | 'complained' | 'suppressed' | 'rejected' | 'opened' | 'clicked' | 'unsubscribed' | 'daily_limit_exceeded' | 'scan_deferred' | 'quarantined' | 'quarantine_released' | 'quarantine_release_dispatched' | 'quarantine_rejected' | 'quarantine_expired' | 'gw_reject' | 'injection_timeout' | 'expired';
|
|
124
|
+
bcc?: EmailEventsAPI.EmailWebhookRecipient | 'redacted';
|
|
76
125
|
/**
|
|
77
|
-
* Legacy
|
|
78
|
-
* render `email.failed`; MTA expirations render `email.bounced`. Webhook
|
|
79
|
-
* subscription allowlists match the legacy name.
|
|
126
|
+
* Legacy message-scoped address, or an empty string when absent.
|
|
80
127
|
*/
|
|
81
|
-
|
|
82
|
-
occurred_at: string;
|
|
128
|
+
cc?: EmailEventsAPI.EmailWebhookRecipient | string;
|
|
83
129
|
/**
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
* exactly one object-valued to, cc, or bcc field. Legacy or message-scoped rows
|
|
87
|
-
* can omit recipient_id and use object-valued or string-valued to/cc fields,
|
|
88
|
-
* including an empty string when no address exists; bcc is redacted. If the
|
|
89
|
-
* related message or recipient cannot be loaded, the minimal fallback can omit
|
|
90
|
-
* from, subject, and recipient fields. Additional persisted public evidence can be
|
|
91
|
-
* present.
|
|
130
|
+
* Sender projection in account event polling. The display name is explicitly null
|
|
131
|
+
* when the message has no sender name.
|
|
92
132
|
*/
|
|
93
|
-
|
|
133
|
+
from?: Payload.From;
|
|
94
134
|
/**
|
|
95
|
-
* Durable email recipient UUID. Present for recipient-scoped events
|
|
96
|
-
* each queued, sending, sandbox, cancelled, and daily_limit_exceeded fan-out
|
|
97
|
-
* event.
|
|
135
|
+
* Durable email recipient UUID. Present for recipient-scoped events.
|
|
98
136
|
*/
|
|
99
137
|
recipient_id?: string;
|
|
100
|
-
|
|
101
|
-
namespace Data {
|
|
138
|
+
subject?: string;
|
|
102
139
|
/**
|
|
103
|
-
*
|
|
104
|
-
* occurred_at. Recipient-scoped rows also include recipient_id, from, subject, and
|
|
105
|
-
* exactly one object-valued to, cc, or bcc field. Legacy or message-scoped rows
|
|
106
|
-
* can omit recipient_id and use object-valued or string-valued to/cc fields,
|
|
107
|
-
* including an empty string when no address exists; bcc is redacted. If the
|
|
108
|
-
* related message or recipient cannot be loaded, the minimal fallback can omit
|
|
109
|
-
* from, subject, and recipient fields. Additional persisted public evidence can be
|
|
110
|
-
* present.
|
|
140
|
+
* Legacy message-scoped address, or an empty string when absent.
|
|
111
141
|
*/
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
* Email message UUID.
|
|
115
|
-
*/
|
|
116
|
-
id: string;
|
|
117
|
-
occurred_at: string;
|
|
118
|
-
/**
|
|
119
|
-
* Stored event outcome slug, not the authoritative recipient status. Account
|
|
120
|
-
* polling returns the stored name, including suppression, scan, and quarantine
|
|
121
|
-
* lifecycle names. Webhooks retain legacy payload names: gateway rejections use
|
|
122
|
-
* failed and MTA expirations use bounced. New sharp stored rows can expose
|
|
123
|
-
* gw_reject, injection_timeout, or expired. Use the envelope canonical_event_type
|
|
124
|
-
* to identify the outcome across surfaces.
|
|
125
|
-
*/
|
|
126
|
-
status: 'queued' | 'deferred' | 'scheduled' | 'cancelled' | 'sandbox' | 'sending' | 'sent' | 'failed' | 'delivered' | 'bounced' | 'complained' | 'suppressed' | 'rejected' | 'opened' | 'clicked' | 'unsubscribed' | 'daily_limit_exceeded' | 'scan_deferred' | 'quarantined' | 'quarantine_released' | 'quarantine_release_dispatched' | 'quarantine_rejected' | 'quarantine_expired' | 'gw_reject' | 'injection_timeout' | 'expired';
|
|
127
|
-
bcc?: EmailEventsAPI.EmailWebhookRecipient | 'redacted';
|
|
128
|
-
/**
|
|
129
|
-
* Legacy message-scoped address, or an empty string when absent.
|
|
130
|
-
*/
|
|
131
|
-
cc?: EmailEventsAPI.EmailWebhookRecipient | string;
|
|
132
|
-
/**
|
|
133
|
-
* Sender projection in account event polling. The display name is explicitly null
|
|
134
|
-
* when the message has no sender name.
|
|
135
|
-
*/
|
|
136
|
-
from?: Payload.From;
|
|
137
|
-
/**
|
|
138
|
-
* Durable email recipient UUID. Present for recipient-scoped events.
|
|
139
|
-
*/
|
|
140
|
-
recipient_id?: string;
|
|
141
|
-
subject?: string;
|
|
142
|
-
/**
|
|
143
|
-
* Legacy message-scoped address, or an empty string when absent.
|
|
144
|
-
*/
|
|
145
|
-
to?: EmailEventsAPI.EmailWebhookRecipient | string;
|
|
146
|
-
[k: string]: unknown;
|
|
147
|
-
}
|
|
148
|
-
namespace Payload {
|
|
149
|
-
/**
|
|
150
|
-
* Sender projection in account event polling. The display name is explicitly null
|
|
151
|
-
* when the message has no sender name.
|
|
152
|
-
*/
|
|
153
|
-
interface From {
|
|
154
|
-
email: string;
|
|
155
|
-
name: string | null;
|
|
156
|
-
}
|
|
157
|
-
}
|
|
142
|
+
to?: EmailEventsAPI.EmailWebhookRecipient | string;
|
|
143
|
+
[k: string]: unknown;
|
|
158
144
|
}
|
|
159
|
-
|
|
160
|
-
page_size: number;
|
|
161
|
-
time_range: EmailEventsAPI.TimeRange;
|
|
145
|
+
namespace Payload {
|
|
162
146
|
/**
|
|
163
|
-
*
|
|
147
|
+
* Sender projection in account event polling. The display name is explicitly null
|
|
148
|
+
* when the message has no sender name.
|
|
164
149
|
*/
|
|
165
|
-
|
|
150
|
+
interface From {
|
|
151
|
+
email: string;
|
|
152
|
+
name: string | null;
|
|
153
|
+
}
|
|
166
154
|
}
|
|
167
155
|
}
|
|
168
156
|
export interface EmailEventRetrieveStatsResponse {
|
|
@@ -239,7 +227,7 @@ export declare namespace EmailEventRetrieveStatsResponse {
|
|
|
239
227
|
}
|
|
240
228
|
}
|
|
241
229
|
}
|
|
242
|
-
export interface EmailEventListParams {
|
|
230
|
+
export interface EmailEventListParams extends EmailEventsCursorPaginationParams {
|
|
243
231
|
/**
|
|
244
232
|
* Filter events for a specific email message UUID. Invalid UUID values are
|
|
245
233
|
* silently ignored (no filter applied).
|
|
@@ -266,16 +254,6 @@ export interface EmailEventListParams {
|
|
|
266
254
|
* Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
|
|
267
255
|
*/
|
|
268
256
|
from?: string;
|
|
269
|
-
/**
|
|
270
|
-
* Number of results to return. Defaults to 25; maximum is 100. Invalid values are
|
|
271
|
-
* clamped to the valid range.
|
|
272
|
-
*/
|
|
273
|
-
page_size?: number;
|
|
274
|
-
/**
|
|
275
|
-
* Opaque URL-safe Base64 cursor returned by a previous event list response. The
|
|
276
|
-
* legacy `page[after]` and flat `page_cursor` forms are also accepted.
|
|
277
|
-
*/
|
|
278
|
-
'page[cursor]'?: string;
|
|
279
257
|
/**
|
|
280
258
|
* Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
|
|
281
259
|
* to `from + 30 days`.
|
|
@@ -294,6 +272,6 @@ export interface EmailEventRetrieveStatsParams {
|
|
|
294
272
|
to?: string;
|
|
295
273
|
}
|
|
296
274
|
export declare namespace EmailEvents {
|
|
297
|
-
export { type EmailEventType as EmailEventType, type EmailWebhookRecipient as EmailWebhookRecipient, type TimeRange as TimeRange, type EmailEventListResponse as EmailEventListResponse, type EmailEventRetrieveStatsResponse as EmailEventRetrieveStatsResponse, type EmailEventListParams as EmailEventListParams, type EmailEventRetrieveStatsParams as EmailEventRetrieveStatsParams, };
|
|
275
|
+
export { type EmailEventType as EmailEventType, type EmailWebhookRecipient as EmailWebhookRecipient, type TimeRange as TimeRange, type EmailEventListResponse as EmailEventListResponse, type EmailEventRetrieveStatsResponse as EmailEventRetrieveStatsResponse, type EmailEventListResponsesEmailEventsCursorPagination as EmailEventListResponsesEmailEventsCursorPagination, type EmailEventListParams as EmailEventListParams, type EmailEventRetrieveStatsParams as EmailEventRetrieveStatsParams, };
|
|
298
276
|
}
|
|
299
277
|
//# sourceMappingURL=email-events.d.ts.map
|
|
@@ -1 +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,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,
|
|
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,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,8BAA2B;AAC5B,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kDAAkD,EAAE,sBAAsB,CAAC;IAO1F;;;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,kDAAkD,GAC5D,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;AAEtD;;;;;;;GAOG;AACH,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,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,SAAS,GACT,cAAc,GACd,sBAAsB,GACtB,eAAe,GACf,aAAa,GACb,qBAAqB,GACrB,+BAA+B,GAC/B,qBAAqB,GACrB,oBAAoB,GACpB,WAAW,GACX,mBAAmB,GACnB,SAAS,CAAC;AAEd,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;IAE3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;CACnB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;OAMG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;OASG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;;;;;;;OASG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,MAAM,CAAC;QAEpB;;;;;;;WAOG;QACH,MAAM,EACF,QAAQ,GACR,UAAU,GACV,WAAW,GACX,WAAW,GACX,SAAS,GACT,SAAS,GACT,MAAM,GACN,QAAQ,GACR,WAAW,GACX,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,SAAS,GACT,cAAc,GACd,sBAAsB,GACtB,eAAe,GACf,aAAa,GACb,qBAAqB,GACrB,+BAA+B,GAC/B,qBAAqB,GACrB,oBAAoB,GACpB,WAAW,GACX,mBAAmB,GACnB,SAAS,CAAC;QAEd,GAAG,CAAC,EAAE,cAAc,CAAC,qBAAqB,GAAG,UAAU,CAAC;QAExD;;WAEG;QACH,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,GAAG,MAAM,CAAC;QAEnD;;;WAGG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,GAAG,MAAM,CAAC;QAEnD,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED,UAAiB,OAAO,CAAC;QACvB;;;WAGG;QACH,UAAiB,IAAI;YACnB,KAAK,EAAE,MAAM,CAAC;YAEd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;SACrB;KACF;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,oBAAqB,SAAQ,iCAAiC;IAC7E;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;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,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kDAAkD,IAAI,kDAAkD,EAC7G,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.EmailEvents = void 0;
|
|
5
5
|
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../core/pagination.js");
|
|
6
7
|
/**
|
|
7
8
|
* Retrieve account-level email events and event statistics.
|
|
8
9
|
*/
|
|
@@ -25,7 +26,10 @@ class EmailEvents extends resource_1.APIResource {
|
|
|
25
26
|
* webhook retains email.bounced, both with canonical email.failed.
|
|
26
27
|
*/
|
|
27
28
|
list(query = {}, options) {
|
|
28
|
-
return this._client.
|
|
29
|
+
return this._client.getAPIList('/email_events', (pagination_1.EmailEventsCursorPagination), {
|
|
30
|
+
query,
|
|
31
|
+
...options,
|
|
32
|
+
});
|
|
29
33
|
}
|
|
30
34
|
/**
|
|
31
35
|
* Returns counts and rates for email events over a time range. The default start
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-events.js","sourceRoot":"","sources":["../src/resources/email-events.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;
|
|
1
|
+
{"version":3,"file":"email-events.js","sourceRoot":"","sources":["../src/resources/email-events.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAI4B;AAG5B;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,wCAAmD,CAAA,EAAE;YACnG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,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;AAtCD,kCAsCC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { EmailEventsCursorPagination, } from "../core/pagination.mjs";
|
|
3
4
|
/**
|
|
4
5
|
* Retrieve account-level email events and event statistics.
|
|
5
6
|
*/
|
|
@@ -22,7 +23,10 @@ export class EmailEvents extends APIResource {
|
|
|
22
23
|
* webhook retains email.bounced, both with canonical email.failed.
|
|
23
24
|
*/
|
|
24
25
|
list(query = {}, options) {
|
|
25
|
-
return this._client.
|
|
26
|
+
return this._client.getAPIList('/email_events', (EmailEventsCursorPagination), {
|
|
27
|
+
query,
|
|
28
|
+
...options,
|
|
29
|
+
});
|
|
26
30
|
}
|
|
27
31
|
/**
|
|
28
32
|
* Returns counts and rates for email events over a time range. The default start
|
|
@@ -1 +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;
|
|
1
|
+
{"version":3,"file":"email-events.mjs","sourceRoot":"","sources":["../src/resources/email-events.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EACL,2BAA2B,GAG5B,+BAA2B;AAG5B;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,2BAAmD,CAAA,EAAE;YACnG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,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"}
|