samva 0.6.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/README.md +2 -2
- package/dist/{categories-4u9Az4No.js → categories-DvsHUJtX.js} +9 -1
- package/dist/client/sdk.gen.d.ts +119 -33
- package/dist/client/types.gen.d.ts +643 -142
- package/dist/{client-DCM6U0-I.js → client-ByJHYp7r.js} +612 -223
- package/dist/{client-attribution-DYUSAa76.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.d.ts +212 -0
- package/dist/effect/brands.js +24 -0
- package/dist/effect/campaigns.d.ts +35 -1
- package/dist/effect/campaigns.js +1 -1
- package/dist/effect/categories.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 +21 -12
- package/dist/effect/conversations.js +1 -1
- package/dist/effect/custom-fields.js +1 -1
- package/dist/effect/email.d.ts +17 -6
- package/dist/effect/email.js +2 -2
- package/dist/effect/generated-metadata.d.ts +8 -0
- package/dist/effect/generated.d.ts +2880 -1661
- package/dist/effect/index.d.ts +2 -2
- package/dist/effect/index.js +4 -4
- package/dist/effect/internal/operation.d.ts +10 -4
- package/dist/effect/media.js +1 -1
- package/dist/effect/messages.d.ts +24 -6
- package/dist/effect/messages.js +1 -1
- package/dist/effect/operations.js +1 -1
- package/dist/effect/organizations.d.ts +5 -268
- package/dist/effect/organizations.js +4 -2
- package/dist/effect/retry.js +1 -1
- package/dist/effect/scheduled-messages.d.ts +16 -0
- package/dist/effect/scheduled-messages.js +1 -1
- package/dist/effect/templates.d.ts +260 -38
- package/dist/effect/templates.js +7 -3
- 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 +2 -2
- package/dist/{operation-02YX3hY9.js → operation-D2nEeKBD.js} +34 -5
- package/dist/promises/errors.gen.d.ts +22 -4
- package/dist/promises/index.d.ts +3 -3
- package/dist/promises/index.js +2 -2
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/{promises-8MaPNAam.js → promises-DAv8ZtOX.js} +376 -52
- package/dist/service-map.d.ts +45 -6
- package/package.json +7 -7
- package/dist/effect/design.d.ts +0 -209
- package/dist/effect/design.js +0 -13
package/README.md
CHANGED
|
@@ -125,12 +125,12 @@ The Promise client exposes:
|
|
|
125
125
|
- `analytics`
|
|
126
126
|
- `apiKeys`
|
|
127
127
|
- `attachments`
|
|
128
|
+
- `brands`
|
|
128
129
|
- `campaigns`
|
|
129
130
|
- `contactGroups`
|
|
130
131
|
- `contacts`
|
|
131
132
|
- `conversations`
|
|
132
133
|
- `customFields`
|
|
133
|
-
- `design`
|
|
134
134
|
- `email`
|
|
135
135
|
- `media`
|
|
136
136
|
- `messages`
|
|
@@ -146,12 +146,12 @@ The Effect SDK exposes Pascal-cased domain modules with lower-camel operations:
|
|
|
146
146
|
- `Analytics`
|
|
147
147
|
- `ApiKeys`
|
|
148
148
|
- `Attachments`
|
|
149
|
+
- `Brands`
|
|
149
150
|
- `Campaigns`
|
|
150
151
|
- `ContactGroups`
|
|
151
152
|
- `Contacts`
|
|
152
153
|
- `Conversations`
|
|
153
154
|
- `CustomFields`
|
|
154
|
-
- `Design`
|
|
155
155
|
- `Email`
|
|
156
156
|
- `Media`
|
|
157
157
|
- `Messages`
|
|
@@ -10,6 +10,14 @@ const SamvaErrorMetadata = {
|
|
|
10
10
|
categories: ["transient"],
|
|
11
11
|
retryable: true
|
|
12
12
|
},
|
|
13
|
+
BrandAddressRequiredError: {
|
|
14
|
+
categories: [],
|
|
15
|
+
retryable: false
|
|
16
|
+
},
|
|
17
|
+
CampaignFooterRequiredError: {
|
|
18
|
+
categories: [],
|
|
19
|
+
retryable: false
|
|
20
|
+
},
|
|
13
21
|
ConflictError: {
|
|
14
22
|
categories: ["conflict"],
|
|
15
23
|
retryable: false
|
|
@@ -160,4 +168,4 @@ const catchTransient = (handler) => (effect) => Effect.catchIf(effect, isTransie
|
|
|
160
168
|
//#endregion
|
|
161
169
|
export { isTransient as _, catchNotFoundError as a, catchValidationError as c, isAuthError as d, isBillingError as f, isThrottlingError as g, isRetryable as h, catchConflictError as i, categoriesOf as l, isNotFoundError as m, catchBillingError as n, catchThrottlingError as o, isConflictError as p, catchCategory as r, catchTransient as s, catchAuthError as t, hasCategory as u, isValidationError as v };
|
|
162
170
|
|
|
163
|
-
//# sourceMappingURL=categories-
|
|
171
|
+
//# sourceMappingURL=categories-DvsHUJtX.js.map
|
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from "./client";
|
|
2
|
-
import type { ActorTracking, 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";
|
|
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
|
|
@@ -255,7 +255,7 @@ export declare class Campaigns {
|
|
|
255
255
|
/**
|
|
256
256
|
* Schedule a campaign run
|
|
257
257
|
*
|
|
258
|
-
* Schedules an email campaign run at the absolute ISO-8601 instant in scheduledFor, or immediately when omitted. The optional idempotencyKey is scoped to the organization and replays return the original run.
|
|
258
|
+
* Schedules an email campaign run at the absolute ISO-8601 instant in scheduledFor, or immediately when omitted. The optional idempotencyKey is scoped to the organization and replays return the original run. An email campaign must carry the brand footer: it is refused with CampaignFooterRequiredError when its footer is off and its template renders no BrandFooter, and with BrandAddressRequiredError when a brand that signs it off has no postal address.
|
|
259
259
|
*/
|
|
260
260
|
static scheduleRun<ThrowOnError extends boolean = false>(parameters: {
|
|
261
261
|
id: CampaignId;
|
|
@@ -374,16 +374,17 @@ export declare class Email {
|
|
|
374
374
|
/**
|
|
375
375
|
* List sending domains
|
|
376
376
|
*
|
|
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
|
+
* Returns a paginated list of the organization's sending domains. `sendable=true` lists only domains a send can use now: active, and verified, or verified before and degraded since. 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.
|
|
378
378
|
*/
|
|
379
379
|
static listDomains<ThrowOnError extends boolean = false>(parameters?: {
|
|
380
380
|
page?: string | null | undefined;
|
|
381
381
|
limit?: string | null | undefined;
|
|
382
|
+
sendable?: "true" | null | undefined;
|
|
382
383
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailListDomainsResponses, EmailListDomainsErrors, ThrowOnError>;
|
|
383
384
|
/**
|
|
384
385
|
* Add a sending domain
|
|
385
386
|
*
|
|
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.
|
|
387
|
+
* 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. A banned organization is refused with 403.
|
|
387
388
|
*/
|
|
388
389
|
static addDomain<ThrowOnError extends boolean = false>(parameters: {
|
|
389
390
|
domain: string;
|
|
@@ -511,7 +512,7 @@ export declare class Email {
|
|
|
511
512
|
/**
|
|
512
513
|
* Update a domain's send-settings config
|
|
513
514
|
*
|
|
514
|
-
* Overrides the domain's open/click tracking, reply-to,
|
|
515
|
+
* Overrides the domain's open/click tracking, reply-to, unsubscribe-group defaults, and the brand its mail uses for the settings cascade. An omitted field is left unchanged; null clears it back to the organization default. Returns the saved config.
|
|
515
516
|
*/
|
|
516
517
|
static updateDomainConfig<ThrowOnError extends boolean = false>(parameters: {
|
|
517
518
|
id: EmailDomainId;
|
|
@@ -520,6 +521,7 @@ export declare class Email {
|
|
|
520
521
|
replyTo?: Array<string> | null | null | undefined;
|
|
521
522
|
unsubscribeGroupId?: UnsubscribeId | null | null | undefined;
|
|
522
523
|
footerEnabled?: boolean | null | null | undefined;
|
|
524
|
+
brandSlug?: string | null | null | undefined;
|
|
523
525
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailUpdateDomainConfigResponses, EmailUpdateDomainConfigErrors, ThrowOnError>;
|
|
524
526
|
/**
|
|
525
527
|
* Disable a custom tracking domain
|
|
@@ -574,9 +576,9 @@ export declare class Email {
|
|
|
574
576
|
errorDescription?: string | null | undefined;
|
|
575
577
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteCustomTrackingDomainConnectErrors, ThrowOnError>;
|
|
576
578
|
/**
|
|
577
|
-
* List
|
|
579
|
+
* List senders
|
|
578
580
|
*
|
|
579
|
-
* 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.
|
|
580
582
|
*/
|
|
581
583
|
static listSenders<ThrowOnError extends boolean = false>(parameters?: {
|
|
582
584
|
page?: string | null | undefined;
|
|
@@ -586,9 +588,9 @@ export declare class Email {
|
|
|
586
588
|
isDefault?: string | null | undefined;
|
|
587
589
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailListSendersResponses, EmailListSendersErrors, ThrowOnError>;
|
|
588
590
|
/**
|
|
589
|
-
* Add a sender
|
|
591
|
+
* Add a sender
|
|
590
592
|
*
|
|
591
|
-
* 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.
|
|
592
594
|
*/
|
|
593
595
|
static addSender<ThrowOnError extends boolean = false>(parameters: {
|
|
594
596
|
"idempotency-key": string;
|
|
@@ -600,23 +602,23 @@ export declare class Email {
|
|
|
600
602
|
/**
|
|
601
603
|
* Check sender verification status
|
|
602
604
|
*
|
|
603
|
-
* Returns the current verification status of a sender
|
|
605
|
+
* Returns the current verification status of a sender.
|
|
604
606
|
*/
|
|
605
607
|
static checkSenderVerification<ThrowOnError extends boolean = false>(parameters: {
|
|
606
608
|
id: EmailSenderId;
|
|
607
609
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCheckSenderVerificationResponses, EmailCheckSenderVerificationErrors, ThrowOnError>;
|
|
608
610
|
/**
|
|
609
|
-
* Remove a sender
|
|
611
|
+
* Remove a sender
|
|
610
612
|
*
|
|
611
|
-
* 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.
|
|
612
614
|
*/
|
|
613
615
|
static removeSender<ThrowOnError extends boolean = false>(parameters: {
|
|
614
616
|
id: EmailSenderId;
|
|
615
617
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailRemoveSenderResponses, EmailRemoveSenderErrors, ThrowOnError>;
|
|
616
618
|
/**
|
|
617
|
-
* Get a sender
|
|
619
|
+
* Get a sender
|
|
618
620
|
*
|
|
619
|
-
* Returns one sender
|
|
621
|
+
* Returns one sender owned by the authenticated organization. Other organizations' ids are reported as not found.
|
|
620
622
|
*/
|
|
621
623
|
static getSender<ThrowOnError extends boolean = false>(parameters: {
|
|
622
624
|
id: EmailSenderId;
|
|
@@ -1477,7 +1479,7 @@ export declare class Unsubscribe {
|
|
|
1477
1479
|
/**
|
|
1478
1480
|
* List unsubscribe groups
|
|
1479
1481
|
*
|
|
1480
|
-
* 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.
|
|
1481
1483
|
*/
|
|
1482
1484
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1483
1485
|
page?: string | null | undefined;
|
|
@@ -1495,7 +1497,7 @@ export declare class Unsubscribe {
|
|
|
1495
1497
|
/**
|
|
1496
1498
|
* Delete an unsubscribe group
|
|
1497
1499
|
*
|
|
1498
|
-
* 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.
|
|
1499
1501
|
*/
|
|
1500
1502
|
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
1501
1503
|
id: UnsubscribeId;
|
|
@@ -1510,6 +1512,14 @@ export declare class Unsubscribe {
|
|
|
1510
1512
|
name?: string | null | undefined;
|
|
1511
1513
|
description?: string | null | null | undefined;
|
|
1512
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>;
|
|
1513
1523
|
/**
|
|
1514
1524
|
* Remove contacts from an unsubscribe group
|
|
1515
1525
|
*
|
|
@@ -1631,6 +1641,7 @@ export declare class Templates {
|
|
|
1631
1641
|
channel?: "email" | null | undefined;
|
|
1632
1642
|
status?: "draft" | "pending" | "approved" | "published" | "rejected" | "archived" | null | undefined;
|
|
1633
1643
|
search?: string | null | undefined;
|
|
1644
|
+
projectId?: TemplateProjectId | null | undefined;
|
|
1634
1645
|
sortBy?: "name" | "createdAt" | "updatedAt" | "usageCount" | "lastUsedAt" | null | undefined;
|
|
1635
1646
|
sortOrder?: "asc" | "desc" | null | undefined;
|
|
1636
1647
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesListResponses, TemplatesListErrors, ThrowOnError>;
|
|
@@ -1644,6 +1655,7 @@ export declare class Templates {
|
|
|
1644
1655
|
projectName?: string | null | undefined;
|
|
1645
1656
|
slug?: string | null | undefined;
|
|
1646
1657
|
galleryTemplateId?: string | null | undefined;
|
|
1658
|
+
useBrand?: boolean | null | undefined;
|
|
1647
1659
|
description?: string | null | null | undefined;
|
|
1648
1660
|
category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | null | undefined;
|
|
1649
1661
|
isActive?: boolean | null | undefined;
|
|
@@ -1737,13 +1749,14 @@ export declare class Templates {
|
|
|
1737
1749
|
/**
|
|
1738
1750
|
* Update a template
|
|
1739
1751
|
*
|
|
1740
|
-
* Updates template metadata. Source changes use the project workspace API.
|
|
1752
|
+
* Updates template metadata. Setting `entryPath` points the template at another file in its project and keeps its id, slug, and publications; move the file in Git separately. Source changes use the project workspace API.
|
|
1741
1753
|
*/
|
|
1742
1754
|
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
1743
1755
|
id: TemplateId;
|
|
1744
1756
|
data: {
|
|
1745
1757
|
name?: string | null | undefined;
|
|
1746
1758
|
slug?: string | null | undefined;
|
|
1759
|
+
entryPath?: string | null | undefined;
|
|
1747
1760
|
description?: string | null | null | undefined;
|
|
1748
1761
|
category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | null | undefined;
|
|
1749
1762
|
fromDefault?: TemplateFromDefault | null | null | undefined;
|
|
@@ -1751,6 +1764,19 @@ export declare class Templates {
|
|
|
1751
1764
|
isActive?: boolean | null | undefined;
|
|
1752
1765
|
};
|
|
1753
1766
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesUpdateResponses, TemplatesUpdateErrors, ThrowOnError>;
|
|
1767
|
+
/**
|
|
1768
|
+
* Add a template entry
|
|
1769
|
+
*
|
|
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.
|
|
1771
|
+
*/
|
|
1772
|
+
static addEntry<ThrowOnError extends boolean = false>(parameters: {
|
|
1773
|
+
projectId: TemplateProjectId;
|
|
1774
|
+
entryPath: string;
|
|
1775
|
+
name: string;
|
|
1776
|
+
slug: string;
|
|
1777
|
+
description?: string | null | null | undefined;
|
|
1778
|
+
category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | null | undefined;
|
|
1779
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesAddEntryResponses, TemplatesAddEntryErrors, ThrowOnError>;
|
|
1754
1780
|
/**
|
|
1755
1781
|
* Patch template project files
|
|
1756
1782
|
*
|
|
@@ -1782,6 +1808,19 @@ export declare class Templates {
|
|
|
1782
1808
|
id: TemplateId;
|
|
1783
1809
|
expectedRevision: string;
|
|
1784
1810
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesDiffWorkspaceResponses, TemplatesDiffWorkspaceErrors, ThrowOnError>;
|
|
1811
|
+
/**
|
|
1812
|
+
* Put a template project asset
|
|
1813
|
+
*
|
|
1814
|
+
* Writes one image or font (png, jpg, jpeg, gif, webp, or woff2) into the shared project workspace as an unsaved file; Save commits it. The JSON body carries the file as canonical base64 in `contentBase64`, at most 1 MiB decoded, and the bytes must match the extension in `path`. `replace` must be `false` to add a new file and `true` to change an existing one.
|
|
1815
|
+
*/
|
|
1816
|
+
static putWorkspaceAsset<ThrowOnError extends boolean = false>(parameters: {
|
|
1817
|
+
id: TemplateId;
|
|
1818
|
+
expectedRevision: string;
|
|
1819
|
+
path: string;
|
|
1820
|
+
contentBase64: string;
|
|
1821
|
+
replace: boolean;
|
|
1822
|
+
idempotencyKey: string;
|
|
1823
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesPutWorkspaceAssetResponses, TemplatesPutWorkspaceAssetErrors, ThrowOnError>;
|
|
1785
1824
|
/**
|
|
1786
1825
|
* Reconcile a template project workspace
|
|
1787
1826
|
*
|
|
@@ -1862,7 +1901,7 @@ export declare class Templates {
|
|
|
1862
1901
|
/**
|
|
1863
1902
|
* Publish an exact template commit
|
|
1864
1903
|
*
|
|
1865
|
-
* 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.
|
|
1866
1905
|
*/
|
|
1867
1906
|
static publish<ThrowOnError extends boolean = false>(parameters: {
|
|
1868
1907
|
id: TemplateId;
|
|
@@ -1870,6 +1909,7 @@ export declare class Templates {
|
|
|
1870
1909
|
commitSha: string;
|
|
1871
1910
|
entryPath: string;
|
|
1872
1911
|
expectedWorkspaceRevision: string;
|
|
1912
|
+
ifCurrentPublicationId?: TemplatePublicationId | null | undefined;
|
|
1873
1913
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesPublishResponses, TemplatesPublishErrors, ThrowOnError>;
|
|
1874
1914
|
/**
|
|
1875
1915
|
* Get a template publication
|
|
@@ -1948,24 +1988,66 @@ export declare class Templates {
|
|
|
1948
1988
|
export declare class Templates2 {
|
|
1949
1989
|
static templates: typeof Templates;
|
|
1950
1990
|
}
|
|
1951
|
-
export declare class
|
|
1991
|
+
export declare class Brands {
|
|
1952
1992
|
/**
|
|
1953
|
-
*
|
|
1993
|
+
* List brands
|
|
1954
1994
|
*
|
|
1955
|
-
* Returns the organization's
|
|
1995
|
+
* Returns the organization's brands, the default brand first.
|
|
1956
1996
|
*/
|
|
1957
|
-
static
|
|
1997
|
+
static list<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<BrandsListResponses, BrandsListErrors, ThrowOnError>;
|
|
1958
1998
|
/**
|
|
1959
|
-
*
|
|
1999
|
+
* Create a brand
|
|
1960
2000
|
*
|
|
1961
|
-
*
|
|
2001
|
+
* Creates a brand. The CSS must parse as a brand theme; a rejected theme answers 422 with located findings under `fields.css`. With `isDefault`, the new brand becomes the default. An organization holds at most 12 brands; creating one more answers 409 with a `ConflictError`.
|
|
2002
|
+
*/
|
|
2003
|
+
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
2004
|
+
slug: string;
|
|
2005
|
+
name: string;
|
|
2006
|
+
css?: string | null | undefined;
|
|
2007
|
+
assets?: BrandAssets | null | undefined;
|
|
2008
|
+
footer?: BrandFooter | null | undefined;
|
|
2009
|
+
isDefault?: boolean | null | undefined;
|
|
2010
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<BrandsCreateResponses, BrandsCreateErrors, ThrowOnError>;
|
|
2011
|
+
/**
|
|
2012
|
+
* Delete a brand
|
|
2013
|
+
*
|
|
2014
|
+
* Deletes a brand. The default brand cannot be deleted; domains that used the deleted brand fall back to the default.
|
|
2015
|
+
*/
|
|
2016
|
+
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
2017
|
+
slug: string;
|
|
2018
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<BrandsRemoveResponses, BrandsRemoveErrors, ThrowOnError>;
|
|
2019
|
+
/**
|
|
2020
|
+
* Get a brand
|
|
2021
|
+
*
|
|
2022
|
+
* Returns one brand by its slug.
|
|
2023
|
+
*/
|
|
2024
|
+
static get<ThrowOnError extends boolean = false>(parameters: {
|
|
2025
|
+
slug: string;
|
|
2026
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<BrandsGetResponses, BrandsGetErrors, ThrowOnError>;
|
|
2027
|
+
/**
|
|
2028
|
+
* Update a brand
|
|
2029
|
+
*
|
|
2030
|
+
* Updates a brand. Each section given replaces that section whole. Published templates keep the brand they were built against until they are republished.
|
|
1962
2031
|
*/
|
|
1963
2032
|
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
1964
|
-
|
|
1965
|
-
|
|
2033
|
+
slug: string;
|
|
2034
|
+
newSlug?: string | null | undefined;
|
|
2035
|
+
name?: string | null | undefined;
|
|
2036
|
+
css?: string | null | undefined;
|
|
2037
|
+
assets?: BrandAssets | null | undefined;
|
|
2038
|
+
footer?: BrandFooter | null | undefined;
|
|
2039
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<BrandsUpdateResponses, BrandsUpdateErrors, ThrowOnError>;
|
|
2040
|
+
/**
|
|
2041
|
+
* Make a brand the default
|
|
2042
|
+
*
|
|
2043
|
+
* Makes this brand the organization's default: bare `samva:brand` and domains without a brand resolve to it at their next build or send.
|
|
2044
|
+
*/
|
|
2045
|
+
static setDefault<ThrowOnError extends boolean = false>(parameters: {
|
|
2046
|
+
slug: string;
|
|
2047
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<BrandsSetDefaultResponses, BrandsSetDefaultErrors, ThrowOnError>;
|
|
1966
2048
|
}
|
|
1967
|
-
export declare class
|
|
1968
|
-
static
|
|
2049
|
+
export declare class Brands2 {
|
|
2050
|
+
static brands: typeof Brands;
|
|
1969
2051
|
}
|
|
1970
2052
|
export declare class Webhooks {
|
|
1971
2053
|
/**
|
|
@@ -1987,7 +2069,7 @@ export declare class Webhooks {
|
|
|
1987
2069
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1988
2070
|
name: string;
|
|
1989
2071
|
url: string;
|
|
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">;
|
|
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">;
|
|
1991
2073
|
channels?: Array<"email"> | null | undefined;
|
|
1992
2074
|
headers?: {
|
|
1993
2075
|
[key: string]: string;
|
|
@@ -2019,7 +2101,7 @@ export declare class Webhooks {
|
|
|
2019
2101
|
id: WebhookEndpointId;
|
|
2020
2102
|
name?: string | null | undefined;
|
|
2021
2103
|
url?: string | null | undefined;
|
|
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;
|
|
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;
|
|
2023
2105
|
channels?: Array<"email"> | null | null | undefined;
|
|
2024
2106
|
headers?: {
|
|
2025
2107
|
[key: string]: string;
|
|
@@ -2094,7 +2176,7 @@ export declare class Organizations {
|
|
|
2094
2176
|
/**
|
|
2095
2177
|
* Update the current organization
|
|
2096
2178
|
*
|
|
2097
|
-
* Updates the current organization's profile, regional defaults,
|
|
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.
|
|
2098
2180
|
*/
|
|
2099
2181
|
static update<ThrowOnError extends boolean = false>(parameters?: {
|
|
2100
2182
|
name?: string | null | undefined;
|
|
@@ -2105,11 +2187,15 @@ export declare class Organizations {
|
|
|
2105
2187
|
metadata?: {
|
|
2106
2188
|
[key: string]: JsonValue;
|
|
2107
2189
|
} | null | undefined;
|
|
2108
|
-
design?: Design3 | null | null | undefined;
|
|
2109
2190
|
replyToDefault?: Array<string> | null | null | undefined;
|
|
2110
|
-
defaultUnsubscribeGroupId?: UnsubscribeId | null | null | undefined;
|
|
2111
2191
|
emailFooterEnabledDefault?: boolean | null | null | undefined;
|
|
2112
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>;
|
|
2113
2199
|
/**
|
|
2114
2200
|
* Get organization usage
|
|
2115
2201
|
*
|