samva 0.1.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +1 -1
- package/README.md +10 -3
- package/dist/client/sdk.gen.d.ts +333 -188
- package/dist/client/types.gen.d.ts +1452 -718
- package/dist/{client-DVALvDUe.js → client-BOghX8fr.js} +1990 -1631
- package/dist/effect/api-keys.d.ts +14 -14
- package/dist/effect/api-keys.js +1 -1
- package/dist/effect/campaigns.d.ts +233 -861
- package/dist/effect/campaigns.js +1 -1
- package/dist/effect/categories.d.ts +1 -1
- package/dist/effect/client.js +1 -1
- package/dist/effect/contacts.d.ts +131 -231
- package/dist/effect/contacts.js +1 -1
- package/dist/effect/conversations.d.ts +91 -208
- package/dist/effect/conversations.js +1 -1
- package/dist/effect/design.d.ts +11 -11
- package/dist/effect/design.js +1 -1
- package/dist/effect/email.d.ts +164 -168
- package/dist/effect/email.js +20 -18
- package/dist/effect/generated.d.ts +13753 -14935
- package/dist/effect/index.d.ts +1 -0
- package/dist/effect/index.js +3 -2
- package/dist/effect/internal/operation.d.ts +15 -113
- package/dist/effect/media.d.ts +80 -0
- package/dist/effect/media.js +19 -0
- package/dist/effect/messages.d.ts +41 -261
- package/dist/effect/messages.js +1 -1
- package/dist/effect/operations.d.ts +10 -10
- package/dist/effect/operations.js +1 -1
- package/dist/effect/organizations.d.ts +24 -42
- package/dist/effect/organizations.js +1 -1
- package/dist/effect/scheduled-messages.d.ts +43 -502
- package/dist/effect/scheduled-messages.js +1 -1
- package/dist/effect/templates.d.ts +312 -1542
- package/dist/effect/templates.js +26 -18
- package/dist/effect/webhooks.d.ts +26 -27
- package/dist/effect/webhooks.js +2 -2
- package/dist/index.js +1 -1
- package/dist/{normalize-LkWl4HUF.js → normalize-BKFjbR9t.js} +5 -13
- package/dist/normalize.d.ts +3 -33
- package/dist/{operation-UtKNITtG.js → operation-C2Q4cFJL.js} +67 -26
- package/dist/promises/index.d.ts +6 -14
- package/dist/promises/index.js +1 -1
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/{promises-QxEfMTho.js → promises-oiy7mOyu.js} +680 -157
- package/dist/service-map.d.ts +92 -40
- package/package.json +19 -14
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from "./client";
|
|
2
|
-
import type { ActorTracking, ApiKeyId, ApiKeyPermissions, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRemoveErrors, ApiKeysRemoveResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, BlockedEmailId, CampaignAudience, CampaignContentInput, CampaignId, CampaignPolicy, CampaignRunId, CampaignsArchiveErrors, CampaignsArchiveResponses, CampaignsCancelRunErrors, CampaignsCancelRunResponses, CampaignsCreateErrors, CampaignsCreateResponses, CampaignsGetErrors, CampaignsGetResponses, CampaignsGetRunErrors, CampaignsGetRunResponses, CampaignsListErrors, CampaignsListRecipientsErrors, CampaignsListRecipientsResponses, CampaignsListResponses, CampaignsListRunsErrors, CampaignsListRunsResponses, CampaignsPauseRunErrors, CampaignsPauseRunResponses, CampaignsResumeRunErrors, CampaignsResumeRunResponses, CampaignsScheduleRunErrors, CampaignsScheduleRunResponses, CampaignsUpdateErrors, CampaignsUpdateResponses, ContactAccessConfig, ContactId, ContactIdentity, ContactPreferences, ContactsBulkDeleteErrors, ContactsBulkDeleteResponses, ContactsBulkImportErrors, ContactsBulkImportResponses, ContactsBulkUpdateStatusErrors, ContactsBulkUpdateStatusResponses, ContactsBulkUpdateTagsErrors, ContactsBulkUpdateTagsResponses, ContactsCreateErrors, ContactsCreateResponses, ContactsExportErrors, ContactsExportResponses, ContactsFindErrors, ContactsFindOrCreateErrors, ContactsFindOrCreateResponses, ContactsFindResponses, ContactsGetActivityTimelineErrors, ContactsGetActivityTimelineResponses, ContactsGetEngagementErrors, ContactsGetEngagementResponses, ContactsGetErrors, ContactsGetGroupMembershipsErrors, ContactsGetGroupMembershipsResponses, ContactsGetResponses, ContactsListErrors, ContactsListResponses, ContactsRemoveErrors, ContactsRemoveResponses, ContactsUpdateErrors, ContactsUpdateResponses, ConversationContext, ConversationId, ConversationMetadata, ConversationMetrics, ConversationsAddContactsErrors, ConversationsAddContactsResponses, ConversationsCreateErrors, ConversationsCreateResponses, ConversationsGetByIdErrors, ConversationsGetByIdResponses, ConversationsListErrors, ConversationsListMessagesErrors, ConversationsListMessagesResponses, ConversationsListResponses, ConversationsRemoveContactsErrors, ConversationsRemoveContactsResponses, ConversationsUpdateErrors, ConversationsUpdateResponses, Design as Design3, DesignGetErrors, DesignGetResponses, DesignUpdateErrors, DesignUpdateResponses, DispatchSendMessagePayload, EmailAddBlockErrors, EmailAddBlockResponses, EmailAddDomainErrors, EmailAddDomainResponses, EmailAddSenderErrors, EmailAddSenderResponses, EmailBuildDomainConnectApplyUrlErrors, EmailBuildDomainConnectApplyUrlResponses, EmailCheckBlockedErrors, EmailCheckBlockedResponses, EmailCheckDomainVerificationErrors, EmailCheckDomainVerificationResponses, EmailCheckSenderVerificationErrors, EmailCheckSenderVerificationResponses, EmailClearDomainDefaultSenderErrors, EmailClearDomainDefaultSenderResponses, EmailCompleteDomainConnectErrors, EmailCompleteDomainConnectResponses, EmailCreateForwardingRuleErrors, EmailCreateForwardingRuleResponses, EmailDeleteForwardingRuleErrors, EmailDeleteForwardingRuleResponses, EmailDetectRegistrarErrors, EmailDetectRegistrarResponses, EmailDisableBrandedTrackingErrors, EmailDisableBrandedTrackingResponses, EmailDisableCatchAllErrors, EmailDisableCatchAllResponses, EmailDomainId, EmailEnableBrandedTrackingErrors, EmailEnableBrandedTrackingResponses, EmailEnableCatchAllErrors, EmailEnableCatchAllResponses, EmailEnableReceivingErrors, EmailEnableReceivingResponses, EmailForwardingRuleId, EmailGetBlockLogsErrors, EmailGetBlockLogsResponses, EmailGetBrandedTrackingErrors, EmailGetBrandedTrackingResponses, EmailGetCatchAllConfigErrors, EmailGetCatchAllConfigResponses, EmailGetCatchAllStatsErrors, EmailGetCatchAllStatsResponses, EmailGetDomainByIdErrors, EmailGetDomainByIdResponses, EmailGetDomainConnectErrors, EmailGetDomainConnectResponses, EmailGetDomainStatusErrors, EmailGetDomainStatusResponses, EmailGetForwardingLogErrors, EmailGetForwardingLogResponses, EmailGetRecipientTrackingPreferenceErrors, EmailGetRecipientTrackingPreferenceResponses, EmailGetStatsErrors, EmailGetStatsResponses, EmailGetTrackingDefaultsErrors, EmailGetTrackingDefaultsResponses, EmailListBlocksErrors, EmailListBlocksResponses, EmailListDomainsErrors, EmailListDomainsResponses, EmailListForwardingRulesErrors, EmailListForwardingRulesResponses, EmailListSendersErrors, EmailListSendersResponses, EmailListSuppressionsErrors, EmailListSuppressionsResponses, EmailProvisionDomainErrors, EmailProvisionDomainResponses, EmailRemoveBlockErrors, EmailRemoveBlockResponses, EmailRemoveDomainErrors, EmailRemoveDomainResponses, EmailRemoveSenderErrors, EmailRemoveSenderResponses, EmailRemoveSuppressionErrors, EmailRemoveSuppressionResponses, EmailSenderId, EmailSendMessagePayload, EmailSetDefaultDomainErrors, EmailSetDefaultDomainResponses, EmailSetDefaultSenderErrors, EmailSetDefaultSenderResponses, EmailSetDomainDefaultSenderErrors, EmailSetDomainDefaultSenderResponses, EmailUpdateBlockErrors, EmailUpdateBlockResponses, EmailUpdateCatchAllConfigErrors, EmailUpdateCatchAllConfigResponses, EmailUpdateDomainConfigErrors, EmailUpdateDomainConfigResponses, EmailUpdateForwardingRuleErrors, EmailUpdateForwardingRuleResponses, EmailUpdateRecipientTrackingPreferenceErrors, EmailUpdateRecipientTrackingPreferenceResponses, EmailUpdateTrackingDefaultsErrors, EmailUpdateTrackingDefaultsResponses, EmailVerifyDomainErrors, EmailVerifyDomainResponses, ForwardingConditions, HumanProfile, JsonObject, JsonValue, MessageId, MessagesGetEmailErrors, MessagesGetEmailResponses, MessagesGetErrors, MessagesGetEventsErrors, MessagesGetEventsResponses, MessagesGetResponses, MessagesGetStatusErrors, MessagesGetStatusResponses, MessagesListErrors, MessagesListResponses, MessagesRemoveErrors, MessagesRemoveResponses, MessagesSendErrors, MessagesSendResponses, OperationId, OperationsGetErrors, OperationsGetResponses, OperationsListErrors, OperationsListResponses, OperationsRetryErrors, OperationsRetryResponses, OrganizationsBootstrapErrors, OrganizationsBootstrapResponses, OrganizationsCreateErrors, OrganizationsCreateResponses, OrganizationsDeleteErrors, OrganizationsDeleteResponses, OrganizationsGetErrors, OrganizationsGetResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, SmsSendMessagePayload, SuppressionId, TemplateCompliance, TemplateFamilyId, TemplateFromDefault, TemplateId, TemplatePerformance, TemplatesAddFamilyChannelErrors, TemplatesAddFamilyChannelResponses, TemplatesApproveErrors, TemplatesApproveResponses, TemplatesAttachFamilyMemberErrors, TemplatesAttachFamilyMemberResponses, TemplatesCreateErrors, TemplatesCreateFamilyErrors, TemplatesCreateFamilyFromTemplateErrors, TemplatesCreateFamilyFromTemplateResponses, TemplatesCreateFamilyResponses, TemplatesCreateResponses, TemplatesDeleteFamilyErrors, TemplatesDeleteFamilyResponses, TemplatesDetachFamilyMemberErrors, TemplatesDetachFamilyMemberResponses, TemplatesDuplicateErrors, TemplatesDuplicateResponses, TemplatesGetByIdErrors, TemplatesGetByIdResponses, TemplatesGetFamilyErrors, TemplatesGetFamilyResponses, TemplatesListDashboardErrors, TemplatesListDashboardResponses, TemplatesListErrors, TemplatesListFamiliesErrors, TemplatesListFamiliesResponses, TemplatesListResponses, TemplateSourceVersionId, TemplatesPublishErrors, TemplatesPublishResponses, TemplatesRemoveErrors, TemplatesRemoveResponses, TemplatesRenameFamilyErrors, TemplatesRenameFamilyResponses, TemplatesRenderErrors, TemplatesRenderResponses, TemplatesRestoreVersionErrors, TemplatesRestoreVersionResponses, TemplatesSpamCheckErrors, TemplatesSpamCheckResponses, TemplatesUnpublishErrors, TemplatesUnpublishResponses, TemplatesUpdateErrors, TemplatesUpdateResponses, TemplatesVersionHistoryErrors, TemplatesVersionHistoryResponses, TemplateVariable, TrackingRecipientEmail, UnknownRecord, UnsubscribeId, WebhookDeliveryId, WebhookEndpointId, WebhooksCreateErrors, WebhooksCreateResponses, WebhooksGetErrors, WebhooksGetLogsErrors, WebhooksGetLogsResponses, WebhooksGetResponses, WebhooksGetStatsErrors, WebhooksGetStatsResponses, WebhooksListErrors, WebhooksListResponses, WebhooksRegenerateSecretErrors, WebhooksRegenerateSecretResponses, WebhooksRemoveErrors, WebhooksRemoveResponses, WebhooksRetryDeliveryErrors, WebhooksRetryDeliveryResponses, WebhooksTestErrors, WebhooksTestResponses, WebhooksUpdateErrors, WebhooksUpdateResponses, WhatsAppSendMessagePayload } from "./types.gen";
|
|
2
|
+
import type { ActorTracking, ApiKeyId, ApiKeyPermissions, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRemoveErrors, ApiKeysRemoveResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, BlockedEmailId, CampaignAudience, CampaignContentInput, CampaignId, CampaignPolicy, CampaignRunId, CampaignsArchiveErrors, CampaignsArchiveResponses, CampaignsCancelRunErrors, CampaignsCancelRunResponses, CampaignsCreateErrors, CampaignsCreateResponses, CampaignsGetErrors, CampaignsGetResponses, CampaignsGetRunErrors, CampaignsGetRunResponses, CampaignsListErrors, CampaignsListRecipientsErrors, CampaignsListRecipientsResponses, CampaignsListResponses, CampaignsListRunsErrors, CampaignsListRunsResponses, CampaignsPauseRunErrors, CampaignsPauseRunResponses, CampaignsResumeRunErrors, CampaignsResumeRunResponses, CampaignsScheduleRunErrors, CampaignsScheduleRunResponses, CampaignsUpdateErrors, CampaignsUpdateResponses, ContactAccessConfig, ContactId, ContactIdentity, ContactPreferences, ContactsBulkDeleteErrors, ContactsBulkDeleteResponses, ContactsBulkImportErrors, ContactsBulkImportResponses, ContactsBulkUpdateStatusErrors, ContactsBulkUpdateStatusResponses, ContactsBulkUpdateTagsErrors, ContactsBulkUpdateTagsResponses, ContactsCreateErrors, ContactsCreateResponses, ContactsExportErrors, ContactsExportResponses, ContactsFindErrors, ContactsFindOrCreateErrors, ContactsFindOrCreateResponses, ContactsFindResponses, ContactsGetActivityTimelineErrors, ContactsGetActivityTimelineResponses, ContactsGetEngagementErrors, ContactsGetEngagementResponses, ContactsGetErrors, ContactsGetGroupMembershipsErrors, ContactsGetGroupMembershipsResponses, ContactsGetResponses, ContactsListErrors, ContactsListResponses, ContactsRemoveErrors, ContactsRemoveResponses, ContactsUpdateErrors, ContactsUpdateResponses, ConversationContext, ConversationId, ConversationMetadata, ConversationMetrics, ConversationsAddContactsErrors, ConversationsAddContactsResponses, ConversationsCreateErrors, ConversationsCreateResponses, ConversationsGetByIdErrors, ConversationsGetByIdResponses, ConversationsListErrors, ConversationsListMessagesErrors, ConversationsListMessagesResponses, ConversationsListResponses, ConversationsRemoveContactsErrors, ConversationsRemoveContactsResponses, ConversationsUpdateErrors, ConversationsUpdateResponses, Design as Design3, DesignGetErrors, DesignGetResponses, DesignUpdateErrors, DesignUpdateResponses, DispatchSendMessagePayload, EmailAddBlockErrors, EmailAddBlockResponses, EmailAddDomainErrors, EmailAddDomainResponses, EmailAddSenderErrors, EmailAddSenderResponses, EmailAdvanceDomainVerificationErrors, EmailAdvanceDomainVerificationResponses, EmailBuildCustomTrackingDomainConnectApplyUrlErrors, EmailBuildCustomTrackingDomainConnectApplyUrlResponses, EmailBuildDomainConnectApplyUrlErrors, EmailBuildDomainConnectApplyUrlResponses, EmailCheckBlockedErrors, EmailCheckBlockedResponses, EmailCheckSenderVerificationErrors, EmailCheckSenderVerificationResponses, EmailClearDomainDefaultSenderErrors, EmailClearDomainDefaultSenderResponses, EmailCompleteCustomTrackingDomainConnectErrors, EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteDomainConnectErrors, EmailCompleteDomainConnectResponses, EmailCreateForwardingRuleErrors, EmailCreateForwardingRuleResponses, EmailDeleteForwardingRuleErrors, EmailDeleteForwardingRuleResponses, EmailDetectRegistrarErrors, EmailDetectRegistrarResponses, EmailDisableCatchAllErrors, EmailDisableCatchAllResponses, EmailDisableCustomTrackingErrors, EmailDisableCustomTrackingResponses, EmailDomainId, EmailEnableCatchAllErrors, EmailEnableCatchAllResponses, EmailEnableCustomTrackingErrors, EmailEnableCustomTrackingResponses, EmailEnableReceivingErrors, EmailEnableReceivingResponses, EmailForwardingRuleId, EmailGetBlockLogsErrors, EmailGetBlockLogsResponses, EmailGetCatchAllConfigErrors, EmailGetCatchAllConfigResponses, EmailGetCatchAllStatsErrors, EmailGetCatchAllStatsResponses, EmailGetCustomTrackingDomainConnectErrors, EmailGetCustomTrackingDomainConnectResponses, EmailGetCustomTrackingErrors, EmailGetCustomTrackingResponses, EmailGetDomainByIdErrors, EmailGetDomainByIdResponses, EmailGetDomainConnectErrors, EmailGetDomainConnectResponses, EmailGetDomainVerificationErrors, EmailGetDomainVerificationResponses, EmailGetForwardingLogErrors, EmailGetForwardingLogResponses, EmailGetRecipientTrackingPreferenceErrors, EmailGetRecipientTrackingPreferenceResponses, EmailGetStatsErrors, EmailGetStatsResponses, EmailGetTrackingDefaultsErrors, EmailGetTrackingDefaultsResponses, EmailListBlocksErrors, EmailListBlocksResponses, EmailListDomainsErrors, EmailListDomainsResponses, EmailListForwardingRulesErrors, EmailListForwardingRulesResponses, EmailListSendersErrors, EmailListSendersResponses, EmailListSuppressionsErrors, EmailListSuppressionsResponses, EmailRemoveBlockErrors, EmailRemoveBlockResponses, EmailRemoveDomainErrors, EmailRemoveDomainResponses, EmailRemoveSenderErrors, EmailRemoveSenderResponses, EmailRemoveSuppressionErrors, EmailRemoveSuppressionResponses, EmailSenderId, EmailSendMessagePayload, EmailSetDefaultDomainErrors, EmailSetDefaultDomainResponses, EmailSetDefaultSenderErrors, EmailSetDefaultSenderResponses, EmailSetDomainDefaultSenderErrors, EmailSetDomainDefaultSenderResponses, EmailUpdateBlockErrors, EmailUpdateBlockResponses, EmailUpdateCatchAllConfigErrors, EmailUpdateCatchAllConfigResponses, EmailUpdateDomainConfigErrors, EmailUpdateDomainConfigResponses, EmailUpdateForwardingRuleErrors, EmailUpdateForwardingRuleResponses, EmailUpdateRecipientTrackingPreferenceErrors, EmailUpdateRecipientTrackingPreferenceResponses, EmailUpdateTrackingDefaultsErrors, EmailUpdateTrackingDefaultsResponses, ForwardingConditions, HumanProfile, JsonObject, JsonValue, MailboxExtensionId, MediaCompleteErrors, MediaCompleteResponses, MediaCreateErrors, MediaCreateResponses, MediaDownloadUrlErrors, MediaDownloadUrlResponses, MediaGetByIdErrors, MediaGetByIdResponses, MediaId, MediaRemoveErrors, MediaRemoveResponses, MessageId, MessagesGetEmailErrors, MessagesGetEmailResponses, MessagesGetErrors, MessagesGetEventsErrors, MessagesGetEventsResponses, MessagesGetResponses, MessagesGetStatusErrors, MessagesGetStatusResponses, MessagesListErrors, MessagesListResponses, MessagesRemoveErrors, MessagesRemoveResponses, MessagesSendErrors, MessagesSendResponses, OperationId, OperationsGetErrors, OperationsGetResponses, OperationsListErrors, OperationsListResponses, OperationsRetryErrors, OperationsRetryResponses, OrganizationsBootstrapErrors, OrganizationsBootstrapResponses, OrganizationsCreateErrors, OrganizationsCreateResponses, OrganizationsDeleteErrors, OrganizationsDeleteResponses, OrganizationsGetErrors, OrganizationsGetResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, SuppressionId, TemplateCompliance, TemplateDocumentsApplyAgentProposalErrors, TemplateDocumentsApplyAgentProposalResponses, TemplateDocumentsBootstrapErrors, TemplateDocumentsBootstrapResponses, TemplateDocumentsCompleteAgentConversationClearErrors, TemplateDocumentsCompleteAgentConversationClearResponses, TemplateDocumentsGetErrors, TemplateDocumentsGetResponses, TemplateDocumentsIssueAgentAdmissionErrors, TemplateDocumentsIssueAgentAdmissionResponses, TemplateDocumentsPublishErrors, TemplateDocumentsPublishResponses, TemplateDocumentsRenderErrors, TemplateDocumentsRenderResponses, TemplateDocumentsReplaceErrors, TemplateDocumentsReplaceResponses, TemplateDocumentsRestoreErrors, TemplateDocumentsRestoreResponses, TemplateDocumentsSaveErrors, TemplateDocumentsSaveResponses, TemplateDocumentsSendErrors, TemplateDocumentsSendResponses, TemplateDocumentsSpamCheckErrors, TemplateDocumentsSpamCheckResponses, TemplateDocumentsTestSendErrors, TemplateDocumentsTestSendResponses, TemplateDocumentsUnpublishErrors, TemplateDocumentsUnpublishResponses, TemplateDocumentsVersionsErrors, TemplateDocumentsVersionsResponses, TemplateFamilyId, TemplateFromDefault, TemplateId, TemplatePerformance, TemplatesAddFamilyChannelErrors, TemplatesAddFamilyChannelResponses, TemplatesApproveErrors, TemplatesApproveResponses, TemplatesAttachFamilyMemberErrors, TemplatesAttachFamilyMemberResponses, TemplatesCreateErrors, TemplatesCreateFamilyErrors, TemplatesCreateFamilyFromTemplateErrors, TemplatesCreateFamilyFromTemplateResponses, TemplatesCreateFamilyResponses, TemplatesCreateResponses, TemplatesDeleteFamilyErrors, TemplatesDeleteFamilyResponses, TemplatesDetachFamilyMemberErrors, TemplatesDetachFamilyMemberResponses, TemplatesGetByIdErrors, TemplatesGetByIdResponses, TemplatesGetFamilyErrors, TemplatesGetFamilyResponses, TemplatesListDashboardErrors, TemplatesListDashboardResponses, TemplatesListErrors, TemplatesListFamiliesErrors, TemplatesListFamiliesResponses, TemplatesListResponses, TemplateSourceVersionId, TemplatesRemoveErrors, TemplatesRemoveResponses, TemplatesRenameFamilyErrors, TemplatesRenameFamilyResponses, TemplatesUpdateErrors, TemplatesUpdateResponses, TemplateVariable, TrackingRecipientEmail, UnknownRecord, UnsubscribeId, WebhookDeliveryId, WebhookEndpointId, WebhooksCreateErrors, WebhooksCreateResponses, WebhooksGetErrors, WebhooksGetLogsErrors, WebhooksGetLogsResponses, WebhooksGetResponses, WebhooksGetStatsErrors, WebhooksGetStatsResponses, WebhooksListErrors, WebhooksListResponses, WebhooksRegenerateSecretErrors, WebhooksRegenerateSecretResponses, WebhooksRemoveErrors, WebhooksRemoveResponses, WebhooksRetryDeliveryErrors, WebhooksRetryDeliveryResponses, WebhooksTestErrors, WebhooksTestResponses, WebhooksUpdateErrors, WebhooksUpdateResponses } from "./types.gen";
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -22,7 +22,7 @@ export declare class Messages {
|
|
|
22
22
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
23
23
|
page?: string | null | undefined;
|
|
24
24
|
limit?: string | null | undefined;
|
|
25
|
-
channel?: "
|
|
25
|
+
channel?: "email" | null | undefined;
|
|
26
26
|
status?: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained" | null | undefined;
|
|
27
27
|
conversationId?: ConversationId | null | undefined;
|
|
28
28
|
contactId?: ContactId | null | undefined;
|
|
@@ -32,11 +32,11 @@ export declare class Messages {
|
|
|
32
32
|
/**
|
|
33
33
|
* Send a message
|
|
34
34
|
*
|
|
35
|
-
* Sends a message on the requested channel and returns the created message with a 201 Created status. `channel` selects the payload variant.
|
|
35
|
+
* Sends a message on the requested channel and returns the created message with a 201 Created status. `channel` selects the payload variant. Repeating an identical request with the same optional `Idempotency-Key` header returns the original message; reusing the key for different content returns a conflict.
|
|
36
36
|
*/
|
|
37
37
|
static send<ThrowOnError extends boolean = false>(parameters: {
|
|
38
38
|
"idempotency-key"?: string | null | undefined;
|
|
39
|
-
|
|
39
|
+
emailSendMessagePayload: EmailSendMessagePayload;
|
|
40
40
|
}, options?: Options<never, ThrowOnError>): RequestResult<MessagesSendResponses, MessagesSendErrors, ThrowOnError>;
|
|
41
41
|
/**
|
|
42
42
|
* Delete a message
|
|
@@ -57,7 +57,7 @@ export declare class Messages {
|
|
|
57
57
|
/**
|
|
58
58
|
* Get email message details
|
|
59
59
|
*
|
|
60
|
-
* Returns
|
|
60
|
+
* Returns email delivery details for a message, optionally including signed URLs for its raw MIME, HTML, and text content.
|
|
61
61
|
*/
|
|
62
62
|
static getEmail<ThrowOnError extends boolean = false>(parameters: {
|
|
63
63
|
id: MessageId;
|
|
@@ -130,7 +130,7 @@ export declare class ScheduledMessages {
|
|
|
130
130
|
/**
|
|
131
131
|
* Schedule a message
|
|
132
132
|
*
|
|
133
|
-
* Schedules a message at the absolute ISO-8601 instant in scheduledFor.
|
|
133
|
+
* Schedules a message at the absolute ISO-8601 instant in scheduledFor. Optional timezone is validated IANA display metadata only and never changes the execution instant.
|
|
134
134
|
*/
|
|
135
135
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
136
136
|
send: DispatchSendMessagePayload;
|
|
@@ -177,7 +177,7 @@ export declare class Campaigns {
|
|
|
177
177
|
*/
|
|
178
178
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
179
179
|
name: string;
|
|
180
|
-
channel: "
|
|
180
|
+
channel: "email";
|
|
181
181
|
content: CampaignContentInput;
|
|
182
182
|
audience: CampaignAudience;
|
|
183
183
|
policy?: CampaignPolicy | null | undefined;
|
|
@@ -334,30 +334,21 @@ export declare class Email {
|
|
|
334
334
|
domain: string;
|
|
335
335
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailAddDomainResponses, EmailAddDomainErrors, ThrowOnError>;
|
|
336
336
|
/**
|
|
337
|
-
*
|
|
337
|
+
* Get domain verification
|
|
338
338
|
*
|
|
339
|
-
*
|
|
339
|
+
* Returns the stored DNS and provider lifecycle snapshot without calling a provider or mutating state.
|
|
340
340
|
*/
|
|
341
|
-
static
|
|
342
|
-
"idempotency-key": string;
|
|
343
|
-
domain: string;
|
|
344
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<EmailProvisionDomainResponses, EmailProvisionDomainErrors, ThrowOnError>;
|
|
345
|
-
/**
|
|
346
|
-
* Verify a sending domain
|
|
347
|
-
*
|
|
348
|
-
* Initiates verification of a sending domain with the email provider and stores the DNS records needed to complete it.
|
|
349
|
-
*/
|
|
350
|
-
static verifyDomain<ThrowOnError extends boolean = false>(parameters: {
|
|
341
|
+
static getDomainVerification<ThrowOnError extends boolean = false>(parameters: {
|
|
351
342
|
id: EmailDomainId;
|
|
352
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
343
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetDomainVerificationResponses, EmailGetDomainVerificationErrors, ThrowOnError>;
|
|
353
344
|
/**
|
|
354
|
-
*
|
|
345
|
+
* Advance domain verification
|
|
355
346
|
*
|
|
356
|
-
*
|
|
347
|
+
* Observes the required DNS records and, once they match, idempotently starts provider provisioning for the staged domain.
|
|
357
348
|
*/
|
|
358
|
-
static
|
|
349
|
+
static advanceDomainVerification<ThrowOnError extends boolean = false>(parameters: {
|
|
359
350
|
id: EmailDomainId;
|
|
360
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
351
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailAdvanceDomainVerificationResponses, EmailAdvanceDomainVerificationErrors, ThrowOnError>;
|
|
361
352
|
/**
|
|
362
353
|
* Remove a sending domain
|
|
363
354
|
*
|
|
@@ -390,15 +381,16 @@ export declare class Email {
|
|
|
390
381
|
*/
|
|
391
382
|
static getDomainConnect<ThrowOnError extends boolean = false>(parameters: {
|
|
392
383
|
id: EmailDomainId;
|
|
384
|
+
mode: "send-only" | "send-and-receive";
|
|
393
385
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetDomainConnectResponses, EmailGetDomainConnectErrors, ThrowOnError>;
|
|
394
386
|
/**
|
|
395
387
|
* Build a one-click DNS apply URL
|
|
396
388
|
*
|
|
397
|
-
* Builds the signed Domain Connect apply URL
|
|
389
|
+
* Builds the signed Domain Connect apply URL for the selected sending-only or sending-and-receiving service. Manual DNS remains available for either mode.
|
|
398
390
|
*/
|
|
399
391
|
static buildDomainConnectApplyUrl<ThrowOnError extends boolean = false>(parameters: {
|
|
400
392
|
id: EmailDomainId;
|
|
401
|
-
|
|
393
|
+
mode: "send-only" | "send-and-receive";
|
|
402
394
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailBuildDomainConnectApplyUrlResponses, EmailBuildDomainConnectApplyUrlErrors, ThrowOnError>;
|
|
403
395
|
/**
|
|
404
396
|
* Complete a one-click DNS return
|
|
@@ -422,14 +414,6 @@ export declare class Email {
|
|
|
422
414
|
endpointId?: WebhookEndpointId | null | undefined;
|
|
423
415
|
addresses?: Array<string> | null | undefined;
|
|
424
416
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailEnableReceivingResponses, EmailEnableReceivingErrors, ThrowOnError>;
|
|
425
|
-
/**
|
|
426
|
-
* Get sending domain status
|
|
427
|
-
*
|
|
428
|
-
* Returns the stored verification status of a sending domain without contacting the email provider.
|
|
429
|
-
*/
|
|
430
|
-
static getDomainStatus<ThrowOnError extends boolean = false>(parameters: {
|
|
431
|
-
id: EmailDomainId;
|
|
432
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetDomainStatusResponses, EmailGetDomainStatusErrors, ThrowOnError>;
|
|
433
417
|
/**
|
|
434
418
|
* Set the default sending domain
|
|
435
419
|
*
|
|
@@ -469,30 +453,56 @@ export declare class Email {
|
|
|
469
453
|
footerEnabled?: boolean | null | null | undefined;
|
|
470
454
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailUpdateDomainConfigResponses, EmailUpdateDomainConfigErrors, ThrowOnError>;
|
|
471
455
|
/**
|
|
472
|
-
* Disable a
|
|
456
|
+
* Disable a custom tracking domain
|
|
473
457
|
*
|
|
474
|
-
* Tears down a domain's
|
|
458
|
+
* Tears down a domain's custom tracking and its managed resources. Sends immediately revert to the shared tracking host. Existing custom links in already-delivered mail stop working.
|
|
475
459
|
*/
|
|
476
|
-
static
|
|
460
|
+
static disableCustomTracking<ThrowOnError extends boolean = false>(parameters: {
|
|
477
461
|
id: EmailDomainId;
|
|
478
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
462
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailDisableCustomTrackingResponses, EmailDisableCustomTrackingErrors, ThrowOnError>;
|
|
479
463
|
/**
|
|
480
|
-
* Get
|
|
464
|
+
* Get custom tracking status
|
|
481
465
|
*
|
|
482
|
-
* Returns the
|
|
466
|
+
* Returns the custom tracking state for a sending domain: lifecycle status, the required DNS records, certificate and CAA readiness, and any scheduled teardown. `enabled` is false when no custom tracking domain is provisioned.
|
|
483
467
|
*/
|
|
484
|
-
static
|
|
468
|
+
static getCustomTracking<ThrowOnError extends boolean = false>(parameters: {
|
|
485
469
|
id: EmailDomainId;
|
|
486
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
470
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetCustomTrackingResponses, EmailGetCustomTrackingErrors, ThrowOnError>;
|
|
487
471
|
/**
|
|
488
|
-
* Enable a
|
|
472
|
+
* Enable a custom tracking domain
|
|
489
473
|
*
|
|
490
|
-
* Provisions a
|
|
474
|
+
* Provisions a custom tracking domain (default label `track`) for a verified sending domain so open/click links redirect through the customer's own subdomain. Requires the custom_tracking_domain entitlement. Returns the resulting state including the two DNS records the customer must create.
|
|
491
475
|
*/
|
|
492
|
-
static
|
|
476
|
+
static enableCustomTracking<ThrowOnError extends boolean = false>(parameters: {
|
|
493
477
|
id: EmailDomainId;
|
|
494
478
|
label?: string | null | undefined;
|
|
495
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
479
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailEnableCustomTrackingResponses, EmailEnableCustomTrackingErrors, ThrowOnError>;
|
|
480
|
+
/**
|
|
481
|
+
* Check automatic Custom Tracking Domain setup eligibility
|
|
482
|
+
*
|
|
483
|
+
* Reports whether the domain's DNS provider supports Domain Connect for its current Custom Tracking Domain. Ineligible is a normal result and the exact manual CNAME records remain available.
|
|
484
|
+
*/
|
|
485
|
+
static getCustomTrackingDomainConnect<ThrowOnError extends boolean = false>(parameters: {
|
|
486
|
+
id: EmailDomainId;
|
|
487
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetCustomTrackingDomainConnectResponses, EmailGetCustomTrackingDomainConnectErrors, ThrowOnError>;
|
|
488
|
+
/**
|
|
489
|
+
* Build an automatic Custom Tracking Domain apply URL
|
|
490
|
+
*
|
|
491
|
+
* Builds the signed Domain Connect URL for the current customer-selected tracking host. The server derives the host and Cloudflare DCV UUID; exact manual CNAME records remain available.
|
|
492
|
+
*/
|
|
493
|
+
static buildCustomTrackingDomainConnectApplyUrl<ThrowOnError extends boolean = false>(parameters: {
|
|
494
|
+
id: EmailDomainId;
|
|
495
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailBuildCustomTrackingDomainConnectApplyUrlResponses, EmailBuildCustomTrackingDomainConnectApplyUrlErrors, ThrowOnError>;
|
|
496
|
+
/**
|
|
497
|
+
* Complete an automatic Custom Tracking Domain return
|
|
498
|
+
*
|
|
499
|
+
* Validates the purpose- and revision-bound registrar state, then re-kicks the existing readiness reconciliation. The callback never declares the host ready or changes email tracking selection.
|
|
500
|
+
*/
|
|
501
|
+
static completeCustomTrackingDomainConnect<ThrowOnError extends boolean = false>(parameters: {
|
|
502
|
+
id: EmailDomainId;
|
|
503
|
+
state: string;
|
|
504
|
+
error?: string | null | undefined;
|
|
505
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteCustomTrackingDomainConnectErrors, ThrowOnError>;
|
|
496
506
|
/**
|
|
497
507
|
* List sender identities
|
|
498
508
|
*
|
|
@@ -754,6 +764,55 @@ export declare class Email {
|
|
|
754
764
|
export declare class Email2 {
|
|
755
765
|
static email: typeof Email;
|
|
756
766
|
}
|
|
767
|
+
export declare class Media {
|
|
768
|
+
/**
|
|
769
|
+
* Create a media object
|
|
770
|
+
*
|
|
771
|
+
* Creates the media object in the pending state and returns it with the upload instruction — URL, method, and headers — for putting its bytes into storage.
|
|
772
|
+
*/
|
|
773
|
+
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
774
|
+
filename: string;
|
|
775
|
+
contentType: string;
|
|
776
|
+
sizeBytes: number;
|
|
777
|
+
purpose: "attachment" | "avatar";
|
|
778
|
+
checksumSha256?: string | null | undefined;
|
|
779
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MediaCreateResponses, MediaCreateErrors, ThrowOnError>;
|
|
780
|
+
/**
|
|
781
|
+
* Complete a media upload
|
|
782
|
+
*
|
|
783
|
+
* Verifies the uploaded object exists in storage, marks the media object ready, and returns it with a download URL.
|
|
784
|
+
*/
|
|
785
|
+
static complete<ThrowOnError extends boolean = false>(parameters: {
|
|
786
|
+
mediaId: MediaId;
|
|
787
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MediaCompleteResponses, MediaCompleteErrors, ThrowOnError>;
|
|
788
|
+
/**
|
|
789
|
+
* Delete a media object
|
|
790
|
+
*
|
|
791
|
+
* Deletes a pending media object and the bytes stored for it. Fails if the media object is already ready.
|
|
792
|
+
*/
|
|
793
|
+
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
794
|
+
mediaId: MediaId;
|
|
795
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MediaRemoveResponses, MediaRemoveErrors, ThrowOnError>;
|
|
796
|
+
/**
|
|
797
|
+
* Get a media object
|
|
798
|
+
*
|
|
799
|
+
* Returns the media object's metadata, including status, dimensions, and confirmation timestamps.
|
|
800
|
+
*/
|
|
801
|
+
static getById<ThrowOnError extends boolean = false>(parameters: {
|
|
802
|
+
mediaId: MediaId;
|
|
803
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MediaGetByIdResponses, MediaGetByIdErrors, ThrowOnError>;
|
|
804
|
+
/**
|
|
805
|
+
* Get a media download URL
|
|
806
|
+
*
|
|
807
|
+
* Generates a presigned, time-limited download URL for a ready media object.
|
|
808
|
+
*/
|
|
809
|
+
static downloadUrl<ThrowOnError extends boolean = false>(parameters: {
|
|
810
|
+
mediaId: MediaId;
|
|
811
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MediaDownloadUrlResponses, MediaDownloadUrlErrors, ThrowOnError>;
|
|
812
|
+
}
|
|
813
|
+
export declare class Media2 {
|
|
814
|
+
static media: typeof Media;
|
|
815
|
+
}
|
|
757
816
|
export declare class Conversations {
|
|
758
817
|
/**
|
|
759
818
|
* List conversations
|
|
@@ -764,7 +823,7 @@ export declare class Conversations {
|
|
|
764
823
|
page?: string | null | undefined;
|
|
765
824
|
limit?: string | null | undefined;
|
|
766
825
|
status?: "active" | "waiting" | "resolved" | "escalated" | "archived" | null | undefined;
|
|
767
|
-
channel?: "
|
|
826
|
+
channel?: "email" | null | undefined;
|
|
768
827
|
contactId?: ContactId | null | undefined;
|
|
769
828
|
startDate?: string | null | undefined;
|
|
770
829
|
endDate?: string | null | undefined;
|
|
@@ -779,8 +838,8 @@ export declare class Conversations {
|
|
|
779
838
|
description?: string | null | undefined;
|
|
780
839
|
externalId?: string | null | undefined;
|
|
781
840
|
parentConversationId?: ConversationId | null | undefined;
|
|
782
|
-
channels: Array<"
|
|
783
|
-
primaryChannel: "
|
|
841
|
+
channels: Array<"email">;
|
|
842
|
+
primaryChannel: "email";
|
|
784
843
|
status?: "active" | "waiting" | "resolved" | "escalated" | "archived" | null | undefined;
|
|
785
844
|
statusReason?: string | null | undefined;
|
|
786
845
|
priority?: number | null | undefined;
|
|
@@ -815,7 +874,7 @@ export declare class Conversations {
|
|
|
815
874
|
description?: string | null | null | undefined;
|
|
816
875
|
externalId?: string | null | null | undefined;
|
|
817
876
|
parentConversationId?: ConversationId | null | null | undefined;
|
|
818
|
-
primaryChannel?: "
|
|
877
|
+
primaryChannel?: "email" | null | undefined;
|
|
819
878
|
status?: "active" | "waiting" | "resolved" | "escalated" | "archived" | null | undefined;
|
|
820
879
|
statusReason?: string | null | null | undefined;
|
|
821
880
|
priority?: number | null | undefined;
|
|
@@ -825,7 +884,7 @@ export declare class Conversations {
|
|
|
825
884
|
metadata?: ConversationMetadata | null | null | undefined;
|
|
826
885
|
metrics?: ConversationMetrics | null | undefined;
|
|
827
886
|
actorTracking?: ActorTracking | null | undefined;
|
|
828
|
-
channels?: Array<"
|
|
887
|
+
channels?: Array<"email"> | null | undefined;
|
|
829
888
|
tags?: Array<string> | null | undefined;
|
|
830
889
|
categories?: Array<string> | null | undefined;
|
|
831
890
|
isTest?: boolean | null | undefined;
|
|
@@ -893,39 +952,6 @@ export declare class Contacts {
|
|
|
893
952
|
humanProfile?: HumanProfile | null | null | undefined;
|
|
894
953
|
capabilities?: Array<string> | null | undefined;
|
|
895
954
|
tags?: Array<string> | null | undefined;
|
|
896
|
-
engagement?: {
|
|
897
|
-
totalInteractions: number;
|
|
898
|
-
lastActiveAt: string;
|
|
899
|
-
averageResponseTime: number;
|
|
900
|
-
satisfactionScore?: number | null | undefined;
|
|
901
|
-
channels: {
|
|
902
|
-
sms?: {
|
|
903
|
-
sent: number;
|
|
904
|
-
received: number;
|
|
905
|
-
failed: number;
|
|
906
|
-
lastAt?: string | null | undefined;
|
|
907
|
-
} | null | undefined;
|
|
908
|
-
whatsapp?: {
|
|
909
|
-
sent: number;
|
|
910
|
-
received: number;
|
|
911
|
-
failed: number;
|
|
912
|
-
lastAt?: string | null | undefined;
|
|
913
|
-
} | null | undefined;
|
|
914
|
-
email?: {
|
|
915
|
-
sent: number;
|
|
916
|
-
received: number;
|
|
917
|
-
failed: number;
|
|
918
|
-
bounced: number;
|
|
919
|
-
lastAt?: string | null | undefined;
|
|
920
|
-
} | null | undefined;
|
|
921
|
-
};
|
|
922
|
-
performance?: {
|
|
923
|
-
successRate: number;
|
|
924
|
-
escalationRate: number;
|
|
925
|
-
resolutionRate: number;
|
|
926
|
-
averageHandlingTime: number;
|
|
927
|
-
} | null | undefined;
|
|
928
|
-
} | null | undefined;
|
|
929
955
|
accessLevel?: "public" | "authenticated" | "vip" | "internal" | null | undefined;
|
|
930
956
|
accessConfig?: ContactAccessConfig | null | null | undefined;
|
|
931
957
|
preferences?: ContactPreferences | null | null | undefined;
|
|
@@ -939,12 +965,11 @@ export declare class Contacts {
|
|
|
939
965
|
/**
|
|
940
966
|
* Find a contact
|
|
941
967
|
*
|
|
942
|
-
*
|
|
968
|
+
* Samva API operation.
|
|
943
969
|
*/
|
|
944
970
|
static find<ThrowOnError extends boolean = false>(parameters?: {
|
|
945
971
|
email?: string | null | undefined;
|
|
946
972
|
phone?: string | null | undefined;
|
|
947
|
-
whatsapp?: string | null | undefined;
|
|
948
973
|
externalId?: string | null | undefined;
|
|
949
974
|
}, options?: Options<never, ThrowOnError>): RequestResult<ContactsFindResponses, ContactsFindErrors, ThrowOnError>;
|
|
950
975
|
/**
|
|
@@ -955,7 +980,6 @@ export declare class Contacts {
|
|
|
955
980
|
static findOrCreate<ThrowOnError extends boolean = false>(parameters?: {
|
|
956
981
|
email?: string | null | undefined;
|
|
957
982
|
phone?: string | null | undefined;
|
|
958
|
-
whatsapp?: string | null | undefined;
|
|
959
983
|
externalId?: string | null | undefined;
|
|
960
984
|
name?: string | null | undefined;
|
|
961
985
|
displayName?: string | null | null | undefined;
|
|
@@ -991,39 +1015,6 @@ export declare class Contacts {
|
|
|
991
1015
|
humanProfile?: HumanProfile | null | null | undefined;
|
|
992
1016
|
capabilities?: Array<string> | null | undefined;
|
|
993
1017
|
tags?: Array<string> | null | undefined;
|
|
994
|
-
engagement?: {
|
|
995
|
-
totalInteractions: number;
|
|
996
|
-
lastActiveAt: string;
|
|
997
|
-
averageResponseTime: number;
|
|
998
|
-
satisfactionScore?: number | null | undefined;
|
|
999
|
-
channels: {
|
|
1000
|
-
sms?: {
|
|
1001
|
-
sent: number;
|
|
1002
|
-
received: number;
|
|
1003
|
-
failed: number;
|
|
1004
|
-
lastAt?: string | null | undefined;
|
|
1005
|
-
} | null | undefined;
|
|
1006
|
-
whatsapp?: {
|
|
1007
|
-
sent: number;
|
|
1008
|
-
received: number;
|
|
1009
|
-
failed: number;
|
|
1010
|
-
lastAt?: string | null | undefined;
|
|
1011
|
-
} | null | undefined;
|
|
1012
|
-
email?: {
|
|
1013
|
-
sent: number;
|
|
1014
|
-
received: number;
|
|
1015
|
-
failed: number;
|
|
1016
|
-
bounced: number;
|
|
1017
|
-
lastAt?: string | null | undefined;
|
|
1018
|
-
} | null | undefined;
|
|
1019
|
-
};
|
|
1020
|
-
performance?: {
|
|
1021
|
-
successRate: number;
|
|
1022
|
-
escalationRate: number;
|
|
1023
|
-
resolutionRate: number;
|
|
1024
|
-
averageHandlingTime: number;
|
|
1025
|
-
} | null | undefined;
|
|
1026
|
-
} | null | undefined;
|
|
1027
1018
|
accessLevel?: "public" | "authenticated" | "vip" | "internal" | null | undefined;
|
|
1028
1019
|
accessConfig?: ContactAccessConfig | null | null | undefined;
|
|
1029
1020
|
preferences?: ContactPreferences | null | null | undefined;
|
|
@@ -1112,7 +1103,7 @@ export declare class Contacts {
|
|
|
1112
1103
|
id: ContactId;
|
|
1113
1104
|
page?: string | null | undefined;
|
|
1114
1105
|
limit?: string | null | undefined;
|
|
1115
|
-
channel?: "
|
|
1106
|
+
channel?: "email" | null | undefined;
|
|
1116
1107
|
}, options?: Options<never, ThrowOnError>): RequestResult<ContactsGetActivityTimelineResponses, ContactsGetActivityTimelineErrors, ThrowOnError>;
|
|
1117
1108
|
/**
|
|
1118
1109
|
* List a contact's group memberships
|
|
@@ -1136,7 +1127,7 @@ export declare class Templates {
|
|
|
1136
1127
|
page?: string | null | undefined;
|
|
1137
1128
|
limit?: string | null | undefined;
|
|
1138
1129
|
category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | undefined;
|
|
1139
|
-
channel?: "
|
|
1130
|
+
channel?: "email" | null | undefined;
|
|
1140
1131
|
status?: "draft" | "pending" | "approved" | "published" | "rejected" | "archived" | null | undefined;
|
|
1141
1132
|
search?: string | null | undefined;
|
|
1142
1133
|
sortBy?: "name" | "createdAt" | "updatedAt" | "usageCount" | "lastUsedAt" | null | undefined;
|
|
@@ -1166,49 +1157,99 @@ export declare class Templates {
|
|
|
1166
1157
|
isDefault?: boolean | null | undefined;
|
|
1167
1158
|
version?: number | null | undefined;
|
|
1168
1159
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesCreateResponses, TemplatesCreateErrors, ThrowOnError>;
|
|
1160
|
+
/**
|
|
1161
|
+
* List templates for the dashboard
|
|
1162
|
+
*
|
|
1163
|
+
* Returns a paginated dashboard view that groups related channel templates into families and leaves standalone templates ungrouped.
|
|
1164
|
+
*/
|
|
1169
1165
|
static listDashboard<ThrowOnError extends boolean = false>(parameters: {
|
|
1170
1166
|
page?: string | null | undefined;
|
|
1171
1167
|
limit?: string | null | undefined;
|
|
1172
|
-
allowedChannels: "
|
|
1168
|
+
allowedChannels: "email" | Array<"email">;
|
|
1173
1169
|
category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | undefined;
|
|
1174
|
-
channel?: "
|
|
1170
|
+
channel?: "email" | null | undefined;
|
|
1175
1171
|
status?: "draft" | "pending" | "approved" | "published" | "rejected" | "archived" | null | undefined;
|
|
1176
1172
|
search?: string | null | undefined;
|
|
1177
1173
|
sortBy?: "name" | "createdAt" | "updatedAt" | "usageCount" | "lastUsedAt" | null | undefined;
|
|
1178
1174
|
sortOrder?: "asc" | "desc" | null | undefined;
|
|
1179
1175
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesListDashboardResponses, TemplatesListDashboardErrors, ThrowOnError>;
|
|
1176
|
+
/**
|
|
1177
|
+
* List template families
|
|
1178
|
+
*
|
|
1179
|
+
* Returns a paginated list of the organization's template families and members.
|
|
1180
|
+
*/
|
|
1180
1181
|
static listFamilies<ThrowOnError extends boolean = false>(parameters?: {
|
|
1181
1182
|
page?: string | null | undefined;
|
|
1182
1183
|
limit?: string | null | undefined;
|
|
1183
1184
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesListFamiliesResponses, TemplatesListFamiliesErrors, ThrowOnError>;
|
|
1185
|
+
/**
|
|
1186
|
+
* Create a template family
|
|
1187
|
+
*
|
|
1188
|
+
* Creates an empty template family with the supplied name and returns it with status 201.
|
|
1189
|
+
*/
|
|
1184
1190
|
static createFamily<ThrowOnError extends boolean = false>(parameters: {
|
|
1185
1191
|
name: string;
|
|
1186
1192
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesCreateFamilyResponses, TemplatesCreateFamilyErrors, ThrowOnError>;
|
|
1193
|
+
/**
|
|
1194
|
+
* Delete a template family
|
|
1195
|
+
*
|
|
1196
|
+
* Deletes a template family without deleting its member templates.
|
|
1197
|
+
*/
|
|
1187
1198
|
static deleteFamily<ThrowOnError extends boolean = false>(parameters: {
|
|
1188
1199
|
familyId: TemplateFamilyId;
|
|
1189
1200
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesDeleteFamilyResponses, TemplatesDeleteFamilyErrors, ThrowOnError>;
|
|
1201
|
+
/**
|
|
1202
|
+
* Get a template family
|
|
1203
|
+
*
|
|
1204
|
+
* Returns a template family and its channel-specific member templates.
|
|
1205
|
+
*/
|
|
1190
1206
|
static getFamily<ThrowOnError extends boolean = false>(parameters: {
|
|
1191
1207
|
familyId: TemplateFamilyId;
|
|
1192
1208
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesGetFamilyResponses, TemplatesGetFamilyErrors, ThrowOnError>;
|
|
1209
|
+
/**
|
|
1210
|
+
* Rename a template family
|
|
1211
|
+
*
|
|
1212
|
+
* Changes a template family's name and returns the updated family.
|
|
1213
|
+
*/
|
|
1193
1214
|
static renameFamily<ThrowOnError extends boolean = false>(parameters: {
|
|
1194
1215
|
familyId: TemplateFamilyId;
|
|
1195
1216
|
name: string;
|
|
1196
1217
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesRenameFamilyResponses, TemplatesRenameFamilyErrors, ThrowOnError>;
|
|
1218
|
+
/**
|
|
1219
|
+
* Create a family from a template
|
|
1220
|
+
*
|
|
1221
|
+
* Creates a template family containing the specified template and returns the new family with status 201.
|
|
1222
|
+
*/
|
|
1197
1223
|
static createFamilyFromTemplate<ThrowOnError extends boolean = false>(parameters: {
|
|
1198
1224
|
templateId: TemplateId;
|
|
1199
1225
|
name: string;
|
|
1200
1226
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesCreateFamilyFromTemplateResponses, TemplatesCreateFamilyFromTemplateErrors, ThrowOnError>;
|
|
1227
|
+
/**
|
|
1228
|
+
* Detach a template from a family
|
|
1229
|
+
*
|
|
1230
|
+
* Removes a member template from the family without deleting the template.
|
|
1231
|
+
*/
|
|
1201
1232
|
static detachFamilyMember<ThrowOnError extends boolean = false>(parameters: {
|
|
1202
1233
|
familyId: TemplateFamilyId;
|
|
1203
1234
|
templateId: TemplateId;
|
|
1204
1235
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesDetachFamilyMemberResponses, TemplatesDetachFamilyMemberErrors, ThrowOnError>;
|
|
1236
|
+
/**
|
|
1237
|
+
* Attach a template to a family
|
|
1238
|
+
*
|
|
1239
|
+
* Adds an existing template as a channel member of the family and returns the updated family.
|
|
1240
|
+
*/
|
|
1205
1241
|
static attachFamilyMember<ThrowOnError extends boolean = false>(parameters: {
|
|
1206
1242
|
familyId: TemplateFamilyId;
|
|
1207
1243
|
templateId: TemplateId;
|
|
1208
1244
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesAttachFamilyMemberResponses, TemplatesAttachFamilyMemberErrors, ThrowOnError>;
|
|
1245
|
+
/**
|
|
1246
|
+
* Add a channel to a template family
|
|
1247
|
+
*
|
|
1248
|
+
* Creates a template for the requested channel in the family and returns the updated family with status 201.
|
|
1249
|
+
*/
|
|
1209
1250
|
static addFamilyChannel<ThrowOnError extends boolean = false>(parameters: {
|
|
1210
1251
|
familyId: TemplateFamilyId;
|
|
1211
|
-
channel: "
|
|
1252
|
+
channel: "email";
|
|
1212
1253
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesAddFamilyChannelResponses, TemplatesAddFamilyChannelErrors, ThrowOnError>;
|
|
1213
1254
|
/**
|
|
1214
1255
|
* Delete a template
|
|
@@ -1221,7 +1262,7 @@ export declare class Templates {
|
|
|
1221
1262
|
/**
|
|
1222
1263
|
* Get a template
|
|
1223
1264
|
*
|
|
1224
|
-
* Returns
|
|
1265
|
+
* Returns template metadata and compiled channel content. Read live SML through the template-document API.
|
|
1225
1266
|
*/
|
|
1226
1267
|
static getById<ThrowOnError extends boolean = false>(parameters: {
|
|
1227
1268
|
id: TemplateId;
|
|
@@ -1229,7 +1270,7 @@ export declare class Templates {
|
|
|
1229
1270
|
/**
|
|
1230
1271
|
* Update a template
|
|
1231
1272
|
*
|
|
1232
|
-
* Updates
|
|
1273
|
+
* Updates template metadata. Source changes use the template-document revision API.
|
|
1233
1274
|
*/
|
|
1234
1275
|
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
1235
1276
|
id: TemplateId;
|
|
@@ -1241,11 +1282,6 @@ export declare class Templates {
|
|
|
1241
1282
|
category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | null | undefined;
|
|
1242
1283
|
fromDefault?: TemplateFromDefault | null | null | undefined;
|
|
1243
1284
|
replyToDefault?: Array<string> | null | null | undefined;
|
|
1244
|
-
source?: string | null | undefined;
|
|
1245
|
-
subject?: string | null | undefined;
|
|
1246
|
-
headers?: {
|
|
1247
|
-
[key: string]: string;
|
|
1248
|
-
} | null | null | undefined;
|
|
1249
1285
|
variableSchema?: Array<TemplateVariable> | null | null | undefined;
|
|
1250
1286
|
compliance?: TemplateCompliance | null | null | undefined;
|
|
1251
1287
|
performance?: TemplatePerformance | null | null | undefined;
|
|
@@ -1266,80 +1302,189 @@ export declare class Templates {
|
|
|
1266
1302
|
notes?: string | null | undefined;
|
|
1267
1303
|
};
|
|
1268
1304
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesApproveResponses, TemplatesApproveErrors, ThrowOnError>;
|
|
1305
|
+
}
|
|
1306
|
+
export declare class Templates2 {
|
|
1307
|
+
static templates: typeof Templates;
|
|
1308
|
+
}
|
|
1309
|
+
export declare class TemplateDocuments {
|
|
1269
1310
|
/**
|
|
1270
|
-
*
|
|
1311
|
+
* Bootstrap a template document
|
|
1271
1312
|
*
|
|
1272
|
-
*
|
|
1313
|
+
* Creates or loads the authoritative editable document for a template and returns its current snapshot.
|
|
1273
1314
|
*/
|
|
1274
|
-
static
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
variables?: {
|
|
1278
|
-
[key: string]: string;
|
|
1279
|
-
} | null | undefined;
|
|
1280
|
-
};
|
|
1281
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesRenderResponses, TemplatesRenderErrors, ThrowOnError>;
|
|
1315
|
+
static bootstrap<ThrowOnError extends boolean = false>(parameters: {
|
|
1316
|
+
templateId: TemplateId;
|
|
1317
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsBootstrapResponses, TemplateDocumentsBootstrapErrors, ThrowOnError>;
|
|
1282
1318
|
/**
|
|
1283
|
-
*
|
|
1319
|
+
* Get a template document
|
|
1284
1320
|
*
|
|
1285
|
-
*
|
|
1321
|
+
* Returns the current authoritative source, revision, and metadata for a template document.
|
|
1286
1322
|
*/
|
|
1287
|
-
static
|
|
1288
|
-
|
|
1289
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
1323
|
+
static get<ThrowOnError extends boolean = false>(parameters: {
|
|
1324
|
+
templateId: TemplateId;
|
|
1325
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsGetResponses, TemplateDocumentsGetErrors, ThrowOnError>;
|
|
1290
1326
|
/**
|
|
1291
|
-
*
|
|
1327
|
+
* Issue an agent admission
|
|
1292
1328
|
*
|
|
1293
|
-
*
|
|
1329
|
+
* Authorizes a bounded template-agent operation against the current document and returns the admission context.
|
|
1294
1330
|
*/
|
|
1295
|
-
static
|
|
1296
|
-
|
|
1297
|
-
|
|
1331
|
+
static issueAgentAdmission<ThrowOnError extends boolean = false>(parameters: {
|
|
1332
|
+
templateId: TemplateId;
|
|
1333
|
+
method: "GET" | "HEAD" | "POST";
|
|
1334
|
+
route: "prompt" | "read" | "abort" | "clear";
|
|
1335
|
+
referenceDigest?: string | undefined;
|
|
1336
|
+
research?: {
|
|
1337
|
+
kind: "query";
|
|
1338
|
+
query: string;
|
|
1339
|
+
} | {
|
|
1340
|
+
kind: "url";
|
|
1341
|
+
url: string;
|
|
1342
|
+
} | {
|
|
1343
|
+
kind: "styleguide";
|
|
1344
|
+
domain: string;
|
|
1345
|
+
} | undefined;
|
|
1346
|
+
competitorMessage?: {
|
|
1347
|
+
watchId: MailboxExtensionId;
|
|
1348
|
+
messageId: MessageId;
|
|
1349
|
+
} | undefined;
|
|
1350
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsIssueAgentAdmissionResponses, TemplateDocumentsIssueAgentAdmissionErrors, ThrowOnError>;
|
|
1298
1351
|
/**
|
|
1299
|
-
*
|
|
1352
|
+
* Complete an agent conversation clear
|
|
1300
1353
|
*
|
|
1301
|
-
*
|
|
1354
|
+
* Records completion of an admitted agent conversation-clear operation for the template document.
|
|
1302
1355
|
*/
|
|
1303
|
-
static
|
|
1304
|
-
|
|
1305
|
-
|
|
1356
|
+
static completeAgentConversationClear<ThrowOnError extends boolean = false>(parameters: {
|
|
1357
|
+
templateId: TemplateId;
|
|
1358
|
+
conversationId: string;
|
|
1359
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsCompleteAgentConversationClearResponses, TemplateDocumentsCompleteAgentConversationClearErrors, ThrowOnError>;
|
|
1306
1360
|
/**
|
|
1307
|
-
*
|
|
1361
|
+
* Apply an agent proposal
|
|
1308
1362
|
*
|
|
1309
|
-
*
|
|
1363
|
+
* Applies an admitted agent-authored source proposal when its revision and source digest still match the document.
|
|
1310
1364
|
*/
|
|
1311
|
-
static
|
|
1312
|
-
|
|
1313
|
-
|
|
1365
|
+
static applyAgentProposal<ThrowOnError extends boolean = false>(parameters: {
|
|
1366
|
+
templateId: TemplateId;
|
|
1367
|
+
expectedRevision: string;
|
|
1368
|
+
sourceDigest: string;
|
|
1369
|
+
idempotencyKey: string;
|
|
1370
|
+
source: string;
|
|
1371
|
+
references: Array<{
|
|
1372
|
+
kind: string;
|
|
1373
|
+
digest: string;
|
|
1374
|
+
locator?: string | undefined;
|
|
1375
|
+
}>;
|
|
1376
|
+
proposalBinding?: string | undefined;
|
|
1377
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsApplyAgentProposalResponses, TemplateDocumentsApplyAgentProposalErrors, ThrowOnError>;
|
|
1314
1378
|
/**
|
|
1315
|
-
*
|
|
1379
|
+
* Replace template source
|
|
1316
1380
|
*
|
|
1317
|
-
*
|
|
1381
|
+
* Replaces the editable SML source when the expected revision matches and returns the updated document snapshot.
|
|
1318
1382
|
*/
|
|
1319
|
-
static
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1383
|
+
static replace<ThrowOnError extends boolean = false>(parameters: {
|
|
1384
|
+
templateId: TemplateId;
|
|
1385
|
+
expectedRevision: string;
|
|
1386
|
+
source: string;
|
|
1387
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsReplaceResponses, TemplateDocumentsReplaceErrors, ThrowOnError>;
|
|
1388
|
+
/**
|
|
1389
|
+
* Save a template document
|
|
1390
|
+
*
|
|
1391
|
+
* Materializes the specified document revision as a durable template source version and returns its receipt.
|
|
1392
|
+
*/
|
|
1393
|
+
static save<ThrowOnError extends boolean = false>(parameters: {
|
|
1394
|
+
templateId: TemplateId;
|
|
1395
|
+
revision: string;
|
|
1396
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsSaveResponses, TemplateDocumentsSaveErrors, ThrowOnError>;
|
|
1323
1397
|
/**
|
|
1324
|
-
*
|
|
1398
|
+
* Render a template document
|
|
1325
1399
|
*
|
|
1326
|
-
*
|
|
1400
|
+
* Renders the specified document revision with optional variables and reports any missing variables.
|
|
1401
|
+
*/
|
|
1402
|
+
static render<ThrowOnError extends boolean = false>(parameters: {
|
|
1403
|
+
templateId: TemplateId;
|
|
1404
|
+
revision: string;
|
|
1405
|
+
variables?: {
|
|
1406
|
+
[key: string]: JsonValue;
|
|
1407
|
+
} | null | undefined;
|
|
1408
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsRenderResponses, TemplateDocumentsRenderErrors, ThrowOnError>;
|
|
1409
|
+
/**
|
|
1410
|
+
* Check a template document for spam
|
|
1411
|
+
*
|
|
1412
|
+
* Renders and analyzes the specified document revision for spam risks, returning issues and recommendations.
|
|
1327
1413
|
*/
|
|
1328
1414
|
static spamCheck<ThrowOnError extends boolean = false>(parameters: {
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1415
|
+
templateId: TemplateId;
|
|
1416
|
+
revision: string;
|
|
1417
|
+
variables?: {
|
|
1418
|
+
[key: string]: JsonValue;
|
|
1419
|
+
} | null | undefined;
|
|
1420
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsSpamCheckResponses, TemplateDocumentsSpamCheckErrors, ThrowOnError>;
|
|
1421
|
+
/**
|
|
1422
|
+
* Send a template test
|
|
1423
|
+
*
|
|
1424
|
+
* Renders the specified document revision and sends a test message to one recipient without publishing it.
|
|
1425
|
+
*/
|
|
1426
|
+
static testSend<ThrowOnError extends boolean = false>(parameters: {
|
|
1427
|
+
templateId: TemplateId;
|
|
1428
|
+
revision: string;
|
|
1429
|
+
to: string;
|
|
1430
|
+
variables?: {
|
|
1431
|
+
[key: string]: JsonValue;
|
|
1432
|
+
} | null | undefined;
|
|
1433
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsTestSendResponses, TemplateDocumentsTestSendErrors, ThrowOnError>;
|
|
1434
|
+
/**
|
|
1435
|
+
* Send a template document
|
|
1436
|
+
*
|
|
1437
|
+
* Sends or schedules the specified document revision for one or more recipients with optional variables.
|
|
1438
|
+
*/
|
|
1439
|
+
static send<ThrowOnError extends boolean = false>(parameters: {
|
|
1440
|
+
templateId: TemplateId;
|
|
1441
|
+
revision: string;
|
|
1442
|
+
to: Array<{
|
|
1443
|
+
address: string;
|
|
1444
|
+
name?: string | null | undefined;
|
|
1445
|
+
}>;
|
|
1446
|
+
variables?: {
|
|
1447
|
+
[key: string]: JsonValue;
|
|
1448
|
+
} | null | undefined;
|
|
1449
|
+
schedule?: string | null | null | undefined;
|
|
1450
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsSendResponses, TemplateDocumentsSendErrors, ThrowOnError>;
|
|
1451
|
+
/**
|
|
1452
|
+
* List template document versions
|
|
1453
|
+
*
|
|
1454
|
+
* Returns the saved source-version history for a template document.
|
|
1455
|
+
*/
|
|
1456
|
+
static versions<ThrowOnError extends boolean = false>(parameters: {
|
|
1457
|
+
templateId: TemplateId;
|
|
1458
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsVersionsResponses, TemplateDocumentsVersionsErrors, ThrowOnError>;
|
|
1459
|
+
/**
|
|
1460
|
+
* Publish a template document
|
|
1461
|
+
*
|
|
1462
|
+
* Publishes the current saved template source version and returns its lifecycle receipt.
|
|
1463
|
+
*/
|
|
1464
|
+
static publish<ThrowOnError extends boolean = false>(parameters: {
|
|
1465
|
+
templateId: TemplateId;
|
|
1466
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsPublishResponses, TemplateDocumentsPublishErrors, ThrowOnError>;
|
|
1467
|
+
/**
|
|
1468
|
+
* Unpublish a template document
|
|
1469
|
+
*
|
|
1470
|
+
* Unpublishes the current template source version and returns its lifecycle receipt.
|
|
1471
|
+
*/
|
|
1472
|
+
static unpublish<ThrowOnError extends boolean = false>(parameters: {
|
|
1473
|
+
templateId: TemplateId;
|
|
1474
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsUnpublishResponses, TemplateDocumentsUnpublishErrors, ThrowOnError>;
|
|
1475
|
+
/**
|
|
1476
|
+
* Restore a template document version
|
|
1477
|
+
*
|
|
1478
|
+
* Restores a saved source version into the editable document when the expected revision matches.
|
|
1479
|
+
*/
|
|
1480
|
+
static restore<ThrowOnError extends boolean = false>(parameters: {
|
|
1481
|
+
templateId: TemplateId;
|
|
1482
|
+
versionId: TemplateSourceVersionId;
|
|
1483
|
+
expectedRevision: string;
|
|
1484
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsRestoreResponses, TemplateDocumentsRestoreErrors, ThrowOnError>;
|
|
1340
1485
|
}
|
|
1341
|
-
export declare class
|
|
1342
|
-
static
|
|
1486
|
+
export declare class TemplateDocuments2 {
|
|
1487
|
+
static templateDocuments: typeof TemplateDocuments;
|
|
1343
1488
|
}
|
|
1344
1489
|
export declare class Design {
|
|
1345
1490
|
/**
|
|
@@ -1379,8 +1524,8 @@ export declare class Webhooks {
|
|
|
1379
1524
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1380
1525
|
name: string;
|
|
1381
1526
|
url: string;
|
|
1382
|
-
eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test">;
|
|
1383
|
-
channels?: Array<"
|
|
1527
|
+
eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated">;
|
|
1528
|
+
channels?: Array<"email"> | null | undefined;
|
|
1384
1529
|
headers?: {
|
|
1385
1530
|
[key: string]: string;
|
|
1386
1531
|
} | null | undefined;
|
|
@@ -1411,8 +1556,8 @@ export declare class Webhooks {
|
|
|
1411
1556
|
id: WebhookEndpointId;
|
|
1412
1557
|
name?: string | null | undefined;
|
|
1413
1558
|
url?: string | null | undefined;
|
|
1414
|
-
eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test"> | null | undefined;
|
|
1415
|
-
channels?: Array<"
|
|
1559
|
+
eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated"> | null | undefined;
|
|
1560
|
+
channels?: Array<"email"> | null | null | undefined;
|
|
1416
1561
|
headers?: {
|
|
1417
1562
|
[key: string]: string;
|
|
1418
1563
|
} | null | undefined;
|
|
@@ -1584,7 +1729,7 @@ export declare class ApiKeys {
|
|
|
1584
1729
|
/**
|
|
1585
1730
|
* Rotate an API key
|
|
1586
1731
|
*
|
|
1587
|
-
*
|
|
1732
|
+
* Issues a replacement with the same owner, name, and permissions, then deactivates the existing key. Returns the new key, including the plaintext secret.
|
|
1588
1733
|
*/
|
|
1589
1734
|
static rotate<ThrowOnError extends boolean = false>(parameters: {
|
|
1590
1735
|
id: ApiKeyId;
|