samva 0.3.0 → 0.5.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 +5 -1
- package/dist/{categories-CsUa8ojo.js → categories-B9Nw2v_F.js} +5 -1
- package/dist/client/sdk.gen.d.ts +312 -190
- package/dist/client/types.gen.d.ts +2284 -728
- package/dist/{client-BOghX8fr.js → client-B7gEkvEq.js} +2740 -1036
- package/dist/client-attribution-B2yJBXdZ.js +9 -0
- package/dist/client-attribution.d.ts +2 -0
- package/dist/effect/api-keys.d.ts +51 -51
- package/dist/effect/api-keys.js +1 -1
- package/dist/effect/campaigns.d.ts +269 -219
- package/dist/effect/campaigns.js +1 -1
- package/dist/effect/categories.d.ts +6 -6
- package/dist/effect/categories.js +1 -1
- package/dist/effect/client.js +1 -1
- package/dist/effect/contacts.d.ts +225 -225
- package/dist/effect/contacts.js +1 -1
- package/dist/effect/conversations.d.ts +308 -293
- package/dist/effect/conversations.js +1 -1
- package/dist/effect/design.d.ts +76 -76
- package/dist/effect/design.js +1 -1
- package/dist/effect/email.d.ts +923 -213
- package/dist/effect/email.js +27 -3
- package/dist/effect/generated-metadata.d.ts +4 -0
- package/dist/effect/generated.d.ts +14948 -10919
- package/dist/effect/index.js +2 -2
- package/dist/effect/internal/client.d.ts +1 -1
- package/dist/effect/internal/operation.d.ts +31 -20
- package/dist/effect/media.d.ts +12 -12
- package/dist/effect/media.js +1 -1
- package/dist/effect/messages.d.ts +243 -61
- package/dist/effect/messages.js +5 -3
- package/dist/effect/operations.d.ts +17 -17
- package/dist/effect/operations.js +1 -1
- package/dist/effect/organizations.d.ts +162 -162
- package/dist/effect/organizations.js +1 -1
- package/dist/effect/retry.js +1 -1
- package/dist/effect/runtime.d.ts +0 -2
- package/dist/effect/scheduled-messages.d.ts +375 -277
- package/dist/effect/scheduled-messages.js +5 -3
- package/dist/effect/templates.d.ts +1383 -1554
- package/dist/effect/templates.js +40 -30
- package/dist/effect/webhooks.d.ts +81 -47
- package/dist/effect/webhooks.js +2 -2
- package/dist/index.js +2 -2
- package/dist/{normalize-BKFjbR9t.js → normalize-BiIJnycv.js} +2 -3
- package/dist/{operation-C2Q4cFJL.js → operation-B4FjN6wq.js} +113 -38
- package/dist/promises/errors.gen.d.ts +21 -2
- package/dist/promises/index.d.ts +11 -8
- package/dist/promises/index.js +2 -2
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/{promises-oiy7mOyu.js → promises-CP_nxUus.js} +828 -306
- package/dist/service-map.d.ts +136 -44
- package/package.json +13 -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, 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";
|
|
2
|
+
import type { ActorTracking, ApiKeyId, ApiKeyPermissions, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRemoveErrors, ApiKeysRemoveResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, BlockedEmailId, CampaignAudience, CampaignContentInput, CampaignId, CampaignPolicy, CampaignRunId, CampaignsArchiveErrors, CampaignsArchiveResponses, CampaignsCancelRunErrors, CampaignsCancelRunResponses, CampaignsCreateErrors, CampaignsCreateResponses, CampaignsGetErrors, CampaignsGetResponses, CampaignsGetRunErrors, CampaignsGetRunResponses, CampaignsListErrors, CampaignsListRecipientsErrors, CampaignsListRecipientsResponses, CampaignsListResponses, CampaignsListRunsErrors, CampaignsListRunsResponses, CampaignsPauseRunErrors, CampaignsPauseRunResponses, CampaignsResumeRunErrors, CampaignsResumeRunResponses, CampaignsScheduleRunErrors, CampaignsScheduleRunResponses, CampaignsUpdateErrors, CampaignsUpdateResponses, ContactAccessConfig, ContactId, ContactIdentity, ContactPreferences, ContactsBulkDeleteErrors, ContactsBulkDeleteResponses, ContactsBulkImportErrors, ContactsBulkImportResponses, ContactsBulkUpdateStatusErrors, ContactsBulkUpdateStatusResponses, ContactsBulkUpdateTagsErrors, ContactsBulkUpdateTagsResponses, ContactsCreateErrors, ContactsCreateResponses, ContactsExportErrors, ContactsExportResponses, ContactsFindErrors, ContactsFindOrCreateErrors, ContactsFindOrCreateResponses, ContactsFindResponses, ContactsGetActivityTimelineErrors, ContactsGetActivityTimelineResponses, ContactsGetEngagementErrors, ContactsGetEngagementResponses, ContactsGetErrors, ContactsGetGroupMembershipsErrors, ContactsGetGroupMembershipsResponses, ContactsGetResponses, ContactsListErrors, ContactsListResponses, ContactsRemoveErrors, ContactsRemoveResponses, ContactsUpdateErrors, ContactsUpdateResponses, ConversationContext, ConversationId, ConversationMetadata, ConversationMetrics, ConversationsAddContactsErrors, ConversationsAddContactsResponses, ConversationsCreateErrors, ConversationsCreateResponses, ConversationsGetByIdErrors, ConversationsGetByIdResponses, ConversationsListErrors, ConversationsListMessagesErrors, ConversationsListMessagesResponses, ConversationsListResponses, ConversationsRemoveContactsErrors, ConversationsRemoveContactsResponses, ConversationsUpdateErrors, ConversationsUpdateResponses, Design as Design3, DesignGetErrors, DesignGetResponses, DesignUpdateErrors, DesignUpdateResponses, DispatchSendMessagePayload, EmailAddBlockErrors, EmailAddBlockResponses, EmailAddDomainErrors, EmailAddDomainResponses, EmailAddSenderErrors, EmailAddSenderResponses, EmailAdvanceDomainVerificationErrors, EmailAdvanceDomainVerificationResponses, EmailBccRecipients, EmailBuildCustomTrackingDomainConnectApplyUrlErrors, EmailBuildCustomTrackingDomainConnectApplyUrlResponses, EmailBuildDomainConnectApplyUrlErrors, EmailBuildDomainConnectApplyUrlResponses, EmailCancelDomainWarmingBatchErrors, EmailCancelDomainWarmingBatchResponses, EmailCcRecipients, EmailCheckBlockedErrors, EmailCheckBlockedResponses, EmailCheckSenderVerificationErrors, EmailCheckSenderVerificationResponses, EmailClearDomainDefaultSenderErrors, EmailClearDomainDefaultSenderResponses, EmailCompleteCustomTrackingDomainConnectErrors, EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteDomainConnectErrors, EmailCompleteDomainConnectResponses, EmailCompleteDomainWarmingErrors, EmailCompleteDomainWarmingResponses, EmailContent, EmailCreateDomainWarmingPlanErrors, EmailCreateDomainWarmingPlanResponses, EmailCreateForwardingRuleErrors, EmailCreateForwardingRuleResponses, EmailDeleteForwardingRuleErrors, EmailDeleteForwardingRuleResponses, EmailDetectRegistrarErrors, EmailDetectRegistrarResponses, EmailDisableCatchAllErrors, EmailDisableCatchAllResponses, EmailDisableCustomTrackingErrors, EmailDisableCustomTrackingResponses, EmailDomainId, EmailDomainWarmingBatchId, EmailEnableCatchAllErrors, EmailEnableCatchAllResponses, EmailEnableCustomTrackingErrors, EmailEnableCustomTrackingResponses, EmailEnableReceivingErrors, EmailEnableReceivingResponses, EmailForwardingRuleId, EmailGetBlockLogsErrors, EmailGetBlockLogsResponses, EmailGetCatchAllConfigErrors, EmailGetCatchAllConfigResponses, EmailGetCatchAllStatsErrors, EmailGetCatchAllStatsResponses, EmailGetCustomTrackingDomainConnectErrors, EmailGetCustomTrackingDomainConnectResponses, EmailGetCustomTrackingErrors, EmailGetCustomTrackingResponses, EmailGetDomainByIdErrors, EmailGetDomainByIdResponses, EmailGetDomainConnectErrors, EmailGetDomainConnectResponses, EmailGetDomainVerificationErrors, EmailGetDomainVerificationResponses, EmailGetDomainWarmingErrors, EmailGetDomainWarmingResponses, EmailGetForwardingLogErrors, EmailGetForwardingLogResponses, EmailGetOnboardingReviewErrors, EmailGetOnboardingReviewResponses, EmailGetRecipientTrackingPreferenceErrors, EmailGetRecipientTrackingPreferenceResponses, EmailGetSenderErrors, EmailGetSenderResponses, EmailGetStatsErrors, EmailGetStatsResponses, EmailGetTrackingDefaultsErrors, EmailGetTrackingDefaultsResponses, EmailListBlocksErrors, EmailListBlocksResponses, EmailListDomainsErrors, EmailListDomainsResponses, EmailListForwardingRulesErrors, EmailListForwardingRulesResponses, EmailListSendersErrors, EmailListSendersResponses, EmailListSuppressionsErrors, EmailListSuppressionsResponses, EmailPauseDomainWarmingErrors, EmailPauseDomainWarmingResponses, EmailReapplyOnboardingReviewErrors, EmailReapplyOnboardingReviewResponses, EmailRecipients, EmailRemoveBlockErrors, EmailRemoveBlockResponses, EmailRemoveDomainErrors, EmailRemoveDomainResponses, EmailRemoveSenderErrors, EmailRemoveSenderResponses, EmailRemoveSuppressionErrors, EmailRemoveSuppressionResponses, EmailRespondToOnboardingInformationRequestErrors, EmailRespondToOnboardingInformationRequestResponses, EmailResumeDomainWarmingErrors, EmailResumeDomainWarmingResponses, EmailRotateDomainDkimErrors, EmailRotateDomainDkimResponses, EmailSender, EmailSenderId, EmailSendMessagePayload, EmailSetDefaultDomainErrors, EmailSetDefaultDomainResponses, EmailSetDefaultSenderErrors, EmailSetDefaultSenderResponses, EmailSetDomainDefaultSenderErrors, EmailSetDomainDefaultSenderResponses, EmailUpdateBlockErrors, EmailUpdateBlockResponses, EmailUpdateCatchAllConfigErrors, EmailUpdateCatchAllConfigResponses, EmailUpdateDomainConfigErrors, EmailUpdateDomainConfigResponses, EmailUpdateDomainWarmingPolicyErrors, EmailUpdateDomainWarmingPolicyResponses, EmailUpdateForwardingRuleErrors, EmailUpdateForwardingRuleResponses, EmailUpdateRecipientTrackingPreferenceErrors, EmailUpdateRecipientTrackingPreferenceResponses, EmailUpdateTrackingDefaultsErrors, EmailUpdateTrackingDefaultsResponses, ForwardingConditions, HumanProfile, IanaTimezone, JsonObject, JsonValue, MediaCompleteErrors, MediaCompleteResponses, MediaCreateErrors, MediaCreateResponses, MediaDownloadUrlErrors, MediaDownloadUrlResponses, MediaGetByIdErrors, MediaGetByIdResponses, MediaId, MediaRemoveErrors, MediaRemoveResponses, MessageId, MessageMetadata, MessagesGetEmailErrors, MessagesGetEmailResponses, MessagesGetErrors, MessagesGetEventsErrors, MessagesGetEventsResponses, MessagesGetResponses, MessagesGetStatusErrors, MessagesGetStatusResponses, MessagesListErrors, MessagesListResponses, MessagesRemoveErrors, MessagesRemoveResponses, MessagesSendErrors, MessagesSendResponses, MessagesValidateEmailErrors, MessagesValidateEmailResponses, OperationId, OperationsGetErrors, OperationsGetResponses, OperationsListErrors, OperationsListResponses, OperationsRetryErrors, OperationsRetryResponses, OrganizationsBootstrapErrors, OrganizationsBootstrapResponses, OrganizationsCreateErrors, OrganizationsCreateResponses, OrganizationsDeleteErrors, OrganizationsDeleteResponses, OrganizationsGetErrors, OrganizationsGetResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, ScheduledMessagesResumeErrors, ScheduledMessagesResumeResponses, SuppressionId, TemplateFamilyId, TemplateFromDefault, TemplateId, TemplateInputContractId, TemplateProjectId, TemplatePublicationId, TemplatesAttachFamilyMemberErrors, TemplatesAttachFamilyMemberResponses, TemplatesAttachWorkspaceResourceErrors, TemplatesAttachWorkspaceResourceResponses, TemplatesCheckWorkspaceErrors, TemplatesCheckWorkspaceResponses, TemplatesCreateErrors, TemplatesCreateFamilyErrors, TemplatesCreateFamilyFromTemplateErrors, TemplatesCreateFamilyFromTemplateResponses, TemplatesCreateFamilyResponses, TemplatesCreateResponses, TemplatesDeleteFamilyErrors, TemplatesDeleteFamilyResponses, TemplatesDetachFamilyMemberErrors, TemplatesDetachFamilyMemberResponses, TemplatesDiffWorkspaceErrors, TemplatesDiffWorkspaceResponses, TemplatesGetByIdErrors, TemplatesGetByIdResponses, TemplatesGetFamilyErrors, TemplatesGetFamilyResponses, TemplatesGetGitRepositoryErrors, TemplatesGetGitRepositoryResponses, TemplatesGetInputContractErrors, TemplatesGetInputContractResponses, TemplatesGetPublicationErrors, TemplatesGetPublicationResponses, TemplatesIssueGitCredentialErrors, TemplatesIssueGitCredentialResponses, TemplatesListDashboardErrors, TemplatesListDashboardResponses, TemplatesListErrors, TemplatesListFamiliesErrors, TemplatesListFamiliesResponses, TemplatesListInputContractsErrors, TemplatesListInputContractsResponses, TemplatesListResponses, TemplatesOpenWorkspaceErrors, TemplatesOpenWorkspaceResponses, TemplatesPatchWorkspaceErrors, TemplatesPatchWorkspaceResponses, TemplatesPublishErrors, TemplatesPublishResponses, TemplatesReconcileWorkspaceErrors, TemplatesReconcileWorkspaceResponses, TemplatesRemoveErrors, TemplatesRemoveResponses, TemplatesRemoveWorkspaceResourceErrors, TemplatesRemoveWorkspaceResourceResponses, TemplatesRenameFamilyErrors, TemplatesRenameFamilyResponses, TemplatesRenderWorkspaceFixtureErrors, TemplatesRenderWorkspaceFixtureResponses, TemplatesResolveWorkspaceConflictErrors, TemplatesResolveWorkspaceConflictResponses, TemplatesRestoreWorkspaceErrors, TemplatesRestoreWorkspaceResponses, TemplatesSaveWorkspaceErrors, TemplatesSaveWorkspaceResponses, TemplatesUpdateErrors, TemplatesUpdateResponses, TemplatesWorkspaceHistoryErrors, TemplatesWorkspaceHistoryResponses, TrackingRecipientEmail, UnknownRecord, UnsubscribeId, WebhookDeliveryId, WebhookEndpointId, WebhooksCreateErrors, WebhooksCreateResponses, WebhooksGetErrors, WebhooksGetLogsErrors, WebhooksGetLogsResponses, WebhooksGetResponses, WebhooksGetStatsErrors, WebhooksGetStatsResponses, WebhooksListErrors, WebhooksListResponses, WebhooksRegenerateSecretErrors, WebhooksRegenerateSecretResponses, WebhooksRemoveErrors, WebhooksRemoveResponses, WebhooksRetryDeliveryErrors, WebhooksRetryDeliveryResponses, WebhooksTestErrors, WebhooksTestResponses, WebhooksUpdateErrors, WebhooksUpdateResponses } from "./types.gen";
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -17,12 +17,13 @@ export declare class Messages {
|
|
|
17
17
|
/**
|
|
18
18
|
* List messages
|
|
19
19
|
*
|
|
20
|
-
* Returns a paginated list of messages
|
|
20
|
+
* Returns a paginated list of messages, with optional filters for channel, direction, status, conversation, contact, and date range.
|
|
21
21
|
*/
|
|
22
22
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
23
23
|
page?: string | null | undefined;
|
|
24
24
|
limit?: string | null | undefined;
|
|
25
25
|
channel?: "email" | null | undefined;
|
|
26
|
+
direction?: "outbound" | "inbound" | null | undefined;
|
|
26
27
|
status?: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained" | null | undefined;
|
|
27
28
|
conversationId?: ConversationId | null | undefined;
|
|
28
29
|
contactId?: ContactId | null | undefined;
|
|
@@ -64,6 +65,21 @@ export declare class Messages {
|
|
|
64
65
|
includeS3Urls?: string | null | undefined;
|
|
65
66
|
urlExpiresIn?: string | null | undefined;
|
|
66
67
|
}, options?: Options<never, ThrowOnError>): RequestResult<MessagesGetEmailResponses, MessagesGetEmailErrors, ThrowOnError>;
|
|
68
|
+
/**
|
|
69
|
+
* Validate an email message
|
|
70
|
+
*
|
|
71
|
+
* Resolves recipients, sender, and inline or published-template content without creating contacts, messages, billing reservations, quota draws, queue work, or provider calls.
|
|
72
|
+
*/
|
|
73
|
+
static validateEmail<ThrowOnError extends boolean = false>(parameters: {
|
|
74
|
+
conversationId?: ConversationId | null | null | undefined;
|
|
75
|
+
metadata?: MessageMetadata | undefined;
|
|
76
|
+
channel: "email";
|
|
77
|
+
to: EmailRecipients;
|
|
78
|
+
cc?: EmailCcRecipients | undefined;
|
|
79
|
+
bcc?: EmailBccRecipients | undefined;
|
|
80
|
+
from?: EmailSender | undefined;
|
|
81
|
+
email: EmailContent;
|
|
82
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MessagesValidateEmailResponses, MessagesValidateEmailErrors, ThrowOnError>;
|
|
67
83
|
/**
|
|
68
84
|
* Get message delivery status
|
|
69
85
|
*
|
|
@@ -123,19 +139,19 @@ export declare class ScheduledMessages {
|
|
|
123
139
|
* Returns a paginated list of scheduled messages, optionally filtered by status.
|
|
124
140
|
*/
|
|
125
141
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
126
|
-
status?: "pending" | "dispatching" | "dispatched" | "cancelled" | "failed" | null | undefined;
|
|
142
|
+
status?: "pending" | "dispatching" | "paused" | "dispatched" | "cancelled" | "failed" | null | undefined;
|
|
127
143
|
page?: string | null | undefined;
|
|
128
144
|
limit?: string | null | undefined;
|
|
129
145
|
}, options?: Options<never, ThrowOnError>): RequestResult<ScheduledMessagesListResponses, ScheduledMessagesListErrors, ThrowOnError>;
|
|
130
146
|
/**
|
|
131
147
|
* Schedule a message
|
|
132
148
|
*
|
|
133
|
-
* Schedules a message at the absolute ISO-8601
|
|
149
|
+
* Schedules a message for dispatch at the absolute ISO-8601 timestamp supplied in scheduledFor. Optional timezone is validated IANA display metadata only and never changes the execution instant.
|
|
134
150
|
*/
|
|
135
151
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
136
152
|
send: DispatchSendMessagePayload;
|
|
137
153
|
scheduledFor: string;
|
|
138
|
-
timezone?:
|
|
154
|
+
timezone?: IanaTimezone | null | undefined;
|
|
139
155
|
idempotencyKey?: string | null | undefined;
|
|
140
156
|
referenceId?: string | null | undefined;
|
|
141
157
|
}, options?: Options<never, ThrowOnError>): RequestResult<ScheduledMessagesCreateResponses, ScheduledMessagesCreateErrors, ThrowOnError>;
|
|
@@ -155,6 +171,20 @@ export declare class ScheduledMessages {
|
|
|
155
171
|
static cancel<ThrowOnError extends boolean = false>(parameters: {
|
|
156
172
|
id: ScheduledMessageId;
|
|
157
173
|
}, options?: Options<never, ThrowOnError>): RequestResult<ScheduledMessagesCancelResponses, ScheduledMessagesCancelErrors, ThrowOnError>;
|
|
174
|
+
/**
|
|
175
|
+
* Resume a review-paused scheduled message
|
|
176
|
+
*
|
|
177
|
+
* Explicitly resumes a scheduled message after onboarding review clearance. An overdue message requires either send_now or a new future scheduledFor value.
|
|
178
|
+
*/
|
|
179
|
+
static resume<ThrowOnError extends boolean = false>(parameters: {
|
|
180
|
+
id: ScheduledMessageId;
|
|
181
|
+
body: {
|
|
182
|
+
choice: "send_now";
|
|
183
|
+
} | {
|
|
184
|
+
choice: "new_time";
|
|
185
|
+
scheduledFor: string;
|
|
186
|
+
};
|
|
187
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ScheduledMessagesResumeResponses, ScheduledMessagesResumeErrors, ThrowOnError>;
|
|
158
188
|
}
|
|
159
189
|
export declare class ScheduledMessages2 {
|
|
160
190
|
static scheduledMessages: typeof ScheduledMessages;
|
|
@@ -284,10 +314,34 @@ export declare class Campaigns2 {
|
|
|
284
314
|
static campaigns: typeof Campaigns;
|
|
285
315
|
}
|
|
286
316
|
export declare class Email {
|
|
317
|
+
/**
|
|
318
|
+
* Get email onboarding review status
|
|
319
|
+
*
|
|
320
|
+
* Returns the customer-safe workspace review decision, workflow stage, next action, and current sending-identity clearances. A missing authority row is returned as a blocked initial state.
|
|
321
|
+
*/
|
|
322
|
+
static getOnboardingReview<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<EmailGetOnboardingReviewResponses, EmailGetOnboardingReviewErrors, ThrowOnError>;
|
|
323
|
+
/**
|
|
324
|
+
* Reapply for email onboarding review
|
|
325
|
+
*
|
|
326
|
+
* Allows a workspace owner or admin to submit a rejected workspace for review again. The expected generation prevents acting on stale status.
|
|
327
|
+
*/
|
|
328
|
+
static reapplyOnboardingReview<ThrowOnError extends boolean = false>(parameters: {
|
|
329
|
+
expectedGeneration: number;
|
|
330
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailReapplyOnboardingReviewResponses, EmailReapplyOnboardingReviewErrors, ThrowOnError>;
|
|
331
|
+
/**
|
|
332
|
+
* Respond to an email onboarding information request
|
|
333
|
+
*
|
|
334
|
+
* Allows workspace owners and admins to submit bounded text and up to three pending-scanned evidence uploads for the current review generation.
|
|
335
|
+
*/
|
|
336
|
+
static respondToOnboardingInformationRequest<ThrowOnError extends boolean = false>(parameters: {
|
|
337
|
+
expectedGeneration: number;
|
|
338
|
+
responseText: string;
|
|
339
|
+
evidenceMediaIds: Array<MediaId>;
|
|
340
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailRespondToOnboardingInformationRequestResponses, EmailRespondToOnboardingInformationRequestErrors, ThrowOnError>;
|
|
287
341
|
/**
|
|
288
342
|
* Get email tracking defaults
|
|
289
343
|
*
|
|
290
|
-
* Returns the
|
|
344
|
+
* Returns the workspace's independent defaults for open and click tracking, both enabled unless configured otherwise. Recipient opt-out takes precedence over these defaults.
|
|
291
345
|
*/
|
|
292
346
|
static getTrackingDefaults<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<EmailGetTrackingDefaultsResponses, EmailGetTrackingDefaultsErrors, ThrowOnError>;
|
|
293
347
|
/**
|
|
@@ -328,10 +382,14 @@ export declare class Email {
|
|
|
328
382
|
/**
|
|
329
383
|
* Add a sending domain
|
|
330
384
|
*
|
|
331
|
-
* Registers a domain for sending and returns it with the DNS records required to verify ownership and configure DKIM. Responds with 201.
|
|
385
|
+
* Registers a domain for sending and returns it with the DNS records required to verify ownership and configure DKIM. Responds with 201. Supplying a connection attaches the domain to that DNS account; the domain must sit inside the zone given with it.
|
|
332
386
|
*/
|
|
333
387
|
static addDomain<ThrowOnError extends boolean = false>(parameters: {
|
|
334
388
|
domain: string;
|
|
389
|
+
connection?: {
|
|
390
|
+
connectionId: string;
|
|
391
|
+
zone: string;
|
|
392
|
+
} | null | undefined;
|
|
335
393
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailAddDomainResponses, EmailAddDomainErrors, ThrowOnError>;
|
|
336
394
|
/**
|
|
337
395
|
* Get domain verification
|
|
@@ -349,6 +407,15 @@ export declare class Email {
|
|
|
349
407
|
static advanceDomainVerification<ThrowOnError extends boolean = false>(parameters: {
|
|
350
408
|
id: EmailDomainId;
|
|
351
409
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailAdvanceDomainVerificationResponses, EmailAdvanceDomainVerificationErrors, ThrowOnError>;
|
|
410
|
+
/**
|
|
411
|
+
* Stage a DKIM selector rotation
|
|
412
|
+
*
|
|
413
|
+
* Creates encrypted signing custody and returns a new public DKIM record. Publish it, then advance domain verification to cut over. Retain the former record until separately approved retirement.
|
|
414
|
+
*/
|
|
415
|
+
static rotateDomainDkim<ThrowOnError extends boolean = false>(parameters: {
|
|
416
|
+
"idempotency-key": string;
|
|
417
|
+
id: EmailDomainId;
|
|
418
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailRotateDomainDkimResponses, EmailRotateDomainDkimErrors, ThrowOnError>;
|
|
352
419
|
/**
|
|
353
420
|
* Remove a sending domain
|
|
354
421
|
*
|
|
@@ -455,7 +522,7 @@ export declare class Email {
|
|
|
455
522
|
/**
|
|
456
523
|
* Disable a custom tracking domain
|
|
457
524
|
*
|
|
458
|
-
*
|
|
525
|
+
* Disables a domain's custom tracking, removes its managed resources, and immediately returns sends to the shared tracking host. Existing custom links in already-delivered mail stop working.
|
|
459
526
|
*/
|
|
460
527
|
static disableCustomTracking<ThrowOnError extends boolean = false>(parameters: {
|
|
461
528
|
id: EmailDomainId;
|
|
@@ -518,9 +585,10 @@ export declare class Email {
|
|
|
518
585
|
/**
|
|
519
586
|
* Add a sender identity
|
|
520
587
|
*
|
|
521
|
-
*
|
|
588
|
+
* Durably creates a sender identity. The required Idempotency-Key replays the original sender for an identical request and conflicts when reused with different input.
|
|
522
589
|
*/
|
|
523
590
|
static addSender<ThrowOnError extends boolean = false>(parameters: {
|
|
591
|
+
"idempotency-key": string;
|
|
524
592
|
email: string;
|
|
525
593
|
domainId?: EmailDomainId | null | undefined;
|
|
526
594
|
name?: string | null | null | undefined;
|
|
@@ -537,11 +605,19 @@ export declare class Email {
|
|
|
537
605
|
/**
|
|
538
606
|
* Remove a sender identity
|
|
539
607
|
*
|
|
540
|
-
*
|
|
608
|
+
* Accepts sender removal, marks it inactive, and retains its deleting lifecycle until provider identity and association cleanup is confirmed.
|
|
541
609
|
*/
|
|
542
610
|
static removeSender<ThrowOnError extends boolean = false>(parameters: {
|
|
543
611
|
id: EmailSenderId;
|
|
544
612
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailRemoveSenderResponses, EmailRemoveSenderErrors, ThrowOnError>;
|
|
613
|
+
/**
|
|
614
|
+
* Get a sender identity
|
|
615
|
+
*
|
|
616
|
+
* Returns one sender identity owned by the authenticated organization. Other organizations' ids are reported as not found.
|
|
617
|
+
*/
|
|
618
|
+
static getSender<ThrowOnError extends boolean = false>(parameters: {
|
|
619
|
+
id: EmailSenderId;
|
|
620
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetSenderResponses, EmailGetSenderErrors, ThrowOnError>;
|
|
545
621
|
/**
|
|
546
622
|
* Set the organization default sender
|
|
547
623
|
*
|
|
@@ -760,6 +836,73 @@ export declare class Email {
|
|
|
760
836
|
limit?: string | null | undefined;
|
|
761
837
|
offset?: string | null | undefined;
|
|
762
838
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetForwardingLogResponses, EmailGetForwardingLogErrors, ThrowOnError>;
|
|
839
|
+
/**
|
|
840
|
+
* Get domain warming
|
|
841
|
+
*
|
|
842
|
+
* Returns the domain's automated warming policy, its system-created 24-hour windows and policy snapshots, the rolling bounce and complaint window the safety rule reads, every pause above the plan, and the decision history. A domain without a plan returns the evidence and a null plan.
|
|
843
|
+
*/
|
|
844
|
+
static getDomainWarming<ThrowOnError extends boolean = false>(parameters: {
|
|
845
|
+
id: EmailDomainId;
|
|
846
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetDomainWarmingResponses, EmailGetDomainWarmingErrors, ThrowOnError>;
|
|
847
|
+
/**
|
|
848
|
+
* Start domain warming
|
|
849
|
+
*
|
|
850
|
+
* Starts an automated warming policy on a verified sending domain. Samva opens the first 24-hour campaign window immediately, then opens later windows from the saved growth policy after safe windows close. Direct sends are counted in the domain's window but never delayed. Responds with 201.
|
|
851
|
+
*/
|
|
852
|
+
static createDomainWarmingPlan<ThrowOnError extends boolean = false>(parameters: {
|
|
853
|
+
id: EmailDomainId;
|
|
854
|
+
identity: "new" | "migrating" | "returning";
|
|
855
|
+
initialDailyRecipients: number;
|
|
856
|
+
dailyGrowthPercent: number;
|
|
857
|
+
targetDailyRecipients: number;
|
|
858
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCreateDomainWarmingPlanResponses, EmailCreateDomainWarmingPlanErrors, ThrowOnError>;
|
|
859
|
+
/**
|
|
860
|
+
* Update domain warming policy
|
|
861
|
+
*
|
|
862
|
+
* Updates the growth percentage and daily target Samva uses for future 24-hour warming windows. Existing windows keep their policy snapshot, including a scheduled window, so prior authorization remains auditable.
|
|
863
|
+
*/
|
|
864
|
+
static updateDomainWarmingPolicy<ThrowOnError extends boolean = false>(parameters: {
|
|
865
|
+
id: EmailDomainId;
|
|
866
|
+
dailyGrowthPercent: number;
|
|
867
|
+
targetDailyRecipients: number;
|
|
868
|
+
note?: string | null | undefined;
|
|
869
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailUpdateDomainWarmingPolicyResponses, EmailUpdateDomainWarmingPolicyErrors, ThrowOnError>;
|
|
870
|
+
/**
|
|
871
|
+
* Cancel a warming window
|
|
872
|
+
*
|
|
873
|
+
* Cancels a scheduled or open system-created warming window. Recipients a campaign run already reserved from it stay reserved; no further runs draw from it.
|
|
874
|
+
*/
|
|
875
|
+
static cancelDomainWarmingBatch<ThrowOnError extends boolean = false>(parameters: {
|
|
876
|
+
id: EmailDomainId;
|
|
877
|
+
batchId: EmailDomainWarmingBatchId;
|
|
878
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCancelDomainWarmingBatchResponses, EmailCancelDomainWarmingBatchErrors, ThrowOnError>;
|
|
879
|
+
/**
|
|
880
|
+
* Pause domain warming
|
|
881
|
+
*
|
|
882
|
+
* Pauses the plan. Campaign runs from the domain stop at their next page and queued campaign email waits until it expires; direct sends are unaffected.
|
|
883
|
+
*/
|
|
884
|
+
static pauseDomainWarming<ThrowOnError extends boolean = false>(parameters: {
|
|
885
|
+
id: EmailDomainId;
|
|
886
|
+
note?: string | null | undefined;
|
|
887
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailPauseDomainWarmingResponses, EmailPauseDomainWarmingErrors, ThrowOnError>;
|
|
888
|
+
/**
|
|
889
|
+
* Resume domain warming
|
|
890
|
+
*
|
|
891
|
+
* Resumes a paused or held plan and the campaign runs it was holding. A plan the domain rule held resumes only once the domain's rolling window is under both limits again; until then the request is refused with the observed rate.
|
|
892
|
+
*/
|
|
893
|
+
static resumeDomainWarming<ThrowOnError extends boolean = false>(parameters: {
|
|
894
|
+
id: EmailDomainId;
|
|
895
|
+
note?: string | null | undefined;
|
|
896
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailResumeDomainWarmingResponses, EmailResumeDomainWarmingErrors, ThrowOnError>;
|
|
897
|
+
/**
|
|
898
|
+
* Complete domain warming
|
|
899
|
+
*
|
|
900
|
+
* Ends the policy. Campaign runs from the domain are no longer gated by warming windows; the workspace safeguards still apply.
|
|
901
|
+
*/
|
|
902
|
+
static completeDomainWarming<ThrowOnError extends boolean = false>(parameters: {
|
|
903
|
+
id: EmailDomainId;
|
|
904
|
+
note?: string | null | undefined;
|
|
905
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailCompleteDomainWarmingResponses, EmailCompleteDomainWarmingErrors, ThrowOnError>;
|
|
763
906
|
}
|
|
764
907
|
export declare class Email2 {
|
|
765
908
|
static email: typeof Email;
|
|
@@ -774,7 +917,7 @@ export declare class Media {
|
|
|
774
917
|
filename: string;
|
|
775
918
|
contentType: string;
|
|
776
919
|
sizeBytes: number;
|
|
777
|
-
purpose: "attachment" | "avatar";
|
|
920
|
+
purpose: "attachment" | "avatar" | "review_evidence";
|
|
778
921
|
checksumSha256?: string | null | undefined;
|
|
779
922
|
}, options?: Options<never, ThrowOnError>): RequestResult<MediaCreateResponses, MediaCreateErrors, ThrowOnError>;
|
|
780
923
|
/**
|
|
@@ -1136,26 +1279,17 @@ export declare class Templates {
|
|
|
1136
1279
|
/**
|
|
1137
1280
|
* Create a template
|
|
1138
1281
|
*
|
|
1139
|
-
* Creates
|
|
1282
|
+
* Creates an email template project from Samva's canonical TSX starter and returns its template entry with status 201.
|
|
1140
1283
|
*/
|
|
1141
1284
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1142
1285
|
name: string;
|
|
1286
|
+
projectName?: string | null | undefined;
|
|
1143
1287
|
slug?: string | null | undefined;
|
|
1144
|
-
|
|
1288
|
+
galleryTemplateId?: string | null | undefined;
|
|
1145
1289
|
description?: string | null | null | undefined;
|
|
1146
1290
|
category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | null | undefined;
|
|
1147
|
-
source: string;
|
|
1148
|
-
subject?: string | null | undefined;
|
|
1149
|
-
headers?: {
|
|
1150
|
-
[key: string]: string;
|
|
1151
|
-
} | null | null | undefined;
|
|
1152
|
-
variableSchema?: Array<TemplateVariable> | null | null | undefined;
|
|
1153
|
-
compliance?: TemplateCompliance | null | null | undefined;
|
|
1154
|
-
performance?: TemplatePerformance | null | null | undefined;
|
|
1155
|
-
designOverrides?: Design3 | null | null | undefined;
|
|
1156
1291
|
isActive?: boolean | null | undefined;
|
|
1157
|
-
|
|
1158
|
-
version?: number | null | undefined;
|
|
1292
|
+
idempotencyKey: string;
|
|
1159
1293
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesCreateResponses, TemplatesCreateErrors, ThrowOnError>;
|
|
1160
1294
|
/**
|
|
1161
1295
|
* List templates for the dashboard
|
|
@@ -1242,15 +1376,6 @@ export declare class Templates {
|
|
|
1242
1376
|
familyId: TemplateFamilyId;
|
|
1243
1377
|
templateId: TemplateId;
|
|
1244
1378
|
}, 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
|
-
*/
|
|
1250
|
-
static addFamilyChannel<ThrowOnError extends boolean = false>(parameters: {
|
|
1251
|
-
familyId: TemplateFamilyId;
|
|
1252
|
-
channel: "email";
|
|
1253
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesAddFamilyChannelResponses, TemplatesAddFamilyChannelErrors, ThrowOnError>;
|
|
1254
1379
|
/**
|
|
1255
1380
|
* Delete a template
|
|
1256
1381
|
*
|
|
@@ -1262,7 +1387,7 @@ export declare class Templates {
|
|
|
1262
1387
|
/**
|
|
1263
1388
|
* Get a template
|
|
1264
1389
|
*
|
|
1265
|
-
* Returns template metadata and compiled channel content.
|
|
1390
|
+
* Returns template metadata, its project entry path, and compiled channel content. Open live project files through the workspace API.
|
|
1266
1391
|
*/
|
|
1267
1392
|
static getById<ThrowOnError extends boolean = false>(parameters: {
|
|
1268
1393
|
id: TemplateId;
|
|
@@ -1270,221 +1395,216 @@ export declare class Templates {
|
|
|
1270
1395
|
/**
|
|
1271
1396
|
* Update a template
|
|
1272
1397
|
*
|
|
1273
|
-
* Updates template metadata. Source changes use the
|
|
1398
|
+
* Updates template metadata. Source changes use the project workspace API.
|
|
1274
1399
|
*/
|
|
1275
1400
|
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
1276
1401
|
id: TemplateId;
|
|
1277
1402
|
data: {
|
|
1278
1403
|
name?: string | null | undefined;
|
|
1279
1404
|
slug?: string | null | undefined;
|
|
1280
|
-
origin?: "dashboard" | "tsx" | null | undefined;
|
|
1281
1405
|
description?: string | null | null | undefined;
|
|
1282
1406
|
category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | null | undefined;
|
|
1283
1407
|
fromDefault?: TemplateFromDefault | null | null | undefined;
|
|
1284
1408
|
replyToDefault?: Array<string> | null | null | undefined;
|
|
1285
|
-
variableSchema?: Array<TemplateVariable> | null | null | undefined;
|
|
1286
|
-
compliance?: TemplateCompliance | null | null | undefined;
|
|
1287
|
-
performance?: TemplatePerformance | null | null | undefined;
|
|
1288
|
-
designOverrides?: Design3 | null | null | undefined;
|
|
1289
1409
|
isActive?: boolean | null | undefined;
|
|
1290
|
-
isDefault?: boolean | null | undefined;
|
|
1291
|
-
version?: number | null | undefined;
|
|
1292
1410
|
};
|
|
1293
1411
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesUpdateResponses, TemplatesUpdateErrors, ThrowOnError>;
|
|
1294
1412
|
/**
|
|
1295
|
-
*
|
|
1413
|
+
* Patch template project files
|
|
1296
1414
|
*
|
|
1297
|
-
*
|
|
1415
|
+
* Applies revision-checked file patches to the shared project workspace overlay.
|
|
1298
1416
|
*/
|
|
1299
|
-
static
|
|
1417
|
+
static patchWorkspace<ThrowOnError extends boolean = false>(parameters: {
|
|
1300
1418
|
id: TemplateId;
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
}
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
}
|
|
1309
|
-
export declare class TemplateDocuments {
|
|
1419
|
+
expectedRevision: string;
|
|
1420
|
+
patches: Array<{
|
|
1421
|
+
path: string;
|
|
1422
|
+
content: string | null;
|
|
1423
|
+
}>;
|
|
1424
|
+
idempotencyKey: string;
|
|
1425
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesPatchWorkspaceResponses, TemplatesPatchWorkspaceErrors, ThrowOnError>;
|
|
1310
1426
|
/**
|
|
1311
|
-
*
|
|
1427
|
+
* Open a template project workspace
|
|
1312
1428
|
*
|
|
1313
|
-
* Creates or
|
|
1429
|
+
* Creates or opens the shared project workspace at the current Artifact branch head and returns its effective files.
|
|
1314
1430
|
*/
|
|
1315
|
-
static
|
|
1316
|
-
|
|
1317
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
1431
|
+
static openWorkspace<ThrowOnError extends boolean = false>(parameters: {
|
|
1432
|
+
id: TemplateId;
|
|
1433
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesOpenWorkspaceResponses, TemplatesOpenWorkspaceErrors, ThrowOnError>;
|
|
1318
1434
|
/**
|
|
1319
|
-
*
|
|
1435
|
+
* Diff a template project workspace
|
|
1320
1436
|
*
|
|
1321
|
-
* Returns
|
|
1437
|
+
* Returns exact added, modified, and deleted project files against the current Git base commit.
|
|
1322
1438
|
*/
|
|
1323
|
-
static
|
|
1324
|
-
|
|
1325
|
-
|
|
1439
|
+
static diffWorkspace<ThrowOnError extends boolean = false>(parameters: {
|
|
1440
|
+
id: TemplateId;
|
|
1441
|
+
expectedRevision: string;
|
|
1442
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesDiffWorkspaceResponses, TemplatesDiffWorkspaceErrors, ThrowOnError>;
|
|
1326
1443
|
/**
|
|
1327
|
-
*
|
|
1444
|
+
* Reconcile a template project workspace
|
|
1328
1445
|
*
|
|
1329
|
-
*
|
|
1446
|
+
* Fast-forwards or rebases the workspace onto the current Artifact branch head, retaining file conflicts for explicit resolution.
|
|
1330
1447
|
*/
|
|
1331
|
-
static
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
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>;
|
|
1448
|
+
static reconcileWorkspace<ThrowOnError extends boolean = false>(parameters: {
|
|
1449
|
+
id: TemplateId;
|
|
1450
|
+
expectedRevision: string;
|
|
1451
|
+
assetResolution?: "draft" | "remote" | undefined;
|
|
1452
|
+
expectedRemoteHead?: string | undefined;
|
|
1453
|
+
idempotencyKey: string;
|
|
1454
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesReconcileWorkspaceResponses, TemplatesReconcileWorkspaceErrors, ThrowOnError>;
|
|
1351
1455
|
/**
|
|
1352
|
-
*
|
|
1456
|
+
* Resolve a template workspace conflict
|
|
1353
1457
|
*
|
|
1354
|
-
*
|
|
1458
|
+
* Resolves one conflicted file by keeping the draft, using main, or supplying edited source.
|
|
1355
1459
|
*/
|
|
1356
|
-
static
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
|
|
1460
|
+
static resolveWorkspaceConflict<ThrowOnError extends boolean = false>(parameters: {
|
|
1461
|
+
id: TemplateId;
|
|
1462
|
+
expectedRevision: string;
|
|
1463
|
+
path: string;
|
|
1464
|
+
resolution: "draft" | "main" | {
|
|
1465
|
+
content: string | null;
|
|
1466
|
+
};
|
|
1467
|
+
idempotencyKey: string;
|
|
1468
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesResolveWorkspaceConflictResponses, TemplatesResolveWorkspaceConflictErrors, ThrowOnError>;
|
|
1360
1469
|
/**
|
|
1361
|
-
*
|
|
1470
|
+
* Save a template project workspace
|
|
1362
1471
|
*
|
|
1363
|
-
*
|
|
1472
|
+
* Validates the effective project tree and creates one normal Git commit on the Artifact default branch.
|
|
1364
1473
|
*/
|
|
1365
|
-
static
|
|
1366
|
-
|
|
1474
|
+
static saveWorkspace<ThrowOnError extends boolean = false>(parameters: {
|
|
1475
|
+
id: TemplateId;
|
|
1367
1476
|
expectedRevision: string;
|
|
1368
|
-
|
|
1477
|
+
expectedHead: string;
|
|
1478
|
+
message: string;
|
|
1369
1479
|
idempotencyKey: string;
|
|
1370
|
-
|
|
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>;
|
|
1480
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesSaveWorkspaceResponses, TemplatesSaveWorkspaceErrors, ThrowOnError>;
|
|
1378
1481
|
/**
|
|
1379
|
-
*
|
|
1482
|
+
* Stage a historical template project tree
|
|
1380
1483
|
*
|
|
1381
|
-
*
|
|
1484
|
+
* Builds the template entry before atomically staging a reachable historical commit and its emitted source; a later Save appends a new commit without rewriting branch history.
|
|
1382
1485
|
*/
|
|
1383
|
-
static
|
|
1384
|
-
|
|
1486
|
+
static restoreWorkspace<ThrowOnError extends boolean = false>(parameters: {
|
|
1487
|
+
id: TemplateId;
|
|
1385
1488
|
expectedRevision: string;
|
|
1386
|
-
|
|
1387
|
-
|
|
1489
|
+
commit: string;
|
|
1490
|
+
idempotencyKey: string;
|
|
1491
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesRestoreWorkspaceResponses, TemplatesRestoreWorkspaceErrors, ThrowOnError>;
|
|
1388
1492
|
/**
|
|
1389
|
-
*
|
|
1493
|
+
* List template project commit history
|
|
1390
1494
|
*
|
|
1391
|
-
*
|
|
1495
|
+
* Returns bounded history from the Artifact repository default branch.
|
|
1392
1496
|
*/
|
|
1393
|
-
static
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
1497
|
+
static workspaceHistory<ThrowOnError extends boolean = false>(parameters: {
|
|
1498
|
+
id: TemplateId;
|
|
1499
|
+
limit?: string | null | undefined;
|
|
1500
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesWorkspaceHistoryResponses, TemplatesWorkspaceHistoryErrors, ThrowOnError>;
|
|
1397
1501
|
/**
|
|
1398
|
-
*
|
|
1502
|
+
* Check a template project workspace
|
|
1399
1503
|
*
|
|
1400
|
-
*
|
|
1504
|
+
* Builds the template entry from the current effective workspace tree, including unsaved file patches, and returns what the template declares plus every compile and target-client finding. Nothing is written and no message is rendered.
|
|
1401
1505
|
*/
|
|
1402
|
-
static
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
[key: string]: JsonValue;
|
|
1407
|
-
} | null | undefined;
|
|
1408
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsRenderResponses, TemplateDocumentsRenderErrors, ThrowOnError>;
|
|
1506
|
+
static checkWorkspace<ThrowOnError extends boolean = false>(parameters: {
|
|
1507
|
+
id: TemplateId;
|
|
1508
|
+
expectedRevision: string;
|
|
1509
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesCheckWorkspaceResponses, TemplatesCheckWorkspaceErrors, ThrowOnError>;
|
|
1409
1510
|
/**
|
|
1410
|
-
*
|
|
1511
|
+
* Render a declared template workspace fixture
|
|
1411
1512
|
*
|
|
1412
|
-
* Renders
|
|
1513
|
+
* Renders one of the named inputs the template declares against the current effective workspace tree. Only declared fixtures render here; arbitrary input renders against a publication.
|
|
1413
1514
|
*/
|
|
1414
|
-
static
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
} | null | undefined;
|
|
1420
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsSpamCheckResponses, TemplateDocumentsSpamCheckErrors, ThrowOnError>;
|
|
1515
|
+
static renderWorkspaceFixture<ThrowOnError extends boolean = false>(parameters: {
|
|
1516
|
+
id: TemplateId;
|
|
1517
|
+
expectedRevision: string;
|
|
1518
|
+
fixture: string;
|
|
1519
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesRenderWorkspaceFixtureResponses, TemplatesRenderWorkspaceFixtureErrors, ThrowOnError>;
|
|
1421
1520
|
/**
|
|
1422
|
-
*
|
|
1521
|
+
* Publish an exact template commit
|
|
1423
1522
|
*
|
|
1424
|
-
*
|
|
1523
|
+
* Builds an exact Git commit and entry path, stores the immutable executable and its assets, records the input contract it validates against, and makes that publication current.
|
|
1425
1524
|
*/
|
|
1426
|
-
static
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsTestSendResponses, TemplateDocumentsTestSendErrors, ThrowOnError>;
|
|
1525
|
+
static publish<ThrowOnError extends boolean = false>(parameters: {
|
|
1526
|
+
id: TemplateId;
|
|
1527
|
+
projectId: TemplateProjectId;
|
|
1528
|
+
commitSha: string;
|
|
1529
|
+
entryPath: string;
|
|
1530
|
+
expectedWorkspaceRevision: string;
|
|
1531
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesPublishResponses, TemplatesPublishErrors, ThrowOnError>;
|
|
1434
1532
|
/**
|
|
1435
|
-
*
|
|
1533
|
+
* Get a template publication
|
|
1436
1534
|
*
|
|
1437
|
-
*
|
|
1535
|
+
* Returns one immutable publication and its exact build receipt.
|
|
1438
1536
|
*/
|
|
1439
|
-
static
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
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>;
|
|
1537
|
+
static getPublication<ThrowOnError extends boolean = false>(parameters: {
|
|
1538
|
+
id: TemplateId;
|
|
1539
|
+
publicationId: TemplatePublicationId;
|
|
1540
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesGetPublicationResponses, TemplatesGetPublicationErrors, ThrowOnError>;
|
|
1451
1541
|
/**
|
|
1452
|
-
* List template
|
|
1542
|
+
* List a template's input contracts
|
|
1453
1543
|
*
|
|
1454
|
-
* Returns
|
|
1544
|
+
* Returns every immutable input contract this template has published under, newest version first. Send against a contract to follow later publications that validate input identically.
|
|
1455
1545
|
*/
|
|
1456
|
-
static
|
|
1457
|
-
|
|
1458
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
1546
|
+
static listInputContracts<ThrowOnError extends boolean = false>(parameters: {
|
|
1547
|
+
id: TemplateId;
|
|
1548
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesListInputContractsResponses, TemplatesListInputContractsErrors, ThrowOnError>;
|
|
1459
1549
|
/**
|
|
1460
|
-
*
|
|
1550
|
+
* Get a template input contract
|
|
1461
1551
|
*
|
|
1462
|
-
*
|
|
1552
|
+
* Returns one immutable input contract and the published schema it validates against.
|
|
1463
1553
|
*/
|
|
1464
|
-
static
|
|
1465
|
-
|
|
1466
|
-
|
|
1554
|
+
static getInputContract<ThrowOnError extends boolean = false>(parameters: {
|
|
1555
|
+
id: TemplateId;
|
|
1556
|
+
inputContractId: TemplateInputContractId;
|
|
1557
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesGetInputContractResponses, TemplatesGetInputContractErrors, ThrowOnError>;
|
|
1467
1558
|
/**
|
|
1468
|
-
*
|
|
1559
|
+
* Get a template project Git repository
|
|
1469
1560
|
*
|
|
1470
|
-
*
|
|
1561
|
+
* Returns the credential-free HTTPS remote and default branch for the template project repository.
|
|
1471
1562
|
*/
|
|
1472
|
-
static
|
|
1473
|
-
|
|
1474
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
1563
|
+
static getGitRepository<ThrowOnError extends boolean = false>(parameters: {
|
|
1564
|
+
id: TemplateId;
|
|
1565
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesGetGitRepositoryResponses, TemplatesGetGitRepositoryErrors, ThrowOnError>;
|
|
1475
1566
|
/**
|
|
1476
|
-
*
|
|
1567
|
+
* Issue a template project Git credential
|
|
1477
1568
|
*
|
|
1478
|
-
*
|
|
1569
|
+
* Exchanges the caller's Samva authorization for a one-hour, repository-scoped Artifact Git credential.
|
|
1479
1570
|
*/
|
|
1480
|
-
static
|
|
1481
|
-
|
|
1482
|
-
|
|
1571
|
+
static issueGitCredential<ThrowOnError extends boolean = false>(parameters: {
|
|
1572
|
+
id: TemplateId;
|
|
1573
|
+
scope: "read" | "write";
|
|
1574
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesIssueGitCredentialResponses, TemplatesIssueGitCredentialErrors, ThrowOnError>;
|
|
1575
|
+
/**
|
|
1576
|
+
* Attach a template workspace resource
|
|
1577
|
+
*
|
|
1578
|
+
* Adds or replaces one bounded persistent read-only resource and advances the workspace revision.
|
|
1579
|
+
*/
|
|
1580
|
+
static attachWorkspaceResource<ThrowOnError extends boolean = false>(parameters: {
|
|
1581
|
+
id: TemplateId;
|
|
1582
|
+
expectedRevision: string;
|
|
1583
|
+
resource: {
|
|
1584
|
+
resourceId: string;
|
|
1585
|
+
name: string;
|
|
1586
|
+
files: Array<{
|
|
1587
|
+
path: string;
|
|
1588
|
+
mediaType: string;
|
|
1589
|
+
contentBase64: string;
|
|
1590
|
+
}>;
|
|
1591
|
+
};
|
|
1592
|
+
idempotencyKey: string;
|
|
1593
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesAttachWorkspaceResourceResponses, TemplatesAttachWorkspaceResourceErrors, ThrowOnError>;
|
|
1594
|
+
/**
|
|
1595
|
+
* Remove a template workspace resource
|
|
1596
|
+
*
|
|
1597
|
+
* Removes one persistent resource from mounted context and advances the workspace revision.
|
|
1598
|
+
*/
|
|
1599
|
+
static removeWorkspaceResource<ThrowOnError extends boolean = false>(parameters: {
|
|
1600
|
+
id: TemplateId;
|
|
1601
|
+
resourceId: string;
|
|
1483
1602
|
expectedRevision: string;
|
|
1484
|
-
|
|
1603
|
+
idempotencyKey: string;
|
|
1604
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesRemoveWorkspaceResourceResponses, TemplatesRemoveWorkspaceResourceErrors, ThrowOnError>;
|
|
1485
1605
|
}
|
|
1486
|
-
export declare class
|
|
1487
|
-
static
|
|
1606
|
+
export declare class Templates2 {
|
|
1607
|
+
static templates: typeof Templates;
|
|
1488
1608
|
}
|
|
1489
1609
|
export declare class Design {
|
|
1490
1610
|
/**
|
|
@@ -1509,22 +1629,23 @@ export declare class Webhooks {
|
|
|
1509
1629
|
/**
|
|
1510
1630
|
* List webhooks
|
|
1511
1631
|
*
|
|
1512
|
-
* Returns a paginated list of the organization's webhook endpoints, optionally filtered by
|
|
1632
|
+
* Returns a paginated list of the organization's webhook endpoints with each endpoint's delivery counts, optionally filtered by name search and status.
|
|
1513
1633
|
*/
|
|
1514
1634
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1515
1635
|
page?: string | null | undefined;
|
|
1516
1636
|
limit?: string | null | undefined;
|
|
1517
1637
|
search?: string | null | undefined;
|
|
1638
|
+
status?: "active" | "disabled" | null | undefined;
|
|
1518
1639
|
}, options?: Options<never, ThrowOnError>): RequestResult<WebhooksListResponses, WebhooksListErrors, ThrowOnError>;
|
|
1519
1640
|
/**
|
|
1520
1641
|
* Create a webhook
|
|
1521
1642
|
*
|
|
1522
|
-
* Creates a webhook endpoint
|
|
1643
|
+
* Creates a signed webhook endpoint for Samva delivery and inbound events, stores subscriptions, and returns the endpoint and signing secret with a 201 response.
|
|
1523
1644
|
*/
|
|
1524
1645
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1525
1646
|
name: string;
|
|
1526
1647
|
url: string;
|
|
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">;
|
|
1648
|
+
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" | "domain.warming.updated">;
|
|
1528
1649
|
channels?: Array<"email"> | null | undefined;
|
|
1529
1650
|
headers?: {
|
|
1530
1651
|
[key: string]: string;
|
|
@@ -1556,7 +1677,7 @@ export declare class Webhooks {
|
|
|
1556
1677
|
id: WebhookEndpointId;
|
|
1557
1678
|
name?: string | null | undefined;
|
|
1558
1679
|
url?: string | null | undefined;
|
|
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;
|
|
1680
|
+
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" | "domain.warming.updated"> | null | undefined;
|
|
1560
1681
|
channels?: Array<"email"> | null | null | undefined;
|
|
1561
1682
|
headers?: {
|
|
1562
1683
|
[key: string]: string;
|
|
@@ -1577,7 +1698,7 @@ export declare class Webhooks {
|
|
|
1577
1698
|
/**
|
|
1578
1699
|
* List webhook delivery logs
|
|
1579
1700
|
*
|
|
1580
|
-
* Returns recent deliveries and
|
|
1701
|
+
* Returns recent deliveries for a webhook endpoint, each naming the event type and time it was made for, with its nested attempt diagnostics.
|
|
1581
1702
|
*/
|
|
1582
1703
|
static getLogs<ThrowOnError extends boolean = false>(parameters: {
|
|
1583
1704
|
webhookId: WebhookEndpointId;
|
|
@@ -1586,10 +1707,11 @@ export declare class Webhooks {
|
|
|
1586
1707
|
/**
|
|
1587
1708
|
* Get webhook delivery statistics
|
|
1588
1709
|
*
|
|
1589
|
-
* Returns aggregate pending, delivered, exhausted, and cancelled delivery counts for a webhook endpoint.
|
|
1710
|
+
* Returns aggregate pending, delivered, exhausted, and cancelled delivery counts for a webhook endpoint, plus the same counts per workspace-local calendar day over the selected period of 7, 30, or 90 days. Deliveries are retained for 90 days, so 90d is the whole history.
|
|
1590
1711
|
*/
|
|
1591
1712
|
static getStats<ThrowOnError extends boolean = false>(parameters: {
|
|
1592
1713
|
webhookId: WebhookEndpointId;
|
|
1714
|
+
period?: "7d" | "30d" | "90d" | null | undefined;
|
|
1593
1715
|
}, options?: Options<never, ThrowOnError>): RequestResult<WebhooksGetStatsResponses, WebhooksGetStatsErrors, ThrowOnError>;
|
|
1594
1716
|
/**
|
|
1595
1717
|
* Retry a webhook delivery
|
|
@@ -1638,7 +1760,7 @@ export declare class Organizations {
|
|
|
1638
1760
|
billingEmail?: string | null | undefined;
|
|
1639
1761
|
countryCode?: string | null | undefined;
|
|
1640
1762
|
currency?: string | null | undefined;
|
|
1641
|
-
timezone?:
|
|
1763
|
+
timezone?: IanaTimezone | null | undefined;
|
|
1642
1764
|
isActive?: boolean | null | undefined;
|
|
1643
1765
|
metadata?: {
|
|
1644
1766
|
[key: string]: JsonValue;
|
|
@@ -1659,7 +1781,7 @@ export declare class Organizations {
|
|
|
1659
1781
|
/**
|
|
1660
1782
|
* Delete the current workspace
|
|
1661
1783
|
*
|
|
1662
|
-
*
|
|
1784
|
+
* Starts an owner-authorized durable workspace deletion operation, confirming the workspace name in the request. Repeating the same request with the same Idempotency-Key returns the existing organization-scoped operation.
|
|
1663
1785
|
*/
|
|
1664
1786
|
static delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1665
1787
|
"idempotency-key": string;
|