samva 0.4.0 → 0.5.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/dist/{categories-CsUa8ojo.js → categories-B9Nw2v_F.js} +5 -1
- package/dist/client/sdk.gen.d.ts +150 -11
- package/dist/client/types.gen.d.ts +893 -37
- package/dist/{client-BmZK_uCt.js → client-B7gEkvEq.js} +952 -110
- package/dist/{client-attribution-BslSOa_8.js → client-attribution-B2yJBXdZ.js} +2 -2
- package/dist/effect/api-keys.js +1 -1
- package/dist/effect/campaigns.d.ts +16 -0
- package/dist/effect/campaigns.js +1 -1
- package/dist/effect/categories.js +1 -1
- package/dist/effect/client.js +1 -1
- package/dist/effect/contacts.js +1 -1
- package/dist/effect/conversations.d.ts +15 -0
- package/dist/effect/conversations.js +1 -1
- package/dist/effect/design.js +1 -1
- package/dist/effect/email.d.ts +700 -2
- package/dist/effect/email.js +27 -3
- package/dist/effect/generated-metadata.d.ts +4 -0
- package/dist/effect/generated.d.ts +4102 -359
- package/dist/effect/index.js +2 -2
- package/dist/effect/internal/operation.d.ts +13 -3
- package/dist/effect/media.d.ts +3 -3
- package/dist/effect/media.js +1 -1
- package/dist/effect/messages.d.ts +180 -1
- package/dist/effect/messages.js +5 -3
- package/dist/effect/operations.js +1 -1
- package/dist/effect/organizations.js +1 -1
- package/dist/effect/retry.js +1 -1
- package/dist/effect/scheduled-messages.d.ts +90 -6
- package/dist/effect/scheduled-messages.js +5 -3
- package/dist/effect/templates.d.ts +12 -0
- package/dist/effect/templates.js +2 -2
- package/dist/effect/webhooks.d.ts +40 -6
- package/dist/effect/webhooks.js +2 -2
- package/dist/index.js +2 -2
- package/dist/{operation-B1knNlxk.js → operation-B4FjN6wq.js} +50 -2
- package/dist/promises/errors.gen.d.ts +21 -2
- package/dist/promises/index.d.ts +1 -0
- package/dist/promises/index.js +2 -2
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/{promises-n1opem5V.js → promises-CP_nxUus.js} +502 -11
- package/dist/service-map.d.ts +66 -0
- package/package.json +3 -3
|
@@ -30,6 +30,10 @@ const SamvaErrorMetadata = {
|
|
|
30
30
|
categories: ["transient"],
|
|
31
31
|
retryable: true
|
|
32
32
|
},
|
|
33
|
+
OnboardingReviewRequiredError: {
|
|
34
|
+
categories: ["validation"],
|
|
35
|
+
retryable: false
|
|
36
|
+
},
|
|
33
37
|
PaymentRequiredError: {
|
|
34
38
|
categories: ["billing"],
|
|
35
39
|
retryable: false
|
|
@@ -140,4 +144,4 @@ const catchTransient = (handler) => (effect) => Effect.catchIf(effect, (error) =
|
|
|
140
144
|
//#endregion
|
|
141
145
|
export { isTransient as _, catchNotFoundError as a, catchValidationError as c, isAuthError as d, isBillingError as f, isThrottlingError as g, isRetryable as h, catchConflictError as i, categoriesOf as l, isNotFoundError as m, catchBillingError as n, catchThrottlingError as o, isConflictError as p, catchCategory as r, catchTransient as s, catchAuthError as t, hasCategory as u, isValidationError as v };
|
|
142
146
|
|
|
143
|
-
//# sourceMappingURL=categories-
|
|
147
|
+
//# sourceMappingURL=categories-B9Nw2v_F.js.map
|
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from "./client";
|
|
2
|
-
import type { ActorTracking, ApiKeyId, ApiKeyPermissions, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRemoveErrors, ApiKeysRemoveResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, BlockedEmailId, CampaignAudience, CampaignContentInput, CampaignId, CampaignPolicy, CampaignRunId, CampaignsArchiveErrors, CampaignsArchiveResponses, CampaignsCancelRunErrors, CampaignsCancelRunResponses, CampaignsCreateErrors, CampaignsCreateResponses, CampaignsGetErrors, CampaignsGetResponses, CampaignsGetRunErrors, CampaignsGetRunResponses, CampaignsListErrors, CampaignsListRecipientsErrors, CampaignsListRecipientsResponses, CampaignsListResponses, CampaignsListRunsErrors, CampaignsListRunsResponses, CampaignsPauseRunErrors, CampaignsPauseRunResponses, CampaignsResumeRunErrors, CampaignsResumeRunResponses, CampaignsScheduleRunErrors, CampaignsScheduleRunResponses, CampaignsUpdateErrors, CampaignsUpdateResponses, ContactAccessConfig, ContactId, ContactIdentity, ContactPreferences, ContactsBulkDeleteErrors, ContactsBulkDeleteResponses, ContactsBulkImportErrors, ContactsBulkImportResponses, ContactsBulkUpdateStatusErrors, ContactsBulkUpdateStatusResponses, ContactsBulkUpdateTagsErrors, ContactsBulkUpdateTagsResponses, ContactsCreateErrors, ContactsCreateResponses, ContactsExportErrors, ContactsExportResponses, ContactsFindErrors, ContactsFindOrCreateErrors, ContactsFindOrCreateResponses, ContactsFindResponses, ContactsGetActivityTimelineErrors, ContactsGetActivityTimelineResponses, ContactsGetEngagementErrors, ContactsGetEngagementResponses, ContactsGetErrors, ContactsGetGroupMembershipsErrors, ContactsGetGroupMembershipsResponses, ContactsGetResponses, ContactsListErrors, ContactsListResponses, ContactsRemoveErrors, ContactsRemoveResponses, ContactsUpdateErrors, ContactsUpdateResponses, ConversationContext, ConversationId, ConversationMetadata, ConversationMetrics, ConversationsAddContactsErrors, ConversationsAddContactsResponses, ConversationsCreateErrors, ConversationsCreateResponses, ConversationsGetByIdErrors, ConversationsGetByIdResponses, ConversationsListErrors, ConversationsListMessagesErrors, ConversationsListMessagesResponses, ConversationsListResponses, ConversationsRemoveContactsErrors, ConversationsRemoveContactsResponses, ConversationsUpdateErrors, ConversationsUpdateResponses, Design as Design3, DesignGetErrors, DesignGetResponses, DesignUpdateErrors, DesignUpdateResponses, DispatchSendMessagePayload, EmailAddBlockErrors, EmailAddBlockResponses, EmailAddDomainErrors, EmailAddDomainResponses, EmailAddSenderErrors, EmailAddSenderResponses, EmailAdvanceDomainVerificationErrors, EmailAdvanceDomainVerificationResponses, EmailBuildCustomTrackingDomainConnectApplyUrlErrors, EmailBuildCustomTrackingDomainConnectApplyUrlResponses, EmailBuildDomainConnectApplyUrlErrors, EmailBuildDomainConnectApplyUrlResponses, EmailCheckBlockedErrors, EmailCheckBlockedResponses, EmailCheckSenderVerificationErrors, EmailCheckSenderVerificationResponses, EmailClearDomainDefaultSenderErrors, EmailClearDomainDefaultSenderResponses, EmailCompleteCustomTrackingDomainConnectErrors, EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteDomainConnectErrors, EmailCompleteDomainConnectResponses, EmailCreateForwardingRuleErrors, EmailCreateForwardingRuleResponses, EmailDeleteForwardingRuleErrors, EmailDeleteForwardingRuleResponses, EmailDetectRegistrarErrors, EmailDetectRegistrarResponses, EmailDisableCatchAllErrors, EmailDisableCatchAllResponses, EmailDisableCustomTrackingErrors, EmailDisableCustomTrackingResponses, EmailDomainId, EmailEnableCatchAllErrors, EmailEnableCatchAllResponses, EmailEnableCustomTrackingErrors, EmailEnableCustomTrackingResponses, EmailEnableReceivingErrors, EmailEnableReceivingResponses, EmailForwardingRuleId, EmailGetBlockLogsErrors, EmailGetBlockLogsResponses, EmailGetCatchAllConfigErrors, EmailGetCatchAllConfigResponses, EmailGetCatchAllStatsErrors, EmailGetCatchAllStatsResponses, EmailGetCustomTrackingDomainConnectErrors, EmailGetCustomTrackingDomainConnectResponses, EmailGetCustomTrackingErrors, EmailGetCustomTrackingResponses, EmailGetDomainByIdErrors, EmailGetDomainByIdResponses, EmailGetDomainConnectErrors, EmailGetDomainConnectResponses, EmailGetDomainVerificationErrors, EmailGetDomainVerificationResponses, EmailGetForwardingLogErrors, EmailGetForwardingLogResponses, EmailGetRecipientTrackingPreferenceErrors, EmailGetRecipientTrackingPreferenceResponses, EmailGetStatsErrors, EmailGetStatsResponses, EmailGetTrackingDefaultsErrors, EmailGetTrackingDefaultsResponses, EmailListBlocksErrors, EmailListBlocksResponses, EmailListDomainsErrors, EmailListDomainsResponses, EmailListForwardingRulesErrors, EmailListForwardingRulesResponses, EmailListSendersErrors, EmailListSendersResponses, EmailListSuppressionsErrors, EmailListSuppressionsResponses, EmailRemoveBlockErrors, EmailRemoveBlockResponses, EmailRemoveDomainErrors, EmailRemoveDomainResponses, EmailRemoveSenderErrors, EmailRemoveSenderResponses, EmailRemoveSuppressionErrors, EmailRemoveSuppressionResponses, EmailSenderId, EmailSendMessagePayload, EmailSetDefaultDomainErrors, EmailSetDefaultDomainResponses, EmailSetDefaultSenderErrors, EmailSetDefaultSenderResponses, EmailSetDomainDefaultSenderErrors, EmailSetDomainDefaultSenderResponses, EmailUpdateBlockErrors, EmailUpdateBlockResponses, EmailUpdateCatchAllConfigErrors, EmailUpdateCatchAllConfigResponses, EmailUpdateDomainConfigErrors, EmailUpdateDomainConfigResponses, EmailUpdateForwardingRuleErrors, EmailUpdateForwardingRuleResponses, EmailUpdateRecipientTrackingPreferenceErrors, EmailUpdateRecipientTrackingPreferenceResponses, EmailUpdateTrackingDefaultsErrors, EmailUpdateTrackingDefaultsResponses, ForwardingConditions, HumanProfile, JsonObject, JsonValue, MediaCompleteErrors, MediaCompleteResponses, MediaCreateErrors, MediaCreateResponses, MediaDownloadUrlErrors, MediaDownloadUrlResponses, MediaGetByIdErrors, MediaGetByIdResponses, MediaId, MediaRemoveErrors, MediaRemoveResponses, MessageId, MessagesGetEmailErrors, MessagesGetEmailResponses, MessagesGetErrors, MessagesGetEventsErrors, MessagesGetEventsResponses, MessagesGetResponses, MessagesGetStatusErrors, MessagesGetStatusResponses, MessagesListErrors, MessagesListResponses, MessagesRemoveErrors, MessagesRemoveResponses, MessagesSendErrors, MessagesSendResponses, OperationId, OperationsGetErrors, OperationsGetResponses, OperationsListErrors, OperationsListResponses, OperationsRetryErrors, OperationsRetryResponses, OrganizationsBootstrapErrors, OrganizationsBootstrapResponses, OrganizationsCreateErrors, OrganizationsCreateResponses, OrganizationsDeleteErrors, OrganizationsDeleteResponses, OrganizationsGetErrors, OrganizationsGetResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, SuppressionId, TemplateFamilyId, TemplateFromDefault, TemplateId, TemplateInputContractId, TemplateProjectId, TemplatePublicationId, TemplatesAttachFamilyMemberErrors, TemplatesAttachFamilyMemberResponses, TemplatesAttachWorkspaceResourceErrors, TemplatesAttachWorkspaceResourceResponses, TemplatesCheckWorkspaceErrors, TemplatesCheckWorkspaceResponses, TemplatesCreateErrors, TemplatesCreateFamilyErrors, TemplatesCreateFamilyFromTemplateErrors, TemplatesCreateFamilyFromTemplateResponses, TemplatesCreateFamilyResponses, TemplatesCreateResponses, TemplatesDeleteFamilyErrors, TemplatesDeleteFamilyResponses, TemplatesDetachFamilyMemberErrors, TemplatesDetachFamilyMemberResponses, TemplatesDiffWorkspaceErrors, TemplatesDiffWorkspaceResponses, TemplatesGetByIdErrors, TemplatesGetByIdResponses, TemplatesGetFamilyErrors, TemplatesGetFamilyResponses, TemplatesGetGitRepositoryErrors, TemplatesGetGitRepositoryResponses, TemplatesGetInputContractErrors, TemplatesGetInputContractResponses, TemplatesGetPublicationErrors, TemplatesGetPublicationResponses, TemplatesIssueGitCredentialErrors, TemplatesIssueGitCredentialResponses, TemplatesListDashboardErrors, TemplatesListDashboardResponses, TemplatesListErrors, TemplatesListFamiliesErrors, TemplatesListFamiliesResponses, TemplatesListInputContractsErrors, TemplatesListInputContractsResponses, TemplatesListResponses, TemplatesOpenWorkspaceErrors, TemplatesOpenWorkspaceResponses, TemplatesPatchWorkspaceErrors, TemplatesPatchWorkspaceResponses, TemplatesPublishErrors, TemplatesPublishResponses, TemplatesReconcileWorkspaceErrors, TemplatesReconcileWorkspaceResponses, TemplatesRemoveErrors, TemplatesRemoveResponses, TemplatesRemoveWorkspaceResourceErrors, TemplatesRemoveWorkspaceResourceResponses, TemplatesRenameFamilyErrors, TemplatesRenameFamilyResponses, TemplatesRenderWorkspaceFixtureErrors, TemplatesRenderWorkspaceFixtureResponses, TemplatesResolveWorkspaceConflictErrors, TemplatesResolveWorkspaceConflictResponses, TemplatesRestoreWorkspaceErrors, TemplatesRestoreWorkspaceResponses, TemplatesSaveWorkspaceErrors, TemplatesSaveWorkspaceResponses, TemplatesUpdateErrors, TemplatesUpdateResponses, TemplatesWorkspaceHistoryErrors, TemplatesWorkspaceHistoryResponses, TrackingRecipientEmail, UnknownRecord, UnsubscribeId, WebhookDeliveryId, WebhookEndpointId, WebhooksCreateErrors, WebhooksCreateResponses, WebhooksGetErrors, WebhooksGetLogsErrors, WebhooksGetLogsResponses, WebhooksGetResponses, WebhooksGetStatsErrors, WebhooksGetStatsResponses, WebhooksListErrors, WebhooksListResponses, WebhooksRegenerateSecretErrors, WebhooksRegenerateSecretResponses, WebhooksRemoveErrors, WebhooksRemoveResponses, WebhooksRetryDeliveryErrors, WebhooksRetryDeliveryResponses, WebhooksTestErrors, WebhooksTestResponses, WebhooksUpdateErrors, WebhooksUpdateResponses } from "./types.gen";
|
|
2
|
+
import type { ActorTracking, ApiKeyId, ApiKeyPermissions, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRemoveErrors, ApiKeysRemoveResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, BlockedEmailId, CampaignAudience, CampaignContentInput, CampaignId, CampaignPolicy, CampaignRunId, CampaignsArchiveErrors, CampaignsArchiveResponses, CampaignsCancelRunErrors, CampaignsCancelRunResponses, CampaignsCreateErrors, CampaignsCreateResponses, CampaignsGetErrors, CampaignsGetResponses, CampaignsGetRunErrors, CampaignsGetRunResponses, CampaignsListErrors, CampaignsListRecipientsErrors, CampaignsListRecipientsResponses, CampaignsListResponses, CampaignsListRunsErrors, CampaignsListRunsResponses, CampaignsPauseRunErrors, CampaignsPauseRunResponses, CampaignsResumeRunErrors, CampaignsResumeRunResponses, CampaignsScheduleRunErrors, CampaignsScheduleRunResponses, CampaignsUpdateErrors, CampaignsUpdateResponses, ContactAccessConfig, ContactId, ContactIdentity, ContactPreferences, ContactsBulkDeleteErrors, ContactsBulkDeleteResponses, ContactsBulkImportErrors, ContactsBulkImportResponses, ContactsBulkUpdateStatusErrors, ContactsBulkUpdateStatusResponses, ContactsBulkUpdateTagsErrors, ContactsBulkUpdateTagsResponses, ContactsCreateErrors, ContactsCreateResponses, ContactsExportErrors, ContactsExportResponses, ContactsFindErrors, ContactsFindOrCreateErrors, ContactsFindOrCreateResponses, ContactsFindResponses, ContactsGetActivityTimelineErrors, ContactsGetActivityTimelineResponses, ContactsGetEngagementErrors, ContactsGetEngagementResponses, ContactsGetErrors, ContactsGetGroupMembershipsErrors, ContactsGetGroupMembershipsResponses, ContactsGetResponses, ContactsListErrors, ContactsListResponses, ContactsRemoveErrors, ContactsRemoveResponses, ContactsUpdateErrors, ContactsUpdateResponses, ConversationContext, ConversationId, ConversationMetadata, ConversationMetrics, ConversationsAddContactsErrors, ConversationsAddContactsResponses, ConversationsCreateErrors, ConversationsCreateResponses, ConversationsGetByIdErrors, ConversationsGetByIdResponses, ConversationsListErrors, ConversationsListMessagesErrors, ConversationsListMessagesResponses, ConversationsListResponses, ConversationsRemoveContactsErrors, ConversationsRemoveContactsResponses, ConversationsUpdateErrors, ConversationsUpdateResponses, Design as Design3, DesignGetErrors, DesignGetResponses, DesignUpdateErrors, DesignUpdateResponses, DispatchSendMessagePayload, EmailAddBlockErrors, EmailAddBlockResponses, EmailAddDomainErrors, EmailAddDomainResponses, EmailAddSenderErrors, EmailAddSenderResponses, EmailAdvanceDomainVerificationErrors, EmailAdvanceDomainVerificationResponses, EmailBccRecipients, EmailBuildCustomTrackingDomainConnectApplyUrlErrors, EmailBuildCustomTrackingDomainConnectApplyUrlResponses, EmailBuildDomainConnectApplyUrlErrors, EmailBuildDomainConnectApplyUrlResponses, EmailCancelDomainWarmingBatchErrors, EmailCancelDomainWarmingBatchResponses, EmailCcRecipients, EmailCheckBlockedErrors, EmailCheckBlockedResponses, EmailCheckSenderVerificationErrors, EmailCheckSenderVerificationResponses, EmailClearDomainDefaultSenderErrors, EmailClearDomainDefaultSenderResponses, EmailCompleteCustomTrackingDomainConnectErrors, EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteDomainConnectErrors, EmailCompleteDomainConnectResponses, EmailCompleteDomainWarmingErrors, EmailCompleteDomainWarmingResponses, EmailContent, EmailCreateDomainWarmingPlanErrors, EmailCreateDomainWarmingPlanResponses, EmailCreateForwardingRuleErrors, EmailCreateForwardingRuleResponses, EmailDeleteForwardingRuleErrors, EmailDeleteForwardingRuleResponses, EmailDetectRegistrarErrors, EmailDetectRegistrarResponses, EmailDisableCatchAllErrors, EmailDisableCatchAllResponses, EmailDisableCustomTrackingErrors, EmailDisableCustomTrackingResponses, EmailDomainId, EmailDomainWarmingBatchId, EmailEnableCatchAllErrors, EmailEnableCatchAllResponses, EmailEnableCustomTrackingErrors, EmailEnableCustomTrackingResponses, EmailEnableReceivingErrors, EmailEnableReceivingResponses, EmailForwardingRuleId, EmailGetBlockLogsErrors, EmailGetBlockLogsResponses, EmailGetCatchAllConfigErrors, EmailGetCatchAllConfigResponses, EmailGetCatchAllStatsErrors, EmailGetCatchAllStatsResponses, EmailGetCustomTrackingDomainConnectErrors, EmailGetCustomTrackingDomainConnectResponses, EmailGetCustomTrackingErrors, EmailGetCustomTrackingResponses, EmailGetDomainByIdErrors, EmailGetDomainByIdResponses, EmailGetDomainConnectErrors, EmailGetDomainConnectResponses, EmailGetDomainVerificationErrors, EmailGetDomainVerificationResponses, EmailGetDomainWarmingErrors, EmailGetDomainWarmingResponses, EmailGetForwardingLogErrors, EmailGetForwardingLogResponses, EmailGetOnboardingReviewErrors, EmailGetOnboardingReviewResponses, EmailGetRecipientTrackingPreferenceErrors, EmailGetRecipientTrackingPreferenceResponses, EmailGetSenderErrors, EmailGetSenderResponses, EmailGetStatsErrors, EmailGetStatsResponses, EmailGetTrackingDefaultsErrors, EmailGetTrackingDefaultsResponses, EmailListBlocksErrors, EmailListBlocksResponses, EmailListDomainsErrors, EmailListDomainsResponses, EmailListForwardingRulesErrors, EmailListForwardingRulesResponses, EmailListSendersErrors, EmailListSendersResponses, EmailListSuppressionsErrors, EmailListSuppressionsResponses, EmailPauseDomainWarmingErrors, EmailPauseDomainWarmingResponses, EmailReapplyOnboardingReviewErrors, EmailReapplyOnboardingReviewResponses, EmailRecipients, EmailRemoveBlockErrors, EmailRemoveBlockResponses, EmailRemoveDomainErrors, EmailRemoveDomainResponses, EmailRemoveSenderErrors, EmailRemoveSenderResponses, EmailRemoveSuppressionErrors, EmailRemoveSuppressionResponses, EmailRespondToOnboardingInformationRequestErrors, EmailRespondToOnboardingInformationRequestResponses, EmailResumeDomainWarmingErrors, EmailResumeDomainWarmingResponses, EmailRotateDomainDkimErrors, EmailRotateDomainDkimResponses, EmailSender, EmailSenderId, EmailSendMessagePayload, EmailSetDefaultDomainErrors, EmailSetDefaultDomainResponses, EmailSetDefaultSenderErrors, EmailSetDefaultSenderResponses, EmailSetDomainDefaultSenderErrors, EmailSetDomainDefaultSenderResponses, EmailUpdateBlockErrors, EmailUpdateBlockResponses, EmailUpdateCatchAllConfigErrors, EmailUpdateCatchAllConfigResponses, EmailUpdateDomainConfigErrors, EmailUpdateDomainConfigResponses, EmailUpdateDomainWarmingPolicyErrors, EmailUpdateDomainWarmingPolicyResponses, EmailUpdateForwardingRuleErrors, EmailUpdateForwardingRuleResponses, EmailUpdateRecipientTrackingPreferenceErrors, EmailUpdateRecipientTrackingPreferenceResponses, EmailUpdateTrackingDefaultsErrors, EmailUpdateTrackingDefaultsResponses, ForwardingConditions, HumanProfile, IanaTimezone, JsonObject, JsonValue, MediaCompleteErrors, MediaCompleteResponses, MediaCreateErrors, MediaCreateResponses, MediaDownloadUrlErrors, MediaDownloadUrlResponses, MediaGetByIdErrors, MediaGetByIdResponses, MediaId, MediaRemoveErrors, MediaRemoveResponses, MessageId, MessageMetadata, MessagesGetEmailErrors, MessagesGetEmailResponses, MessagesGetErrors, MessagesGetEventsErrors, MessagesGetEventsResponses, MessagesGetResponses, MessagesGetStatusErrors, MessagesGetStatusResponses, MessagesListErrors, MessagesListResponses, MessagesRemoveErrors, MessagesRemoveResponses, MessagesSendErrors, MessagesSendResponses, MessagesValidateEmailErrors, MessagesValidateEmailResponses, OperationId, OperationsGetErrors, OperationsGetResponses, OperationsListErrors, OperationsListResponses, OperationsRetryErrors, OperationsRetryResponses, OrganizationsBootstrapErrors, OrganizationsBootstrapResponses, OrganizationsCreateErrors, OrganizationsCreateResponses, OrganizationsDeleteErrors, OrganizationsDeleteResponses, OrganizationsGetErrors, OrganizationsGetResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, ScheduledMessagesResumeErrors, ScheduledMessagesResumeResponses, SuppressionId, TemplateFamilyId, TemplateFromDefault, TemplateId, TemplateInputContractId, TemplateProjectId, TemplatePublicationId, TemplatesAttachFamilyMemberErrors, TemplatesAttachFamilyMemberResponses, TemplatesAttachWorkspaceResourceErrors, TemplatesAttachWorkspaceResourceResponses, TemplatesCheckWorkspaceErrors, TemplatesCheckWorkspaceResponses, TemplatesCreateErrors, TemplatesCreateFamilyErrors, TemplatesCreateFamilyFromTemplateErrors, TemplatesCreateFamilyFromTemplateResponses, TemplatesCreateFamilyResponses, TemplatesCreateResponses, TemplatesDeleteFamilyErrors, TemplatesDeleteFamilyResponses, TemplatesDetachFamilyMemberErrors, TemplatesDetachFamilyMemberResponses, TemplatesDiffWorkspaceErrors, TemplatesDiffWorkspaceResponses, TemplatesGetByIdErrors, TemplatesGetByIdResponses, TemplatesGetFamilyErrors, TemplatesGetFamilyResponses, TemplatesGetGitRepositoryErrors, TemplatesGetGitRepositoryResponses, TemplatesGetInputContractErrors, TemplatesGetInputContractResponses, TemplatesGetPublicationErrors, TemplatesGetPublicationResponses, TemplatesIssueGitCredentialErrors, TemplatesIssueGitCredentialResponses, TemplatesListDashboardErrors, TemplatesListDashboardResponses, TemplatesListErrors, TemplatesListFamiliesErrors, TemplatesListFamiliesResponses, TemplatesListInputContractsErrors, TemplatesListInputContractsResponses, TemplatesListResponses, TemplatesOpenWorkspaceErrors, TemplatesOpenWorkspaceResponses, TemplatesPatchWorkspaceErrors, TemplatesPatchWorkspaceResponses, TemplatesPublishErrors, TemplatesPublishResponses, TemplatesReconcileWorkspaceErrors, TemplatesReconcileWorkspaceResponses, TemplatesRemoveErrors, TemplatesRemoveResponses, TemplatesRemoveWorkspaceResourceErrors, TemplatesRemoveWorkspaceResourceResponses, TemplatesRenameFamilyErrors, TemplatesRenameFamilyResponses, TemplatesRenderWorkspaceFixtureErrors, TemplatesRenderWorkspaceFixtureResponses, TemplatesResolveWorkspaceConflictErrors, TemplatesResolveWorkspaceConflictResponses, TemplatesRestoreWorkspaceErrors, TemplatesRestoreWorkspaceResponses, TemplatesSaveWorkspaceErrors, TemplatesSaveWorkspaceResponses, TemplatesUpdateErrors, TemplatesUpdateResponses, TemplatesWorkspaceHistoryErrors, TemplatesWorkspaceHistoryResponses, TrackingRecipientEmail, UnknownRecord, UnsubscribeId, WebhookDeliveryId, WebhookEndpointId, WebhooksCreateErrors, WebhooksCreateResponses, WebhooksGetErrors, WebhooksGetLogsErrors, WebhooksGetLogsResponses, WebhooksGetResponses, WebhooksGetStatsErrors, WebhooksGetStatsResponses, WebhooksListErrors, WebhooksListResponses, WebhooksRegenerateSecretErrors, WebhooksRegenerateSecretResponses, WebhooksRemoveErrors, WebhooksRemoveResponses, WebhooksRetryDeliveryErrors, WebhooksRetryDeliveryResponses, WebhooksTestErrors, WebhooksTestResponses, WebhooksUpdateErrors, WebhooksUpdateResponses } from "./types.gen";
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -17,7 +17,7 @@ export declare class Messages {
|
|
|
17
17
|
/**
|
|
18
18
|
* List messages
|
|
19
19
|
*
|
|
20
|
-
* Returns a paginated list of messages
|
|
20
|
+
* Returns a paginated list of messages, with optional filters for channel, direction, status, conversation, contact, and date range.
|
|
21
21
|
*/
|
|
22
22
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
23
23
|
page?: string | null | undefined;
|
|
@@ -65,6 +65,21 @@ export declare class Messages {
|
|
|
65
65
|
includeS3Urls?: string | null | undefined;
|
|
66
66
|
urlExpiresIn?: string | null | undefined;
|
|
67
67
|
}, options?: Options<never, ThrowOnError>): RequestResult<MessagesGetEmailResponses, MessagesGetEmailErrors, ThrowOnError>;
|
|
68
|
+
/**
|
|
69
|
+
* Validate an email message
|
|
70
|
+
*
|
|
71
|
+
* Resolves recipients, sender, and inline or published-template content without creating contacts, messages, billing reservations, quota draws, queue work, or provider calls.
|
|
72
|
+
*/
|
|
73
|
+
static validateEmail<ThrowOnError extends boolean = false>(parameters: {
|
|
74
|
+
conversationId?: ConversationId | null | null | undefined;
|
|
75
|
+
metadata?: MessageMetadata | undefined;
|
|
76
|
+
channel: "email";
|
|
77
|
+
to: EmailRecipients;
|
|
78
|
+
cc?: EmailCcRecipients | undefined;
|
|
79
|
+
bcc?: EmailBccRecipients | undefined;
|
|
80
|
+
from?: EmailSender | undefined;
|
|
81
|
+
email: EmailContent;
|
|
82
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MessagesValidateEmailResponses, MessagesValidateEmailErrors, ThrowOnError>;
|
|
68
83
|
/**
|
|
69
84
|
* Get message delivery status
|
|
70
85
|
*
|
|
@@ -124,7 +139,7 @@ export declare class ScheduledMessages {
|
|
|
124
139
|
* Returns a paginated list of scheduled messages, optionally filtered by status.
|
|
125
140
|
*/
|
|
126
141
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
127
|
-
status?: "pending" | "dispatching" | "dispatched" | "cancelled" | "failed" | null | undefined;
|
|
142
|
+
status?: "pending" | "dispatching" | "paused" | "dispatched" | "cancelled" | "failed" | null | undefined;
|
|
128
143
|
page?: string | null | undefined;
|
|
129
144
|
limit?: string | null | undefined;
|
|
130
145
|
}, options?: Options<never, ThrowOnError>): RequestResult<ScheduledMessagesListResponses, ScheduledMessagesListErrors, ThrowOnError>;
|
|
@@ -136,7 +151,7 @@ export declare class ScheduledMessages {
|
|
|
136
151
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
137
152
|
send: DispatchSendMessagePayload;
|
|
138
153
|
scheduledFor: string;
|
|
139
|
-
timezone?:
|
|
154
|
+
timezone?: IanaTimezone | null | undefined;
|
|
140
155
|
idempotencyKey?: string | null | undefined;
|
|
141
156
|
referenceId?: string | null | undefined;
|
|
142
157
|
}, options?: Options<never, ThrowOnError>): RequestResult<ScheduledMessagesCreateResponses, ScheduledMessagesCreateErrors, ThrowOnError>;
|
|
@@ -156,6 +171,20 @@ export declare class ScheduledMessages {
|
|
|
156
171
|
static cancel<ThrowOnError extends boolean = false>(parameters: {
|
|
157
172
|
id: ScheduledMessageId;
|
|
158
173
|
}, options?: Options<never, ThrowOnError>): RequestResult<ScheduledMessagesCancelResponses, ScheduledMessagesCancelErrors, ThrowOnError>;
|
|
174
|
+
/**
|
|
175
|
+
* Resume a review-paused scheduled message
|
|
176
|
+
*
|
|
177
|
+
* Explicitly resumes a scheduled message after onboarding review clearance. An overdue message requires either send_now or a new future scheduledFor value.
|
|
178
|
+
*/
|
|
179
|
+
static resume<ThrowOnError extends boolean = false>(parameters: {
|
|
180
|
+
id: ScheduledMessageId;
|
|
181
|
+
body: {
|
|
182
|
+
choice: "send_now";
|
|
183
|
+
} | {
|
|
184
|
+
choice: "new_time";
|
|
185
|
+
scheduledFor: string;
|
|
186
|
+
};
|
|
187
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ScheduledMessagesResumeResponses, ScheduledMessagesResumeErrors, ThrowOnError>;
|
|
159
188
|
}
|
|
160
189
|
export declare class ScheduledMessages2 {
|
|
161
190
|
static scheduledMessages: typeof ScheduledMessages;
|
|
@@ -285,6 +314,30 @@ export declare class Campaigns2 {
|
|
|
285
314
|
static campaigns: typeof Campaigns;
|
|
286
315
|
}
|
|
287
316
|
export declare class Email {
|
|
317
|
+
/**
|
|
318
|
+
* Get email onboarding review status
|
|
319
|
+
*
|
|
320
|
+
* Returns the customer-safe workspace review decision, workflow stage, next action, and current sending-identity clearances. A missing authority row is returned as a blocked initial state.
|
|
321
|
+
*/
|
|
322
|
+
static getOnboardingReview<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<EmailGetOnboardingReviewResponses, EmailGetOnboardingReviewErrors, ThrowOnError>;
|
|
323
|
+
/**
|
|
324
|
+
* Reapply for email onboarding review
|
|
325
|
+
*
|
|
326
|
+
* Allows a workspace owner or admin to submit a rejected workspace for review again. The expected generation prevents acting on stale status.
|
|
327
|
+
*/
|
|
328
|
+
static reapplyOnboardingReview<ThrowOnError extends boolean = false>(parameters: {
|
|
329
|
+
expectedGeneration: number;
|
|
330
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailReapplyOnboardingReviewResponses, EmailReapplyOnboardingReviewErrors, ThrowOnError>;
|
|
331
|
+
/**
|
|
332
|
+
* Respond to an email onboarding information request
|
|
333
|
+
*
|
|
334
|
+
* Allows workspace owners and admins to submit bounded text and up to three pending-scanned evidence uploads for the current review generation.
|
|
335
|
+
*/
|
|
336
|
+
static respondToOnboardingInformationRequest<ThrowOnError extends boolean = false>(parameters: {
|
|
337
|
+
expectedGeneration: number;
|
|
338
|
+
responseText: string;
|
|
339
|
+
evidenceMediaIds: Array<MediaId>;
|
|
340
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailRespondToOnboardingInformationRequestResponses, EmailRespondToOnboardingInformationRequestErrors, ThrowOnError>;
|
|
288
341
|
/**
|
|
289
342
|
* Get email tracking defaults
|
|
290
343
|
*
|
|
@@ -354,6 +407,15 @@ export declare class Email {
|
|
|
354
407
|
static advanceDomainVerification<ThrowOnError extends boolean = false>(parameters: {
|
|
355
408
|
id: EmailDomainId;
|
|
356
409
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailAdvanceDomainVerificationResponses, EmailAdvanceDomainVerificationErrors, ThrowOnError>;
|
|
410
|
+
/**
|
|
411
|
+
* Stage a DKIM selector rotation
|
|
412
|
+
*
|
|
413
|
+
* Creates encrypted signing custody and returns a new public DKIM record. Publish it, then advance domain verification to cut over. Retain the former record until separately approved retirement.
|
|
414
|
+
*/
|
|
415
|
+
static rotateDomainDkim<ThrowOnError extends boolean = false>(parameters: {
|
|
416
|
+
"idempotency-key": string;
|
|
417
|
+
id: EmailDomainId;
|
|
418
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailRotateDomainDkimResponses, EmailRotateDomainDkimErrors, ThrowOnError>;
|
|
357
419
|
/**
|
|
358
420
|
* Remove a sending domain
|
|
359
421
|
*
|
|
@@ -548,6 +610,14 @@ export declare class Email {
|
|
|
548
610
|
static removeSender<ThrowOnError extends boolean = false>(parameters: {
|
|
549
611
|
id: EmailSenderId;
|
|
550
612
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailRemoveSenderResponses, EmailRemoveSenderErrors, ThrowOnError>;
|
|
613
|
+
/**
|
|
614
|
+
* Get a sender identity
|
|
615
|
+
*
|
|
616
|
+
* Returns one sender identity owned by the authenticated organization. Other organizations' ids are reported as not found.
|
|
617
|
+
*/
|
|
618
|
+
static getSender<ThrowOnError extends boolean = false>(parameters: {
|
|
619
|
+
id: EmailSenderId;
|
|
620
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetSenderResponses, EmailGetSenderErrors, ThrowOnError>;
|
|
551
621
|
/**
|
|
552
622
|
* Set the organization default sender
|
|
553
623
|
*
|
|
@@ -766,6 +836,73 @@ export declare class Email {
|
|
|
766
836
|
limit?: string | null | undefined;
|
|
767
837
|
offset?: string | null | undefined;
|
|
768
838
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetForwardingLogResponses, EmailGetForwardingLogErrors, ThrowOnError>;
|
|
839
|
+
/**
|
|
840
|
+
* Get domain warming
|
|
841
|
+
*
|
|
842
|
+
* Returns the domain's automated warming policy, its system-created 24-hour windows and policy snapshots, the rolling bounce and complaint window the safety rule reads, every pause above the plan, and the decision history. A domain without a plan returns the evidence and a null plan.
|
|
843
|
+
*/
|
|
844
|
+
static getDomainWarming<ThrowOnError extends boolean = false>(parameters: {
|
|
845
|
+
id: EmailDomainId;
|
|
846
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetDomainWarmingResponses, EmailGetDomainWarmingErrors, ThrowOnError>;
|
|
847
|
+
/**
|
|
848
|
+
* Start domain warming
|
|
849
|
+
*
|
|
850
|
+
* Starts an automated warming policy on a verified sending domain. Samva opens the first 24-hour campaign window immediately, then opens later windows from the saved growth policy after safe windows close. Direct sends are counted in the domain's window but never delayed. Responds with 201.
|
|
851
|
+
*/
|
|
852
|
+
static createDomainWarmingPlan<ThrowOnError extends boolean = false>(parameters: {
|
|
853
|
+
id: EmailDomainId;
|
|
854
|
+
identity: "new" | "migrating" | "returning";
|
|
855
|
+
initialDailyRecipients: number;
|
|
856
|
+
dailyGrowthPercent: number;
|
|
857
|
+
targetDailyRecipients: number;
|
|
858
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCreateDomainWarmingPlanResponses, EmailCreateDomainWarmingPlanErrors, ThrowOnError>;
|
|
859
|
+
/**
|
|
860
|
+
* Update domain warming policy
|
|
861
|
+
*
|
|
862
|
+
* Updates the growth percentage and daily target Samva uses for future 24-hour warming windows. Existing windows keep their policy snapshot, including a scheduled window, so prior authorization remains auditable.
|
|
863
|
+
*/
|
|
864
|
+
static updateDomainWarmingPolicy<ThrowOnError extends boolean = false>(parameters: {
|
|
865
|
+
id: EmailDomainId;
|
|
866
|
+
dailyGrowthPercent: number;
|
|
867
|
+
targetDailyRecipients: number;
|
|
868
|
+
note?: string | null | undefined;
|
|
869
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailUpdateDomainWarmingPolicyResponses, EmailUpdateDomainWarmingPolicyErrors, ThrowOnError>;
|
|
870
|
+
/**
|
|
871
|
+
* Cancel a warming window
|
|
872
|
+
*
|
|
873
|
+
* Cancels a scheduled or open system-created warming window. Recipients a campaign run already reserved from it stay reserved; no further runs draw from it.
|
|
874
|
+
*/
|
|
875
|
+
static cancelDomainWarmingBatch<ThrowOnError extends boolean = false>(parameters: {
|
|
876
|
+
id: EmailDomainId;
|
|
877
|
+
batchId: EmailDomainWarmingBatchId;
|
|
878
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCancelDomainWarmingBatchResponses, EmailCancelDomainWarmingBatchErrors, ThrowOnError>;
|
|
879
|
+
/**
|
|
880
|
+
* Pause domain warming
|
|
881
|
+
*
|
|
882
|
+
* Pauses the plan. Campaign runs from the domain stop at their next page and queued campaign email waits until it expires; direct sends are unaffected.
|
|
883
|
+
*/
|
|
884
|
+
static pauseDomainWarming<ThrowOnError extends boolean = false>(parameters: {
|
|
885
|
+
id: EmailDomainId;
|
|
886
|
+
note?: string | null | undefined;
|
|
887
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailPauseDomainWarmingResponses, EmailPauseDomainWarmingErrors, ThrowOnError>;
|
|
888
|
+
/**
|
|
889
|
+
* Resume domain warming
|
|
890
|
+
*
|
|
891
|
+
* Resumes a paused or held plan and the campaign runs it was holding. A plan the domain rule held resumes only once the domain's rolling window is under both limits again; until then the request is refused with the observed rate.
|
|
892
|
+
*/
|
|
893
|
+
static resumeDomainWarming<ThrowOnError extends boolean = false>(parameters: {
|
|
894
|
+
id: EmailDomainId;
|
|
895
|
+
note?: string | null | undefined;
|
|
896
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailResumeDomainWarmingResponses, EmailResumeDomainWarmingErrors, ThrowOnError>;
|
|
897
|
+
/**
|
|
898
|
+
* Complete domain warming
|
|
899
|
+
*
|
|
900
|
+
* Ends the policy. Campaign runs from the domain are no longer gated by warming windows; the workspace safeguards still apply.
|
|
901
|
+
*/
|
|
902
|
+
static completeDomainWarming<ThrowOnError extends boolean = false>(parameters: {
|
|
903
|
+
id: EmailDomainId;
|
|
904
|
+
note?: string | null | undefined;
|
|
905
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCompleteDomainWarmingResponses, EmailCompleteDomainWarmingErrors, ThrowOnError>;
|
|
769
906
|
}
|
|
770
907
|
export declare class Email2 {
|
|
771
908
|
static email: typeof Email;
|
|
@@ -780,7 +917,7 @@ export declare class Media {
|
|
|
780
917
|
filename: string;
|
|
781
918
|
contentType: string;
|
|
782
919
|
sizeBytes: number;
|
|
783
|
-
purpose: "attachment" | "avatar";
|
|
920
|
+
purpose: "attachment" | "avatar" | "review_evidence";
|
|
784
921
|
checksumSha256?: string | null | undefined;
|
|
785
922
|
}, options?: Options<never, ThrowOnError>): RequestResult<MediaCreateResponses, MediaCreateErrors, ThrowOnError>;
|
|
786
923
|
/**
|
|
@@ -1492,12 +1629,13 @@ export declare class Webhooks {
|
|
|
1492
1629
|
/**
|
|
1493
1630
|
* List webhooks
|
|
1494
1631
|
*
|
|
1495
|
-
* Returns a paginated list of the organization's webhook endpoints, optionally filtered by
|
|
1632
|
+
* Returns a paginated list of the organization's webhook endpoints with each endpoint's delivery counts, optionally filtered by name search and status.
|
|
1496
1633
|
*/
|
|
1497
1634
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1498
1635
|
page?: string | null | undefined;
|
|
1499
1636
|
limit?: string | null | undefined;
|
|
1500
1637
|
search?: string | null | undefined;
|
|
1638
|
+
status?: "active" | "disabled" | null | undefined;
|
|
1501
1639
|
}, options?: Options<never, ThrowOnError>): RequestResult<WebhooksListResponses, WebhooksListErrors, ThrowOnError>;
|
|
1502
1640
|
/**
|
|
1503
1641
|
* Create a webhook
|
|
@@ -1507,7 +1645,7 @@ export declare class Webhooks {
|
|
|
1507
1645
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1508
1646
|
name: string;
|
|
1509
1647
|
url: string;
|
|
1510
|
-
eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated">;
|
|
1648
|
+
eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
|
|
1511
1649
|
channels?: Array<"email"> | null | undefined;
|
|
1512
1650
|
headers?: {
|
|
1513
1651
|
[key: string]: string;
|
|
@@ -1539,7 +1677,7 @@ export declare class Webhooks {
|
|
|
1539
1677
|
id: WebhookEndpointId;
|
|
1540
1678
|
name?: string | null | undefined;
|
|
1541
1679
|
url?: string | null | undefined;
|
|
1542
|
-
eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated"> | null | undefined;
|
|
1680
|
+
eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated"> | null | undefined;
|
|
1543
1681
|
channels?: Array<"email"> | null | null | undefined;
|
|
1544
1682
|
headers?: {
|
|
1545
1683
|
[key: string]: string;
|
|
@@ -1560,7 +1698,7 @@ export declare class Webhooks {
|
|
|
1560
1698
|
/**
|
|
1561
1699
|
* List webhook delivery logs
|
|
1562
1700
|
*
|
|
1563
|
-
* Returns recent deliveries and
|
|
1701
|
+
* Returns recent deliveries for a webhook endpoint, each naming the event type and time it was made for, with its nested attempt diagnostics.
|
|
1564
1702
|
*/
|
|
1565
1703
|
static getLogs<ThrowOnError extends boolean = false>(parameters: {
|
|
1566
1704
|
webhookId: WebhookEndpointId;
|
|
@@ -1569,10 +1707,11 @@ export declare class Webhooks {
|
|
|
1569
1707
|
/**
|
|
1570
1708
|
* Get webhook delivery statistics
|
|
1571
1709
|
*
|
|
1572
|
-
* Returns aggregate pending, delivered, exhausted, and cancelled delivery counts for a webhook endpoint.
|
|
1710
|
+
* Returns aggregate pending, delivered, exhausted, and cancelled delivery counts for a webhook endpoint, plus the same counts per workspace-local calendar day over the selected period of 7, 30, or 90 days. Deliveries are retained for 90 days, so 90d is the whole history.
|
|
1573
1711
|
*/
|
|
1574
1712
|
static getStats<ThrowOnError extends boolean = false>(parameters: {
|
|
1575
1713
|
webhookId: WebhookEndpointId;
|
|
1714
|
+
period?: "7d" | "30d" | "90d" | null | undefined;
|
|
1576
1715
|
}, options?: Options<never, ThrowOnError>): RequestResult<WebhooksGetStatsResponses, WebhooksGetStatsErrors, ThrowOnError>;
|
|
1577
1716
|
/**
|
|
1578
1717
|
* Retry a webhook delivery
|
|
@@ -1621,7 +1760,7 @@ export declare class Organizations {
|
|
|
1621
1760
|
billingEmail?: string | null | undefined;
|
|
1622
1761
|
countryCode?: string | null | undefined;
|
|
1623
1762
|
currency?: string | null | undefined;
|
|
1624
|
-
timezone?:
|
|
1763
|
+
timezone?: IanaTimezone | null | undefined;
|
|
1625
1764
|
isActive?: boolean | null | undefined;
|
|
1626
1765
|
metadata?: {
|
|
1627
1766
|
[key: string]: JsonValue;
|