samva 0.15.0 → 0.17.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/AGENTS.md +4 -1
- package/README.md +46 -1
- package/dist/analytics-CaqPRsry.js +207 -0
- package/dist/api-keys-Ce1Y4_Ip.js +274 -0
- package/dist/attachments-DYqVIraC.js +140 -0
- package/dist/brands-ZwuOGIWO.js +175 -0
- package/dist/campaigns-DZlz1E9E.js +522 -0
- package/dist/categories-CA4XIQAb.js +1011 -0
- package/dist/client/sdk.gen.d.ts +234 -49
- package/dist/client/types.gen.d.ts +1521 -348
- package/dist/client-DOzUrdTE.js +1115 -0
- package/dist/contact-groups-BLbFXnjq.js +446 -0
- package/dist/contacts-BbsoXXB4.js +787 -0
- package/dist/conversations-_sRHueML.js +494 -0
- package/dist/custom-fields-BHWbwlKn.js +176 -0
- package/dist/effect/analytics.js +2 -21
- package/dist/effect/api-keys.d.ts +1 -0
- package/dist/effect/api-keys.js +2 -25
- package/dist/effect/attachments.js +2 -17
- package/dist/effect/brands.d.ts +1 -1
- package/dist/effect/brands.js +3 -24
- package/dist/effect/campaigns.js +2 -33
- package/dist/effect/categories.js +1 -1
- package/dist/effect/client.d.ts +1 -1
- package/dist/effect/client.js +3 -4
- package/dist/effect/contact-groups.js +2 -29
- package/dist/effect/contacts.d.ts +52 -0
- package/dist/effect/contacts.js +2 -47
- package/dist/effect/conversations.js +2 -35
- package/dist/effect/custom-fields.js +2 -17
- package/dist/effect/email.d.ts +3 -20
- package/dist/effect/email.js +2 -141
- package/dist/effect/events.d.ts +121 -0
- package/dist/effect/events.js +3 -0
- package/dist/effect/extension-installations.js +2 -27
- package/dist/effect/extensions.js +2 -19
- package/dist/effect/feedback.d.ts +1 -1
- package/dist/effect/feedback.js +3 -13
- package/dist/effect/generated/analytics.d.ts +715 -0
- package/dist/effect/generated/api-keys.d.ts +1627 -0
- package/dist/effect/generated/attachments.d.ts +554 -0
- package/dist/effect/generated/brands.d.ts +1118 -0
- package/dist/effect/generated/campaigns.d.ts +3783 -0
- package/dist/effect/generated/contact-events.d.ts +158 -0
- package/dist/effect/generated/contact-groups.d.ts +1445 -0
- package/dist/effect/generated/contacts.d.ts +3789 -0
- package/dist/effect/generated/conversations.d.ts +2870 -0
- package/dist/effect/generated/custom-fields.d.ts +562 -0
- package/dist/effect/generated/email.d.ts +10622 -0
- package/dist/effect/generated/events.d.ts +463 -0
- package/dist/effect/generated/extension-installations.d.ts +1786 -0
- package/dist/effect/generated/extensions.d.ts +927 -0
- package/dist/effect/generated/feedback.d.ts +116 -0
- package/dist/effect/generated/index.d.ts +61 -0
- package/dist/effect/generated/journeys.d.ts +6135 -0
- package/dist/effect/generated/mailboxes.d.ts +13641 -0
- package/dist/effect/generated/media.d.ts +741 -0
- package/dist/effect/generated/messages.d.ts +2355 -0
- package/dist/effect/generated/namespaces.d.ts +654 -0
- package/dist/effect/generated/operations.d.ts +514 -0
- package/dist/effect/generated/organizations.d.ts +1111 -0
- package/dist/effect/generated/scheduled-messages.d.ts +1798 -0
- package/dist/effect/generated/shared.d.ts +3250 -0
- package/dist/effect/generated/subscriptions.d.ts +188 -0
- package/dist/effect/generated/templates.d.ts +8177 -0
- package/dist/effect/generated/unsubscribe-groups.d.ts +1153 -0
- package/dist/effect/generated/webhooks.d.ts +1697 -0
- package/dist/effect/generated/whoami.d.ts +291 -0
- package/dist/effect/generated-metadata.d.ts +1631 -0
- package/dist/effect/index.d.ts +4 -1
- package/dist/effect/index.js +29 -26
- package/dist/effect/internal/client.d.ts +10 -7
- package/dist/effect/internal/email-sender.d.ts +17 -0
- package/dist/effect/internal/operation.d.ts +12 -72
- package/dist/effect/internal/send.d.ts +60 -0
- package/dist/effect/journeys.d.ts +2153 -0
- package/dist/effect/journeys.js +2 -0
- package/dist/effect/mailboxes.d.ts +255 -205
- package/dist/effect/mailboxes.js +2 -2
- package/dist/effect/media.js +3 -1
- package/dist/effect/messages.d.ts +2 -2
- package/dist/effect/messages.js +3 -1
- package/dist/effect/namespaces.js +2 -19
- package/dist/effect/operations.js +2 -15
- package/dist/effect/organizations.js +2 -23
- package/dist/effect/retry.js +1 -1
- package/dist/effect/scheduled-messages.js +2 -19
- package/dist/effect/subscriptions.js +2 -9
- package/dist/effect/templates.d.ts +1 -1
- package/dist/effect/templates.js +3 -78
- package/dist/effect/unsubscribe-groups.js +2 -27
- package/dist/effect/webhooks.d.ts +9 -9
- package/dist/effect/webhooks.js +3 -33
- package/dist/effect/whoami.d.ts +46 -0
- package/dist/effect/whoami.js +2 -0
- package/dist/email-R0NAA9PW.js +2498 -0
- package/dist/events-CxbTUHYT.js +82 -0
- package/dist/extension-installations-CD94LPmk.js +407 -0
- package/dist/extensions-BKyNQLvu.js +220 -0
- package/dist/feedback-Bpa09JOS.js +52 -0
- package/dist/index.js +3 -3
- package/dist/{inline-attachments-UxLeyytJ.js → inline-attachments-Bi1hDltp.js} +2 -2
- package/dist/journeys-CARo_BJT.js +499 -0
- package/dist/mailboxes-BRDn7BIK.js +2470 -0
- package/dist/media-VrrtNnft.js +181 -0
- package/dist/namespaces-CcvEbG-y.js +152 -0
- package/dist/{operation-BZ5Xov-x.js → operation-n_IYgNVK.js} +85 -102
- package/dist/operations-CmB3FHwf.js +93 -0
- package/dist/organizations-A-plufWc.js +252 -0
- package/dist/promises/errors.gen.d.ts +12 -2
- package/dist/promises/index.d.ts +9 -3
- package/dist/promises/index.js +3 -3
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/{promises-Cd6Jamqk.js → promises---Kbh-7z.js} +745 -195
- package/dist/runtime-P0l1_2-C.js +25 -0
- package/dist/scheduled-messages-DkKZRRaN.js +207 -0
- package/dist/send-Bxc0XfGE.js +722 -0
- package/dist/service-map.d.ts +101 -15
- package/dist/subscriptions-DEXYtMXg.js +67 -0
- package/dist/templates-DZomxsG7.js +2289 -0
- package/dist/unsubscribe-groups-Iqk4Isf9.js +291 -0
- package/dist/webhooks-CPXuu8Xf.js +530 -0
- package/dist/whoami-Ccz0jwlt.js +59 -0
- package/package.json +17 -3
- package/dist/categories-BGUBFdH9.js +0 -183
- package/dist/client-CDg7zJs0.js +0 -13726
- package/dist/effect/generated.d.ts +0 -64059
- package/dist/mailboxes-BH_JPmOE.js +0 -159
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 { AnalyticsExportDataErrors, AnalyticsExportDataResponses, AnalyticsGetChannelStatsErrors, AnalyticsGetChannelStatsResponses, AnalyticsGetDeliveryMetricsErrors, AnalyticsGetDeliveryMetricsResponses, AnalyticsGetHourlyDistributionErrors, AnalyticsGetHourlyDistributionResponses, AnalyticsGetStatsErrors, AnalyticsGetStatsResponses, AnalyticsGetTopContactsErrors, AnalyticsGetTopContactsResponses, ApiKeyAccess, ApiKeyId, ApiKeyMailboxAccessUpdate, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, AttachmentId, AttachmentsDownloadUrlErrors, AttachmentsDownloadUrlResponses, AttachmentsGetByIdErrors, AttachmentsGetByIdResponses, AttachmentsListErrors, AttachmentsListResponses, AttachmentsRemoveErrors, AttachmentsRemoveResponses, BlockedEmailId, BrandAssets, BrandFooter, BrandsCreateErrors, BrandsCreateResponses, BrandsGetErrors, BrandsGetResponses, BrandsListErrors, BrandsListResponses, BrandsRemoveErrors, BrandsRemoveResponses, BrandsSetDefaultErrors, BrandsSetDefaultResponses, BrandsUpdateErrors, BrandsUpdateResponses, 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, ContactGroupId, ContactGroupsAddMembersErrors, ContactGroupsAddMembersResponses, ContactGroupsCreateErrors, ContactGroupsCreateResponses, ContactGroupsEvaluateDynamicErrors, ContactGroupsEvaluateDynamicResponses, ContactGroupsGetByIdErrors, ContactGroupsGetByIdResponses, ContactGroupsGetMembersErrors, ContactGroupsGetMembersResponses, ContactGroupsListErrors, ContactGroupsListResponses, ContactGroupsPreviewErrors, ContactGroupsPreviewResponses, ContactGroupsRemoveErrors, ContactGroupsRemoveMembersErrors, ContactGroupsRemoveMembersResponses, ContactGroupsRemoveResponses, ContactGroupsUpdateErrors, ContactGroupsUpdateResponses, ContactId, ContactIdentityId, ContactIdentityInput, ContactLookup, ContactPreferences, ContactProfile, ContactProfileUpdate, ContactsAddIdentityErrors, ContactsAddIdentityResponses, ContactsAddTagsErrors, ContactsAddTagsResponses, 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, ContactsRemoveIdentityErrors, ContactsRemoveIdentityResponses, ContactsRemoveResponses, ContactsRemoveTagsErrors, ContactsRemoveTagsResponses, ContactsUpdateErrors, ContactsUpdateResponses, ConversationContext, ConversationId, ConversationsAddCategoriesErrors, ConversationsAddCategoriesResponses, ConversationsAddChannelsErrors, ConversationsAddChannelsResponses, ConversationsAddContactsErrors, ConversationsAddContactsResponses, ConversationsAddTagsErrors, ConversationsAddTagsResponses, ConversationsCreateErrors, ConversationsCreateResponses, ConversationsGetByIdErrors, ConversationsGetByIdResponses, ConversationsListErrors, ConversationsListMessagesErrors, ConversationsListMessagesResponses, ConversationsListResponses, ConversationsRemoveCategoriesErrors, ConversationsRemoveCategoriesResponses, ConversationsRemoveChannelsErrors, ConversationsRemoveChannelsResponses, ConversationsRemoveContactsErrors, ConversationsRemoveContactsResponses, ConversationsRemoveTagsErrors, ConversationsRemoveTagsResponses, ConversationsUpdateErrors, ConversationsUpdateResponses, Cursor, CustomFieldDefinitionId, CustomFieldsCreateErrors, CustomFieldsCreateResponses, CustomFieldsListErrors, CustomFieldsListResponses, CustomFieldsRemoveErrors, CustomFieldsRemoveResponses, CustomFieldsUpdateErrors, CustomFieldsUpdateResponses, DispatchSendMessagePayload, EmailAddBlockErrors, EmailAddBlockResponses, EmailAddDomainErrors, EmailAddDomainResponses, EmailAddSenderErrors, EmailAddSenderResponses, EmailAdvanceDomainVerificationErrors, EmailAdvanceDomainVerificationResponses, EmailAttachment, EmailBccRecipients, EmailBuildCustomTrackingDomainConnectApplyUrlErrors, EmailBuildCustomTrackingDomainConnectApplyUrlResponses, EmailBuildDomainConnectApplyUrlErrors, EmailBuildDomainConnectApplyUrlResponses, EmailCancelDomainWarmingBatchErrors, EmailCancelDomainWarmingBatchResponses, EmailCcRecipients, EmailCheckBlockedErrors, EmailCheckBlockedResponses, EmailCheckSenderVerificationErrors, EmailCheckSenderVerificationResponses, EmailClearDomainDefaultSenderErrors, EmailClearDomainDefaultSenderResponses, EmailCompleteCustomTrackingDomainConnectErrors, EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteDomainConnectErrors, EmailCompleteDomainConnectResponses, EmailCompleteDomainWarmingErrors, EmailCompleteDomainWarmingResponses, EmailContent, EmailCountSuppressionsErrors, EmailCountSuppressionsResponses, 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, EmailGetReceivingStatusErrors, EmailGetReceivingStatusResponses, EmailGetRecipientTrackingPreferenceErrors, EmailGetRecipientTrackingPreferenceResponses, EmailGetSenderErrors, EmailGetSenderResponses, EmailGetStatsErrors, EmailGetStatsResponses, EmailGetTrackingDefaultsErrors, EmailGetTrackingDefaultsResponses, EmailListBlocksErrors, EmailListBlocksResponses, EmailListDomainsErrors, EmailListDomainsResponses, EmailListForwardingRulesErrors, EmailListForwardingRulesResponses, EmailListSendersErrors, EmailListSendersResponses, EmailListSuppressionsErrors, EmailListSuppressionsResponses, EmailPauseDomainWarmingErrors, EmailPauseDomainWarmingResponses, EmailReapplyOnboardingReviewErrors, EmailReapplyOnboardingReviewResponses, EmailRecheckCustomTrackingErrors, EmailRecheckCustomTrackingResponses, 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, ExtensionInstallationId, ExtensionInstallationsDisableErrors, ExtensionInstallationsDisableResponses, ExtensionInstallationsEnableErrors, ExtensionInstallationsEnableResponses, ExtensionInstallationsGetErrors, ExtensionInstallationsGetResponses, ExtensionInstallationsGetRunErrors, ExtensionInstallationsGetRunResponses, ExtensionInstallationsInstallErrors, ExtensionInstallationsInstallResponses, ExtensionInstallationsListErrors, ExtensionInstallationsListResponses, ExtensionInstallationsListRunsErrors, ExtensionInstallationsListRunsResponses, ExtensionInstallationsUninstallErrors, ExtensionInstallationsUninstallResponses, ExtensionInstallationsUpgradeErrors, ExtensionInstallationsUpgradeResponses, ExtensionsGetErrors, ExtensionsGetResponses, ExtensionsGetVersionErrors, ExtensionsGetVersionResponses, ExtensionsListErrors, ExtensionsListResponses, ExtensionsListVersionsErrors, ExtensionsListVersionsResponses, ExtensionsPublishErrors, ExtensionsPublishResponses, ExtensionVersionId, FeedbackContext, FeedbackSendErrors, FeedbackSendResponses, ForwardingConditions, IanaTimezone, JsonObject, JsonValue, MailboxActionId, MailboxAddressId, MailboxDraftId, MailboxesAddThreadLabelsErrors, MailboxesAddThreadLabelsResponses, MailboxesApproveActionErrors, MailboxesApproveActionResponses, MailboxesCancelActionErrors, MailboxesCancelActionResponses, MailboxesCopyMessageAttachmentErrors, MailboxesCopyMessageAttachmentResponses, MailboxesCreateAddressErrors, MailboxesCreateAddressResponses, MailboxesCreateDraftErrors, MailboxesCreateDraftResponses, MailboxesCreateErrors, MailboxesCreateGrantErrors, MailboxesCreateGrantResponses, MailboxesCreateLabelErrors, MailboxesCreateLabelResponses, MailboxesCreateNoteErrors, MailboxesCreateNoteResponses, MailboxesCreatePolicyErrors, MailboxesCreatePolicyResponses, MailboxesCreateResponses, MailboxesDeleteDraftErrors, MailboxesDeleteDraftResponses, MailboxesDeleteLabelErrors, MailboxesDeleteLabelResponses, MailboxesDeleteNoteErrors, MailboxesDeleteNoteResponses, MailboxesDeletePolicyErrors, MailboxesDeletePolicyResponses, MailboxesDenyActionErrors, MailboxesDenyActionResponses, MailboxesDiscardMessageErrors, MailboxesDiscardMessageResponses, MailboxesForwardErrors, MailboxesForwardResponses, MailboxesGetActionErrors, MailboxesGetActionResponses, MailboxesGetAgentActivityErrors, MailboxesGetAgentActivityResponses, MailboxesGetDraftErrors, MailboxesGetDraftResponses, MailboxesGetErrors, MailboxesGetMessageAttachmentErrors, MailboxesGetMessageAttachmentResponses, MailboxesGetMessageErrors, MailboxesGetMessageRawErrors, MailboxesGetMessageRawResponses, MailboxesGetMessageResponses, MailboxesGetPolicyErrors, MailboxesGetPolicyResponses, MailboxesGetResponses, MailboxesGetThreadContentErrors, MailboxesGetThreadContentResponses, MailboxesGetThreadErrors, MailboxesGetThreadResponses, MailboxesListActionsErrors, MailboxesListActionsResponses, MailboxesListDraftsErrors, MailboxesListDraftsResponses, MailboxesListErrors, MailboxesListEventsErrors, MailboxesListEventsResponses, MailboxesListFoldersErrors, MailboxesListFoldersResponses, MailboxesListGrantsErrors, MailboxesListGrantsResponses, MailboxesListLabelsErrors, MailboxesListLabelsResponses, MailboxesListPoliciesErrors, MailboxesListPoliciesResponses, MailboxesListQuarantineErrors, MailboxesListQuarantineResponses, MailboxesListResponses, MailboxesListThreadMessagesErrors, MailboxesListThreadMessagesResponses, MailboxesListThreadNotesErrors, MailboxesListThreadNotesResponses, MailboxesListThreadsErrors, MailboxesListThreadsResponses, MailboxesPauseErrors, MailboxesPauseResponses, MailboxesReleaseMessageErrors, MailboxesReleaseMessageResponses, MailboxesRemoveAddressErrors, MailboxesRemoveAddressResponses, MailboxesRemoveErrors, MailboxesRemoveResponses, MailboxesRemoveThreadLabelsErrors, MailboxesRemoveThreadLabelsResponses, MailboxesReplyAllErrors, MailboxesReplyAllResponses, MailboxesReplyErrors, MailboxesReplyResponses, MailboxesResumeErrors, MailboxesResumeResponses, MailboxesRetryActionErrors, MailboxesRetryActionResponses, MailboxesRevokeGrantErrors, MailboxesRevokeGrantResponses, MailboxesSendDraftErrors, MailboxesSendDraftResponses, MailboxesSendMessageErrors, MailboxesSendMessageResponses, MailboxesUpdateDraftErrors, MailboxesUpdateDraftResponses, MailboxesUpdateErrors, MailboxesUpdateGrantErrors, MailboxesUpdateGrantResponses, MailboxesUpdateLabelErrors, MailboxesUpdateLabelResponses, MailboxesUpdateNoteErrors, MailboxesUpdateNoteResponses, MailboxesUpdatePolicyErrors, MailboxesUpdatePolicyResponses, MailboxesUpdateResponses, MailboxesUpdateThreadErrors, MailboxesUpdateThreadResponses, MailboxGrantId, MailboxGrantRole, MailboxId, MailboxLabelId, MailboxMetadata, MailboxMetadataPatch, MailboxNoteId, MailboxPolicyId, MailboxPolicyOutcomeKind, MailboxSendMode, MailboxThreadFolder, MailboxThreadId, MailboxThreadPriority, MediaCompleteErrors, MediaCompleteResponses, MediaCreateErrors, MediaCreateResponses, MediaDownloadUrlErrors, MediaDownloadUrlResponses, MediaGetByIdErrors, MediaGetByIdResponses, MediaId, MediaRemoveErrors, MediaRemoveResponses, MessageId, MessageMetadata, MessagesGetContentErrors, MessagesGetContentResponses, MessagesGetEmailErrors, MessagesGetEmailResponses, MessagesGetErrors, MessagesGetEventsErrors, MessagesGetEventsResponses, MessagesGetResponses, MessagesGetStatusErrors, MessagesGetStatusResponses, MessagesListDeliveriesErrors, MessagesListDeliveriesResponses, MessagesListErrors, MessagesListResponses, MessagesRemoveErrors, MessagesRemoveResponses, MessagesSendErrors, MessagesSendResponses, MessagesValidateEmailErrors, MessagesValidateEmailResponses, NamespaceId, NamespaceMetadata, NamespacesCreateErrors, NamespacesCreateResponses, NamespacesGetErrors, NamespacesGetResponses, NamespacesListErrors, NamespacesListResponses, NamespacesRemoveErrors, NamespacesRemoveResponses, NamespacesUpdateErrors, NamespacesUpdateResponses, OperationId, OperationsGetErrors, OperationsGetResponses, OperationsListErrors, OperationsListResponses, OperationsRetryErrors, OperationsRetryResponses, OrganizationsCreateErrors, OrganizationsCreateResponses, OrganizationsDeleteErrors, OrganizationsDeleteResponses, OrganizationsGetErrors, OrganizationsGetProfileErrors, OrganizationsGetProfileResponses, OrganizationsGetResponses, OrganizationsGetTrustTierErrors, OrganizationsGetTrustTierResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, RenderLocale, RenderTimeZone, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, ScheduledMessagesResumeErrors, ScheduledMessagesResumeResponses, SubscriptionsSubscribeErrors, SubscriptionsSubscribeResponses, SuppressionId, TemplateFamilyId, TemplateFromDefault, TemplateId, TemplateInputContractId, TemplateProjectId, TemplatePublicationId, TemplatesAddEntryErrors, TemplatesAddEntryResponses, 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, TemplatesListErrors, TemplatesListFamiliesErrors, TemplatesListFamiliesResponses, TemplatesListInputContractsErrors, TemplatesListInputContractsResponses, TemplatesListResponses, TemplatesOpenWorkspaceErrors, TemplatesOpenWorkspaceResponses, TemplatesPatchWorkspaceErrors, TemplatesPatchWorkspaceResponses, TemplatesPublishErrors, TemplatesPublishResponses, TemplatesPutWorkspaceAssetErrors, TemplatesPutWorkspaceAssetResponses, TemplatesRemoveErrors, TemplatesRemoveResponses, TemplatesRemoveWorkspaceResourceErrors, TemplatesRemoveWorkspaceResourceResponses, TemplatesRenameFamilyErrors, TemplatesRenameFamilyResponses, TemplatesRenderPublicationErrors, TemplatesRenderPublicationResponses, TemplatesRenderWorkspaceFixtureErrors, TemplatesRenderWorkspaceFixtureResponses, TemplatesResolveWorkspaceConflictErrors, TemplatesResolveWorkspaceConflictResponses, TemplatesRestoreWorkspaceErrors, TemplatesRestoreWorkspaceResponses, TemplatesSaveWorkspaceErrors, TemplatesSaveWorkspaceResponses, TemplatesUpdateErrors, TemplatesUpdateResponses, TemplatesWorkspaceHistoryErrors, TemplatesWorkspaceHistoryResponses, TrackingRecipientEmail, UnsubscribeAddEmailsErrors, UnsubscribeAddEmailsResponses, UnsubscribeCheckSubscriptionErrors, UnsubscribeCheckSubscriptionResponses, UnsubscribeCreateErrors, UnsubscribeCreateResponses, UnsubscribeId, UnsubscribeListErrors, UnsubscribeListMembersErrors, UnsubscribeListMembersResponses, UnsubscribeListResponses, UnsubscribeRemoveEmailsErrors, UnsubscribeRemoveEmailsResponses, UnsubscribeRemoveErrors, UnsubscribeRemoveResponses, UnsubscribeSetDefaultErrors, UnsubscribeSetDefaultResponses, UnsubscribeUpdateErrors, UnsubscribeUpdateResponses, UserId, VersionCursor, 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 { AnalyticsExportDataErrors, AnalyticsExportDataResponses, AnalyticsGetChannelStatsErrors, AnalyticsGetChannelStatsResponses, AnalyticsGetDeliveryMetricsErrors, AnalyticsGetDeliveryMetricsResponses, AnalyticsGetHourlyDistributionErrors, AnalyticsGetHourlyDistributionResponses, AnalyticsGetStatsErrors, AnalyticsGetStatsResponses, AnalyticsGetTopContactsErrors, AnalyticsGetTopContactsResponses, ApiKeyAccess, ApiKeyId, ApiKeyMailboxAccessUpdate, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, AttachmentId, AttachmentsDownloadUrlErrors, AttachmentsDownloadUrlResponses, AttachmentsGetByIdErrors, AttachmentsGetByIdResponses, AttachmentsListErrors, AttachmentsListResponses, AttachmentsRemoveErrors, AttachmentsRemoveResponses, BlockedEmailId, BrandAssets, BrandFooter, BrandsCreateErrors, BrandsCreateResponses, BrandsGetErrors, BrandsGetResponses, BrandsListErrors, BrandsListResponses, BrandsRemoveErrors, BrandsRemoveResponses, BrandsSetDefaultErrors, BrandsSetDefaultResponses, BrandsUpdateErrors, BrandsUpdateResponses, 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, ContactEventReference, ContactEventsListEventsErrors, ContactEventsListEventsResponses, ContactGroupId, ContactGroupsAddMembersErrors, ContactGroupsAddMembersResponses, ContactGroupsCreateErrors, ContactGroupsCreateResponses, ContactGroupsEvaluateDynamicErrors, ContactGroupsEvaluateDynamicResponses, ContactGroupsGetByIdErrors, ContactGroupsGetByIdResponses, ContactGroupsGetMembersErrors, ContactGroupsGetMembersResponses, ContactGroupsListErrors, ContactGroupsListResponses, ContactGroupsPreviewErrors, ContactGroupsPreviewResponses, ContactGroupsRemoveErrors, ContactGroupsRemoveMembersErrors, ContactGroupsRemoveMembersResponses, ContactGroupsRemoveResponses, ContactGroupsUpdateErrors, ContactGroupsUpdateResponses, ContactId, ContactIdentityId, ContactIdentityInput, ContactLookup, ContactPreferences, ContactProfile, ContactProfileUpdate, ContactsAddIdentityErrors, ContactsAddIdentityResponses, ContactsAddTagsErrors, ContactsAddTagsResponses, 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, ContactsRemoveIdentityErrors, ContactsRemoveIdentityResponses, ContactsRemoveResponses, ContactsRemoveTagsErrors, ContactsRemoveTagsResponses, ContactsUpdateErrors, ContactsUpdateResponses, ConversationContext, ConversationId, ConversationsAddCategoriesErrors, ConversationsAddCategoriesResponses, ConversationsAddChannelsErrors, ConversationsAddChannelsResponses, ConversationsAddContactsErrors, ConversationsAddContactsResponses, ConversationsAddTagsErrors, ConversationsAddTagsResponses, ConversationsCreateErrors, ConversationsCreateResponses, ConversationsGetByIdErrors, ConversationsGetByIdResponses, ConversationsListErrors, ConversationsListMessagesErrors, ConversationsListMessagesResponses, ConversationsListResponses, ConversationsRemoveCategoriesErrors, ConversationsRemoveCategoriesResponses, ConversationsRemoveChannelsErrors, ConversationsRemoveChannelsResponses, ConversationsRemoveContactsErrors, ConversationsRemoveContactsResponses, ConversationsRemoveTagsErrors, ConversationsRemoveTagsResponses, ConversationsUpdateErrors, ConversationsUpdateResponses, CreateEventPayload, CreateMailboxEndpointPayload, Cursor, CustomFieldDefinitionId, CustomFieldsCreateErrors, CustomFieldsCreateResponses, CustomFieldsListErrors, CustomFieldsListResponses, CustomFieldsRemoveErrors, CustomFieldsRemoveResponses, CustomFieldsUpdateErrors, CustomFieldsUpdateResponses, DispatchSendMessagePayload, EmailAddBlockErrors, EmailAddBlockResponses, EmailAddDomainErrors, EmailAddDomainResponses, EmailAddSenderErrors, EmailAddSenderResponses, EmailAdvanceDomainVerificationErrors, EmailAdvanceDomainVerificationResponses, EmailAttachment, EmailBccRecipients, EmailBuildCustomTrackingDomainConnectApplyUrlErrors, EmailBuildCustomTrackingDomainConnectApplyUrlResponses, EmailBuildDomainConnectApplyUrlErrors, EmailBuildDomainConnectApplyUrlResponses, EmailCancelDomainWarmingBatchErrors, EmailCancelDomainWarmingBatchResponses, EmailCcRecipients, EmailCheckBlockedErrors, EmailCheckBlockedResponses, EmailCheckSenderVerificationErrors, EmailCheckSenderVerificationResponses, EmailCompleteCustomTrackingDomainConnectErrors, EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteDomainConnectErrors, EmailCompleteDomainConnectResponses, EmailCompleteDomainWarmingErrors, EmailCompleteDomainWarmingResponses, EmailContent, EmailCountSuppressionsErrors, EmailCountSuppressionsResponses, 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, EmailGetReceivingStatusErrors, EmailGetReceivingStatusResponses, EmailGetRecipientTrackingPreferenceErrors, EmailGetRecipientTrackingPreferenceResponses, EmailGetSenderErrors, EmailGetSenderResponses, EmailGetStatsErrors, EmailGetStatsResponses, EmailGetTrackingDefaultsErrors, EmailGetTrackingDefaultsResponses, EmailListBlocksErrors, EmailListBlocksResponses, EmailListDomainsErrors, EmailListDomainsResponses, EmailListForwardingRulesErrors, EmailListForwardingRulesResponses, EmailListSendersErrors, EmailListSendersResponses, EmailListSuppressionsErrors, EmailListSuppressionsResponses, EmailPauseDomainWarmingErrors, EmailPauseDomainWarmingResponses, EmailReapplyOnboardingReviewErrors, EmailReapplyOnboardingReviewResponses, EmailRecheckCustomTrackingErrors, EmailRecheckCustomTrackingResponses, EmailRecipients, EmailRemoveBlockErrors, EmailRemoveBlockResponses, EmailRemoveDomainErrors, EmailRemoveDomainResponses, EmailRemoveSenderErrors, EmailRemoveSenderResponses, EmailRemoveSuppressionErrors, EmailRemoveSuppressionResponses, EmailRespondToOnboardingInformationRequestErrors, EmailRespondToOnboardingInformationRequestResponses, EmailResumeDomainWarmingErrors, EmailResumeDomainWarmingResponses, EmailRotateDomainDkimErrors, EmailRotateDomainDkimResponses, EmailSender, EmailSenderId, EmailSetDefaultDomainErrors, EmailSetDefaultDomainResponses, EmailSetDefaultSenderErrors, EmailSetDefaultSenderResponses, EmailUpdateBlockErrors, EmailUpdateBlockResponses, EmailUpdateCatchAllConfigErrors, EmailUpdateCatchAllConfigResponses, EmailUpdateDomainConfigErrors, EmailUpdateDomainConfigResponses, EmailUpdateDomainWarmingPolicyErrors, EmailUpdateDomainWarmingPolicyResponses, EmailUpdateForwardingRuleErrors, EmailUpdateForwardingRuleResponses, EmailUpdateRecipientTrackingPreferenceErrors, EmailUpdateRecipientTrackingPreferenceResponses, EmailUpdateTrackingDefaultsErrors, EmailUpdateTrackingDefaultsResponses, EventsBatchErrors, EventsBatchResponses, EventsCreateErrors, EventsCreateResponses, ExtensionInstallationId, ExtensionInstallationsDisableErrors, ExtensionInstallationsDisableResponses, ExtensionInstallationsEnableErrors, ExtensionInstallationsEnableResponses, ExtensionInstallationsGetErrors, ExtensionInstallationsGetResponses, ExtensionInstallationsGetRunErrors, ExtensionInstallationsGetRunResponses, ExtensionInstallationsInstallErrors, ExtensionInstallationsInstallResponses, ExtensionInstallationsListErrors, ExtensionInstallationsListResponses, ExtensionInstallationsListRunsErrors, ExtensionInstallationsListRunsResponses, ExtensionInstallationsUninstallErrors, ExtensionInstallationsUninstallResponses, ExtensionInstallationsUpgradeErrors, ExtensionInstallationsUpgradeResponses, ExtensionsGetErrors, ExtensionsGetResponses, ExtensionsGetVersionErrors, ExtensionsGetVersionResponses, ExtensionsListErrors, ExtensionsListResponses, ExtensionsListVersionsErrors, ExtensionsListVersionsResponses, ExtensionsPublishErrors, ExtensionsPublishResponses, ExtensionVersionId, FeedbackContext, FeedbackSendErrors, FeedbackSendResponses, ForwardingConditions, IanaTimezone, JourneyDefinition, JourneyId, JourneyName, JourneyRunId, JourneyRunStatus, JourneysArchiveErrors, JourneysArchiveResponses, JourneysCreateErrors, JourneysCreateResponses, JourneysGetErrors, JourneysGetResponses, JourneysGetRunErrors, JourneysGetRunResponses, JourneysGetVersionErrors, JourneysGetVersionResponses, JourneysListErrors, JourneysListResponses, JourneysListRunsErrors, JourneysListRunsResponses, JourneysPauseErrors, JourneysPauseResponses, JourneysPublishErrors, JourneysPublishResponses, JourneysRemoveErrors, JourneysRemoveResponses, JourneysReplaceDraftErrors, JourneysReplaceDraftResponses, JourneysResumeErrors, JourneysResumeResponses, JourneysStatsErrors, JourneysStatsResponses, JourneyStatus, JourneysUpdateErrors, JourneysUpdateResponses, JsonObject, JsonValue, MailboxActionId, MailboxChannel, MailboxDraftId, MailboxEndpointId, MailboxesAddThreadLabelsErrors, MailboxesAddThreadLabelsResponses, MailboxesApproveActionErrors, MailboxesApproveActionResponses, MailboxesCancelActionErrors, MailboxesCancelActionResponses, MailboxesCopyMessageAttachmentErrors, MailboxesCopyMessageAttachmentResponses, MailboxesCreateDraftErrors, MailboxesCreateDraftResponses, MailboxesCreateEndpointErrors, MailboxesCreateEndpointResponses, MailboxesCreateErrors, MailboxesCreateGrantErrors, MailboxesCreateGrantResponses, MailboxesCreateLabelErrors, MailboxesCreateLabelResponses, MailboxesCreateNoteErrors, MailboxesCreateNoteResponses, MailboxesCreatePolicyErrors, MailboxesCreatePolicyResponses, MailboxesCreateResponses, MailboxesDeleteDraftErrors, MailboxesDeleteDraftResponses, MailboxesDeleteLabelErrors, MailboxesDeleteLabelResponses, MailboxesDeleteNoteErrors, MailboxesDeleteNoteResponses, MailboxesDeletePolicyErrors, MailboxesDeletePolicyResponses, MailboxesDenyActionErrors, MailboxesDenyActionResponses, MailboxesDiscardMessageErrors, MailboxesDiscardMessageResponses, MailboxesForwardErrors, MailboxesForwardResponses, MailboxesGetActionErrors, MailboxesGetActionResponses, MailboxesGetAgentActivityErrors, MailboxesGetAgentActivityResponses, MailboxesGetDraftErrors, MailboxesGetDraftResponses, MailboxesGetErrors, MailboxesGetMessageAttachmentErrors, MailboxesGetMessageAttachmentResponses, MailboxesGetMessageErrors, MailboxesGetMessageRawErrors, MailboxesGetMessageRawResponses, MailboxesGetMessageResponses, MailboxesGetPolicyErrors, MailboxesGetPolicyResponses, MailboxesGetResponses, MailboxesGetThreadContentErrors, MailboxesGetThreadContentResponses, MailboxesGetThreadErrors, MailboxesGetThreadResponses, MailboxesListActionsErrors, MailboxesListActionsResponses, MailboxesListDraftsErrors, MailboxesListDraftsResponses, MailboxesListErrors, MailboxesListEventsErrors, MailboxesListEventsResponses, MailboxesListFoldersErrors, MailboxesListFoldersResponses, MailboxesListGrantsErrors, MailboxesListGrantsResponses, MailboxesListLabelsErrors, MailboxesListLabelsResponses, MailboxesListPoliciesErrors, MailboxesListPoliciesResponses, MailboxesListQuarantineErrors, MailboxesListQuarantineResponses, MailboxesListResponses, MailboxesListThreadMessagesErrors, MailboxesListThreadMessagesResponses, MailboxesListThreadNotesErrors, MailboxesListThreadNotesResponses, MailboxesListThreadsErrors, MailboxesListThreadsResponses, MailboxesPauseErrors, MailboxesPauseResponses, MailboxesReleaseMessageErrors, MailboxesReleaseMessageResponses, MailboxesRemoveEndpointErrors, MailboxesRemoveEndpointResponses, MailboxesRemoveErrors, MailboxesRemoveResponses, MailboxesRemoveThreadLabelsErrors, MailboxesRemoveThreadLabelsResponses, MailboxesReplyAllErrors, MailboxesReplyAllResponses, MailboxesReplyErrors, MailboxesReplyResponses, MailboxesResumeErrors, MailboxesResumeResponses, MailboxesRetryActionErrors, MailboxesRetryActionResponses, MailboxesRevokeGrantErrors, MailboxesRevokeGrantResponses, MailboxesSendDraftErrors, MailboxesSendDraftResponses, MailboxesSendMessageErrors, MailboxesSendMessageResponses, MailboxesUpdateDraftErrors, MailboxesUpdateDraftResponses, MailboxesUpdateEndpointErrors, MailboxesUpdateEndpointResponses, MailboxesUpdateErrors, MailboxesUpdateGrantErrors, MailboxesUpdateGrantResponses, MailboxesUpdateLabelErrors, MailboxesUpdateLabelResponses, MailboxesUpdateNoteErrors, MailboxesUpdateNoteResponses, MailboxesUpdatePolicyErrors, MailboxesUpdatePolicyResponses, MailboxesUpdateResponses, MailboxesUpdateThreadErrors, MailboxesUpdateThreadResponses, MailboxGrantId, MailboxGrantRole, MailboxId, MailboxLabelId, MailboxMetadata, MailboxMetadataPatch, MailboxNoteId, MailboxPolicyId, MailboxPolicyOutcomeKind, MailboxSendMode, MailboxThreadFolder, MailboxThreadId, MailboxThreadPriority, MediaCompleteErrors, MediaCompleteResponses, MediaCreateErrors, MediaCreateResponses, MediaDownloadUrlErrors, MediaDownloadUrlResponses, MediaGetByIdErrors, MediaGetByIdResponses, MediaId, MediaRemoveErrors, MediaRemoveResponses, MessageId, MessageMetadata, MessagesGetContentErrors, MessagesGetContentResponses, MessagesGetEmailErrors, MessagesGetEmailResponses, MessagesGetErrors, MessagesGetEventsErrors, MessagesGetEventsResponses, MessagesGetResponses, MessagesGetStatusErrors, MessagesGetStatusResponses, MessagesListDeliveriesErrors, MessagesListDeliveriesResponses, MessagesListErrors, MessagesListResponses, MessagesRemoveErrors, MessagesRemoveResponses, MessagesSendErrors, MessagesSendResponses, MessagesValidateEmailErrors, MessagesValidateEmailResponses, NamespaceId, NamespaceMetadata, NamespacesCreateErrors, NamespacesCreateResponses, NamespacesGetErrors, NamespacesGetResponses, NamespacesListErrors, NamespacesListResponses, NamespacesRemoveErrors, NamespacesRemoveResponses, NamespacesUpdateErrors, NamespacesUpdateResponses, OperationId, OperationsGetErrors, OperationsGetResponses, OperationsListErrors, OperationsListResponses, OperationsRetryErrors, OperationsRetryResponses, OrganizationsCreateErrors, OrganizationsCreateResponses, OrganizationsDeleteErrors, OrganizationsDeleteResponses, OrganizationsGetErrors, OrganizationsGetProfileErrors, OrganizationsGetProfileResponses, OrganizationsGetResponses, OrganizationsGetTrustTierErrors, OrganizationsGetTrustTierResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, RenderLocale, RenderTimeZone, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, ScheduledMessagesResumeErrors, ScheduledMessagesResumeResponses, SubscriptionsSubscribeErrors, SubscriptionsSubscribeResponses, SuppressionId, TemplateFamilyId, TemplateFromDefault, TemplateId, TemplateInputContractId, TemplateProjectId, TemplatePublicationId, TemplatesAddEntryErrors, TemplatesAddEntryResponses, 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, TemplatesListErrors, TemplatesListFamiliesErrors, TemplatesListFamiliesResponses, TemplatesListInputContractsErrors, TemplatesListInputContractsResponses, TemplatesListResponses, TemplatesOpenWorkspaceErrors, TemplatesOpenWorkspaceResponses, TemplatesPatchWorkspaceErrors, TemplatesPatchWorkspaceResponses, TemplatesPublishErrors, TemplatesPublishResponses, TemplatesPutWorkspaceAssetErrors, TemplatesPutWorkspaceAssetResponses, TemplatesRemoveErrors, TemplatesRemoveResponses, TemplatesRemoveWorkspaceResourceErrors, TemplatesRemoveWorkspaceResourceResponses, TemplatesRenameFamilyErrors, TemplatesRenameFamilyResponses, TemplatesRenderPublicationErrors, TemplatesRenderPublicationResponses, TemplatesRenderWorkspaceFixtureErrors, TemplatesRenderWorkspaceFixtureResponses, TemplatesResolveWorkspaceConflictErrors, TemplatesResolveWorkspaceConflictResponses, TemplatesRestoreWorkspaceErrors, TemplatesRestoreWorkspaceResponses, TemplatesSaveWorkspaceErrors, TemplatesSaveWorkspaceResponses, TemplatesUpdateErrors, TemplatesUpdateResponses, TemplatesWorkspaceHistoryErrors, TemplatesWorkspaceHistoryResponses, TrackingRecipientEmail, UnsubscribeAddEmailsErrors, UnsubscribeAddEmailsResponses, UnsubscribeCheckSubscriptionErrors, UnsubscribeCheckSubscriptionResponses, UnsubscribeCreateErrors, UnsubscribeCreateResponses, UnsubscribeId, UnsubscribeListErrors, UnsubscribeListMembersErrors, UnsubscribeListMembersResponses, UnsubscribeListResponses, UnsubscribeRemoveEmailsErrors, UnsubscribeRemoveEmailsResponses, UnsubscribeRemoveErrors, UnsubscribeRemoveResponses, UnsubscribeSetDefaultErrors, UnsubscribeSetDefaultResponses, UnsubscribeUpdateErrors, UnsubscribeUpdateResponses, UserId, VersionCursor, WebhookDeliveryId, WebhookEndpointId, WebhooksCreateErrors, WebhooksCreateResponses, WebhooksGetErrors, WebhooksGetLogsErrors, WebhooksGetLogsResponses, WebhooksGetResponses, WebhooksGetStatsErrors, WebhooksGetStatsResponses, WebhooksListErrors, WebhooksListResponses, WebhooksRegenerateSecretErrors, WebhooksRegenerateSecretResponses, WebhooksRemoveErrors, WebhooksRemoveResponses, WebhooksRetryDeliveryErrors, WebhooksRetryDeliveryResponses, WebhooksTestErrors, WebhooksTestResponses, WebhooksUpdateErrors, WebhooksUpdateResponses, WhoamiGetErrors, WhoamiGetResponses } 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
|
|
@@ -38,7 +38,14 @@ export declare class Messages {
|
|
|
38
38
|
*/
|
|
39
39
|
static send<ThrowOnError extends boolean = false>(parameters: {
|
|
40
40
|
"idempotency-key"?: string | null | undefined;
|
|
41
|
-
|
|
41
|
+
conversationId?: ConversationId | null | null | undefined;
|
|
42
|
+
metadata?: MessageMetadata | undefined;
|
|
43
|
+
channel: "email";
|
|
44
|
+
to: EmailRecipients;
|
|
45
|
+
cc?: EmailCcRecipients | undefined;
|
|
46
|
+
bcc?: EmailBccRecipients | undefined;
|
|
47
|
+
from?: EmailSender | undefined;
|
|
48
|
+
email: EmailContent;
|
|
42
49
|
}, options?: Options<never, ThrowOnError>): RequestResult<MessagesSendResponses, MessagesSendErrors, ThrowOnError>;
|
|
43
50
|
/**
|
|
44
51
|
* Delete a message
|
|
@@ -513,28 +520,11 @@ export declare class Email {
|
|
|
513
520
|
/**
|
|
514
521
|
* Set the default sending domain
|
|
515
522
|
*
|
|
516
|
-
* Marks a verified domain as the organization's default sending domain, atomically clearing any previous default.
|
|
523
|
+
* Marks a verified domain as the organization's default sending domain, atomically clearing any previous default. Provisioning and inbound routing prefer the default domain when several apply. It does not choose the `from` of omitted-`from` sends; those use the organization default sender.
|
|
517
524
|
*/
|
|
518
525
|
static setDefaultDomain<ThrowOnError extends boolean = false>(parameters: {
|
|
519
526
|
id: EmailDomainId;
|
|
520
527
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailSetDefaultDomainResponses, EmailSetDefaultDomainErrors, ThrowOnError>;
|
|
521
|
-
/**
|
|
522
|
-
* Clear a domain's default sender
|
|
523
|
-
*
|
|
524
|
-
* Removes the domain's default sender so omitted-`from` sends fall through to the organization default sender.
|
|
525
|
-
*/
|
|
526
|
-
static clearDomainDefaultSender<ThrowOnError extends boolean = false>(parameters: {
|
|
527
|
-
id: EmailDomainId;
|
|
528
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<EmailClearDomainDefaultSenderResponses, EmailClearDomainDefaultSenderErrors, ThrowOnError>;
|
|
529
|
-
/**
|
|
530
|
-
* Set a domain's default sender
|
|
531
|
-
*
|
|
532
|
-
* Sets the default sender used for omitted-`from` sends from this domain. The sender must belong to the domain and be verified and active.
|
|
533
|
-
*/
|
|
534
|
-
static setDomainDefaultSender<ThrowOnError extends boolean = false>(parameters: {
|
|
535
|
-
id: EmailDomainId;
|
|
536
|
-
senderId: EmailSenderId;
|
|
537
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<EmailSetDomainDefaultSenderResponses, EmailSetDomainDefaultSenderErrors, ThrowOnError>;
|
|
538
528
|
/**
|
|
539
529
|
* Update a domain's send-settings config
|
|
540
530
|
*
|
|
@@ -660,7 +650,7 @@ export declare class Email {
|
|
|
660
650
|
/**
|
|
661
651
|
* Set the organization default sender
|
|
662
652
|
*
|
|
663
|
-
* Marks a verified, active sender as the organization default, atomically clearing any previous default.
|
|
653
|
+
* Marks a verified, active sender as the organization default, atomically clearing any previous default. Omitted-`from` sends use it when neither the request nor the template names a `from`; with no default, the organization's sole verified sender is used.
|
|
664
654
|
*/
|
|
665
655
|
static setDefaultSender<ThrowOnError extends boolean = false>(parameters: {
|
|
666
656
|
id: EmailSenderId;
|
|
@@ -1423,6 +1413,177 @@ export declare class Contacts {
|
|
|
1423
1413
|
export declare class Contacts2 {
|
|
1424
1414
|
static contacts: typeof Contacts;
|
|
1425
1415
|
}
|
|
1416
|
+
export declare class Events {
|
|
1417
|
+
/**
|
|
1418
|
+
* Record a contact event
|
|
1419
|
+
*
|
|
1420
|
+
* Records a custom contact event. Identify the contact by exactly one ID, external ID, or email. A missing email or external ID creates a contact; an unknown contact ID returns 404. An organization-scoped idempotency key replays the original event. Event names use letters, digits, underscores, hyphens, and dots, up to 255 characters; contact. and samva. prefixes are reserved. Properties allow at most 50 keys and 32 KiB of UTF-8 JSON. Events are retained for 90 days.
|
|
1421
|
+
*/
|
|
1422
|
+
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1423
|
+
contact: ContactEventReference;
|
|
1424
|
+
name: string;
|
|
1425
|
+
properties?: JsonObject | null | undefined;
|
|
1426
|
+
occurredAt?: string | null | undefined;
|
|
1427
|
+
idempotencyKey?: string | null | undefined;
|
|
1428
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EventsCreateResponses, EventsCreateErrors, ThrowOnError>;
|
|
1429
|
+
/**
|
|
1430
|
+
* Record contact events in a batch
|
|
1431
|
+
*
|
|
1432
|
+
* Validates the full request shape, contact references, and event names before processing. A schema failure rejects the entire batch without writes. Between 1 and 100 valid entries are then processed in input order, with independent indexed results for properties limits, contact resolution, and idempotency.
|
|
1433
|
+
*/
|
|
1434
|
+
static batch<ThrowOnError extends boolean = false>(parameters: {
|
|
1435
|
+
events: [CreateEventPayload];
|
|
1436
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EventsBatchResponses, EventsBatchErrors, ThrowOnError>;
|
|
1437
|
+
}
|
|
1438
|
+
export declare class Events2 {
|
|
1439
|
+
static events: typeof Events;
|
|
1440
|
+
}
|
|
1441
|
+
export declare class ContactEvents {
|
|
1442
|
+
/**
|
|
1443
|
+
* List contact events
|
|
1444
|
+
*
|
|
1445
|
+
* Returns custom and Samva lifecycle events, newest occurrence first, within the 90-day retention window. Pass nextCursor back as cursor for the next page.
|
|
1446
|
+
*/
|
|
1447
|
+
static listEvents<ThrowOnError extends boolean = false>(parameters: {
|
|
1448
|
+
id: ContactId;
|
|
1449
|
+
limit?: string | null | undefined;
|
|
1450
|
+
cursor?: Cursor | null | undefined;
|
|
1451
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactEventsListEventsResponses, ContactEventsListEventsErrors, ThrowOnError>;
|
|
1452
|
+
}
|
|
1453
|
+
export declare class ContactEvents2 {
|
|
1454
|
+
static contactEvents: typeof ContactEvents;
|
|
1455
|
+
}
|
|
1456
|
+
export declare class Journeys {
|
|
1457
|
+
/**
|
|
1458
|
+
* List journeys
|
|
1459
|
+
*
|
|
1460
|
+
* Returns the organization's journeys, newest first, optionally filtered by status. Pass nextCursor back as cursor for the next page.
|
|
1461
|
+
*/
|
|
1462
|
+
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1463
|
+
status?: JourneyStatus | null | undefined;
|
|
1464
|
+
limit?: string | null | undefined;
|
|
1465
|
+
cursor?: Cursor | null | undefined;
|
|
1466
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysListResponses, JourneysListErrors, ThrowOnError>;
|
|
1467
|
+
/**
|
|
1468
|
+
* Create a journey
|
|
1469
|
+
*
|
|
1470
|
+
* Creates a draft journey from a definition: a trigger, a root node, and a graph of at most 200 nodes that is acyclic and fully reachable. Templates, senders, and groups the definition names must belong to the organization. Requires a plan that includes journeys.
|
|
1471
|
+
*/
|
|
1472
|
+
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1473
|
+
name: JourneyName;
|
|
1474
|
+
definition: JourneyDefinition;
|
|
1475
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysCreateResponses, JourneysCreateErrors, ThrowOnError>;
|
|
1476
|
+
/**
|
|
1477
|
+
* Delete a journey
|
|
1478
|
+
*
|
|
1479
|
+
* Deletes a journey that was never published or is archived, with its versions and runs. An active or paused journey returns 409; archive it first.
|
|
1480
|
+
*/
|
|
1481
|
+
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
1482
|
+
id: JourneyId;
|
|
1483
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysRemoveResponses, JourneysRemoveErrors, ThrowOnError>;
|
|
1484
|
+
/**
|
|
1485
|
+
* Get a journey
|
|
1486
|
+
*
|
|
1487
|
+
* Returns a journey with its draft definition, its current revision, and its newest published version number.
|
|
1488
|
+
*/
|
|
1489
|
+
static get<ThrowOnError extends boolean = false>(parameters: {
|
|
1490
|
+
id: JourneyId;
|
|
1491
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysGetResponses, JourneysGetErrors, ThrowOnError>;
|
|
1492
|
+
/**
|
|
1493
|
+
* Rename a journey
|
|
1494
|
+
*
|
|
1495
|
+
* Renames a journey.
|
|
1496
|
+
*/
|
|
1497
|
+
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
1498
|
+
id: JourneyId;
|
|
1499
|
+
name: JourneyName;
|
|
1500
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysUpdateResponses, JourneysUpdateErrors, ThrowOnError>;
|
|
1501
|
+
/**
|
|
1502
|
+
* Replace a journey draft
|
|
1503
|
+
*
|
|
1504
|
+
* Replaces the draft definition and returns the journey with a new revision. The request names the revision it read; a stale revision returns 409. Published versions and the runs on them do not change.
|
|
1505
|
+
*/
|
|
1506
|
+
static replaceDraft<ThrowOnError extends boolean = false>(parameters: {
|
|
1507
|
+
id: JourneyId;
|
|
1508
|
+
revision: string;
|
|
1509
|
+
definition: JourneyDefinition;
|
|
1510
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysReplaceDraftResponses, JourneysReplaceDraftErrors, ThrowOnError>;
|
|
1511
|
+
/**
|
|
1512
|
+
* Publish a journey
|
|
1513
|
+
*
|
|
1514
|
+
* Publishes the draft as the next immutable version; new runs start on it and existing runs stay on the version they entered. The request names the revision it read; a stale revision returns 409. Publishing a draft identical to the newest version changes nothing. A draft journey becomes active; a paused journey stays paused. A published version sends and updates tags as its publisher, so a draft with a send_email node requires a key that can send email and one with an update_tags node requires contacts:update; without them the request returns 403.
|
|
1515
|
+
*/
|
|
1516
|
+
static publish<ThrowOnError extends boolean = false>(parameters: {
|
|
1517
|
+
id: JourneyId;
|
|
1518
|
+
revision: string;
|
|
1519
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysPublishResponses, JourneysPublishErrors, ThrowOnError>;
|
|
1520
|
+
/**
|
|
1521
|
+
* Pause a journey
|
|
1522
|
+
*
|
|
1523
|
+
* Stops new enrollment and holds every live run before its next node, including a run whose wait ends while the journey is paused. Held runs report status paused.
|
|
1524
|
+
*/
|
|
1525
|
+
static pause<ThrowOnError extends boolean = false>(parameters: {
|
|
1526
|
+
id: JourneyId;
|
|
1527
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysPauseResponses, JourneysPauseErrors, ThrowOnError>;
|
|
1528
|
+
/**
|
|
1529
|
+
* Resume a journey
|
|
1530
|
+
*
|
|
1531
|
+
* Resumes enrollment and continues the runs the pause held. Requires a plan that includes journeys.
|
|
1532
|
+
*/
|
|
1533
|
+
static resume<ThrowOnError extends boolean = false>(parameters: {
|
|
1534
|
+
id: JourneyId;
|
|
1535
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysResumeResponses, JourneysResumeErrors, ThrowOnError>;
|
|
1536
|
+
/**
|
|
1537
|
+
* Archive a journey
|
|
1538
|
+
*
|
|
1539
|
+
* Stops new enrollment for good and exits every live run with exit reason archived. An archived journey cannot be edited, published, or resumed.
|
|
1540
|
+
*/
|
|
1541
|
+
static archive<ThrowOnError extends boolean = false>(parameters: {
|
|
1542
|
+
id: JourneyId;
|
|
1543
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysArchiveResponses, JourneysArchiveErrors, ThrowOnError>;
|
|
1544
|
+
/**
|
|
1545
|
+
* Get a published journey version
|
|
1546
|
+
*
|
|
1547
|
+
* Returns the immutable definition of one published version.
|
|
1548
|
+
*/
|
|
1549
|
+
static getVersion<ThrowOnError extends boolean = false>(parameters: {
|
|
1550
|
+
id: JourneyId;
|
|
1551
|
+
version: string;
|
|
1552
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysGetVersionResponses, JourneysGetVersionErrors, ThrowOnError>;
|
|
1553
|
+
/**
|
|
1554
|
+
* Get journey run counts
|
|
1555
|
+
*
|
|
1556
|
+
* Counts one published version's runs by status, and per node the live runs there now and the runs that have entered it. Defaults to the newest published version.
|
|
1557
|
+
*/
|
|
1558
|
+
static stats<ThrowOnError extends boolean = false>(parameters: {
|
|
1559
|
+
id: JourneyId;
|
|
1560
|
+
version?: string | null | undefined;
|
|
1561
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysStatsResponses, JourneysStatsErrors, ThrowOnError>;
|
|
1562
|
+
/**
|
|
1563
|
+
* List journey runs
|
|
1564
|
+
*
|
|
1565
|
+
* Returns a journey's runs, newest first, optionally filtered by status or contact. Pass nextCursor back as cursor for the next page.
|
|
1566
|
+
*/
|
|
1567
|
+
static listRuns<ThrowOnError extends boolean = false>(parameters: {
|
|
1568
|
+
id: JourneyId;
|
|
1569
|
+
status?: JourneyRunStatus | null | undefined;
|
|
1570
|
+
contactId?: ContactId | null | undefined;
|
|
1571
|
+
limit?: string | null | undefined;
|
|
1572
|
+
cursor?: Cursor | null | undefined;
|
|
1573
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysListRunsResponses, JourneysListRunsErrors, ThrowOnError>;
|
|
1574
|
+
/**
|
|
1575
|
+
* Get a journey run
|
|
1576
|
+
*
|
|
1577
|
+
* Returns one run with every node it entered, in order: when it entered and left, how it left, and the message a send node created.
|
|
1578
|
+
*/
|
|
1579
|
+
static getRun<ThrowOnError extends boolean = false>(parameters: {
|
|
1580
|
+
id: JourneyId;
|
|
1581
|
+
runId: JourneyRunId;
|
|
1582
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysGetRunResponses, JourneysGetRunErrors, ThrowOnError>;
|
|
1583
|
+
}
|
|
1584
|
+
export declare class Journeys2 {
|
|
1585
|
+
static journeys: typeof Journeys;
|
|
1586
|
+
}
|
|
1426
1587
|
export declare class Subscriptions {
|
|
1427
1588
|
/**
|
|
1428
1589
|
* Request subscription confirmation
|
|
@@ -2205,7 +2366,7 @@ export declare class Webhooks {
|
|
|
2205
2366
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
2206
2367
|
name: string;
|
|
2207
2368
|
url: string;
|
|
2208
|
-
eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded">;
|
|
2369
|
+
eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded" | "journey.webhook">;
|
|
2209
2370
|
channels?: Array<"email"> | null | undefined;
|
|
2210
2371
|
mailboxIds?: [MailboxId] | null | undefined;
|
|
2211
2372
|
namespaceId?: NamespaceId | null | undefined;
|
|
@@ -2239,7 +2400,7 @@ export declare class Webhooks {
|
|
|
2239
2400
|
id: WebhookEndpointId;
|
|
2240
2401
|
name?: string | null | undefined;
|
|
2241
2402
|
url?: string | null | undefined;
|
|
2242
|
-
eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded"> | null | undefined;
|
|
2403
|
+
eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded" | "journey.webhook"> | null | undefined;
|
|
2243
2404
|
channels?: Array<"email"> | null | null | undefined;
|
|
2244
2405
|
mailboxIds?: [MailboxId] | null | null | undefined;
|
|
2245
2406
|
namespaceId?: NamespaceId | null | null | undefined;
|
|
@@ -2463,11 +2624,22 @@ export declare class Feedback {
|
|
|
2463
2624
|
export declare class Feedback2 {
|
|
2464
2625
|
static feedback: typeof Feedback;
|
|
2465
2626
|
}
|
|
2627
|
+
export declare class Whoami {
|
|
2628
|
+
/**
|
|
2629
|
+
* Get the calling credential
|
|
2630
|
+
*
|
|
2631
|
+
* Returns the organization the request acts in and the credential it presents: an API key with its name, prefix, and access, or a signed-in user with their role. Any valid credential may call it, whatever its grants.
|
|
2632
|
+
*/
|
|
2633
|
+
static get<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<WhoamiGetResponses, WhoamiGetErrors, ThrowOnError>;
|
|
2634
|
+
}
|
|
2635
|
+
export declare class Whoami2 {
|
|
2636
|
+
static whoami: typeof Whoami;
|
|
2637
|
+
}
|
|
2466
2638
|
export declare class Mailboxes {
|
|
2467
2639
|
/**
|
|
2468
2640
|
* List mailboxes
|
|
2469
2641
|
*
|
|
2470
|
-
* Returns summaries of the mailboxes the caller can read, newest first, filterable by creation time (`after`, `before`). Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Read a mailbox's
|
|
2642
|
+
* Returns summaries of the mailboxes the caller can read, newest first, filterable by creation time (`after`, `before`). Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Read a mailbox's endpoints and metadata with `GET /v1/mailboxes/{id}`.
|
|
2471
2643
|
*/
|
|
2472
2644
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2473
2645
|
limit?: string | null | undefined;
|
|
@@ -2478,11 +2650,11 @@ export declare class Mailboxes {
|
|
|
2478
2650
|
/**
|
|
2479
2651
|
* Create a mailbox
|
|
2480
2652
|
*
|
|
2481
|
-
* Creates a mailbox with one
|
|
2653
|
+
* Creates a mailbox with one endpoint and returns it with status 201; the caller gets an admin grant on it. Email is the channel a mailbox endpoint uses today; another channel is refused (422). An email endpoint's address must be under the organization's Samva-hosted mail domain or a verified domain with receiving enabled, and the mailbox sends from it. The slug defaults to the address's local part. Pass `slug` when that is taken or not a valid slug. The mailbox receives mail from now on; mail that arrived earlier is not added to it. Conflicts if the address or slug is already in use. Returns 402 when the organization is at its plan's mailbox allowance or at its mailbox storage allowance; incoming mail is still received past the storage allowance.
|
|
2482
2654
|
*/
|
|
2483
2655
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
2484
2656
|
namespaceId?: NamespaceId | null | undefined;
|
|
2485
|
-
|
|
2657
|
+
endpoint: CreateMailboxEndpointPayload;
|
|
2486
2658
|
name: string;
|
|
2487
2659
|
slug?: string | null | undefined;
|
|
2488
2660
|
metadata?: MailboxMetadata | null | undefined;
|
|
@@ -2490,7 +2662,7 @@ export declare class Mailboxes {
|
|
|
2490
2662
|
/**
|
|
2491
2663
|
* Delete a mailbox
|
|
2492
2664
|
*
|
|
2493
|
-
* Deletes a mailbox with its
|
|
2665
|
+
* Deletes a mailbox with its endpoints, threads, drafts, and history. The messages it received stay with the organization. The mailbox leaves every API key scope and webhook endpoint filter that named it; a key or endpoint left with no mailbox is disabled.
|
|
2494
2666
|
*/
|
|
2495
2667
|
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
2496
2668
|
id: MailboxId;
|
|
@@ -2498,7 +2670,7 @@ export declare class Mailboxes {
|
|
|
2498
2670
|
/**
|
|
2499
2671
|
* Get a mailbox
|
|
2500
2672
|
*
|
|
2501
|
-
* Returns a mailbox with its
|
|
2673
|
+
* Returns a mailbox with its endpoints and metadata; each endpoint says whether it is the mailbox's default on its channel. Its grants are `GET /v1/mailboxes/{id}/grants` and its send policies `GET /v1/mailboxes/{id}/policies`.
|
|
2502
2674
|
*/
|
|
2503
2675
|
static get<ThrowOnError extends boolean = false>(parameters: {
|
|
2504
2676
|
id: MailboxId;
|
|
@@ -2506,36 +2678,44 @@ export declare class Mailboxes {
|
|
|
2506
2678
|
/**
|
|
2507
2679
|
* Update a mailbox
|
|
2508
2680
|
*
|
|
2509
|
-
* Updates the fields you name and keeps the rest. `metadata` merges into the stored metadata by key, and a `null` value deletes that key.
|
|
2681
|
+
* Updates the fields you name and keeps the rest. `metadata` merges into the stored metadata by key, and a `null` value deletes that key. Change an endpoint's sender name or default with `PATCH /v1/mailboxes/{id}/endpoints/{endpointId}`.
|
|
2510
2682
|
*/
|
|
2511
2683
|
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
2512
2684
|
id: MailboxId;
|
|
2513
2685
|
name?: string | null | undefined;
|
|
2514
2686
|
metadata?: MailboxMetadataPatch | null | undefined;
|
|
2515
|
-
defaultFrom?: {
|
|
2516
|
-
address: string;
|
|
2517
|
-
displayName?: string | null | null | undefined;
|
|
2518
|
-
} | null | undefined;
|
|
2519
2687
|
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesUpdateResponses, MailboxesUpdateErrors, ThrowOnError>;
|
|
2520
2688
|
/**
|
|
2521
|
-
* Add an
|
|
2689
|
+
* Add an endpoint to a mailbox
|
|
2522
2690
|
*
|
|
2523
|
-
* Adds an
|
|
2691
|
+
* Adds an endpoint to a mailbox and returns the mailbox with status 201. It follows the same rules as the endpoint of a new mailbox: email is the channel a mailbox endpoint uses today (422 otherwise), the address must be under the organization's Samva-hosted mail domain or a verified domain with receiving enabled, and no mailbox may already hold it (409). Messages sent to it reach the mailbox from now on. It becomes the default on its channel only when the mailbox has no endpoint there yet.
|
|
2524
2692
|
*/
|
|
2525
|
-
static
|
|
2693
|
+
static createEndpoint<ThrowOnError extends boolean = false>(parameters: {
|
|
2526
2694
|
id: MailboxId;
|
|
2695
|
+
channel: MailboxChannel;
|
|
2527
2696
|
address: string;
|
|
2528
2697
|
displayName?: string | null | undefined;
|
|
2529
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
2698
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesCreateEndpointResponses, MailboxesCreateEndpointErrors, ThrowOnError>;
|
|
2699
|
+
/**
|
|
2700
|
+
* Remove an endpoint from a mailbox
|
|
2701
|
+
*
|
|
2702
|
+
* Removes an endpoint from a mailbox and returns the mailbox. Messages sent to it stop reaching the mailbox; its existing threads and messages stay, and replies in them leave from the mailbox's default endpoint on their channel. A mailbox keeps at least one endpoint, so removing the last one is refused (422). When the removed endpoint was the default on its channel, the oldest remaining endpoint there becomes the default.
|
|
2703
|
+
*/
|
|
2704
|
+
static removeEndpoint<ThrowOnError extends boolean = false>(parameters: {
|
|
2705
|
+
id: MailboxId;
|
|
2706
|
+
endpointId: MailboxEndpointId;
|
|
2707
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesRemoveEndpointResponses, MailboxesRemoveEndpointErrors, ThrowOnError>;
|
|
2530
2708
|
/**
|
|
2531
|
-
*
|
|
2709
|
+
* Update a mailbox endpoint
|
|
2532
2710
|
*
|
|
2533
|
-
*
|
|
2711
|
+
* Updates the fields you name and keeps the rest, and returns the mailbox. `displayName` is the name messages sent from the endpoint carry; null falls back to the mailbox's name. `default: true` makes the endpoint the one the mailbox starts new conversations from on its channel; replies always leave from the endpoint of their thread.
|
|
2534
2712
|
*/
|
|
2535
|
-
static
|
|
2713
|
+
static updateEndpoint<ThrowOnError extends boolean = false>(parameters: {
|
|
2536
2714
|
id: MailboxId;
|
|
2537
|
-
|
|
2538
|
-
|
|
2715
|
+
endpointId: MailboxEndpointId;
|
|
2716
|
+
displayName?: string | null | null | undefined;
|
|
2717
|
+
default?: true | null | undefined;
|
|
2718
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesUpdateEndpointResponses, MailboxesUpdateEndpointErrors, ThrowOnError>;
|
|
2539
2719
|
/**
|
|
2540
2720
|
* Pause a mailbox
|
|
2541
2721
|
*
|
|
@@ -2833,11 +3013,12 @@ export declare class Mailboxes {
|
|
|
2833
3013
|
/**
|
|
2834
3014
|
* Send a new message
|
|
2835
3015
|
*
|
|
2836
|
-
* Records a send action and returns 202 with its current receipt and a Location for action status. An installation, grant, or policy may require approval; otherwise the send is queued. Observe the same action through acceptance and mailbox completion. A policy refusal returns 403 with the recorded receipt.
|
|
3016
|
+
* Starts a new conversation from the mailbox's default endpoint on the channel the body names (email when omitted); a channel the mailbox cannot send on yet is refused (422). Records a send action and returns 202 with its current receipt and a Location for action status. An installation, grant, or policy may require approval; otherwise the send is queued. Observe the same action through acceptance and mailbox completion. A policy refusal returns 403 with the recorded receipt.
|
|
2837
3017
|
*/
|
|
2838
3018
|
static sendMessage<ThrowOnError extends boolean = false>(parameters: {
|
|
2839
3019
|
"idempotency-key"?: string | null | undefined;
|
|
2840
3020
|
id: MailboxId;
|
|
3021
|
+
channel?: "email" | null | undefined;
|
|
2841
3022
|
to: [string];
|
|
2842
3023
|
cc?: Array<string> | null | undefined;
|
|
2843
3024
|
bcc?: Array<string> | null | undefined;
|
|
@@ -2850,7 +3031,7 @@ export declare class Mailboxes {
|
|
|
2850
3031
|
/**
|
|
2851
3032
|
* Get a mailbox message
|
|
2852
3033
|
*
|
|
2853
|
-
* Returns a message in the mailbox
|
|
3034
|
+
* Returns a message in the mailbox, discriminated by `channel`. An email has its text, sanitized HTML, `replyText` (what the sender wrote, without quoted history), authentication verdicts, and attachments.
|
|
2854
3035
|
*/
|
|
2855
3036
|
static getMessage<ThrowOnError extends boolean = false>(parameters: {
|
|
2856
3037
|
id: MailboxId;
|
|
@@ -2888,12 +3069,13 @@ export declare class Mailboxes {
|
|
|
2888
3069
|
/**
|
|
2889
3070
|
* Reply to a message
|
|
2890
3071
|
*
|
|
2891
|
-
* Replies to the message's Reply-To address, or its sender, in the same thread. The server sets the recipients, subject, and threading headers.
|
|
3072
|
+
* Replies to the message's Reply-To address, or its sender, in the same thread and from the thread's endpoint. The server sets the recipients, subject, and threading headers. The body's `channel` must match the thread's.
|
|
2892
3073
|
*/
|
|
2893
3074
|
static reply<ThrowOnError extends boolean = false>(parameters: {
|
|
2894
3075
|
"idempotency-key"?: string | null | undefined;
|
|
2895
3076
|
id: MailboxId;
|
|
2896
3077
|
messageId: MessageId;
|
|
3078
|
+
channel?: "email" | null | undefined;
|
|
2897
3079
|
cc?: Array<string> | null | undefined;
|
|
2898
3080
|
bcc?: Array<string> | null | undefined;
|
|
2899
3081
|
text?: string | null | undefined;
|
|
@@ -2903,12 +3085,13 @@ export declare class Mailboxes {
|
|
|
2903
3085
|
/**
|
|
2904
3086
|
* Reply to all recipients of a message
|
|
2905
3087
|
*
|
|
2906
|
-
* Replies to the sender and every other recipient of the message except the mailbox itself, in the same thread.
|
|
3088
|
+
* Replies to the sender and every other recipient of the message except the mailbox itself, in the same thread and from the thread's endpoint.
|
|
2907
3089
|
*/
|
|
2908
3090
|
static replyAll<ThrowOnError extends boolean = false>(parameters: {
|
|
2909
3091
|
"idempotency-key"?: string | null | undefined;
|
|
2910
3092
|
id: MailboxId;
|
|
2911
3093
|
messageId: MessageId;
|
|
3094
|
+
channel?: "email" | null | undefined;
|
|
2912
3095
|
cc?: Array<string> | null | undefined;
|
|
2913
3096
|
bcc?: Array<string> | null | undefined;
|
|
2914
3097
|
text?: string | null | undefined;
|
|
@@ -2918,7 +3101,7 @@ export declare class Mailboxes {
|
|
|
2918
3101
|
/**
|
|
2919
3102
|
* Forward a message
|
|
2920
3103
|
*
|
|
2921
|
-
* Forwards
|
|
3104
|
+
* Forwards an email to new recipients as a new conversation from the thread's endpoint, with the original quoted below the caller's text and its attachments attached ahead of any the caller adds. The combined attachments must fit the email attachment limits.
|
|
2922
3105
|
*/
|
|
2923
3106
|
static forward<ThrowOnError extends boolean = false>(parameters: {
|
|
2924
3107
|
"idempotency-key"?: string | null | undefined;
|
|
@@ -2975,10 +3158,12 @@ export declare class Mailboxes {
|
|
|
2975
3158
|
/**
|
|
2976
3159
|
* Create a draft
|
|
2977
3160
|
*
|
|
2978
|
-
* Saves a draft of a new message, or of a reply when `inReplyToMessageId` names a message in the mailbox, and returns it with status 201. Send it with `POST /v1/mailboxes/{id}/drafts/{draftId}/send`.
|
|
3161
|
+
* Saves a draft of a new message, or of a reply when `inReplyToMessageId` names a message in the mailbox, and returns it with status 201. Email drafts are the kind a mailbox saves today; another channel is refused (422). Send it with `POST /v1/mailboxes/{id}/drafts/{draftId}/send`.
|
|
2979
3162
|
*/
|
|
2980
3163
|
static createDraft<ThrowOnError extends boolean = false>(parameters: {
|
|
2981
3164
|
id: MailboxId;
|
|
3165
|
+
channel?: "email" | null | undefined;
|
|
3166
|
+
endpointId?: MailboxEndpointId | null | undefined;
|
|
2982
3167
|
to?: Array<string> | null | undefined;
|
|
2983
3168
|
cc?: Array<string> | null | undefined;
|
|
2984
3169
|
bcc?: Array<string> | null | undefined;
|
|
@@ -3097,7 +3282,7 @@ export declare class Mailboxes {
|
|
|
3097
3282
|
/**
|
|
3098
3283
|
* List mailbox events
|
|
3099
3284
|
*
|
|
3100
|
-
* Returns mailbox audit records, newest first, filterable by when they happened (`after`, `before`). Audit event types: `mailbox.created`, `
|
|
3285
|
+
* Returns mailbox audit records, newest first, filterable by when they happened (`after`, `before`). Audit event types: `mailbox.created`, `endpoint.attached`, `endpoint.detached`, `message.received`, `message.released`, `message.sent`, `thread.created`, `action.proposed`, `action.policy_decided`, `action.approval_requested`, `action.approval_resolved`, `action.accepted`, `action.executed`, `action.failed`. Thread and draft changes have no dedicated audit event types. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
3101
3286
|
*/
|
|
3102
3287
|
static listEvents<ThrowOnError extends boolean = false>(parameters: {
|
|
3103
3288
|
id: MailboxId;
|