samva 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client/sdk.gen.d.ts +31 -18
- package/dist/client/types.gen.d.ts +133 -48
- package/dist/{client-5O8KsY5Z.js → client-ByJHYp7r.js} +155 -91
- package/dist/{client-attribution-27MNycCV.js → client-attribution-N5A784Zo.js} +2 -2
- package/dist/effect/analytics.js +1 -1
- package/dist/effect/api-keys.js +1 -1
- package/dist/effect/attachments.js +1 -1
- package/dist/effect/brands.js +2 -2
- package/dist/effect/campaigns.d.ts +34 -0
- package/dist/effect/campaigns.js +1 -1
- package/dist/effect/client.js +1 -1
- package/dist/effect/contact-groups.js +1 -1
- package/dist/effect/contacts.js +1 -1
- package/dist/effect/conversations.d.ts +9 -9
- package/dist/effect/conversations.js +1 -1
- package/dist/effect/custom-fields.js +1 -1
- package/dist/effect/email.js +2 -2
- package/dist/effect/generated.d.ts +508 -221
- package/dist/effect/index.js +1 -1
- package/dist/effect/media.js +1 -1
- package/dist/effect/messages.d.ts +2 -0
- package/dist/effect/messages.js +1 -1
- package/dist/effect/operations.js +1 -1
- package/dist/effect/organizations.d.ts +5 -4
- package/dist/effect/organizations.js +4 -2
- package/dist/effect/scheduled-messages.d.ts +16 -0
- package/dist/effect/scheduled-messages.js +1 -1
- package/dist/effect/templates.d.ts +30 -38
- package/dist/effect/templates.js +2 -2
- package/dist/effect/unsubscribe-groups.d.ts +17 -0
- package/dist/effect/unsubscribe-groups.js +4 -2
- package/dist/effect/webhooks.d.ts +6 -6
- package/dist/effect/webhooks.js +2 -2
- package/dist/index.js +1 -1
- package/dist/{operation-Cb5V9FJ7.js → operation-D2nEeKBD.js} +7 -2
- package/dist/promises/index.js +1 -1
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/{promises-C2yyw-pf.js → promises-DAv8ZtOX.js} +51 -20
- package/dist/service-map.d.ts +9 -0
- package/package.json +2 -2
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, 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, 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, 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, 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, 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, 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";
|
|
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, 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, 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, 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, OrganizationsGetProfileErrors, OrganizationsGetProfileResponses, OrganizationsGetResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, ScheduledMessagesResumeErrors, ScheduledMessagesResumeResponses, 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, 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, UnsubscribeSetDefaultErrors, UnsubscribeSetDefaultResponses, 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
|
|
@@ -576,9 +576,9 @@ export declare class Email {
|
|
|
576
576
|
errorDescription?: string | null | undefined;
|
|
577
577
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteCustomTrackingDomainConnectErrors, ThrowOnError>;
|
|
578
578
|
/**
|
|
579
|
-
* List
|
|
579
|
+
* List senders
|
|
580
580
|
*
|
|
581
|
-
* Returns a paginated list of
|
|
581
|
+
* Returns a paginated list of senders, 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.
|
|
582
582
|
*/
|
|
583
583
|
static listSenders<ThrowOnError extends boolean = false>(parameters?: {
|
|
584
584
|
page?: string | null | undefined;
|
|
@@ -588,9 +588,9 @@ export declare class Email {
|
|
|
588
588
|
isDefault?: string | null | undefined;
|
|
589
589
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailListSendersResponses, EmailListSendersErrors, ThrowOnError>;
|
|
590
590
|
/**
|
|
591
|
-
* Add a sender
|
|
591
|
+
* Add a sender
|
|
592
592
|
*
|
|
593
|
-
* Creates a sender
|
|
593
|
+
* Creates a sender. The required Idempotency-Key replays the original sender for an identical request and conflicts when reused with different input.
|
|
594
594
|
*/
|
|
595
595
|
static addSender<ThrowOnError extends boolean = false>(parameters: {
|
|
596
596
|
"idempotency-key": string;
|
|
@@ -602,23 +602,23 @@ export declare class Email {
|
|
|
602
602
|
/**
|
|
603
603
|
* Check sender verification status
|
|
604
604
|
*
|
|
605
|
-
* Returns the current verification status of a sender
|
|
605
|
+
* Returns the current verification status of a sender.
|
|
606
606
|
*/
|
|
607
607
|
static checkSenderVerification<ThrowOnError extends boolean = false>(parameters: {
|
|
608
608
|
id: EmailSenderId;
|
|
609
609
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCheckSenderVerificationResponses, EmailCheckSenderVerificationErrors, ThrowOnError>;
|
|
610
610
|
/**
|
|
611
|
-
* Remove a sender
|
|
611
|
+
* Remove a sender
|
|
612
612
|
*
|
|
613
|
-
* Accepts sender removal and marks the sender inactive. It reports the `deleting` lifecycle until removal finishes.
|
|
613
|
+
* Accepts sender removal and marks the sender inactive. A default sender can be removed when no other active sender remains in the organization. It reports the `deleting` lifecycle until removal finishes.
|
|
614
614
|
*/
|
|
615
615
|
static removeSender<ThrowOnError extends boolean = false>(parameters: {
|
|
616
616
|
id: EmailSenderId;
|
|
617
617
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailRemoveSenderResponses, EmailRemoveSenderErrors, ThrowOnError>;
|
|
618
618
|
/**
|
|
619
|
-
* Get a sender
|
|
619
|
+
* Get a sender
|
|
620
620
|
*
|
|
621
|
-
* Returns one sender
|
|
621
|
+
* Returns one sender owned by the authenticated organization. Other organizations' ids are reported as not found.
|
|
622
622
|
*/
|
|
623
623
|
static getSender<ThrowOnError extends boolean = false>(parameters: {
|
|
624
624
|
id: EmailSenderId;
|
|
@@ -1479,7 +1479,7 @@ export declare class Unsubscribe {
|
|
|
1479
1479
|
/**
|
|
1480
1480
|
* List unsubscribe groups
|
|
1481
1481
|
*
|
|
1482
|
-
* Returns a paginated list of the organization's unsubscribe groups.
|
|
1482
|
+
* Returns a paginated list of the organization's unsubscribe groups, the default group first.
|
|
1483
1483
|
*/
|
|
1484
1484
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1485
1485
|
page?: string | null | undefined;
|
|
@@ -1497,7 +1497,7 @@ export declare class Unsubscribe {
|
|
|
1497
1497
|
/**
|
|
1498
1498
|
* Delete an unsubscribe group
|
|
1499
1499
|
*
|
|
1500
|
-
* Permanently deletes an unsubscribe group by its ID.
|
|
1500
|
+
* Permanently deletes an unsubscribe group by its ID. The default group cannot be deleted; make another group the default first. A group a scheduled or running campaign uses cannot be deleted until that run finishes or is cancelled.
|
|
1501
1501
|
*/
|
|
1502
1502
|
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
1503
1503
|
id: UnsubscribeId;
|
|
@@ -1512,6 +1512,14 @@ export declare class Unsubscribe {
|
|
|
1512
1512
|
name?: string | null | undefined;
|
|
1513
1513
|
description?: string | null | null | undefined;
|
|
1514
1514
|
}, options?: Options<never, ThrowOnError>): RequestResult<UnsubscribeUpdateResponses, UnsubscribeUpdateErrors, ThrowOnError>;
|
|
1515
|
+
/**
|
|
1516
|
+
* Make an unsubscribe group the default
|
|
1517
|
+
*
|
|
1518
|
+
* Makes this group the organization's default: campaigns that name no group, and whose template and sending domain name none, unsubscribe recipients from it.
|
|
1519
|
+
*/
|
|
1520
|
+
static setDefault<ThrowOnError extends boolean = false>(parameters: {
|
|
1521
|
+
id: UnsubscribeId;
|
|
1522
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<UnsubscribeSetDefaultResponses, UnsubscribeSetDefaultErrors, ThrowOnError>;
|
|
1515
1523
|
/**
|
|
1516
1524
|
* Remove contacts from an unsubscribe group
|
|
1517
1525
|
*
|
|
@@ -1759,7 +1767,7 @@ export declare class Templates {
|
|
|
1759
1767
|
/**
|
|
1760
1768
|
* Add a template entry
|
|
1761
1769
|
*
|
|
1762
|
-
* Registers
|
|
1770
|
+
* Registers a `.tsx` file under `templates/` or `emails/` in an existing template project as its own template and returns it with status 201. The file does not need to exist yet; publishing fails until a commit contains it. Repeating the call with the same entry path, name, and slug returns the existing template.
|
|
1763
1771
|
*/
|
|
1764
1772
|
static addEntry<ThrowOnError extends boolean = false>(parameters: {
|
|
1765
1773
|
projectId: TemplateProjectId;
|
|
@@ -1893,7 +1901,7 @@ export declare class Templates {
|
|
|
1893
1901
|
/**
|
|
1894
1902
|
* Publish an exact template commit
|
|
1895
1903
|
*
|
|
1896
|
-
* Builds an exact Git commit and entry path, stores the immutable
|
|
1904
|
+
* Builds an exact Git commit and entry path, stores the immutable compiled IR and its assets, records the input contract it validates against, and makes that publication current.
|
|
1897
1905
|
*/
|
|
1898
1906
|
static publish<ThrowOnError extends boolean = false>(parameters: {
|
|
1899
1907
|
id: TemplateId;
|
|
@@ -2061,7 +2069,7 @@ export declare class Webhooks {
|
|
|
2061
2069
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
2062
2070
|
name: string;
|
|
2063
2071
|
url: string;
|
|
2064
|
-
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">;
|
|
2072
|
+
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.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
|
|
2065
2073
|
channels?: Array<"email"> | null | undefined;
|
|
2066
2074
|
headers?: {
|
|
2067
2075
|
[key: string]: string;
|
|
@@ -2093,7 +2101,7 @@ export declare class Webhooks {
|
|
|
2093
2101
|
id: WebhookEndpointId;
|
|
2094
2102
|
name?: string | null | undefined;
|
|
2095
2103
|
url?: string | null | undefined;
|
|
2096
|
-
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;
|
|
2104
|
+
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.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated"> | null | undefined;
|
|
2097
2105
|
channels?: Array<"email"> | null | null | undefined;
|
|
2098
2106
|
headers?: {
|
|
2099
2107
|
[key: string]: string;
|
|
@@ -2168,7 +2176,7 @@ export declare class Organizations {
|
|
|
2168
2176
|
/**
|
|
2169
2177
|
* Update the current organization
|
|
2170
2178
|
*
|
|
2171
|
-
* Updates the current organization's profile, regional defaults, reply-to
|
|
2179
|
+
* Updates the current organization's profile, regional defaults, and reply-to default and returns the saved organization. `metadata` is merged into the stored value; every other field is replaced.
|
|
2172
2180
|
*/
|
|
2173
2181
|
static update<ThrowOnError extends boolean = false>(parameters?: {
|
|
2174
2182
|
name?: string | null | undefined;
|
|
@@ -2180,9 +2188,14 @@ export declare class Organizations {
|
|
|
2180
2188
|
[key: string]: JsonValue;
|
|
2181
2189
|
} | null | undefined;
|
|
2182
2190
|
replyToDefault?: Array<string> | null | null | undefined;
|
|
2183
|
-
defaultUnsubscribeGroupId?: UnsubscribeId | null | null | undefined;
|
|
2184
2191
|
emailFooterEnabledDefault?: boolean | null | null | undefined;
|
|
2185
2192
|
}, options?: Options<never, ThrowOnError>): RequestResult<OrganizationsUpdateResponses, OrganizationsUpdateErrors, ThrowOnError>;
|
|
2193
|
+
/**
|
|
2194
|
+
* Get the current account profile
|
|
2195
|
+
*
|
|
2196
|
+
* Returns your identity in the organization authorized by your credential. The ID remains stable across reconnects and display-name changes. Removing and re-adding your membership creates a new ID.
|
|
2197
|
+
*/
|
|
2198
|
+
static getProfile<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<OrganizationsGetProfileResponses, OrganizationsGetProfileErrors, ThrowOnError>;
|
|
2186
2199
|
/**
|
|
2187
2200
|
* Get organization usage
|
|
2188
2201
|
*
|
|
@@ -258,6 +258,8 @@ export type TemplatePublicationId = string;
|
|
|
258
258
|
export type TemplateInputContractId = string;
|
|
259
259
|
export type TemplateId = string;
|
|
260
260
|
export type TemplateData = JsonObject | null;
|
|
261
|
+
export type RenderLocale = string;
|
|
262
|
+
export type RenderTimeZone = string;
|
|
261
263
|
export type ReplyToAddresses = Array<string> | null | null;
|
|
262
264
|
export type UnsubscribeId = string;
|
|
263
265
|
export type EmailFooterOverride = {
|
|
@@ -273,6 +275,8 @@ export type EmailContent = {
|
|
|
273
275
|
templateId?: TemplateId | null | undefined;
|
|
274
276
|
templateSlug?: string | null | undefined;
|
|
275
277
|
templateData?: TemplateData | undefined;
|
|
278
|
+
locale?: RenderLocale | undefined;
|
|
279
|
+
timeZone?: RenderTimeZone | undefined;
|
|
276
280
|
inReplyToMessageId?: MessageId | null | undefined;
|
|
277
281
|
replyTo?: ReplyToAddresses | undefined;
|
|
278
282
|
unsubscribeGroupId?: UnsubscribeId | null | undefined;
|
|
@@ -399,6 +403,8 @@ export type EmailDispatchContent = {
|
|
|
399
403
|
templateId?: TemplateId | null | undefined;
|
|
400
404
|
templateSlug?: string | null | undefined;
|
|
401
405
|
templateData?: TemplateData | undefined;
|
|
406
|
+
locale?: RenderLocale | undefined;
|
|
407
|
+
timeZone?: RenderTimeZone | undefined;
|
|
402
408
|
inReplyToMessageId?: MessageId | null | undefined;
|
|
403
409
|
replyTo?: ReplyToAddresses | undefined;
|
|
404
410
|
unsubscribeGroupId?: UnsubscribeId | null | undefined;
|
|
@@ -988,7 +994,7 @@ export type ActorTracking = {
|
|
|
988
994
|
activeActorIds: Array<ActorId>;
|
|
989
995
|
actorHistory: Array<{
|
|
990
996
|
actorId: ActorId;
|
|
991
|
-
actorType: "contact" | "system" | "
|
|
997
|
+
actorType: "contact" | "system" | "sender" | "agent" | "user";
|
|
992
998
|
joinedAt: string;
|
|
993
999
|
leftAt?: string | null | undefined;
|
|
994
1000
|
role: "initiator" | "responder" | "observer";
|
|
@@ -1056,7 +1062,7 @@ export type Conversation = {
|
|
|
1056
1062
|
};
|
|
1057
1063
|
export type ConversationParticipant = {
|
|
1058
1064
|
actorId: ActorId;
|
|
1059
|
-
actorType: "contact" | "system" | "
|
|
1065
|
+
actorType: "contact" | "system" | "sender" | "agent" | "user";
|
|
1060
1066
|
contact: MessageContact;
|
|
1061
1067
|
};
|
|
1062
1068
|
export type ConversationDetail = {
|
|
@@ -1359,6 +1365,14 @@ export type BrandFooter = {
|
|
|
1359
1365
|
address?: BrandAddress | null | undefined;
|
|
1360
1366
|
socialLinks?: Array<BrandSocialLink> | null | undefined;
|
|
1361
1367
|
};
|
|
1368
|
+
export type BrandFooterBlock = {
|
|
1369
|
+
html: string;
|
|
1370
|
+
text: string;
|
|
1371
|
+
};
|
|
1372
|
+
export type BrandRenderedFooter = {
|
|
1373
|
+
withUnsubscribe: BrandFooterBlock;
|
|
1374
|
+
withoutUnsubscribe: BrandFooterBlock;
|
|
1375
|
+
};
|
|
1362
1376
|
export type BrandId = string;
|
|
1363
1377
|
export type Brand = {
|
|
1364
1378
|
id: BrandId;
|
|
@@ -1405,7 +1419,7 @@ export type UpdateBrand = {
|
|
|
1405
1419
|
export type CreateWebhookPayload = {
|
|
1406
1420
|
name: string;
|
|
1407
1421
|
url: string;
|
|
1408
|
-
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">;
|
|
1422
|
+
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.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
|
|
1409
1423
|
channels?: Array<"email"> | null | undefined;
|
|
1410
1424
|
headers?: {
|
|
1411
1425
|
[key: string]: string;
|
|
@@ -1416,7 +1430,7 @@ export type WebhookEndpoint = {
|
|
|
1416
1430
|
id: WebhookEndpointId;
|
|
1417
1431
|
name: string;
|
|
1418
1432
|
url: string;
|
|
1419
|
-
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">;
|
|
1433
|
+
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.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
|
|
1420
1434
|
channels: Array<"email"> | null;
|
|
1421
1435
|
status: "active" | "disabled";
|
|
1422
1436
|
hasCustomHeaders: boolean;
|
|
@@ -1436,7 +1450,7 @@ export type WebhookEndpointListItem = {
|
|
|
1436
1450
|
id: WebhookEndpointId;
|
|
1437
1451
|
name: string;
|
|
1438
1452
|
url: string;
|
|
1439
|
-
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">;
|
|
1453
|
+
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.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
|
|
1440
1454
|
channels: Array<"email"> | null;
|
|
1441
1455
|
status: "active" | "disabled";
|
|
1442
1456
|
hasCustomHeaders: boolean;
|
|
@@ -1449,7 +1463,7 @@ export type WebhookEndpointListItem = {
|
|
|
1449
1463
|
export type UpdateWebhookPayload = {
|
|
1450
1464
|
name?: string | null | undefined;
|
|
1451
1465
|
url?: string | null | undefined;
|
|
1452
|
-
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;
|
|
1466
|
+
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.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated"> | null | undefined;
|
|
1453
1467
|
channels?: Array<"email"> | null | null | undefined;
|
|
1454
1468
|
headers?: {
|
|
1455
1469
|
[key: string]: string;
|
|
@@ -1494,7 +1508,6 @@ export type Organization = {
|
|
|
1494
1508
|
[key: string]: JsonValue;
|
|
1495
1509
|
} | null;
|
|
1496
1510
|
replyToDefault: Array<string> | null;
|
|
1497
|
-
defaultUnsubscribeGroupId: UnsubscribeId | null;
|
|
1498
1511
|
emailFooterEnabledDefault: boolean | null;
|
|
1499
1512
|
messagesUsed: number;
|
|
1500
1513
|
messagesUsedThisMonth: number;
|
|
@@ -7954,6 +7967,7 @@ export type UnsubscribeListResponses = {
|
|
|
7954
7967
|
organizationId: string;
|
|
7955
7968
|
name: string;
|
|
7956
7969
|
description: string | null;
|
|
7970
|
+
isDefault: boolean;
|
|
7957
7971
|
memberCount: number;
|
|
7958
7972
|
createdAt: string;
|
|
7959
7973
|
updatedAt: string;
|
|
@@ -7999,6 +8013,7 @@ export type UnsubscribeCreateResponses = {
|
|
|
7999
8013
|
organizationId: string;
|
|
8000
8014
|
name: string;
|
|
8001
8015
|
description: string | null;
|
|
8016
|
+
isDefault: boolean;
|
|
8002
8017
|
memberCount: number;
|
|
8003
8018
|
createdAt: string;
|
|
8004
8019
|
updatedAt: string;
|
|
@@ -8026,6 +8041,10 @@ export type UnsubscribeRemoveErrors = {
|
|
|
8026
8041
|
* ResourceNotFoundError
|
|
8027
8042
|
*/
|
|
8028
8043
|
404: ResourceNotFoundError;
|
|
8044
|
+
/**
|
|
8045
|
+
* ConflictError
|
|
8046
|
+
*/
|
|
8047
|
+
409: ConflictError;
|
|
8029
8048
|
/**
|
|
8030
8049
|
* InternalError
|
|
8031
8050
|
*/
|
|
@@ -8088,12 +8107,60 @@ export type UnsubscribeUpdateResponses = {
|
|
|
8088
8107
|
organizationId: string;
|
|
8089
8108
|
name: string;
|
|
8090
8109
|
description: string | null;
|
|
8110
|
+
isDefault: boolean;
|
|
8091
8111
|
memberCount: number;
|
|
8092
8112
|
createdAt: string;
|
|
8093
8113
|
updatedAt: string;
|
|
8094
8114
|
};
|
|
8095
8115
|
};
|
|
8096
8116
|
export type UnsubscribeUpdateResponse = UnsubscribeUpdateResponses[keyof UnsubscribeUpdateResponses];
|
|
8117
|
+
export type UnsubscribeSetDefaultData = {
|
|
8118
|
+
body?: never;
|
|
8119
|
+
path: {
|
|
8120
|
+
id: UnsubscribeId;
|
|
8121
|
+
};
|
|
8122
|
+
query?: never;
|
|
8123
|
+
url: "/v1/unsubscribe-groups/{id}/default";
|
|
8124
|
+
};
|
|
8125
|
+
export type UnsubscribeSetDefaultErrors = {
|
|
8126
|
+
/**
|
|
8127
|
+
* UnauthorizedError
|
|
8128
|
+
*/
|
|
8129
|
+
401: UnauthorizedError;
|
|
8130
|
+
/**
|
|
8131
|
+
* ForbiddenError
|
|
8132
|
+
*/
|
|
8133
|
+
403: ForbiddenError;
|
|
8134
|
+
/**
|
|
8135
|
+
* ResourceNotFoundError
|
|
8136
|
+
*/
|
|
8137
|
+
404: ResourceNotFoundError;
|
|
8138
|
+
/**
|
|
8139
|
+
* InternalError
|
|
8140
|
+
*/
|
|
8141
|
+
500: InternalError;
|
|
8142
|
+
/**
|
|
8143
|
+
* GatewayTimeoutError
|
|
8144
|
+
*/
|
|
8145
|
+
504: GatewayTimeoutError;
|
|
8146
|
+
};
|
|
8147
|
+
export type UnsubscribeSetDefaultError = UnsubscribeSetDefaultErrors[keyof UnsubscribeSetDefaultErrors];
|
|
8148
|
+
export type UnsubscribeSetDefaultResponses = {
|
|
8149
|
+
/**
|
|
8150
|
+
* Success
|
|
8151
|
+
*/
|
|
8152
|
+
200: {
|
|
8153
|
+
id: UnsubscribeId;
|
|
8154
|
+
organizationId: string;
|
|
8155
|
+
name: string;
|
|
8156
|
+
description: string | null;
|
|
8157
|
+
isDefault: boolean;
|
|
8158
|
+
memberCount: number;
|
|
8159
|
+
createdAt: string;
|
|
8160
|
+
updatedAt: string;
|
|
8161
|
+
};
|
|
8162
|
+
};
|
|
8163
|
+
export type UnsubscribeSetDefaultResponse = UnsubscribeSetDefaultResponses[keyof UnsubscribeSetDefaultResponses];
|
|
8097
8164
|
export type UnsubscribeRemoveEmailsData = {
|
|
8098
8165
|
body: {
|
|
8099
8166
|
emails: Array<string>;
|
|
@@ -10210,10 +10277,6 @@ export type TemplatesCheckWorkspaceResponses = {
|
|
|
10210
10277
|
schemaDigest: string;
|
|
10211
10278
|
contractDigest: string;
|
|
10212
10279
|
};
|
|
10213
|
-
runtime: {
|
|
10214
|
-
now?: number | undefined;
|
|
10215
|
-
randomSeed?: number | undefined;
|
|
10216
|
-
};
|
|
10217
10280
|
fixtures: Array<string>;
|
|
10218
10281
|
} | null;
|
|
10219
10282
|
diagnostics: Array<{
|
|
@@ -10321,10 +10384,6 @@ export type TemplatesRenderWorkspaceFixtureResponses = {
|
|
|
10321
10384
|
schemaDigest: string;
|
|
10322
10385
|
contractDigest: string;
|
|
10323
10386
|
};
|
|
10324
|
-
runtime: {
|
|
10325
|
-
now?: number | undefined;
|
|
10326
|
-
randomSeed?: number | undefined;
|
|
10327
|
-
};
|
|
10328
10387
|
fixtures: Array<string>;
|
|
10329
10388
|
} | null;
|
|
10330
10389
|
diagnostics: Array<{
|
|
@@ -10459,26 +10518,16 @@ export type TemplatesPublishResponses = {
|
|
|
10459
10518
|
buildIdentity: string;
|
|
10460
10519
|
manifest: {
|
|
10461
10520
|
templateKey: string;
|
|
10462
|
-
|
|
10463
|
-
|
|
10521
|
+
ir: {
|
|
10522
|
+
version: number;
|
|
10523
|
+
digest: string;
|
|
10464
10524
|
bytes: number;
|
|
10465
10525
|
};
|
|
10526
|
+
compiler: string;
|
|
10466
10527
|
input: {
|
|
10467
10528
|
schemaDigest: string;
|
|
10468
10529
|
contractDigest: string;
|
|
10469
10530
|
};
|
|
10470
|
-
environment: {
|
|
10471
|
-
locale: string;
|
|
10472
|
-
timeZone: "UTC";
|
|
10473
|
-
now?: number | undefined;
|
|
10474
|
-
randomSeed?: number | undefined;
|
|
10475
|
-
compiler: string;
|
|
10476
|
-
runtime: string;
|
|
10477
|
-
checker: string;
|
|
10478
|
-
lockKind: "bun" | "npm";
|
|
10479
|
-
lockDigest: string;
|
|
10480
|
-
digest: string;
|
|
10481
|
-
};
|
|
10482
10531
|
assets: {
|
|
10483
10532
|
base: string;
|
|
10484
10533
|
entries: Array<{
|
|
@@ -10501,11 +10550,12 @@ export type TemplatesPublishResponses = {
|
|
|
10501
10550
|
css: string;
|
|
10502
10551
|
assets: BrandAssets;
|
|
10503
10552
|
footer: BrandFooter;
|
|
10553
|
+
renderedFooter: BrandRenderedFooter;
|
|
10504
10554
|
digest: string;
|
|
10505
10555
|
rendersFooter: "every" | "some" | "none";
|
|
10506
10556
|
} | undefined;
|
|
10507
10557
|
};
|
|
10508
|
-
|
|
10558
|
+
ir: {
|
|
10509
10559
|
key: string;
|
|
10510
10560
|
digest: string;
|
|
10511
10561
|
};
|
|
@@ -10618,26 +10668,16 @@ export type TemplatesGetPublicationResponses = {
|
|
|
10618
10668
|
buildIdentity: string;
|
|
10619
10669
|
manifest: {
|
|
10620
10670
|
templateKey: string;
|
|
10621
|
-
|
|
10622
|
-
|
|
10671
|
+
ir: {
|
|
10672
|
+
version: number;
|
|
10673
|
+
digest: string;
|
|
10623
10674
|
bytes: number;
|
|
10624
10675
|
};
|
|
10676
|
+
compiler: string;
|
|
10625
10677
|
input: {
|
|
10626
10678
|
schemaDigest: string;
|
|
10627
10679
|
contractDigest: string;
|
|
10628
10680
|
};
|
|
10629
|
-
environment: {
|
|
10630
|
-
locale: string;
|
|
10631
|
-
timeZone: "UTC";
|
|
10632
|
-
now?: number | undefined;
|
|
10633
|
-
randomSeed?: number | undefined;
|
|
10634
|
-
compiler: string;
|
|
10635
|
-
runtime: string;
|
|
10636
|
-
checker: string;
|
|
10637
|
-
lockKind: "bun" | "npm";
|
|
10638
|
-
lockDigest: string;
|
|
10639
|
-
digest: string;
|
|
10640
|
-
};
|
|
10641
10681
|
assets: {
|
|
10642
10682
|
base: string;
|
|
10643
10683
|
entries: Array<{
|
|
@@ -10660,11 +10700,12 @@ export type TemplatesGetPublicationResponses = {
|
|
|
10660
10700
|
css: string;
|
|
10661
10701
|
assets: BrandAssets;
|
|
10662
10702
|
footer: BrandFooter;
|
|
10703
|
+
renderedFooter: BrandRenderedFooter;
|
|
10663
10704
|
digest: string;
|
|
10664
10705
|
rendersFooter: "every" | "some" | "none";
|
|
10665
10706
|
} | undefined;
|
|
10666
10707
|
};
|
|
10667
|
-
|
|
10708
|
+
ir: {
|
|
10668
10709
|
key: string;
|
|
10669
10710
|
digest: string;
|
|
10670
10711
|
};
|
|
@@ -11463,7 +11504,7 @@ export type WebhooksCreateData = {
|
|
|
11463
11504
|
body: {
|
|
11464
11505
|
name: string;
|
|
11465
11506
|
url: string;
|
|
11466
|
-
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">;
|
|
11507
|
+
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.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
|
|
11467
11508
|
channels?: Array<"email"> | null | undefined;
|
|
11468
11509
|
headers?: {
|
|
11469
11510
|
[key: string]: string;
|
|
@@ -11603,7 +11644,7 @@ export type WebhooksUpdateData = {
|
|
|
11603
11644
|
body: {
|
|
11604
11645
|
name?: string | null | undefined;
|
|
11605
11646
|
url?: string | null | undefined;
|
|
11606
|
-
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;
|
|
11647
|
+
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.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated"> | null | undefined;
|
|
11607
11648
|
channels?: Array<"email"> | null | null | undefined;
|
|
11608
11649
|
headers?: {
|
|
11609
11650
|
[key: string]: string;
|
|
@@ -11996,7 +12037,6 @@ export type OrganizationsUpdateData = {
|
|
|
11996
12037
|
[key: string]: JsonValue;
|
|
11997
12038
|
} | null | undefined;
|
|
11998
12039
|
replyToDefault?: Array<string> | null | null | undefined;
|
|
11999
|
-
defaultUnsubscribeGroupId?: UnsubscribeId | null | null | undefined;
|
|
12000
12040
|
emailFooterEnabledDefault?: boolean | null | null | undefined;
|
|
12001
12041
|
};
|
|
12002
12042
|
path?: never;
|
|
@@ -12037,6 +12077,51 @@ export type OrganizationsUpdateResponses = {
|
|
|
12037
12077
|
200: Organization;
|
|
12038
12078
|
};
|
|
12039
12079
|
export type OrganizationsUpdateResponse = OrganizationsUpdateResponses[keyof OrganizationsUpdateResponses];
|
|
12080
|
+
export type OrganizationsGetProfileData = {
|
|
12081
|
+
body?: never;
|
|
12082
|
+
path?: never;
|
|
12083
|
+
query?: never;
|
|
12084
|
+
url: "/v1/organizations/current/profile";
|
|
12085
|
+
};
|
|
12086
|
+
export type OrganizationsGetProfileErrors = {
|
|
12087
|
+
/**
|
|
12088
|
+
* UnauthorizedError
|
|
12089
|
+
*/
|
|
12090
|
+
401: UnauthorizedError;
|
|
12091
|
+
/**
|
|
12092
|
+
* ForbiddenError
|
|
12093
|
+
*/
|
|
12094
|
+
403: ForbiddenError;
|
|
12095
|
+
/**
|
|
12096
|
+
* InternalError
|
|
12097
|
+
*/
|
|
12098
|
+
500: InternalError;
|
|
12099
|
+
/**
|
|
12100
|
+
* GatewayTimeoutError
|
|
12101
|
+
*/
|
|
12102
|
+
504: GatewayTimeoutError;
|
|
12103
|
+
};
|
|
12104
|
+
export type OrganizationsGetProfileError = OrganizationsGetProfileErrors[keyof OrganizationsGetProfileErrors];
|
|
12105
|
+
export type OrganizationsGetProfileResponses = {
|
|
12106
|
+
/**
|
|
12107
|
+
* Success
|
|
12108
|
+
*/
|
|
12109
|
+
200: {
|
|
12110
|
+
/**
|
|
12111
|
+
* Opaque identity for your organization membership
|
|
12112
|
+
*/
|
|
12113
|
+
id: string;
|
|
12114
|
+
/**
|
|
12115
|
+
* Your display name
|
|
12116
|
+
*/
|
|
12117
|
+
name: string;
|
|
12118
|
+
/**
|
|
12119
|
+
* Your display name and organization name
|
|
12120
|
+
*/
|
|
12121
|
+
nickname: string;
|
|
12122
|
+
};
|
|
12123
|
+
};
|
|
12124
|
+
export type OrganizationsGetProfileResponse = OrganizationsGetProfileResponses[keyof OrganizationsGetProfileResponses];
|
|
12040
12125
|
export type OrganizationsGetUsageData = {
|
|
12041
12126
|
body?: never;
|
|
12042
12127
|
path?: never;
|