samva 0.1.1 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client/sdk.gen.d.ts +120 -184
- package/dist/client/types.gen.d.ts +811 -418
- package/dist/{client-DVALvDUe.js → client-BqkU-sFv.js} +937 -576
- package/dist/effect/api-keys.js +1 -1
- package/dist/effect/campaigns.d.ts +98 -7
- package/dist/effect/campaigns.js +1 -1
- package/dist/effect/client.js +1 -1
- package/dist/effect/contacts.d.ts +16 -94
- package/dist/effect/contacts.js +1 -1
- package/dist/effect/conversations.d.ts +65 -50
- package/dist/effect/conversations.js +1 -1
- package/dist/effect/design.js +1 -1
- package/dist/effect/email.d.ts +107 -67
- package/dist/effect/email.js +20 -18
- package/dist/effect/generated.d.ts +11823 -11603
- package/dist/effect/index.js +1 -1
- package/dist/effect/messages.js +1 -1
- package/dist/effect/operations.d.ts +3 -3
- package/dist/effect/operations.js +1 -1
- package/dist/effect/organizations.d.ts +1 -1
- package/dist/effect/organizations.js +1 -1
- package/dist/effect/scheduled-messages.d.ts +0 -48
- package/dist/effect/scheduled-messages.js +1 -1
- package/dist/effect/templates.d.ts +262 -1018
- package/dist/effect/templates.js +26 -18
- package/dist/effect/webhooks.d.ts +6 -6
- package/dist/effect/webhooks.js +2 -2
- package/dist/index.js +1 -1
- package/dist/{operation-UtKNITtG.js → operation-Ccqh_yxb.js} +48 -25
- package/dist/promises/index.d.ts +3 -1
- package/dist/promises/index.js +1 -1
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/{promises-QxEfMTho.js → promises-Dgv8UmCC.js} +319 -153
- package/dist/service-map.d.ts +66 -40
- package/package.json +4 -4
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,
|
|
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, 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, TemplateDocumentsBootstrapErrors, TemplateDocumentsBootstrapResponses, TemplateDocumentsGetErrors, TemplateDocumentsGetResponses, 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, WhatsAppSendMessagePayload } 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
|
|
@@ -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
|
*
|
|
@@ -893,39 +903,6 @@ export declare class Contacts {
|
|
|
893
903
|
humanProfile?: HumanProfile | null | null | undefined;
|
|
894
904
|
capabilities?: Array<string> | null | undefined;
|
|
895
905
|
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
906
|
accessLevel?: "public" | "authenticated" | "vip" | "internal" | null | undefined;
|
|
930
907
|
accessConfig?: ContactAccessConfig | null | null | undefined;
|
|
931
908
|
preferences?: ContactPreferences | null | null | undefined;
|
|
@@ -991,39 +968,6 @@ export declare class Contacts {
|
|
|
991
968
|
humanProfile?: HumanProfile | null | null | undefined;
|
|
992
969
|
capabilities?: Array<string> | null | undefined;
|
|
993
970
|
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
971
|
accessLevel?: "public" | "authenticated" | "vip" | "internal" | null | undefined;
|
|
1028
972
|
accessConfig?: ContactAccessConfig | null | null | undefined;
|
|
1029
973
|
preferences?: ContactPreferences | null | null | undefined;
|
|
@@ -1221,7 +1165,7 @@ export declare class Templates {
|
|
|
1221
1165
|
/**
|
|
1222
1166
|
* Get a template
|
|
1223
1167
|
*
|
|
1224
|
-
* Returns
|
|
1168
|
+
* Returns template metadata and compiled channel content. Read live SML through the template-document API.
|
|
1225
1169
|
*/
|
|
1226
1170
|
static getById<ThrowOnError extends boolean = false>(parameters: {
|
|
1227
1171
|
id: TemplateId;
|
|
@@ -1229,7 +1173,7 @@ export declare class Templates {
|
|
|
1229
1173
|
/**
|
|
1230
1174
|
* Update a template
|
|
1231
1175
|
*
|
|
1232
|
-
* Updates
|
|
1176
|
+
* Updates template metadata. Source changes use the template-document revision API.
|
|
1233
1177
|
*/
|
|
1234
1178
|
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
1235
1179
|
id: TemplateId;
|
|
@@ -1241,11 +1185,6 @@ export declare class Templates {
|
|
|
1241
1185
|
category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | null | undefined;
|
|
1242
1186
|
fromDefault?: TemplateFromDefault | null | null | undefined;
|
|
1243
1187
|
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
1188
|
variableSchema?: Array<TemplateVariable> | null | null | undefined;
|
|
1250
1189
|
compliance?: TemplateCompliance | null | null | undefined;
|
|
1251
1190
|
performance?: TemplatePerformance | null | null | undefined;
|
|
@@ -1266,80 +1205,77 @@ export declare class Templates {
|
|
|
1266
1205
|
notes?: string | null | undefined;
|
|
1267
1206
|
};
|
|
1268
1207
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesApproveResponses, TemplatesApproveErrors, ThrowOnError>;
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1208
|
+
}
|
|
1209
|
+
export declare class Templates2 {
|
|
1210
|
+
static templates: typeof Templates;
|
|
1211
|
+
}
|
|
1212
|
+
export declare class TemplateDocuments {
|
|
1213
|
+
static bootstrap<ThrowOnError extends boolean = false>(parameters: {
|
|
1214
|
+
templateId: TemplateId;
|
|
1215
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsBootstrapResponses, TemplateDocumentsBootstrapErrors, ThrowOnError>;
|
|
1216
|
+
static get<ThrowOnError extends boolean = false>(parameters: {
|
|
1217
|
+
templateId: TemplateId;
|
|
1218
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsGetResponses, TemplateDocumentsGetErrors, ThrowOnError>;
|
|
1219
|
+
static replace<ThrowOnError extends boolean = false>(parameters: {
|
|
1220
|
+
templateId: TemplateId;
|
|
1221
|
+
expectedRevision: string;
|
|
1222
|
+
source: string;
|
|
1223
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsReplaceResponses, TemplateDocumentsReplaceErrors, ThrowOnError>;
|
|
1224
|
+
static save<ThrowOnError extends boolean = false>(parameters: {
|
|
1225
|
+
templateId: TemplateId;
|
|
1226
|
+
revision: string;
|
|
1227
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsSaveResponses, TemplateDocumentsSaveErrors, ThrowOnError>;
|
|
1274
1228
|
static render<ThrowOnError extends boolean = false>(parameters: {
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1229
|
+
templateId: TemplateId;
|
|
1230
|
+
revision: string;
|
|
1231
|
+
variables?: {
|
|
1232
|
+
[key: string]: JsonValue;
|
|
1233
|
+
} | null | undefined;
|
|
1234
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsRenderResponses, TemplateDocumentsRenderErrors, ThrowOnError>;
|
|
1235
|
+
static spamCheck<ThrowOnError extends boolean = false>(parameters: {
|
|
1236
|
+
templateId: TemplateId;
|
|
1237
|
+
revision: string;
|
|
1238
|
+
variables?: {
|
|
1239
|
+
[key: string]: JsonValue;
|
|
1240
|
+
} | null | undefined;
|
|
1241
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsSpamCheckResponses, TemplateDocumentsSpamCheckErrors, ThrowOnError>;
|
|
1242
|
+
static testSend<ThrowOnError extends boolean = false>(parameters: {
|
|
1243
|
+
templateId: TemplateId;
|
|
1244
|
+
revision: string;
|
|
1245
|
+
to: string;
|
|
1246
|
+
variables?: {
|
|
1247
|
+
[key: string]: JsonValue;
|
|
1248
|
+
} | null | undefined;
|
|
1249
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsTestSendResponses, TemplateDocumentsTestSendErrors, ThrowOnError>;
|
|
1250
|
+
static send<ThrowOnError extends boolean = false>(parameters: {
|
|
1251
|
+
templateId: TemplateId;
|
|
1252
|
+
revision: string;
|
|
1253
|
+
to: Array<{
|
|
1254
|
+
address: string;
|
|
1255
|
+
name?: string | null | undefined;
|
|
1256
|
+
}>;
|
|
1257
|
+
variables?: {
|
|
1258
|
+
[key: string]: JsonValue;
|
|
1259
|
+
} | null | undefined;
|
|
1260
|
+
schedule?: string | null | null | undefined;
|
|
1261
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsSendResponses, TemplateDocumentsSendErrors, ThrowOnError>;
|
|
1262
|
+
static versions<ThrowOnError extends boolean = false>(parameters: {
|
|
1263
|
+
templateId: TemplateId;
|
|
1264
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsVersionsResponses, TemplateDocumentsVersionsErrors, ThrowOnError>;
|
|
1295
1265
|
static publish<ThrowOnError extends boolean = false>(parameters: {
|
|
1296
|
-
|
|
1297
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
1298
|
-
/**
|
|
1299
|
-
* Unpublish a template
|
|
1300
|
-
*
|
|
1301
|
-
* Reverts a published template by creating a new draft version from its current source. Returns the updated template.
|
|
1302
|
-
*/
|
|
1266
|
+
templateId: TemplateId;
|
|
1267
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsPublishResponses, TemplateDocumentsPublishErrors, ThrowOnError>;
|
|
1303
1268
|
static unpublish<ThrowOnError extends boolean = false>(parameters: {
|
|
1304
|
-
|
|
1305
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
*
|
|
1309
|
-
* Returns the template's version history, listing each source version with its status and publish metadata.
|
|
1310
|
-
*/
|
|
1311
|
-
static versionHistory<ThrowOnError extends boolean = false>(parameters: {
|
|
1312
|
-
id: TemplateId;
|
|
1313
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesVersionHistoryResponses, TemplatesVersionHistoryErrors, ThrowOnError>;
|
|
1314
|
-
/**
|
|
1315
|
-
* Restore a template version
|
|
1316
|
-
*
|
|
1317
|
-
* Recompiles an older version's source and restores it as a new draft version. Fails if the source no longer compiles or its channel differs.
|
|
1318
|
-
*/
|
|
1319
|
-
static restoreVersion<ThrowOnError extends boolean = false>(parameters: {
|
|
1320
|
-
id: TemplateId;
|
|
1269
|
+
templateId: TemplateId;
|
|
1270
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsUnpublishResponses, TemplateDocumentsUnpublishErrors, ThrowOnError>;
|
|
1271
|
+
static restore<ThrowOnError extends boolean = false>(parameters: {
|
|
1272
|
+
templateId: TemplateId;
|
|
1321
1273
|
versionId: TemplateSourceVersionId;
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
* Spam-check a template or email content
|
|
1325
|
-
*
|
|
1326
|
-
* Scores email content for spam risk, from either a stored email template or raw subject, HTML, and text. Returns a score, severity, issues, and recommendations.
|
|
1327
|
-
*/
|
|
1328
|
-
static spamCheck<ThrowOnError extends boolean = false>(parameters: {
|
|
1329
|
-
body: {
|
|
1330
|
-
templateId: TemplateId;
|
|
1331
|
-
inputs?: {
|
|
1332
|
-
[key: string]: JsonValue;
|
|
1333
|
-
} | null | undefined;
|
|
1334
|
-
} | {
|
|
1335
|
-
subject: string;
|
|
1336
|
-
html: string;
|
|
1337
|
-
text: string;
|
|
1338
|
-
};
|
|
1339
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesSpamCheckResponses, TemplatesSpamCheckErrors, ThrowOnError>;
|
|
1274
|
+
expectedRevision: string;
|
|
1275
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsRestoreResponses, TemplateDocumentsRestoreErrors, ThrowOnError>;
|
|
1340
1276
|
}
|
|
1341
|
-
export declare class
|
|
1342
|
-
static
|
|
1277
|
+
export declare class TemplateDocuments2 {
|
|
1278
|
+
static templateDocuments: typeof TemplateDocuments;
|
|
1343
1279
|
}
|
|
1344
1280
|
export declare class Design {
|
|
1345
1281
|
/**
|
|
@@ -1379,7 +1315,7 @@ export declare class Webhooks {
|
|
|
1379
1315
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1380
1316
|
name: string;
|
|
1381
1317
|
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">;
|
|
1318
|
+
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">;
|
|
1383
1319
|
channels?: Array<"sms" | "whatsapp" | "email"> | null | undefined;
|
|
1384
1320
|
headers?: {
|
|
1385
1321
|
[key: string]: string;
|
|
@@ -1411,7 +1347,7 @@ export declare class Webhooks {
|
|
|
1411
1347
|
id: WebhookEndpointId;
|
|
1412
1348
|
name?: string | null | undefined;
|
|
1413
1349
|
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;
|
|
1350
|
+
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;
|
|
1415
1351
|
channels?: Array<"sms" | "whatsapp" | "email"> | null | null | undefined;
|
|
1416
1352
|
headers?: {
|
|
1417
1353
|
[key: string]: string;
|