samva 0.2.0 → 0.4.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.
Files changed (51) hide show
  1. package/AGENTS.md +1 -1
  2. package/README.md +14 -3
  3. package/dist/client/sdk.gen.d.ts +321 -129
  4. package/dist/client/types.gen.d.ts +1818 -777
  5. package/dist/{client-BqkU-sFv.js → client-BmZK_uCt.js} +2699 -1839
  6. package/dist/client-attribution-BslSOa_8.js +9 -0
  7. package/dist/client-attribution.d.ts +2 -0
  8. package/dist/effect/api-keys.d.ts +51 -51
  9. package/dist/effect/api-keys.js +1 -1
  10. package/dist/effect/campaigns.d.ts +320 -1005
  11. package/dist/effect/campaigns.js +1 -1
  12. package/dist/effect/categories.d.ts +6 -6
  13. package/dist/effect/client.js +1 -1
  14. package/dist/effect/contacts.d.ts +292 -314
  15. package/dist/effect/contacts.js +1 -1
  16. package/dist/effect/conversations.d.ts +305 -437
  17. package/dist/effect/conversations.js +1 -1
  18. package/dist/effect/design.d.ts +74 -74
  19. package/dist/effect/design.js +1 -1
  20. package/dist/effect/email.d.ts +233 -265
  21. package/dist/effect/email.js +2 -2
  22. package/dist/effect/generated.d.ts +13410 -14526
  23. package/dist/effect/index.d.ts +1 -0
  24. package/dist/effect/index.js +3 -2
  25. package/dist/effect/internal/client.d.ts +1 -1
  26. package/dist/effect/internal/operation.d.ts +32 -129
  27. package/dist/effect/media.d.ts +80 -0
  28. package/dist/effect/media.js +19 -0
  29. package/dist/effect/messages.d.ts +90 -307
  30. package/dist/effect/messages.js +1 -1
  31. package/dist/effect/operations.d.ts +17 -17
  32. package/dist/effect/operations.js +1 -1
  33. package/dist/effect/organizations.d.ts +162 -180
  34. package/dist/effect/organizations.js +1 -1
  35. package/dist/effect/runtime.d.ts +0 -2
  36. package/dist/effect/scheduled-messages.d.ts +242 -639
  37. package/dist/effect/scheduled-messages.js +1 -1
  38. package/dist/effect/templates.d.ts +1376 -2033
  39. package/dist/effect/templates.js +40 -30
  40. package/dist/effect/webhooks.d.ts +53 -54
  41. package/dist/effect/webhooks.js +2 -2
  42. package/dist/index.js +1 -1
  43. package/dist/{normalize-LkWl4HUF.js → normalize-BiIJnycv.js} +6 -15
  44. package/dist/normalize.d.ts +3 -33
  45. package/dist/{operation-Ccqh_yxb.js → operation-B1knNlxk.js} +83 -38
  46. package/dist/promises/index.d.ts +13 -21
  47. package/dist/promises/index.js +1 -1
  48. package/dist/promises/types.gen.d.ts +1 -1
  49. package/dist/{promises-Dgv8UmCC.js → promises-n1opem5V.js} +572 -184
  50. package/dist/service-map.d.ts +96 -44
  51. package/package.json +23 -19
