samva 0.5.0 → 0.6.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 +3 -2
- package/README.md +12 -2
- package/dist/{categories-B9Nw2v_F.js → categories-4u9Az4No.js} +24 -8
- package/dist/client/sdk.gen.d.ts +406 -74
- package/dist/client/types.gen.d.ts +2583 -279
- package/dist/{client-B7gEkvEq.js → client-DCM6U0-I.js} +2183 -772
- package/dist/{client-attribution-B2yJBXdZ.js → client-attribution-DYUSAa76.js} +2 -2
- package/dist/effect/analytics.d.ts +66 -0
- package/dist/effect/analytics.js +21 -0
- package/dist/effect/api-keys.d.ts +198 -34
- package/dist/effect/api-keys.js +1 -1
- package/dist/effect/attachments.d.ts +53 -0
- package/dist/effect/attachments.js +17 -0
- package/dist/effect/campaigns.d.ts +36 -18
- package/dist/effect/campaigns.js +1 -1
- package/dist/effect/categories.d.ts +3 -3
- package/dist/effect/categories.js +1 -1
- package/dist/effect/client.js +1 -1
- package/dist/effect/contact-groups.d.ts +375 -0
- package/dist/effect/contact-groups.js +29 -0
- package/dist/effect/contacts.d.ts +35 -19
- package/dist/effect/contacts.js +1 -1
- package/dist/effect/conversations.d.ts +179 -47
- package/dist/effect/conversations.js +1 -1
- package/dist/effect/custom-fields.d.ts +111 -0
- package/dist/effect/custom-fields.js +17 -0
- package/dist/effect/design.d.ts +2 -2
- package/dist/effect/design.js +1 -1
- package/dist/effect/email.d.ts +254 -118
- package/dist/effect/email.js +2 -2
- package/dist/effect/generated-metadata.d.ts +12 -4
- package/dist/effect/generated.d.ts +11189 -6155
- package/dist/effect/index.d.ts +6 -1
- package/dist/effect/index.js +8 -3
- package/dist/effect/internal/operation.d.ts +115 -27
- package/dist/effect/media.d.ts +5 -5
- package/dist/effect/media.js +1 -1
- package/dist/effect/messages.d.ts +303 -73
- package/dist/effect/messages.js +1 -1
- package/dist/effect/operations.d.ts +6 -6
- package/dist/effect/operations.js +1 -1
- package/dist/effect/organizations.d.ts +7 -110
- package/dist/effect/organizations.js +2 -4
- package/dist/effect/retry.js +1 -1
- package/dist/effect/scheduled-messages.d.ts +7 -7
- package/dist/effect/scheduled-messages.js +1 -1
- package/dist/effect/templates.d.ts +35 -307
- package/dist/effect/templates.js +3 -5
- package/dist/effect/unsubscribe-groups.d.ts +161 -0
- package/dist/effect/unsubscribe-groups.js +25 -0
- package/dist/effect/webhooks.d.ts +18 -18
- package/dist/effect/webhooks.js +2 -2
- package/dist/index.js +2 -2
- package/dist/{normalize-BiIJnycv.js → normalize-B79uJIeb.js} +13 -14
- package/dist/normalize.d.ts +3 -7
- package/dist/{operation-B4FjN6wq.js → operation-02YX3hY9.js} +96 -8
- package/dist/promises/errors.gen.d.ts +30 -41
- package/dist/promises/index.d.ts +18 -4
- package/dist/promises/index.js +2 -2
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/{promises-CP_nxUus.js → promises-8MaPNAam.js} +1209 -288
- package/dist/service-map.d.ts +155 -8
- package/package.json +28 -8
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, 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";
|
|
2
|
+
import type { ActorTracking, AnalyticsExportDataErrors, AnalyticsExportDataResponses, AnalyticsGetChannelStatsErrors, AnalyticsGetChannelStatsResponses, AnalyticsGetDeliveryMetricsErrors, AnalyticsGetDeliveryMetricsResponses, AnalyticsGetHourlyDistributionErrors, AnalyticsGetHourlyDistributionResponses, AnalyticsGetStatsErrors, AnalyticsGetStatsResponses, AnalyticsGetTopContactsErrors, AnalyticsGetTopContactsResponses, ApiKeyAccess, ApiKeyId, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRemoveErrors, ApiKeysRemoveResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, AttachmentId, AttachmentsDownloadUrlErrors, AttachmentsDownloadUrlResponses, AttachmentsGetByIdErrors, AttachmentsGetByIdResponses, AttachmentsListErrors, AttachmentsListResponses, AttachmentsRemoveErrors, AttachmentsRemoveResponses, 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, ContactGroupId, ContactGroupsAddMembersErrors, ContactGroupsAddMembersResponses, ContactGroupsCreateErrors, ContactGroupsCreateResponses, ContactGroupsEvaluateDynamicErrors, ContactGroupsEvaluateDynamicResponses, ContactGroupsGetByIdErrors, ContactGroupsGetByIdResponses, ContactGroupsGetMembersErrors, ContactGroupsGetMembersResponses, ContactGroupsListErrors, ContactGroupsListResponses, ContactGroupsPreviewErrors, ContactGroupsPreviewResponses, ContactGroupsRemoveErrors, ContactGroupsRemoveMembersErrors, ContactGroupsRemoveMembersResponses, ContactGroupsRemoveResponses, ContactGroupsUpdateErrors, ContactGroupsUpdateResponses, 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, CustomFieldDefinitionId, CustomFieldsCreateErrors, CustomFieldsCreateResponses, CustomFieldsListErrors, CustomFieldsListResponses, CustomFieldsRemoveErrors, CustomFieldsRemoveResponses, CustomFieldsUpdateErrors, CustomFieldsUpdateResponses, 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, 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, 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, UnsubscribeAddEmailsErrors, UnsubscribeAddEmailsResponses, UnsubscribeCheckSubscriptionErrors, UnsubscribeCheckSubscriptionResponses, UnsubscribeCreateErrors, UnsubscribeCreateResponses, UnsubscribeId, UnsubscribeListErrors, UnsubscribeListMembersErrors, UnsubscribeListMembersResponses, UnsubscribeListResponses, UnsubscribeRemoveEmailsErrors, UnsubscribeRemoveEmailsResponses, UnsubscribeRemoveErrors, UnsubscribeRemoveResponses, UnsubscribeUpdateErrors, UnsubscribeUpdateResponses, 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, with optional filters for channel, direction, status, conversation, contact, and date range.
|
|
20
|
+
* Returns a paginated list of messages, with optional filters for channel, direction, status, conversation, contact, sender address, and date range.
|
|
21
21
|
*/
|
|
22
22
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
23
23
|
page?: string | null | undefined;
|
|
@@ -27,13 +27,14 @@ export declare class Messages {
|
|
|
27
27
|
status?: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained" | null | undefined;
|
|
28
28
|
conversationId?: ConversationId | null | undefined;
|
|
29
29
|
contactId?: ContactId | null | undefined;
|
|
30
|
+
from?: string | null | undefined;
|
|
30
31
|
startDate?: string | null | undefined;
|
|
31
32
|
endDate?: string | null | undefined;
|
|
32
33
|
}, options?: Options<never, ThrowOnError>): RequestResult<MessagesListResponses, MessagesListErrors, ThrowOnError>;
|
|
33
34
|
/**
|
|
34
35
|
* Send a message
|
|
35
36
|
*
|
|
36
|
-
* Sends a message on the requested channel and returns the created message with a 201 Created status. `channel` selects the payload variant. Repeating an identical request with the same optional `Idempotency-Key` header returns the original message; reusing the key for different content returns a conflict.
|
|
37
|
+
* Sends a message on the requested channel and returns the created message with a 201 Created status. Requires `messages:create` or the send permission of the channel it sends on, such as `email:send`. `channel` selects the payload variant. Repeating an identical request with the same optional `Idempotency-Key` header returns the original message; reusing the key for different content returns a conflict.
|
|
37
38
|
*/
|
|
38
39
|
static send<ThrowOnError extends boolean = false>(parameters: {
|
|
39
40
|
"idempotency-key"?: string | null | undefined;
|
|
@@ -68,7 +69,7 @@ export declare class Messages {
|
|
|
68
69
|
/**
|
|
69
70
|
* Validate an email message
|
|
70
71
|
*
|
|
71
|
-
* Resolves recipients, sender, and inline or published-template content without
|
|
72
|
+
* Resolves recipients, sender, and inline or published-template content without sending anything, creating contacts or messages, or counting toward your quota.
|
|
72
73
|
*/
|
|
73
74
|
static validateEmail<ThrowOnError extends boolean = false>(parameters: {
|
|
74
75
|
conversationId?: ConversationId | null | null | undefined;
|
|
@@ -104,7 +105,7 @@ export declare class Operations {
|
|
|
104
105
|
/**
|
|
105
106
|
* List asynchronous operations
|
|
106
107
|
*
|
|
107
|
-
* Lists
|
|
108
|
+
* Lists asynchronous operations for the active organization.
|
|
108
109
|
*/
|
|
109
110
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
110
111
|
page?: string | null | undefined;
|
|
@@ -115,7 +116,7 @@ export declare class Operations {
|
|
|
115
116
|
/**
|
|
116
117
|
* Get an asynchronous operation
|
|
117
118
|
*
|
|
118
|
-
* Returns one
|
|
119
|
+
* Returns one asynchronous operation from the active organization.
|
|
119
120
|
*/
|
|
120
121
|
static get<ThrowOnError extends boolean = false>(parameters: {
|
|
121
122
|
operationId: OperationId;
|
|
@@ -123,7 +124,7 @@ export declare class Operations {
|
|
|
123
124
|
/**
|
|
124
125
|
* Retry an asynchronous operation
|
|
125
126
|
*
|
|
126
|
-
* Retries
|
|
127
|
+
* Retries a failed operation in place when its error is retryable. Retrying an organization deletion additionally requires `organization:delete`.
|
|
127
128
|
*/
|
|
128
129
|
static retry<ThrowOnError extends boolean = false>(parameters: {
|
|
129
130
|
operationId: OperationId;
|
|
@@ -146,7 +147,7 @@ export declare class ScheduledMessages {
|
|
|
146
147
|
/**
|
|
147
148
|
* Schedule a message
|
|
148
149
|
*
|
|
149
|
-
* Schedules a message for dispatch at the absolute ISO-8601 timestamp supplied in scheduledFor. Optional timezone is validated IANA display metadata only and never changes the execution instant.
|
|
150
|
+
* Schedules a message for dispatch at the absolute ISO-8601 timestamp supplied in scheduledFor. Requires `messages:create` or the send permission of the channel it sends on, such as `email:send`. Optional timezone is validated IANA display metadata only and never changes the execution instant.
|
|
150
151
|
*/
|
|
151
152
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
152
153
|
send: DispatchSendMessagePayload;
|
|
@@ -193,7 +194,7 @@ export declare class Campaigns {
|
|
|
193
194
|
/**
|
|
194
195
|
* List campaigns
|
|
195
196
|
*
|
|
196
|
-
* Returns a paginated list of the organization's campaigns, optionally filtered by status.
|
|
197
|
+
* Returns a paginated list of the organization's campaigns, optionally filtered by status. Each row carries `series`, the last 14 days of daily email sends the campaign produced, oldest first.
|
|
197
198
|
*/
|
|
198
199
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
199
200
|
status?: "draft" | "archived" | null | undefined;
|
|
@@ -291,7 +292,7 @@ export declare class Campaigns {
|
|
|
291
292
|
/**
|
|
292
293
|
* Cancel a campaign run
|
|
293
294
|
*
|
|
294
|
-
* Best-effort cancellation: pending recipients are skipped, while already
|
|
295
|
+
* Best-effort cancellation: pending recipients are skipped, while deliveries already handed off for sending may finish. Returns the updated run.
|
|
295
296
|
*/
|
|
296
297
|
static cancelRun<ThrowOnError extends boolean = false>(parameters: {
|
|
297
298
|
id: CampaignId;
|
|
@@ -317,13 +318,13 @@ export declare class Email {
|
|
|
317
318
|
/**
|
|
318
319
|
* Get email onboarding review status
|
|
319
320
|
*
|
|
320
|
-
* Returns the customer-safe
|
|
321
|
+
* Returns the customer-safe organization review decision, workflow stage, next action, and current sending-identity clearances. An organization that has not been reviewed yet is returned in the blocked initial state.
|
|
321
322
|
*/
|
|
322
323
|
static getOnboardingReview<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<EmailGetOnboardingReviewResponses, EmailGetOnboardingReviewErrors, ThrowOnError>;
|
|
323
324
|
/**
|
|
324
325
|
* Reapply for email onboarding review
|
|
325
326
|
*
|
|
326
|
-
* Allows
|
|
327
|
+
* Allows an organization owner or admin to submit a rejected organization for review again. The expected generation prevents acting on stale status.
|
|
327
328
|
*/
|
|
328
329
|
static reapplyOnboardingReview<ThrowOnError extends boolean = false>(parameters: {
|
|
329
330
|
expectedGeneration: number;
|
|
@@ -331,7 +332,7 @@ export declare class Email {
|
|
|
331
332
|
/**
|
|
332
333
|
* Respond to an email onboarding information request
|
|
333
334
|
*
|
|
334
|
-
* Allows
|
|
335
|
+
* Allows organization owners and admins to submit a text response and up to three evidence uploads for the current information request.
|
|
335
336
|
*/
|
|
336
337
|
static respondToOnboardingInformationRequest<ThrowOnError extends boolean = false>(parameters: {
|
|
337
338
|
expectedGeneration: number;
|
|
@@ -341,7 +342,7 @@ export declare class Email {
|
|
|
341
342
|
/**
|
|
342
343
|
* Get email tracking defaults
|
|
343
344
|
*
|
|
344
|
-
* Returns the
|
|
345
|
+
* Returns the organization's independent defaults for open and click tracking, both enabled unless configured otherwise. Recipient opt-out takes precedence over these defaults.
|
|
345
346
|
*/
|
|
346
347
|
static getTrackingDefaults<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<EmailGetTrackingDefaultsResponses, EmailGetTrackingDefaultsErrors, ThrowOnError>;
|
|
347
348
|
/**
|
|
@@ -373,7 +374,7 @@ export declare class Email {
|
|
|
373
374
|
/**
|
|
374
375
|
* List sending domains
|
|
375
376
|
*
|
|
376
|
-
* Returns a paginated list of the organization's sending domains.
|
|
377
|
+
* Returns a paginated list of the organization's sending domains. Each row carries `deliverability` (bounce and complaint rates over the last 24 hours, the window the 5% bounce limit is enforced over) and `series`, the last 14 days of daily email sends attributed to the domain, oldest first.
|
|
377
378
|
*/
|
|
378
379
|
static listDomains<ThrowOnError extends boolean = false>(parameters?: {
|
|
379
380
|
page?: string | null | undefined;
|
|
@@ -382,7 +383,7 @@ export declare class Email {
|
|
|
382
383
|
/**
|
|
383
384
|
* Add a sending domain
|
|
384
385
|
*
|
|
385
|
-
* Registers a domain for sending and returns it with the DNS records required to verify ownership and configure DKIM. Responds with 201. Supplying a connection attaches the domain to that DNS account; the domain must sit inside the zone given with it.
|
|
386
|
+
* Registers a domain for sending and returns it with the DNS records required to verify ownership and configure DKIM. Responds with 201. Supplying a connection attaches the domain to that DNS account; the domain must sit inside the zone given with it. When Samva cannot register another sending domain right now, this responds with 429 and no domain is created.
|
|
386
387
|
*/
|
|
387
388
|
static addDomain<ThrowOnError extends boolean = false>(parameters: {
|
|
388
389
|
domain: string;
|
|
@@ -394,7 +395,7 @@ export declare class Email {
|
|
|
394
395
|
/**
|
|
395
396
|
* Get domain verification
|
|
396
397
|
*
|
|
397
|
-
* Returns the
|
|
398
|
+
* Returns the domain's last observed DNS and verification state. Reading it does not check DNS again or change anything; use advance to check now.
|
|
398
399
|
*/
|
|
399
400
|
static getDomainVerification<ThrowOnError extends boolean = false>(parameters: {
|
|
400
401
|
id: EmailDomainId;
|
|
@@ -402,7 +403,7 @@ export declare class Email {
|
|
|
402
403
|
/**
|
|
403
404
|
* Advance domain verification
|
|
404
405
|
*
|
|
405
|
-
*
|
|
406
|
+
* Checks the required DNS records now and, once they all match, moves the domain toward verified. Safe to call repeatedly.
|
|
406
407
|
*/
|
|
407
408
|
static advanceDomainVerification<ThrowOnError extends boolean = false>(parameters: {
|
|
408
409
|
id: EmailDomainId;
|
|
@@ -410,7 +411,7 @@ export declare class Email {
|
|
|
410
411
|
/**
|
|
411
412
|
* Stage a DKIM selector rotation
|
|
412
413
|
*
|
|
413
|
-
* Creates
|
|
414
|
+
* Creates a new DKIM signing key and returns its public DKIM record. Publish it, then advance domain verification to switch signing to the new key. Keep the former record published at least until `minimumRetainUntil`.
|
|
414
415
|
*/
|
|
415
416
|
static rotateDomainDkim<ThrowOnError extends boolean = false>(parameters: {
|
|
416
417
|
"idempotency-key": string;
|
|
@@ -462,17 +463,18 @@ export declare class Email {
|
|
|
462
463
|
/**
|
|
463
464
|
* Complete a one-click DNS return
|
|
464
465
|
*
|
|
465
|
-
* Consumes the Domain Connect provider's redirect. Validates the signed state and, when the
|
|
466
|
+
* Consumes the Domain Connect provider's redirect. Validates the signed state and, when the DNS provider reports success, starts checking the domain's records. A DNS provider error is reported separately from a customer cancelling setup.
|
|
466
467
|
*/
|
|
467
468
|
static completeDomainConnect<ThrowOnError extends boolean = false>(parameters: {
|
|
468
469
|
id: EmailDomainId;
|
|
469
470
|
state: string;
|
|
470
471
|
error?: string | null | undefined;
|
|
472
|
+
errorDescription?: string | null | undefined;
|
|
471
473
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCompleteDomainConnectResponses, EmailCompleteDomainConnectErrors, ThrowOnError>;
|
|
472
474
|
/**
|
|
473
475
|
* Enable inbound email for a domain
|
|
474
476
|
*
|
|
475
|
-
* Enables inbound receiving for a verified domain
|
|
477
|
+
* Enables inbound receiving for a verified domain and returns the recipient addresses it accepts. Set `catchAll` to route every address on the domain; that requires a webhook endpoint, supplied as `endpointId` or already configured on the domain.
|
|
476
478
|
*/
|
|
477
479
|
static enableReceiving<ThrowOnError extends boolean = false>(parameters: {
|
|
478
480
|
id: EmailDomainId;
|
|
@@ -538,7 +540,7 @@ export declare class Email {
|
|
|
538
540
|
/**
|
|
539
541
|
* Enable a custom tracking domain
|
|
540
542
|
*
|
|
541
|
-
* Provisions a custom tracking domain (default label `track`) for a verified sending domain so open/click links redirect through the customer's own subdomain. Requires
|
|
543
|
+
* Provisions a custom tracking domain (default label `track`) for a verified sending domain so open/click links redirect through the customer's own subdomain. Requires a plan that includes custom tracking domains. Returns the resulting state including the two DNS records the customer must create.
|
|
542
544
|
*/
|
|
543
545
|
static enableCustomTracking<ThrowOnError extends boolean = false>(parameters: {
|
|
544
546
|
id: EmailDomainId;
|
|
@@ -555,7 +557,7 @@ export declare class Email {
|
|
|
555
557
|
/**
|
|
556
558
|
* Build an automatic Custom Tracking Domain apply URL
|
|
557
559
|
*
|
|
558
|
-
* Builds the signed Domain Connect URL for the current customer-selected tracking host.
|
|
560
|
+
* Builds the signed Domain Connect URL for the current customer-selected tracking host. Samva fills in the host and the certificate validation record; the manual CNAME records remain available.
|
|
559
561
|
*/
|
|
560
562
|
static buildCustomTrackingDomainConnectApplyUrl<ThrowOnError extends boolean = false>(parameters: {
|
|
561
563
|
id: EmailDomainId;
|
|
@@ -563,17 +565,18 @@ export declare class Email {
|
|
|
563
565
|
/**
|
|
564
566
|
* Complete an automatic Custom Tracking Domain return
|
|
565
567
|
*
|
|
566
|
-
* Validates the
|
|
568
|
+
* Validates the signed state returned by the DNS provider, then checks the tracking host again. Returning here never marks the host ready or changes which tracking host email uses.
|
|
567
569
|
*/
|
|
568
570
|
static completeCustomTrackingDomainConnect<ThrowOnError extends boolean = false>(parameters: {
|
|
569
571
|
id: EmailDomainId;
|
|
570
572
|
state: string;
|
|
571
573
|
error?: string | null | undefined;
|
|
574
|
+
errorDescription?: string | null | undefined;
|
|
572
575
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteCustomTrackingDomainConnectErrors, ThrowOnError>;
|
|
573
576
|
/**
|
|
574
577
|
* List sender identities
|
|
575
578
|
*
|
|
576
|
-
* Returns a paginated list of sender identities, optionally filtered by verification status, active state, or default flag.
|
|
579
|
+
* Returns a paginated list of sender identities, optionally filtered by verification status, active state, or default flag. Each row carries `deliverability` (bounce and complaint rates over the last 24 hours) and `series`, the last 14 days of daily email sends from the address, oldest first.
|
|
577
580
|
*/
|
|
578
581
|
static listSenders<ThrowOnError extends boolean = false>(parameters?: {
|
|
579
582
|
page?: string | null | undefined;
|
|
@@ -585,7 +588,7 @@ export declare class Email {
|
|
|
585
588
|
/**
|
|
586
589
|
* Add a sender identity
|
|
587
590
|
*
|
|
588
|
-
*
|
|
591
|
+
* Creates a sender identity. The required Idempotency-Key replays the original sender for an identical request and conflicts when reused with different input.
|
|
589
592
|
*/
|
|
590
593
|
static addSender<ThrowOnError extends boolean = false>(parameters: {
|
|
591
594
|
"idempotency-key": string;
|
|
@@ -605,7 +608,7 @@ export declare class Email {
|
|
|
605
608
|
/**
|
|
606
609
|
* Remove a sender identity
|
|
607
610
|
*
|
|
608
|
-
* Accepts sender removal
|
|
611
|
+
* Accepts sender removal and marks the sender inactive. It reports the `deleting` lifecycle until removal finishes.
|
|
609
612
|
*/
|
|
610
613
|
static removeSender<ThrowOnError extends boolean = false>(parameters: {
|
|
611
614
|
id: EmailSenderId;
|
|
@@ -638,7 +641,7 @@ export declare class Email {
|
|
|
638
641
|
/**
|
|
639
642
|
* Enable catch-all receiving
|
|
640
643
|
*
|
|
641
|
-
* Enables catch-all inbound receiving for a domain
|
|
644
|
+
* Enables catch-all inbound receiving for a domain. `endpointId` is one of the organization's webhook endpoints; every address on the domain delivers `message.received` to it. Responds with 201.
|
|
642
645
|
*/
|
|
643
646
|
static enableCatchAll<ThrowOnError extends boolean = false>(parameters: {
|
|
644
647
|
domainId: EmailDomainId;
|
|
@@ -682,7 +685,7 @@ export declare class Email {
|
|
|
682
685
|
/**
|
|
683
686
|
* List suppressed addresses
|
|
684
687
|
*
|
|
685
|
-
* Returns the addresses this
|
|
688
|
+
* Returns the addresses this organization will not send to, newest first, optionally filtered by suppression type, active or expired state, and an address substring, with limit and offset paging.
|
|
686
689
|
*/
|
|
687
690
|
static listSuppressions<ThrowOnError extends boolean = false>(parameters?: {
|
|
688
691
|
type?: "bounce" | "complaint" | "unsubscribe" | "manual" | null | undefined;
|
|
@@ -694,7 +697,7 @@ export declare class Email {
|
|
|
694
697
|
/**
|
|
695
698
|
* Remove a suppressed address
|
|
696
699
|
*
|
|
697
|
-
* Deletes a suppression so this
|
|
700
|
+
* Deletes a suppression so this organization can send to the address again. If the deletion cannot complete, it fails rather than reporting success, and it is safe to retry. Deliverability caveat: a bounce or complaint suppression records a real delivery failure, and sending to the address again risks the reputation damage the suppression prevented.
|
|
698
701
|
*/
|
|
699
702
|
static removeSuppression<ThrowOnError extends boolean = false>(parameters: {
|
|
700
703
|
id: SuppressionId;
|
|
@@ -897,7 +900,7 @@ export declare class Email {
|
|
|
897
900
|
/**
|
|
898
901
|
* Complete domain warming
|
|
899
902
|
*
|
|
900
|
-
* Ends the policy. Campaign runs from the domain are no longer gated by warming windows; the
|
|
903
|
+
* Ends the policy. Campaign runs from the domain are no longer gated by warming windows; the organization safeguards still apply.
|
|
901
904
|
*/
|
|
902
905
|
static completeDomainWarming<ThrowOnError extends boolean = false>(parameters: {
|
|
903
906
|
id: EmailDomainId;
|
|
@@ -956,6 +959,44 @@ export declare class Media {
|
|
|
956
959
|
export declare class Media2 {
|
|
957
960
|
static media: typeof Media;
|
|
958
961
|
}
|
|
962
|
+
export declare class Attachments {
|
|
963
|
+
/**
|
|
964
|
+
* Delete an attachment
|
|
965
|
+
*
|
|
966
|
+
* Deletes an attachment and returns the deleted attachment's ID.
|
|
967
|
+
*/
|
|
968
|
+
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
969
|
+
id: AttachmentId;
|
|
970
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<AttachmentsRemoveResponses, AttachmentsRemoveErrors, ThrowOnError>;
|
|
971
|
+
/**
|
|
972
|
+
* Get an attachment
|
|
973
|
+
*
|
|
974
|
+
* Returns metadata for a single attachment, including filename, content type, and size.
|
|
975
|
+
*/
|
|
976
|
+
static getById<ThrowOnError extends boolean = false>(parameters: {
|
|
977
|
+
id: AttachmentId;
|
|
978
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<AttachmentsGetByIdResponses, AttachmentsGetByIdErrors, ThrowOnError>;
|
|
979
|
+
/**
|
|
980
|
+
* List message attachments
|
|
981
|
+
*
|
|
982
|
+
* Returns all attachments for the given message, along with a total count.
|
|
983
|
+
*/
|
|
984
|
+
static list<ThrowOnError extends boolean = false>(parameters: {
|
|
985
|
+
messageId: MessageId;
|
|
986
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<AttachmentsListResponses, AttachmentsListErrors, ThrowOnError>;
|
|
987
|
+
/**
|
|
988
|
+
* Get an attachment download URL
|
|
989
|
+
*
|
|
990
|
+
* Generates a presigned, time-limited download URL for the attachment; expiry is configurable via the expiresIn query parameter.
|
|
991
|
+
*/
|
|
992
|
+
static downloadUrl<ThrowOnError extends boolean = false>(parameters: {
|
|
993
|
+
id: AttachmentId;
|
|
994
|
+
expiresIn?: string | null | undefined;
|
|
995
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<AttachmentsDownloadUrlResponses, AttachmentsDownloadUrlErrors, ThrowOnError>;
|
|
996
|
+
}
|
|
997
|
+
export declare class Attachments2 {
|
|
998
|
+
static attachments: typeof Attachments;
|
|
999
|
+
}
|
|
959
1000
|
export declare class Conversations {
|
|
960
1001
|
/**
|
|
961
1002
|
* List conversations
|
|
@@ -1108,7 +1149,7 @@ export declare class Contacts {
|
|
|
1108
1149
|
/**
|
|
1109
1150
|
* Find a contact
|
|
1110
1151
|
*
|
|
1111
|
-
*
|
|
1152
|
+
* Looks up a single contact by email address or external ID and returns null when no contact matches.
|
|
1112
1153
|
*/
|
|
1113
1154
|
static find<ThrowOnError extends boolean = false>(parameters?: {
|
|
1114
1155
|
email?: string | null | undefined;
|
|
@@ -1260,6 +1301,323 @@ export declare class Contacts {
|
|
|
1260
1301
|
export declare class Contacts2 {
|
|
1261
1302
|
static contacts: typeof Contacts;
|
|
1262
1303
|
}
|
|
1304
|
+
export declare class ContactGroups {
|
|
1305
|
+
/**
|
|
1306
|
+
* List contact groups
|
|
1307
|
+
*
|
|
1308
|
+
* Returns a paginated list of contact groups for the organization, filterable by type and active state.
|
|
1309
|
+
*/
|
|
1310
|
+
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1311
|
+
page?: string | null | undefined;
|
|
1312
|
+
limit?: string | null | undefined;
|
|
1313
|
+
type?: "static" | "dynamic" | "smart" | Array<"static" | "dynamic" | "smart"> | null | undefined;
|
|
1314
|
+
isActive?: string | null | undefined;
|
|
1315
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsListResponses, ContactGroupsListErrors, ThrowOnError>;
|
|
1316
|
+
/**
|
|
1317
|
+
* Create a contact group
|
|
1318
|
+
*
|
|
1319
|
+
* Creates a new contact group and returns it with a 201 status.
|
|
1320
|
+
*/
|
|
1321
|
+
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1322
|
+
name: string;
|
|
1323
|
+
description?: string | null | null | undefined;
|
|
1324
|
+
type?: "static" | "dynamic" | "smart" | null | undefined;
|
|
1325
|
+
criteria?: {
|
|
1326
|
+
[key: string]: JsonValue;
|
|
1327
|
+
} | null | null | undefined;
|
|
1328
|
+
color?: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null | null | undefined;
|
|
1329
|
+
icon?: string | null | null | undefined;
|
|
1330
|
+
parentGroupId?: ContactGroupId | null | null | undefined;
|
|
1331
|
+
isActive?: boolean | null | undefined;
|
|
1332
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsCreateResponses, ContactGroupsCreateErrors, ThrowOnError>;
|
|
1333
|
+
/**
|
|
1334
|
+
* Delete a contact group
|
|
1335
|
+
*
|
|
1336
|
+
* Permanently deletes a contact group by its ID.
|
|
1337
|
+
*/
|
|
1338
|
+
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
1339
|
+
id: ContactGroupId;
|
|
1340
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsRemoveResponses, ContactGroupsRemoveErrors, ThrowOnError>;
|
|
1341
|
+
/**
|
|
1342
|
+
* Get a contact group
|
|
1343
|
+
*
|
|
1344
|
+
* Returns a single contact group by its ID.
|
|
1345
|
+
*/
|
|
1346
|
+
static getById<ThrowOnError extends boolean = false>(parameters: {
|
|
1347
|
+
id: ContactGroupId;
|
|
1348
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsGetByIdResponses, ContactGroupsGetByIdErrors, ThrowOnError>;
|
|
1349
|
+
/**
|
|
1350
|
+
* Update a contact group
|
|
1351
|
+
*
|
|
1352
|
+
* Updates an existing contact group's fields and returns the updated group.
|
|
1353
|
+
*/
|
|
1354
|
+
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
1355
|
+
id: ContactGroupId;
|
|
1356
|
+
name?: string | null | undefined;
|
|
1357
|
+
description?: string | null | null | undefined;
|
|
1358
|
+
type?: "static" | "dynamic" | "smart" | null | undefined;
|
|
1359
|
+
criteria?: {
|
|
1360
|
+
[key: string]: JsonValue;
|
|
1361
|
+
} | null | null | undefined;
|
|
1362
|
+
color?: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null | null | undefined;
|
|
1363
|
+
icon?: string | null | null | undefined;
|
|
1364
|
+
parentGroupId?: ContactGroupId | null | null | undefined;
|
|
1365
|
+
isActive?: boolean | null | undefined;
|
|
1366
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsUpdateResponses, ContactGroupsUpdateErrors, ThrowOnError>;
|
|
1367
|
+
/**
|
|
1368
|
+
* Remove members from a contact group
|
|
1369
|
+
*
|
|
1370
|
+
* Removes one or more contacts from a contact group, returning the count of removed members.
|
|
1371
|
+
*/
|
|
1372
|
+
static removeMembers<ThrowOnError extends boolean = false>(parameters: {
|
|
1373
|
+
groupId: ContactGroupId;
|
|
1374
|
+
contactIds: [ContactId, ContactId];
|
|
1375
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsRemoveMembersResponses, ContactGroupsRemoveMembersErrors, ThrowOnError>;
|
|
1376
|
+
/**
|
|
1377
|
+
* List members of a contact group
|
|
1378
|
+
*
|
|
1379
|
+
* Returns a paginated list of contacts belonging to a contact group.
|
|
1380
|
+
*/
|
|
1381
|
+
static getMembers<ThrowOnError extends boolean = false>(parameters: {
|
|
1382
|
+
groupId: ContactGroupId;
|
|
1383
|
+
page?: string | null | undefined;
|
|
1384
|
+
limit?: string | null | undefined;
|
|
1385
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsGetMembersResponses, ContactGroupsGetMembersErrors, ThrowOnError>;
|
|
1386
|
+
/**
|
|
1387
|
+
* Add members to a contact group
|
|
1388
|
+
*
|
|
1389
|
+
* Adds one or more contacts to a contact group, returning counts of added and skipped members.
|
|
1390
|
+
*/
|
|
1391
|
+
static addMembers<ThrowOnError extends boolean = false>(parameters: {
|
|
1392
|
+
groupId: ContactGroupId;
|
|
1393
|
+
contactIds: [ContactId, ContactId];
|
|
1394
|
+
role?: "member" | "moderator" | "admin" | null | undefined;
|
|
1395
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsAddMembersResponses, ContactGroupsAddMembersErrors, ThrowOnError>;
|
|
1396
|
+
/**
|
|
1397
|
+
* Evaluate a dynamic contact group
|
|
1398
|
+
*
|
|
1399
|
+
* Recomputes a dynamic contact group's membership from its criteria, returning counts of added, removed, and total members.
|
|
1400
|
+
*/
|
|
1401
|
+
static evaluateDynamic<ThrowOnError extends boolean = false>(parameters: {
|
|
1402
|
+
groupId: ContactGroupId;
|
|
1403
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsEvaluateDynamicResponses, ContactGroupsEvaluateDynamicErrors, ThrowOnError>;
|
|
1404
|
+
/**
|
|
1405
|
+
* Preview contact group criteria
|
|
1406
|
+
*
|
|
1407
|
+
* Evaluates group criteria without persisting, returning the matching contact count and a sample of matches.
|
|
1408
|
+
*/
|
|
1409
|
+
static preview<ThrowOnError extends boolean = false>(parameters: {
|
|
1410
|
+
criteria: {
|
|
1411
|
+
contactTypes?: Array<string> | null | undefined;
|
|
1412
|
+
capabilities?: Array<string> | null | undefined;
|
|
1413
|
+
tags?: Array<string> | null | undefined;
|
|
1414
|
+
channels?: Array<string> | null | undefined;
|
|
1415
|
+
match?: "all" | "any" | null | undefined;
|
|
1416
|
+
conditions?: Array<{
|
|
1417
|
+
field: string;
|
|
1418
|
+
operator: string;
|
|
1419
|
+
value: JsonValue;
|
|
1420
|
+
}> | null | undefined;
|
|
1421
|
+
};
|
|
1422
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsPreviewResponses, ContactGroupsPreviewErrors, ThrowOnError>;
|
|
1423
|
+
}
|
|
1424
|
+
export declare class ContactGroups2 {
|
|
1425
|
+
static contactGroups: typeof ContactGroups;
|
|
1426
|
+
}
|
|
1427
|
+
export declare class CustomFields {
|
|
1428
|
+
/**
|
|
1429
|
+
* List custom fields
|
|
1430
|
+
*
|
|
1431
|
+
* Returns a paginated list of custom field definitions for the organization.
|
|
1432
|
+
*/
|
|
1433
|
+
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1434
|
+
page?: string | null | undefined;
|
|
1435
|
+
limit?: string | null | undefined;
|
|
1436
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<CustomFieldsListResponses, CustomFieldsListErrors, ThrowOnError>;
|
|
1437
|
+
/**
|
|
1438
|
+
* Create a custom field
|
|
1439
|
+
*
|
|
1440
|
+
* Creates a new custom field definition and returns it with a 201 status; the field key must be unique.
|
|
1441
|
+
*/
|
|
1442
|
+
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1443
|
+
key: string;
|
|
1444
|
+
label: string;
|
|
1445
|
+
type: "text" | "number" | "boolean" | "date" | "select";
|
|
1446
|
+
options?: Array<string> | null | undefined;
|
|
1447
|
+
defaultValue?: string | null | null | undefined;
|
|
1448
|
+
isRequired?: boolean | null | undefined;
|
|
1449
|
+
sortOrder?: number | null | undefined;
|
|
1450
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<CustomFieldsCreateResponses, CustomFieldsCreateErrors, ThrowOnError>;
|
|
1451
|
+
/**
|
|
1452
|
+
* Delete a custom field
|
|
1453
|
+
*
|
|
1454
|
+
* Permanently deletes a custom field definition by its ID.
|
|
1455
|
+
*/
|
|
1456
|
+
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
1457
|
+
id: CustomFieldDefinitionId;
|
|
1458
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<CustomFieldsRemoveResponses, CustomFieldsRemoveErrors, ThrowOnError>;
|
|
1459
|
+
/**
|
|
1460
|
+
* Update a custom field
|
|
1461
|
+
*
|
|
1462
|
+
* Updates an existing custom field definition and returns the updated field.
|
|
1463
|
+
*/
|
|
1464
|
+
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
1465
|
+
id: CustomFieldDefinitionId;
|
|
1466
|
+
label?: string | null | undefined;
|
|
1467
|
+
options?: Array<string> | null | undefined;
|
|
1468
|
+
defaultValue?: string | null | null | undefined;
|
|
1469
|
+
isRequired?: boolean | null | undefined;
|
|
1470
|
+
sortOrder?: number | null | undefined;
|
|
1471
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<CustomFieldsUpdateResponses, CustomFieldsUpdateErrors, ThrowOnError>;
|
|
1472
|
+
}
|
|
1473
|
+
export declare class CustomFields2 {
|
|
1474
|
+
static customFields: typeof CustomFields;
|
|
1475
|
+
}
|
|
1476
|
+
export declare class Unsubscribe {
|
|
1477
|
+
/**
|
|
1478
|
+
* List unsubscribe groups
|
|
1479
|
+
*
|
|
1480
|
+
* Returns a paginated list of the organization's unsubscribe groups.
|
|
1481
|
+
*/
|
|
1482
|
+
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1483
|
+
page?: string | null | undefined;
|
|
1484
|
+
limit?: string | null | undefined;
|
|
1485
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<UnsubscribeListResponses, UnsubscribeListErrors, ThrowOnError>;
|
|
1486
|
+
/**
|
|
1487
|
+
* Create an unsubscribe group
|
|
1488
|
+
*
|
|
1489
|
+
* Creates a new unsubscribe group and returns it with a 201 Created status.
|
|
1490
|
+
*/
|
|
1491
|
+
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1492
|
+
name: string;
|
|
1493
|
+
description?: string | null | null | undefined;
|
|
1494
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<UnsubscribeCreateResponses, UnsubscribeCreateErrors, ThrowOnError>;
|
|
1495
|
+
/**
|
|
1496
|
+
* Delete an unsubscribe group
|
|
1497
|
+
*
|
|
1498
|
+
* Permanently deletes an unsubscribe group by its ID.
|
|
1499
|
+
*/
|
|
1500
|
+
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
1501
|
+
id: UnsubscribeId;
|
|
1502
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<UnsubscribeRemoveResponses, UnsubscribeRemoveErrors, ThrowOnError>;
|
|
1503
|
+
/**
|
|
1504
|
+
* Update an unsubscribe group
|
|
1505
|
+
*
|
|
1506
|
+
* Updates the name or description of an unsubscribe group.
|
|
1507
|
+
*/
|
|
1508
|
+
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
1509
|
+
id: UnsubscribeId;
|
|
1510
|
+
name?: string | null | undefined;
|
|
1511
|
+
description?: string | null | null | undefined;
|
|
1512
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<UnsubscribeUpdateResponses, UnsubscribeUpdateErrors, ThrowOnError>;
|
|
1513
|
+
/**
|
|
1514
|
+
* Remove contacts from an unsubscribe group
|
|
1515
|
+
*
|
|
1516
|
+
* Removes one or more email addresses from an unsubscribe group and returns the number removed.
|
|
1517
|
+
*/
|
|
1518
|
+
static removeEmails<ThrowOnError extends boolean = false>(parameters: {
|
|
1519
|
+
groupId: UnsubscribeId;
|
|
1520
|
+
emails: Array<string>;
|
|
1521
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<UnsubscribeRemoveEmailsResponses, UnsubscribeRemoveEmailsErrors, ThrowOnError>;
|
|
1522
|
+
/**
|
|
1523
|
+
* List unsubscribe group members
|
|
1524
|
+
*
|
|
1525
|
+
* Returns a paginated list of the email addresses in an unsubscribe group.
|
|
1526
|
+
*/
|
|
1527
|
+
static listMembers<ThrowOnError extends boolean = false>(parameters: {
|
|
1528
|
+
groupId: UnsubscribeId;
|
|
1529
|
+
page?: string | null | undefined;
|
|
1530
|
+
limit?: string | null | undefined;
|
|
1531
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<UnsubscribeListMembersResponses, UnsubscribeListMembersErrors, ThrowOnError>;
|
|
1532
|
+
/**
|
|
1533
|
+
* Add contacts to an unsubscribe group
|
|
1534
|
+
*
|
|
1535
|
+
* Adds one or more email addresses to an unsubscribe group and returns the number added and the number skipped.
|
|
1536
|
+
*/
|
|
1537
|
+
static addEmails<ThrowOnError extends boolean = false>(parameters: {
|
|
1538
|
+
groupId: UnsubscribeId;
|
|
1539
|
+
emails: Array<string>;
|
|
1540
|
+
source?: "link" | "api" | "manual" | "complaint" | null | undefined;
|
|
1541
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<UnsubscribeAddEmailsResponses, UnsubscribeAddEmailsErrors, ThrowOnError>;
|
|
1542
|
+
/**
|
|
1543
|
+
* Check unsubscribe group membership
|
|
1544
|
+
*
|
|
1545
|
+
* Returns the unsubscribe groups that an email address has unsubscribed from, optionally limited to a specified set of groups.
|
|
1546
|
+
*/
|
|
1547
|
+
static checkSubscription<ThrowOnError extends boolean = false>(parameters: {
|
|
1548
|
+
email: string;
|
|
1549
|
+
groupIds?: string | null | undefined;
|
|
1550
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<UnsubscribeCheckSubscriptionResponses, UnsubscribeCheckSubscriptionErrors, ThrowOnError>;
|
|
1551
|
+
}
|
|
1552
|
+
export declare class UnsubscribeGroups {
|
|
1553
|
+
static unsubscribe: typeof Unsubscribe;
|
|
1554
|
+
}
|
|
1555
|
+
export declare class Analytics {
|
|
1556
|
+
/**
|
|
1557
|
+
* Get message volume analytics
|
|
1558
|
+
*
|
|
1559
|
+
* Returns outbound message counts over the half-open selected instant range, grouped by organization-local calendar day, week, or month. A range with traffic returns every bucket in it, including the ones that saw none; a range with no outbound traffic at all returns no buckets. A range with no `endDate` runs through the current instant, so its quiet trailing buckets are reported as zero.
|
|
1560
|
+
*/
|
|
1561
|
+
static getStats<ThrowOnError extends boolean = false>(parameters?: {
|
|
1562
|
+
startDate?: string | null | undefined;
|
|
1563
|
+
endDate?: string | null | undefined;
|
|
1564
|
+
groupBy?: "day" | "week" | "month" | null | undefined;
|
|
1565
|
+
channel?: "email" | null | undefined;
|
|
1566
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsGetStatsResponses, AnalyticsGetStatsErrors, ThrowOnError>;
|
|
1567
|
+
/**
|
|
1568
|
+
* Get channel performance analytics
|
|
1569
|
+
*
|
|
1570
|
+
* Returns aggregate delivery metrics plus unique-message email Open and Click rates over the selected date range. `sent` counts every outbound message accepted in the range; each rate is taken over the messages the channel actually attempted, so one still waiting to be sent neither helps nor hurts it. Each engagement rate uses the corresponding tracking-eligible delivered-message cohort; repeated provider observations do not inflate the numerator.
|
|
1571
|
+
*/
|
|
1572
|
+
static getChannelStats<ThrowOnError extends boolean = false>(parameters?: {
|
|
1573
|
+
startDate?: string | null | undefined;
|
|
1574
|
+
endDate?: string | null | undefined;
|
|
1575
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsGetChannelStatsResponses, AnalyticsGetChannelStatsErrors, ThrowOnError>;
|
|
1576
|
+
/**
|
|
1577
|
+
* List top contacts by message volume
|
|
1578
|
+
*
|
|
1579
|
+
* Returns the contacts your organization exchanged the most messages with over the selected date range. `sortBy` chooses the traffic `messageCount` reports and ranks by: `sent` counts outbound messages addressed to the contact, `received` counts inbound messages the contact sent you, and `total` (the default) counts both. Contacts with no traffic in the range are omitted, and at most 100 are returned.
|
|
1580
|
+
*/
|
|
1581
|
+
static getTopContacts<ThrowOnError extends boolean = false>(parameters?: {
|
|
1582
|
+
startDate?: string | null | undefined;
|
|
1583
|
+
endDate?: string | null | undefined;
|
|
1584
|
+
limit?: string | null | undefined;
|
|
1585
|
+
sortBy?: "sent" | "received" | "total" | null | undefined;
|
|
1586
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsGetTopContactsResponses, AnalyticsGetTopContactsErrors, ThrowOnError>;
|
|
1587
|
+
/**
|
|
1588
|
+
* Get hourly message distribution
|
|
1589
|
+
*
|
|
1590
|
+
* Returns outbound message counts over the half-open selected instant range, bucketed by organization-local hour. Empty ranges return no rows; non-empty ranges include all 24 hours.
|
|
1591
|
+
*/
|
|
1592
|
+
static getHourlyDistribution<ThrowOnError extends boolean = false>(parameters?: {
|
|
1593
|
+
startDate?: string | null | undefined;
|
|
1594
|
+
endDate?: string | null | undefined;
|
|
1595
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsGetHourlyDistributionResponses, AnalyticsGetHourlyDistributionErrors, ThrowOnError>;
|
|
1596
|
+
/**
|
|
1597
|
+
* Get message delivery metrics
|
|
1598
|
+
*
|
|
1599
|
+
* Returns delivered, failed, and pending rates plus average delivery time for the outbound messages accepted in the selected date range, optionally filtered by channel. Every accepted message falls into exactly one of the three, so they always sum to 100%: a complaint counts as delivered because the message arrived, a bounce counts as failed, and anything the provider has not resolved yet counts as pending. Mail your organization received is not rated here.
|
|
1600
|
+
*/
|
|
1601
|
+
static getDeliveryMetrics<ThrowOnError extends boolean = false>(parameters?: {
|
|
1602
|
+
startDate?: string | null | undefined;
|
|
1603
|
+
endDate?: string | null | undefined;
|
|
1604
|
+
channel?: "email" | null | undefined;
|
|
1605
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsGetDeliveryMetricsResponses, AnalyticsGetDeliveryMetricsErrors, ThrowOnError>;
|
|
1606
|
+
/**
|
|
1607
|
+
* Export messaging analytics data
|
|
1608
|
+
*
|
|
1609
|
+
* Exports one record per outbound message accepted in the given date range as CSV or JSON and returns the file content inline. CSV follows RFC 4180: fields containing a quote, comma, or line break are quoted with embedded quotes doubled, and records are separated by CRLF. At most 10,000 records are returned, newest first.
|
|
1610
|
+
*/
|
|
1611
|
+
static exportData<ThrowOnError extends boolean = false>(parameters: {
|
|
1612
|
+
startDate: string;
|
|
1613
|
+
endDate: string;
|
|
1614
|
+
format?: "csv" | "json" | null | undefined;
|
|
1615
|
+
includeChannels?: Array<"email"> | null | undefined;
|
|
1616
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsExportDataResponses, AnalyticsExportDataErrors, ThrowOnError>;
|
|
1617
|
+
}
|
|
1618
|
+
export declare class Analytics2 {
|
|
1619
|
+
static analytics: typeof Analytics;
|
|
1620
|
+
}
|
|
1263
1621
|
export declare class Templates {
|
|
1264
1622
|
/**
|
|
1265
1623
|
* List templates
|
|
@@ -1291,22 +1649,6 @@ export declare class Templates {
|
|
|
1291
1649
|
isActive?: boolean | null | undefined;
|
|
1292
1650
|
idempotencyKey: string;
|
|
1293
1651
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesCreateResponses, TemplatesCreateErrors, ThrowOnError>;
|
|
1294
|
-
/**
|
|
1295
|
-
* List templates for the dashboard
|
|
1296
|
-
*
|
|
1297
|
-
* Returns a paginated dashboard view that groups related channel templates into families and leaves standalone templates ungrouped.
|
|
1298
|
-
*/
|
|
1299
|
-
static listDashboard<ThrowOnError extends boolean = false>(parameters: {
|
|
1300
|
-
page?: string | null | undefined;
|
|
1301
|
-
limit?: string | null | undefined;
|
|
1302
|
-
allowedChannels: "email" | Array<"email">;
|
|
1303
|
-
category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | undefined;
|
|
1304
|
-
channel?: "email" | null | undefined;
|
|
1305
|
-
status?: "draft" | "pending" | "approved" | "published" | "rejected" | "archived" | null | undefined;
|
|
1306
|
-
search?: string | null | undefined;
|
|
1307
|
-
sortBy?: "name" | "createdAt" | "updatedAt" | "usageCount" | "lastUsedAt" | null | undefined;
|
|
1308
|
-
sortOrder?: "asc" | "desc" | null | undefined;
|
|
1309
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesListDashboardResponses, TemplatesListDashboardErrors, ThrowOnError>;
|
|
1310
1652
|
/**
|
|
1311
1653
|
* List template families
|
|
1312
1654
|
*
|
|
@@ -1426,7 +1768,7 @@ export declare class Templates {
|
|
|
1426
1768
|
/**
|
|
1427
1769
|
* Open a template project workspace
|
|
1428
1770
|
*
|
|
1429
|
-
* Creates or opens the shared project workspace at the
|
|
1771
|
+
* Creates or opens the shared project workspace at the latest saved version and returns its effective files.
|
|
1430
1772
|
*/
|
|
1431
1773
|
static openWorkspace<ThrowOnError extends boolean = false>(parameters: {
|
|
1432
1774
|
id: TemplateId;
|
|
@@ -1443,7 +1785,7 @@ export declare class Templates {
|
|
|
1443
1785
|
/**
|
|
1444
1786
|
* Reconcile a template project workspace
|
|
1445
1787
|
*
|
|
1446
|
-
* Fast-forwards or rebases the workspace onto the
|
|
1788
|
+
* Fast-forwards or rebases the workspace onto the latest saved version, retaining file conflicts for explicit resolution.
|
|
1447
1789
|
*/
|
|
1448
1790
|
static reconcileWorkspace<ThrowOnError extends boolean = false>(parameters: {
|
|
1449
1791
|
id: TemplateId;
|
|
@@ -1469,7 +1811,7 @@ export declare class Templates {
|
|
|
1469
1811
|
/**
|
|
1470
1812
|
* Save a template project workspace
|
|
1471
1813
|
*
|
|
1472
|
-
* Validates the effective project tree and
|
|
1814
|
+
* Validates the effective project tree and saves it as one Git commit on the template repository's default branch.
|
|
1473
1815
|
*/
|
|
1474
1816
|
static saveWorkspace<ThrowOnError extends boolean = false>(parameters: {
|
|
1475
1817
|
id: TemplateId;
|
|
@@ -1492,7 +1834,7 @@ export declare class Templates {
|
|
|
1492
1834
|
/**
|
|
1493
1835
|
* List template project commit history
|
|
1494
1836
|
*
|
|
1495
|
-
* Returns
|
|
1837
|
+
* Returns recent history from the template repository's default branch.
|
|
1496
1838
|
*/
|
|
1497
1839
|
static workspaceHistory<ThrowOnError extends boolean = false>(parameters: {
|
|
1498
1840
|
id: TemplateId;
|
|
@@ -1566,7 +1908,7 @@ export declare class Templates {
|
|
|
1566
1908
|
/**
|
|
1567
1909
|
* Issue a template project Git credential
|
|
1568
1910
|
*
|
|
1569
|
-
* Exchanges the caller's Samva authorization for a one-hour
|
|
1911
|
+
* Exchanges the caller's Samva authorization for a one-hour Git credential scoped to the template repository.
|
|
1570
1912
|
*/
|
|
1571
1913
|
static issueGitCredential<ThrowOnError extends boolean = false>(parameters: {
|
|
1572
1914
|
id: TemplateId;
|
|
@@ -1645,7 +1987,7 @@ export declare class Webhooks {
|
|
|
1645
1987
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1646
1988
|
name: string;
|
|
1647
1989
|
url: string;
|
|
1648
|
-
eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.
|
|
1990
|
+
eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
|
|
1649
1991
|
channels?: Array<"email"> | null | undefined;
|
|
1650
1992
|
headers?: {
|
|
1651
1993
|
[key: string]: string;
|
|
@@ -1677,7 +2019,7 @@ export declare class Webhooks {
|
|
|
1677
2019
|
id: WebhookEndpointId;
|
|
1678
2020
|
name?: string | null | undefined;
|
|
1679
2021
|
url?: string | 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.
|
|
2022
|
+
eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated"> | null | undefined;
|
|
1681
2023
|
channels?: Array<"email"> | null | null | undefined;
|
|
1682
2024
|
headers?: {
|
|
1683
2025
|
[key: string]: string;
|
|
@@ -1707,7 +2049,7 @@ export declare class Webhooks {
|
|
|
1707
2049
|
/**
|
|
1708
2050
|
* Get webhook delivery statistics
|
|
1709
2051
|
*
|
|
1710
|
-
* Returns aggregate pending, delivered, exhausted, and cancelled delivery counts for a webhook endpoint, plus the same counts per
|
|
2052
|
+
* Returns aggregate pending, delivered, exhausted, and cancelled delivery counts for a webhook endpoint, plus the same counts per organization-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.
|
|
1711
2053
|
*/
|
|
1712
2054
|
static getStats<ThrowOnError extends boolean = false>(parameters: {
|
|
1713
2055
|
webhookId: WebhookEndpointId;
|
|
@@ -1736,9 +2078,9 @@ export declare class Webhooks2 {
|
|
|
1736
2078
|
}
|
|
1737
2079
|
export declare class Organizations {
|
|
1738
2080
|
/**
|
|
1739
|
-
* Create
|
|
2081
|
+
* Create an organization
|
|
1740
2082
|
*
|
|
1741
|
-
* Creates a new
|
|
2083
|
+
* Creates a new organization under the current billing account and returns it.
|
|
1742
2084
|
*/
|
|
1743
2085
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1744
2086
|
name: string;
|
|
@@ -1752,14 +2094,12 @@ export declare class Organizations {
|
|
|
1752
2094
|
/**
|
|
1753
2095
|
* Update the current organization
|
|
1754
2096
|
*
|
|
1755
|
-
* Updates the current organization's profile,
|
|
2097
|
+
* Updates the current organization's profile, regional defaults, design, reply-to, and unsubscribe-group defaults and returns the saved organization. `metadata` and `design` are merged into the stored values; every other field is replaced.
|
|
1756
2098
|
*/
|
|
1757
2099
|
static update<ThrowOnError extends boolean = false>(parameters?: {
|
|
1758
2100
|
name?: string | null | undefined;
|
|
1759
2101
|
slug?: string | null | undefined;
|
|
1760
|
-
billingEmail?: string | null | undefined;
|
|
1761
2102
|
countryCode?: string | null | undefined;
|
|
1762
|
-
currency?: string | null | undefined;
|
|
1763
2103
|
timezone?: IanaTimezone | null | undefined;
|
|
1764
2104
|
isActive?: boolean | null | undefined;
|
|
1765
2105
|
metadata?: {
|
|
@@ -1779,22 +2119,14 @@ export declare class Organizations {
|
|
|
1779
2119
|
period?: "current" | "last_30_days" | "last_90_days" | "last_year" | null | undefined;
|
|
1780
2120
|
}, options?: Options<never, ThrowOnError>): RequestResult<OrganizationsGetUsageResponses, OrganizationsGetUsageErrors, ThrowOnError>;
|
|
1781
2121
|
/**
|
|
1782
|
-
* Delete the current
|
|
2122
|
+
* Delete the current organization
|
|
1783
2123
|
*
|
|
1784
|
-
* Starts an owner-authorized
|
|
2124
|
+
* Starts an owner-authorized organization deletion operation, confirming the organization name in the request. Repeating the same request with the same Idempotency-Key returns the existing organization-scoped operation.
|
|
1785
2125
|
*/
|
|
1786
2126
|
static delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1787
2127
|
"idempotency-key": string;
|
|
1788
2128
|
confirmationName: string;
|
|
1789
2129
|
}, options?: Options<never, ThrowOnError>): RequestResult<OrganizationsDeleteResponses, OrganizationsDeleteErrors, ThrowOnError>;
|
|
1790
|
-
/**
|
|
1791
|
-
* Create the first workspace
|
|
1792
|
-
*
|
|
1793
|
-
* Creates a replacement first workspace under the signed-in user's billing account when no workspace membership remains.
|
|
1794
|
-
*/
|
|
1795
|
-
static bootstrap<ThrowOnError extends boolean = false>(parameters: {
|
|
1796
|
-
name: string;
|
|
1797
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<OrganizationsBootstrapResponses, OrganizationsBootstrapErrors, ThrowOnError>;
|
|
1798
2130
|
}
|
|
1799
2131
|
export declare class Organizations2 {
|
|
1800
2132
|
static organizations: typeof Organizations;
|
|
@@ -1820,7 +2152,7 @@ export declare class ApiKeys {
|
|
|
1820
2152
|
name: string;
|
|
1821
2153
|
description?: string | null | undefined;
|
|
1822
2154
|
expiresAt?: string | null | undefined;
|
|
1823
|
-
|
|
2155
|
+
access?: ApiKeyAccess | null | undefined;
|
|
1824
2156
|
}, options?: Options<never, ThrowOnError>): RequestResult<ApiKeysCreateResponses, ApiKeysCreateErrors, ThrowOnError>;
|
|
1825
2157
|
/**
|
|
1826
2158
|
* Revoke an API key
|
|
@@ -1833,7 +2165,7 @@ export declare class ApiKeys {
|
|
|
1833
2165
|
/**
|
|
1834
2166
|
* Get an API key
|
|
1835
2167
|
*
|
|
1836
|
-
* Returns the API key with the given ID, including its metadata and
|
|
2168
|
+
* Returns the API key with the given ID, including its metadata and access.
|
|
1837
2169
|
*/
|
|
1838
2170
|
static get<ThrowOnError extends boolean = false>(parameters: {
|
|
1839
2171
|
id: ApiKeyId;
|
|
@@ -1851,7 +2183,7 @@ export declare class ApiKeys {
|
|
|
1851
2183
|
/**
|
|
1852
2184
|
* Rotate an API key
|
|
1853
2185
|
*
|
|
1854
|
-
* Issues a replacement with the same owner, name, and
|
|
2186
|
+
* Issues a replacement with the same owner, name, and access, then deactivates the existing key. Returns the new key, including the plaintext secret.
|
|
1855
2187
|
*/
|
|
1856
2188
|
static rotate<ThrowOnError extends boolean = false>(parameters: {
|
|
1857
2189
|
id: ApiKeyId;
|