@@ -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, 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";
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, 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, 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 across all channels, with optional filters for channel, status, conversation, contact, and date range.
20
+ * Returns a paginated list of messages across all channels, 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
- channel?: "sms" | "whatsapp" | "email" | null | undefined;
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;
@@ -32,11 +33,11 @@ export declare class Messages {
32
33
  /**
33
34
  * Send a message
34
35
  *
35
- * Sends a message on the requested channel and returns the created message with a 201 Created status. `channel` selects the payload variant. Email sends today; the SMS and WhatsApp variants are coming soon and answer 403 until the channel launches for your organization, so integrating against them now costs no rewrite later. Repeating an identical request with the same optional `Idempotency-Key` header returns the original message; reusing the key for different content returns a conflict.
36
+ * Sends a message on the requested channel and returns the created message with a 201 Created status. `channel` selects the payload variant. Repeating an identical request with the same optional `Idempotency-Key` header returns the original message; reusing the key for different content returns a conflict.
36
37
  */
37
38
  static send<ThrowOnError extends boolean = false>(parameters: {
38
39
  "idempotency-key"?: string | null | undefined;
39
- body: EmailSendMessagePayload | SmsSendMessagePayload | WhatsAppSendMessagePayload;
40
+ emailSendMessagePayload: EmailSendMessagePayload;
40
41
  }, options?: Options<never, ThrowOnError>): RequestResult<MessagesSendResponses, MessagesSendErrors, ThrowOnError>;
41
42
  /**
42
43
  * Delete a message
@@ -57,7 +58,7 @@ export declare class Messages {
57
58
  /**
58
59
  * Get email message details
59
60
  *
60
- * Returns the email projection of a message, optionally including signed S3 URLs for its raw MIME, HTML, and text content.
61
+ * Returns email delivery details for a message, optionally including signed URLs for its raw MIME, HTML, and text content.
61
62
  */
62
63
  static getEmail<ThrowOnError extends boolean = false>(parameters: {
63
64
  id: MessageId;
@@ -130,7 +131,7 @@ export declare class ScheduledMessages {
130
131
  /**
131
132
  * Schedule a message
132
133
  *
133
- * Schedules a message at the absolute ISO-8601 instant in scheduledFor. The send payload is the same channel union the immediate send accepts, with each channel's content checked at schedule time so a send that could never render fails now rather than hours later: email schedules today, and the SMS and WhatsApp variants are coming soon and answer 403 until the channel launches. Optional timezone is validated IANA display metadata only and never changes the execution instant.
134
+ * 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
135
  */
135
136
  static create<ThrowOnError extends boolean = false>(parameters: {
136
137
  send: DispatchSendMessagePayload;
@@ -177,7 +178,7 @@ export declare class Campaigns {
177
178
  */
178
179
  static create<ThrowOnError extends boolean = false>(parameters: {
179
180
  name: string;
180
- channel: "sms" | "whatsapp" | "email";
181
+ channel: "email";
181
182
  content: CampaignContentInput;
182
183
  audience: CampaignAudience;
183
184
  policy?: CampaignPolicy | null | undefined;
@@ -287,7 +288,7 @@ export declare class Email {
287
288
  /**
288
289
  * Get email tracking defaults
289
290
  *
290
- * Returns the organization's default open and click tracking policy. Each field is independent and defaults to enabled. Recipient opt-out takes precedence over these defaults.
291
+ * 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
292
  */
292
293
  static getTrackingDefaults<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<EmailGetTrackingDefaultsResponses, EmailGetTrackingDefaultsErrors, ThrowOnError>;
293
294
  /**
@@ -328,10 +329,14 @@ export declare class Email {
328
329
  /**
329
330
  * Add a sending domain
330
331
  *
331
- * Registers a domain for sending and returns it with the DNS records required to verify ownership and configure DKIM. Responds with 201.
332
+ * 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
333
  */
333
334
  static addDomain<ThrowOnError extends boolean = false>(parameters: {
334
335
  domain: string;
336
+ connection?: {
337
+ connectionId: string;
338
+ zone: string;
339
+ } | null | undefined;
335
340
  }, options?: Options<never, ThrowOnError>): RequestResult<EmailAddDomainResponses, EmailAddDomainErrors, ThrowOnError>;
336
341
  /**
337
342
  * Get domain verification
@@ -455,7 +460,7 @@ export declare class Email {
455
460
  /**
456
461
  * Disable a custom tracking domain
457
462
  *
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.
463
+ * 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
464
  */
460
465
  static disableCustomTracking<ThrowOnError extends boolean = false>(parameters: {
461
466
  id: EmailDomainId;
@@ -518,9 +523,10 @@ export declare class Email {
518
523
  /**
519
524
  * Add a sender identity
520
525
  *
521
- * Creates a sender identity for an email address and returns it. Responds with 201.
526
+ * 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
527
  */
523
528
  static addSender<ThrowOnError extends boolean = false>(parameters: {
529
+ "idempotency-key": string;
524
530
  email: string;
525
531
  domainId?: EmailDomainId | null | undefined;
526
532
  name?: string | null | null | undefined;
@@ -537,7 +543,7 @@ export declare class Email {
537
543
  /**
538
544
  * Remove a sender identity
539
545
  *
540
- * Permanently deletes a sender identity from the organization.
546
+ * Accepts sender removal, marks it inactive, and retains its deleting lifecycle until provider identity and association cleanup is confirmed.
541
547
  */
542
548
  static removeSender<ThrowOnError extends boolean = false>(parameters: {
543
549
  id: EmailSenderId;
@@ -764,6 +770,55 @@ export declare class Email {
764
770
  export declare class Email2 {
765
771
  static email: typeof Email;
766
772
  }
773
+ export declare class Media {
774
+ /**
775
+ * Create a media object
776
+ *
777
+ * Creates the media object in the pending state and returns it with the upload instruction — URL, method, and headers — for putting its bytes into storage.
778
+ */
779
+ static create<ThrowOnError extends boolean = false>(parameters: {
780
+ filename: string;
781
+ contentType: string;
782
+ sizeBytes: number;
783
+ purpose: "attachment" | "avatar";
784
+ checksumSha256?: string | null | undefined;
785
+ }, options?: Options<never, ThrowOnError>): RequestResult<MediaCreateResponses, MediaCreateErrors, ThrowOnError>;
786
+ /**
787
+ * Complete a media upload
788
+ *
789
+ * Verifies the uploaded object exists in storage, marks the media object ready, and returns it with a download URL.
790
+ */
791
+ static complete<ThrowOnError extends boolean = false>(parameters: {
792
+ mediaId: MediaId;
793
+ }, options?: Options<never, ThrowOnError>): RequestResult<MediaCompleteResponses, MediaCompleteErrors, ThrowOnError>;
794
+ /**
795
+ * Delete a media object
796
+ *
797
+ * Deletes a pending media object and the bytes stored for it. Fails if the media object is already ready.
798
+ */
799
+ static remove<ThrowOnError extends boolean = false>(parameters: {
800
+ mediaId: MediaId;
801
+ }, options?: Options<never, ThrowOnError>): RequestResult<MediaRemoveResponses, MediaRemoveErrors, ThrowOnError>;
802
+ /**
803
+ * Get a media object
804
+ *
805
+ * Returns the media object's metadata, including status, dimensions, and confirmation timestamps.
806
+ */
807
+ static getById<ThrowOnError extends boolean = false>(parameters: {
808
+ mediaId: MediaId;
809
+ }, options?: Options<never, ThrowOnError>): RequestResult<MediaGetByIdResponses, MediaGetByIdErrors, ThrowOnError>;
810
+ /**
811
+ * Get a media download URL
812
+ *
813
+ * Generates a presigned, time-limited download URL for a ready media object.
814
+ */
815
+ static downloadUrl<ThrowOnError extends boolean = false>(parameters: {
816
+ mediaId: MediaId;
817
+ }, options?: Options<never, ThrowOnError>): RequestResult<MediaDownloadUrlResponses, MediaDownloadUrlErrors, ThrowOnError>;
818
+ }
819
+ export declare class Media2 {
820
+ static media: typeof Media;
821
+ }
767
822
  export declare class Conversations {
768
823
  /**
769
824
  * List conversations
@@ -774,7 +829,7 @@ export declare class Conversations {
774
829
  page?: string | null | undefined;
775
830
  limit?: string | null | undefined;
776
831
  status?: "active" | "waiting" | "resolved" | "escalated" | "archived" | null | undefined;
777
- channel?: "sms" | "whatsapp" | "email" | null | undefined;
832
+ channel?: "email" | null | undefined;
778
833
  contactId?: ContactId | null | undefined;
779
834
  startDate?: string | null | undefined;
780
835
  endDate?: string | null | undefined;
@@ -789,8 +844,8 @@ export declare class Conversations {
789
844
  description?: string | null | undefined;
790
845
  externalId?: string | null | undefined;
791
846
  parentConversationId?: ConversationId | null | undefined;
792
- channels: Array<"sms" | "whatsapp" | "email">;
793
- primaryChannel: "sms" | "whatsapp" | "email";
847
+ channels: Array<"email">;
848
+ primaryChannel: "email";
794
849
  status?: "active" | "waiting" | "resolved" | "escalated" | "archived" | null | undefined;
795
850
  statusReason?: string | null | undefined;
796
851
  priority?: number | null | undefined;
@@ -825,7 +880,7 @@ export declare class Conversations {
825
880
  description?: string | null | null | undefined;
826
881
  externalId?: string | null | null | undefined;
827
882
  parentConversationId?: ConversationId | null | null | undefined;
828
- primaryChannel?: "sms" | "whatsapp" | "email" | null | undefined;
883
+ primaryChannel?: "email" | null | undefined;
829
884
  status?: "active" | "waiting" | "resolved" | "escalated" | "archived" | null | undefined;
830
885
  statusReason?: string | null | null | undefined;
831
886
  priority?: number | null | undefined;
@@ -835,7 +890,7 @@ export declare class Conversations {
835
890
  metadata?: ConversationMetadata | null | null | undefined;
836
891
  metrics?: ConversationMetrics | null | undefined;
837
892
  actorTracking?: ActorTracking | null | undefined;
838
- channels?: Array<"sms" | "whatsapp" | "email"> | null | undefined;
893
+ channels?: Array<"email"> | null | undefined;
839
894
  tags?: Array<string> | null | undefined;
840
895
  categories?: Array<string> | null | undefined;
841
896
  isTest?: boolean | null | undefined;
@@ -916,12 +971,11 @@ export declare class Contacts {
916
971
  /**
917
972
  * Find a contact
918
973
  *
919
- * Looks up a single contact by email, phone, WhatsApp, or external ID, returning null when no contact matches.
974
+ * Samva API operation.
920
975
  */
921
976
  static find<ThrowOnError extends boolean = false>(parameters?: {
922
977
  email?: string | null | undefined;
923
978
  phone?: string | null | undefined;
924
- whatsapp?: string | null | undefined;
925
979
  externalId?: string | null | undefined;
926
980
  }, options?: Options<never, ThrowOnError>): RequestResult<ContactsFindResponses, ContactsFindErrors, ThrowOnError>;
927
981
  /**
@@ -932,7 +986,6 @@ export declare class Contacts {
932
986
  static findOrCreate<ThrowOnError extends boolean = false>(parameters?: {
933
987
  email?: string | null | undefined;
934
988
  phone?: string | null | undefined;
935
- whatsapp?: string | null | undefined;
936
989
  externalId?: string | null | undefined;
937
990
  name?: string | null | undefined;
938
991
  displayName?: string | null | null | undefined;
@@ -1056,7 +1109,7 @@ export declare class Contacts {
1056
1109
  id: ContactId;
1057
1110
  page?: string | null | undefined;
1058
1111
  limit?: string | null | undefined;
1059
- channel?: "sms" | "whatsapp" | "email" | null | undefined;
1112
+ channel?: "email" | null | undefined;
1060
1113
  }, options?: Options<never, ThrowOnError>): RequestResult<ContactsGetActivityTimelineResponses, ContactsGetActivityTimelineErrors, ThrowOnError>;
1061
1114
  /**
1062
1115
  * List a contact's group memberships
@@ -1080,7 +1133,7 @@ export declare class Templates {
1080
1133
  page?: string | null | undefined;
1081
1134
  limit?: string | null | undefined;
1082
1135
  category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | undefined;
1083
- channel?: "sms" | "whatsapp" | "email" | null | undefined;
1136
+ channel?: "email" | null | undefined;
1084
1137
  status?: "draft" | "pending" | "approved" | "published" | "rejected" | "archived" | null | undefined;
1085
1138
  search?: string | null | undefined;
1086
1139
  sortBy?: "name" | "createdAt" | "updatedAt" | "usageCount" | "lastUsedAt" | null | undefined;
@@ -1089,71 +1142,103 @@ export declare class Templates {
1089
1142
  /**
1090
1143
  * Create a template
1091
1144
  *
1092
- * Creates a template from SML source; the source's root tag determines the template's channel. Returns the created template with status 201.
1145
+ * Creates an email template project from Samva's canonical TSX starter and returns its template entry with status 201.
1093
1146
  */
1094
1147
  static create<ThrowOnError extends boolean = false>(parameters: {
1095
1148
  name: string;
1149
+ projectName?: string | null | undefined;
1096
1150
  slug?: string | null | undefined;
1097
- origin?: "dashboard" | "tsx" | null | undefined;
1151
+ galleryTemplateId?: string | null | undefined;
1098
1152
  description?: string | null | null | undefined;
1099
1153
  category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | null | undefined;
1100
- source: string;
1101
- subject?: string | null | undefined;
1102
- headers?: {
1103
- [key: string]: string;
1104
- } | null | null | undefined;
1105
- variableSchema?: Array<TemplateVariable> | null | null | undefined;
1106
- compliance?: TemplateCompliance | null | null | undefined;
1107
- performance?: TemplatePerformance | null | null | undefined;
1108
- designOverrides?: Design3 | null | null | undefined;
1109
1154
  isActive?: boolean | null | undefined;
1110
- isDefault?: boolean | null | undefined;
1111
- version?: number | null | undefined;
1155
+ idempotencyKey: string;
1112
1156
  }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesCreateResponses, TemplatesCreateErrors, ThrowOnError>;
1157
+ /**
1158
+ * List templates for the dashboard
1159
+ *
1160
+ * Returns a paginated dashboard view that groups related channel templates into families and leaves standalone templates ungrouped.
1161
+ */
1113
1162
  static listDashboard<ThrowOnError extends boolean = false>(parameters: {
1114
1163
  page?: string | null | undefined;
1115
1164
  limit?: string | null | undefined;
1116
- allowedChannels: "sms" | "whatsapp" | "email" | Array<"sms" | "whatsapp" | "email">;
1165
+ allowedChannels: "email" | Array<"email">;
1117
1166
  category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | undefined;
1118
- channel?: "sms" | "whatsapp" | "email" | null | undefined;
1167
+ channel?: "email" | null | undefined;
1119
1168
  status?: "draft" | "pending" | "approved" | "published" | "rejected" | "archived" | null | undefined;
1120
1169
  search?: string | null | undefined;
1121
1170
  sortBy?: "name" | "createdAt" | "updatedAt" | "usageCount" | "lastUsedAt" | null | undefined;
1122
1171
  sortOrder?: "asc" | "desc" | null | undefined;
1123
1172
  }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesListDashboardResponses, TemplatesListDashboardErrors, ThrowOnError>;
1173
+ /**
1174
+ * List template families
1175
+ *
1176
+ * Returns a paginated list of the organization's template families and members.
1177
+ */
1124
1178
  static listFamilies<ThrowOnError extends boolean = false>(parameters?: {
1125
1179
  page?: string | null | undefined;
1126
1180
  limit?: string | null | undefined;
1127
1181
  }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesListFamiliesResponses, TemplatesListFamiliesErrors, ThrowOnError>;
1182
+ /**
1183
+ * Create a template family
1184
+ *
1185
+ * Creates an empty template family with the supplied name and returns it with status 201.
1186
+ */
1128
1187
  static createFamily<ThrowOnError extends boolean = false>(parameters: {
1129
1188
  name: string;
1130
1189
  }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesCreateFamilyResponses, TemplatesCreateFamilyErrors, ThrowOnError>;
1190
+ /**
1191
+ * Delete a template family
1192
+ *
1193
+ * Deletes a template family without deleting its member templates.
1194
+ */
1131
1195
  static deleteFamily<ThrowOnError extends boolean = false>(parameters: {
1132
1196
  familyId: TemplateFamilyId;
1133
1197
  }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesDeleteFamilyResponses, TemplatesDeleteFamilyErrors, ThrowOnError>;
1198
+ /**
1199
+ * Get a template family
1200
+ *
1201
+ * Returns a template family and its channel-specific member templates.
1202
+ */
1134
1203
  static getFamily<ThrowOnError extends boolean = false>(parameters: {
1135
1204
  familyId: TemplateFamilyId;
1136
1205
  }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesGetFamilyResponses, TemplatesGetFamilyErrors, ThrowOnError>;
1206
+ /**
1207
+ * Rename a template family
1208
+ *
1209
+ * Changes a template family's name and returns the updated family.
1210
+ */
1137
1211
  static renameFamily<ThrowOnError extends boolean = false>(parameters: {
1138
1212
  familyId: TemplateFamilyId;
1139
1213
  name: string;
1140
1214
  }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesRenameFamilyResponses, TemplatesRenameFamilyErrors, ThrowOnError>;
1215
+ /**
1216
+ * Create a family from a template
1217
+ *
1218
+ * Creates a template family containing the specified template and returns the new family with status 201.
1219
+ */
1141
1220
  static createFamilyFromTemplate<ThrowOnError extends boolean = false>(parameters: {
1142
1221
  templateId: TemplateId;
1143
1222
  name: string;
1144
1223
  }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesCreateFamilyFromTemplateResponses, TemplatesCreateFamilyFromTemplateErrors, ThrowOnError>;
1224
+ /**
1225
+ * Detach a template from a family
1226
+ *
1227
+ * Removes a member template from the family without deleting the template.
1228
+ */
1145
1229
  static detachFamilyMember<ThrowOnError extends boolean = false>(parameters: {
1146
1230
  familyId: TemplateFamilyId;
1147
1231
  templateId: TemplateId;
1148
1232
  }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesDetachFamilyMemberResponses, TemplatesDetachFamilyMemberErrors, ThrowOnError>;
1233
+ /**
1234
+ * Attach a template to a family
1235
+ *
1236
+ * Adds an existing template as a channel member of the family and returns the updated family.
1237
+ */
1149
1238
  static attachFamilyMember<ThrowOnError extends boolean = false>(parameters: {
1150
1239
  familyId: TemplateFamilyId;
1151
1240
  templateId: TemplateId;
1152
1241
  }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesAttachFamilyMemberResponses, TemplatesAttachFamilyMemberErrors, ThrowOnError>;
1153
- static addFamilyChannel<ThrowOnError extends boolean = false>(parameters: {
1154
- familyId: TemplateFamilyId;
1155
- channel: "sms" | "whatsapp" | "email";
1156
- }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesAddFamilyChannelResponses, TemplatesAddFamilyChannelErrors, ThrowOnError>;
1157
1242
  /**
1158
1243
  * Delete a template
1159
1244
  *
@@ -1165,7 +1250,7 @@ export declare class Templates {
1165
1250
  /**
1166
1251
  * Get a template
1167
1252
  *
1168
- * Returns template metadata and compiled channel content. Read live SML through the template-document API.
1253
+ * Returns template metadata, its project entry path, and compiled channel content. Open live project files through the workspace API.
1169
1254
  */
1170
1255
  static getById<ThrowOnError extends boolean = false>(parameters: {
1171
1256
  id: TemplateId;
@@ -1173,109 +1258,216 @@ export declare class Templates {
1173
1258
  /**
1174
1259
  * Update a template
1175
1260
  *
1176
- * Updates template metadata. Source changes use the template-document revision API.
1261
+ * Updates template metadata. Source changes use the project workspace API.
1177
1262
  */
1178
1263
  static update<ThrowOnError extends boolean = false>(parameters: {
1179
1264
  id: TemplateId;
1180
1265
  data: {
1181
1266
  name?: string | null | undefined;
1182
1267
  slug?: string | null | undefined;
1183
- origin?: "dashboard" | "tsx" | null | undefined;
1184
1268
  description?: string | null | null | undefined;
1185
1269
  category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | null | undefined;
1186
1270
  fromDefault?: TemplateFromDefault | null | null | undefined;
1187
1271
  replyToDefault?: Array<string> | null | null | undefined;
1188
- variableSchema?: Array<TemplateVariable> | null | null | undefined;
1189
- compliance?: TemplateCompliance | null | null | undefined;
1190
- performance?: TemplatePerformance | null | null | undefined;
1191
- designOverrides?: Design3 | null | null | undefined;
1192
1272
  isActive?: boolean | null | undefined;
1193
- isDefault?: boolean | null | undefined;
1194
- version?: number | null | undefined;
1195
1273
  };
1196
1274
  }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesUpdateResponses, TemplatesUpdateErrors, ThrowOnError>;
1197
1275
  /**
1198
- * Approve a template
1276
+ * Patch template project files
1199
1277
  *
1200
- * Records compliance approval for a template with optional notes and moves its status to approved unless it is already published or archived.
1278
+ * Applies revision-checked file patches to the shared project workspace overlay.
1201
1279
  */
1202
- static approve<ThrowOnError extends boolean = false>(parameters: {
1280
+ static patchWorkspace<ThrowOnError extends boolean = false>(parameters: {
1203
1281
  id: TemplateId;
1204
- data: {
1205
- notes?: string | null | undefined;
1206
- };
1207
- }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesApproveResponses, TemplatesApproveErrors, ThrowOnError>;
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
1282
  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>;
1228
- static render<ThrowOnError extends boolean = false>(parameters: {
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;
1283
+ patches: Array<{
1284
+ path: string;
1285
+ content: string | null;
1256
1286
  }>;
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>;
1287
+ idempotencyKey: string;
1288
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesPatchWorkspaceResponses, TemplatesPatchWorkspaceErrors, ThrowOnError>;
1289
+ /**
1290
+ * Open a template project workspace
1291
+ *
1292
+ * Creates or opens the shared project workspace at the current Artifact branch head and returns its effective files.
1293
+ */
1294
+ static openWorkspace<ThrowOnError extends boolean = false>(parameters: {
1295
+ id: TemplateId;
1296
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesOpenWorkspaceResponses, TemplatesOpenWorkspaceErrors, ThrowOnError>;
1297
+ /**
1298
+ * Diff a template project workspace
1299
+ *
1300
+ * Returns exact added, modified, and deleted project files against the current Git base commit.
1301
+ */
1302
+ static diffWorkspace<ThrowOnError extends boolean = false>(parameters: {
1303
+ id: TemplateId;
1304
+ expectedRevision: string;
1305
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesDiffWorkspaceResponses, TemplatesDiffWorkspaceErrors, ThrowOnError>;
1306
+ /**
1307
+ * Reconcile a template project workspace
1308
+ *
1309
+ * Fast-forwards or rebases the workspace onto the current Artifact branch head, retaining file conflicts for explicit resolution.
1310
+ */
1311
+ static reconcileWorkspace<ThrowOnError extends boolean = false>(parameters: {
1312
+ id: TemplateId;
1313
+ expectedRevision: string;
1314
+ assetResolution?: "draft" | "remote" | undefined;
1315
+ expectedRemoteHead?: string | undefined;
1316
+ idempotencyKey: string;
1317
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesReconcileWorkspaceResponses, TemplatesReconcileWorkspaceErrors, ThrowOnError>;
1318
+ /**
1319
+ * Resolve a template workspace conflict
1320
+ *
1321
+ * Resolves one conflicted file by keeping the draft, using main, or supplying edited source.
1322
+ */
1323
+ static resolveWorkspaceConflict<ThrowOnError extends boolean = false>(parameters: {
1324
+ id: TemplateId;
1325
+ expectedRevision: string;
1326
+ path: string;
1327
+ resolution: "draft" | "main" | {
1328
+ content: string | null;
1329
+ };
1330
+ idempotencyKey: string;
1331
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesResolveWorkspaceConflictResponses, TemplatesResolveWorkspaceConflictErrors, ThrowOnError>;
1332
+ /**
1333
+ * Save a template project workspace
1334
+ *
1335
+ * Validates the effective project tree and creates one normal Git commit on the Artifact default branch.
1336
+ */
1337
+ static saveWorkspace<ThrowOnError extends boolean = false>(parameters: {
1338
+ id: TemplateId;
1339
+ expectedRevision: string;
1340
+ expectedHead: string;
1341
+ message: string;
1342
+ idempotencyKey: string;
1343
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesSaveWorkspaceResponses, TemplatesSaveWorkspaceErrors, ThrowOnError>;
1344
+ /**
1345
+ * Stage a historical template project tree
1346
+ *
1347
+ * 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.
1348
+ */
1349
+ static restoreWorkspace<ThrowOnError extends boolean = false>(parameters: {
1350
+ id: TemplateId;
1351
+ expectedRevision: string;
1352
+ commit: string;
1353
+ idempotencyKey: string;
1354
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesRestoreWorkspaceResponses, TemplatesRestoreWorkspaceErrors, ThrowOnError>;
1355
+ /**
1356
+ * List template project commit history
1357
+ *
1358
+ * Returns bounded history from the Artifact repository default branch.
1359
+ */
1360
+ static workspaceHistory<ThrowOnError extends boolean = false>(parameters: {
1361
+ id: TemplateId;
1362
+ limit?: string | null | undefined;
1363
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesWorkspaceHistoryResponses, TemplatesWorkspaceHistoryErrors, ThrowOnError>;
1364
+ /**
1365
+ * Check a template project workspace
1366
+ *
1367
+ * 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.
1368
+ */
1369
+ static checkWorkspace<ThrowOnError extends boolean = false>(parameters: {
1370
+ id: TemplateId;
1371
+ expectedRevision: string;
1372
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesCheckWorkspaceResponses, TemplatesCheckWorkspaceErrors, ThrowOnError>;
1373
+ /**
1374
+ * Render a declared template workspace fixture
1375
+ *
1376
+ * 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.
1377
+ */
1378
+ static renderWorkspaceFixture<ThrowOnError extends boolean = false>(parameters: {
1379
+ id: TemplateId;
1380
+ expectedRevision: string;
1381
+ fixture: string;
1382
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesRenderWorkspaceFixtureResponses, TemplatesRenderWorkspaceFixtureErrors, ThrowOnError>;
1383
+ /**
1384
+ * Publish an exact template commit
1385
+ *
1386
+ * 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.
1387
+ */
1265
1388
  static publish<ThrowOnError extends boolean = false>(parameters: {
1266
- templateId: TemplateId;
1267
- }, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsPublishResponses, TemplateDocumentsPublishErrors, ThrowOnError>;
1268
- static unpublish<ThrowOnError extends boolean = false>(parameters: {
1269
- templateId: TemplateId;
1270
- }, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsUnpublishResponses, TemplateDocumentsUnpublishErrors, ThrowOnError>;
1271
- static restore<ThrowOnError extends boolean = false>(parameters: {
1272
- templateId: TemplateId;
1273
- versionId: TemplateSourceVersionId;
1389
+ id: TemplateId;
1390
+ projectId: TemplateProjectId;
1391
+ commitSha: string;
1392
+ entryPath: string;
1393
+ expectedWorkspaceRevision: string;
1394
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesPublishResponses, TemplatesPublishErrors, ThrowOnError>;
1395
+ /**
1396
+ * Get a template publication
1397
+ *
1398
+ * Returns one immutable publication and its exact build receipt.
1399
+ */
1400
+ static getPublication<ThrowOnError extends boolean = false>(parameters: {
1401
+ id: TemplateId;
1402
+ publicationId: TemplatePublicationId;
1403
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesGetPublicationResponses, TemplatesGetPublicationErrors, ThrowOnError>;
1404
+ /**
1405
+ * List a template's input contracts
1406
+ *
1407
+ * 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.
1408
+ */
1409
+ static listInputContracts<ThrowOnError extends boolean = false>(parameters: {
1410
+ id: TemplateId;
1411
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesListInputContractsResponses, TemplatesListInputContractsErrors, ThrowOnError>;
1412
+ /**
1413
+ * Get a template input contract
1414
+ *
1415
+ * Returns one immutable input contract and the published schema it validates against.
1416
+ */
1417
+ static getInputContract<ThrowOnError extends boolean = false>(parameters: {
1418
+ id: TemplateId;
1419
+ inputContractId: TemplateInputContractId;
1420
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesGetInputContractResponses, TemplatesGetInputContractErrors, ThrowOnError>;
1421
+ /**
1422
+ * Get a template project Git repository
1423
+ *
1424
+ * Returns the credential-free HTTPS remote and default branch for the template project repository.
1425
+ */
1426
+ static getGitRepository<ThrowOnError extends boolean = false>(parameters: {
1427
+ id: TemplateId;
1428
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesGetGitRepositoryResponses, TemplatesGetGitRepositoryErrors, ThrowOnError>;
1429
+ /**
1430
+ * Issue a template project Git credential
1431
+ *
1432
+ * Exchanges the caller's Samva authorization for a one-hour, repository-scoped Artifact Git credential.
1433
+ */
1434
+ static issueGitCredential<ThrowOnError extends boolean = false>(parameters: {
1435
+ id: TemplateId;
1436
+ scope: "read" | "write";
1437
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesIssueGitCredentialResponses, TemplatesIssueGitCredentialErrors, ThrowOnError>;
1438
+ /**
1439
+ * Attach a template workspace resource
1440
+ *
1441
+ * Adds or replaces one bounded persistent read-only resource and advances the workspace revision.
1442
+ */
1443
+ static attachWorkspaceResource<ThrowOnError extends boolean = false>(parameters: {
1444
+ id: TemplateId;
1445
+ expectedRevision: string;
1446
+ resource: {
1447
+ resourceId: string;
1448
+ name: string;
1449
+ files: Array<{
1450
+ path: string;
1451
+ mediaType: string;
1452
+ contentBase64: string;
1453
+ }>;
1454
+ };
1455
+ idempotencyKey: string;
1456
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesAttachWorkspaceResourceResponses, TemplatesAttachWorkspaceResourceErrors, ThrowOnError>;
1457
+ /**
1458
+ * Remove a template workspace resource
1459
+ *
1460
+ * Removes one persistent resource from mounted context and advances the workspace revision.
1461
+ */
1462
+ static removeWorkspaceResource<ThrowOnError extends boolean = false>(parameters: {
1463
+ id: TemplateId;
1464
+ resourceId: string;
1274
1465
  expectedRevision: string;
1275
- }, options?: Options<never, ThrowOnError>): RequestResult<TemplateDocumentsRestoreResponses, TemplateDocumentsRestoreErrors, ThrowOnError>;
1466
+ idempotencyKey: string;
1467
+ }, options?: Options<never, ThrowOnError>): RequestResult<TemplatesRemoveWorkspaceResourceResponses, TemplatesRemoveWorkspaceResourceErrors, ThrowOnError>;
1276
1468
  }
1277
- export declare class TemplateDocuments2 {
1278
- static templateDocuments: typeof TemplateDocuments;
1469
+ export declare class Templates2 {
1470
+ static templates: typeof Templates;
1279
1471
  }
1280
1472
  export declare class Design {
1281
1473
  /**
@@ -1310,13 +1502,13 @@ export declare class Webhooks {
1310
1502
  /**
1311
1503
  * Create a webhook
1312
1504
  *
1313
- * Creates a webhook endpoint subscribed to the given event types and returns it with a 201 response.
1505
+ * Creates a signed webhook endpoint for Samva delivery and inbound events, stores subscriptions, and returns the endpoint and signing secret with a 201 response.
1314
1506
  */
1315
1507
  static create<ThrowOnError extends boolean = false>(parameters: {
1316
1508
  name: string;
1317
1509
  url: string;
1318
1510
  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">;
1319
- channels?: Array<"sms" | "whatsapp" | "email"> | null | undefined;
1511
+ channels?: Array<"email"> | null | undefined;
1320
1512
  headers?: {
1321
1513
  [key: string]: string;
1322
1514
  } | null | undefined;
@@ -1348,7 +1540,7 @@ export declare class Webhooks {
1348
1540
  name?: string | null | undefined;
1349
1541
  url?: string | null | undefined;
1350
1542
  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;
1351
- channels?: Array<"sms" | "whatsapp" | "email"> | null | null | undefined;
1543
+ channels?: Array<"email"> | null | null | undefined;
1352
1544
  headers?: {
1353
1545
  [key: string]: string;
1354
1546
  } | null | undefined;
@@ -1450,7 +1642,7 @@ export declare class Organizations {
1450
1642
  /**
1451
1643
  * Delete the current workspace
1452
1644
  *
1453
- * Accepts owner-authorized durable workspace deletion. Repeating the same request with the same Idempotency-Key returns the existing organization-scoped operation.
1645
+ * 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.
1454
1646
  */
1455
1647
  static delete<ThrowOnError extends boolean = false>(parameters: {
1456
1648
  "idempotency-key": string;
@@ -1520,7 +1712,7 @@ export declare class ApiKeys {
1520
1712
  /**
1521
1713
  * Rotate an API key
1522
1714
  *
1523
- * Deactivates the existing key and issues a replacement with the same name and permissions. Returns the new key, including the plaintext secret.
1715
+ * Issues a replacement with the same owner, name, and permissions, then deactivates the existing key. Returns the new key, including the plaintext secret.
1524
1716
  */
1525
1717
  static rotate<ThrowOnError extends boolean = false>(parameters: {
1526
1718
  id: ApiKeyId;