samva 0.13.0 → 0.15.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 +9 -0
- package/README.md +55 -6
- package/dist/{categories-Bcwq5jPV.js → categories-BGUBFdH9.js} +9 -1
- package/dist/client/sdk.gen.d.ts +129 -27
- package/dist/client/types.gen.d.ts +920 -166
- package/dist/{client-DYPNDvVU.js → client-CDg7zJs0.js} +760 -147
- package/dist/effect/analytics.d.ts +6 -6
- package/dist/effect/analytics.js +1 -1
- package/dist/effect/api-keys.d.ts +20 -20
- package/dist/effect/api-keys.js +1 -1
- package/dist/effect/attachments.js +1 -1
- package/dist/effect/brands.js +2 -2
- package/dist/effect/campaigns.d.ts +12 -12
- package/dist/effect/campaigns.js +1 -1
- package/dist/effect/categories.js +1 -1
- package/dist/effect/client.js +1 -1
- package/dist/effect/contact-groups.d.ts +9 -9
- package/dist/effect/contact-groups.js +1 -1
- package/dist/effect/contacts.d.ts +126 -73
- package/dist/effect/contacts.js +1 -1
- package/dist/effect/conversations.d.ts +20 -20
- package/dist/effect/conversations.js +1 -1
- package/dist/effect/custom-fields.d.ts +1 -1
- package/dist/effect/custom-fields.js +1 -1
- package/dist/effect/email.d.ts +26 -26
- package/dist/effect/email.js +2 -2
- package/dist/effect/extension-installations.d.ts +3 -3
- package/dist/effect/extension-installations.js +1 -1
- package/dist/effect/extensions.d.ts +3 -3
- package/dist/effect/extensions.js +1 -1
- package/dist/effect/feedback.d.ts +1 -1
- package/dist/effect/feedback.js +2 -2
- package/dist/effect/generated-metadata.d.ts +8 -0
- package/dist/effect/generated.d.ts +6335 -1112
- package/dist/effect/index.d.ts +2 -1
- package/dist/effect/index.js +6 -5
- package/dist/effect/internal/client.d.ts +2 -2
- package/dist/effect/internal/operation.d.ts +9 -9
- package/dist/effect/mailboxes.d.ts +1775 -109
- package/dist/effect/mailboxes.js +3 -3
- package/dist/effect/media.d.ts +1 -1
- package/dist/effect/media.js +1 -1
- package/dist/effect/messages.d.ts +19 -17
- package/dist/effect/messages.js +1 -1
- package/dist/effect/namespaces.js +1 -1
- package/dist/effect/operations.d.ts +6 -6
- package/dist/effect/operations.js +1 -1
- package/dist/effect/organizations.d.ts +30 -0
- package/dist/effect/organizations.js +4 -2
- package/dist/effect/retry.js +1 -1
- package/dist/effect/scheduled-messages.d.ts +6 -6
- package/dist/effect/scheduled-messages.js +1 -1
- package/dist/effect/subscriptions.d.ts +15 -0
- package/dist/effect/subscriptions.js +9 -0
- package/dist/effect/templates.d.ts +52 -14
- package/dist/effect/templates.js +5 -3
- package/dist/effect/unsubscribe-groups.d.ts +1 -1
- package/dist/effect/unsubscribe-groups.js +1 -1
- package/dist/effect/webhooks.d.ts +15 -15
- package/dist/effect/webhooks.js +2 -2
- package/dist/index.js +4 -4
- package/dist/{inline-attachments-B56eS0MF.js → inline-attachments-UxLeyytJ.js} +2 -2
- package/dist/{mailbox-events-CsbF35vH.js → mailbox-events-VKR4f3qq.js} +6 -4
- package/dist/mailbox-events.d.ts +1 -1
- package/dist/{mailboxes-D3Kx7elM.js → mailboxes-BH_JPmOE.js} +17 -5
- package/dist/{operation-B_Ty1LG-.js → operation-BZ5Xov-x.js} +37 -3
- package/dist/promises/errors.gen.d.ts +26 -2
- package/dist/promises/index.d.ts +6 -4
- package/dist/promises/index.js +4 -4
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/{promises-D9FJyU0q.js → promises-Cd6Jamqk.js} +1004 -47
- package/dist/service-map.d.ts +45 -0
- package/package.json +7 -2
package/AGENTS.md
CHANGED
|
@@ -12,3 +12,12 @@ Effect error channel and can be handled with `Effect.catchTag`.
|
|
|
12
12
|
|
|
13
13
|
Treat exported request and response types as the API contract. Do not import package-internal files
|
|
14
14
|
or generated implementation paths; use only the subpaths declared in `package.json`.
|
|
15
|
+
|
|
16
|
+
Mailbox send operations return asynchronous action receipts. Interpret `state`, preserve `actionId`,
|
|
17
|
+
and read `mailboxes.getAction` (or `Mailboxes.getAction`) to follow progress. Narrow on action `type`
|
|
18
|
+
before reading send-specific `send` receipt and frozen `intent`. `queued` is not a sent confirmation;
|
|
19
|
+
`accepted` supplies `messageId` and `acceptedAt`, while `completed` records mailbox projection,
|
|
20
|
+
not recipient delivery. A timeout preserves the original idempotency key and body; a new key can
|
|
21
|
+
send another email. `uncertain` requires reconciliation. Only a permitted person can cancel before
|
|
22
|
+
acceptance or retry an eligible original action without extending its deadline. Approval is also
|
|
23
|
+
asynchronous. See https://samva.dev/docs/mailboxes/approvals for the receipt contract.
|
package/README.md
CHANGED
|
@@ -36,9 +36,9 @@ const client = createClient({
|
|
|
36
36
|
apiKey: "<samva-api-key>",
|
|
37
37
|
});
|
|
38
38
|
|
|
39
|
-
const contact = await client.contacts.findOrCreate({
|
|
40
|
-
|
|
41
|
-
|
|
39
|
+
const { contact } = await client.contacts.findOrCreate({
|
|
40
|
+
lookup: { type: "email", value: "ada@example.com" },
|
|
41
|
+
create: { name: "Ada Lovelace" },
|
|
42
42
|
});
|
|
43
43
|
|
|
44
44
|
const message = await client.messages.send({
|
|
@@ -58,6 +58,9 @@ const messages = await client.messages.list({ limit: "20" });
|
|
|
58
58
|
// Pass `messages.nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
59
59
|
```
|
|
60
60
|
|
|
61
|
+
Creation fails with `ConflictError` (HTTP 409) when an external ID or address belongs to another
|
|
62
|
+
contact. The error names the conflicting field and the creation is rolled back.
|
|
63
|
+
|
|
61
64
|
## Effect Quick Start
|
|
62
65
|
|
|
63
66
|
Install `effect` next to `samva` when using the Effect entrypoint:
|
|
@@ -197,6 +200,10 @@ returned instruction, call `media.complete`, and pass the ready `mediaId` to `em
|
|
|
197
200
|
`messages.send`. A message accepts at most 10 attachments totaling 25 MiB of raw bytes; the same
|
|
198
201
|
budget covers inline base64 content and owned media references. Remote URL attachments are not.
|
|
199
202
|
|
|
203
|
+
Inline base64 `content` is capped at 4 MiB of raw bytes per request. When a send carries more,
|
|
204
|
+
`email.send` and `messages.send` upload the largest attachments through `media` first and send them
|
|
205
|
+
by `mediaId`; a failed upload throws `MediaUploadError` before the send request.
|
|
206
|
+
|
|
200
207
|
Effect failures carry Samva's real tagged errors (`RateLimitedError`, `ValidationError`, `PaymentRequiredError`, …) directly in the error channel, so `Effect.catchTag("RateLimitedError", …)` works against any operation without enumerating status codes, and each error exposes its own fields (no wrapper `cause`). The SDK also exports category helpers such as `isRetryable`, `isTransient`, `catchAuthError`, and `catchTransient`. Success values decode to domain types: annotated absolute instants become `Date`, sensitive fields become `Redacted`, and unannotated wire timestamps remain strings.
|
|
201
208
|
|
|
202
209
|
### Default-on retry
|
|
@@ -256,6 +263,10 @@ The companions are attached uniformly to every paginated list, including `Messag
|
|
|
256
263
|
|
|
257
264
|
### Redacted secrets
|
|
258
265
|
|
|
266
|
+
Effect client configuration accepts `apiKey: string | Redacted<string>` and unwraps a Redacted key
|
|
267
|
+
only for authentication. Promise client configuration accepts `apiKey: string` and does not require
|
|
268
|
+
Effect, including in browser bundles.
|
|
269
|
+
|
|
259
270
|
Secret-bearing response fields — the plaintext API key returned by `apiKeys.create` / `apiKeys.rotate`, and the webhook signing secret from `webhooks.regenerateSecret` — decode to `Redacted<string>` on the Effect surface. The secret never leaks through logs, `String(...)`, or `JSON.stringify`; unwrap it explicitly with `Redacted.value` when you need the plaintext:
|
|
260
271
|
|
|
261
272
|
```typescript
|
|
@@ -289,9 +300,9 @@ These let MCP and third-party consumers read retry/idempotency/secret semantics
|
|
|
289
300
|
### Send Email Through Unified Messages
|
|
290
301
|
|
|
291
302
|
```typescript
|
|
292
|
-
const contact = await client.contacts.findOrCreate({
|
|
293
|
-
|
|
294
|
-
|
|
303
|
+
const { contact } = await client.contacts.findOrCreate({
|
|
304
|
+
lookup: { type: "email", value: "ada@example.com" },
|
|
305
|
+
create: { name: "Ada Lovelace" },
|
|
295
306
|
});
|
|
296
307
|
|
|
297
308
|
const response = await client.messages.send({
|
|
@@ -371,6 +382,44 @@ const recipients = await client.campaigns.listRecipients({
|
|
|
371
382
|
});
|
|
372
383
|
```
|
|
373
384
|
|
|
385
|
+
### Follow a Mailbox Send
|
|
386
|
+
|
|
387
|
+
Mailbox send, reply, forward, and draft send return action receipts. A successful `202` records
|
|
388
|
+
pending work; it is not a sent confirmation. Read `receipt.state` and preserve `receipt.actionId`:
|
|
389
|
+
|
|
390
|
+
```typescript
|
|
391
|
+
const receipt = await client.mailboxes.sendMessage({
|
|
392
|
+
id: "mbx_...",
|
|
393
|
+
to: ["ada@example.com"],
|
|
394
|
+
subject: "Hello",
|
|
395
|
+
text: "Hello from Samva",
|
|
396
|
+
"idempotency-key": "support-message-123",
|
|
397
|
+
});
|
|
398
|
+
|
|
399
|
+
const action = await client.mailboxes.getAction({ id: "mbx_...", actionId: receipt.actionId });
|
|
400
|
+
if (action.type === "sendMessage" || action.type === "reply") {
|
|
401
|
+
console.log(action.state, action.send.messageId);
|
|
402
|
+
}
|
|
403
|
+
```
|
|
404
|
+
|
|
405
|
+
`approvalRequired` awaits a person; `queued` is authorized work; `accepted` has a durable
|
|
406
|
+
`messageId` and `acceptedAt`; `completed` has its mailbox sent item recorded. Recipient delivery
|
|
407
|
+
is separate. `notSent` reopens the draft; `uncertain` requires reconciliation and must not trigger
|
|
408
|
+
a replacement email. Until acceptance, `messageId` and `acceptedAt` are null. The action's `intent`
|
|
409
|
+
is the frozen public email snapshot; inspect the action type before using send-specific fields.
|
|
410
|
+
|
|
411
|
+
Preserve the original key and body after a timeout. Replaying them reads the same action's current
|
|
412
|
+
phase, and changing the body under that key is a conflict. `getAction` reads progress. A permitted
|
|
413
|
+
person can `cancelAction` before acceptance or `retryAction` when `retryEligible` is true; Retry
|
|
414
|
+
continues the original action and never extends `executeUntil`. API keys and extensions cannot
|
|
415
|
+
cancel or Retry. `approveAction` returns an action with `202` while the send is pending; accepted,
|
|
416
|
+
completed, and `notSent` replays return `200`. Non-send approvals execute synchronously and return
|
|
417
|
+
`200`, as does `denyAction`.
|
|
418
|
+
The same behavior applies to `samva/effect/mailboxes`.
|
|
419
|
+
|
|
420
|
+
See [mailbox approvals and receipts](https://samva.dev/docs/mailboxes/approvals) for the receipt
|
|
421
|
+
fields, sending deadline, approval permissions, and idempotency retention.
|
|
422
|
+
|
|
374
423
|
### Read Mailbox Events
|
|
375
424
|
|
|
376
425
|
`mailboxes.events` reads the `mailbox.*` events over a WebSocket, for a program without a public
|
|
@@ -50,6 +50,14 @@ const SamvaErrorMetadata = {
|
|
|
50
50
|
categories: ["transient"],
|
|
51
51
|
retryable: true
|
|
52
52
|
},
|
|
53
|
+
MailboxSendConflictError: {
|
|
54
|
+
categories: [],
|
|
55
|
+
retryable: false
|
|
56
|
+
},
|
|
57
|
+
MailboxSendRefusedError: {
|
|
58
|
+
categories: [],
|
|
59
|
+
retryable: false
|
|
60
|
+
},
|
|
53
61
|
OnboardingReviewRequiredError: {
|
|
54
62
|
categories: ["validation"],
|
|
55
63
|
retryable: false
|
|
@@ -172,4 +180,4 @@ const catchTransient = (handler) => (effect) => Effect.catchIf(effect, isTransie
|
|
|
172
180
|
//#endregion
|
|
173
181
|
export { isTransient as _, catchNotFoundError as a, catchValidationError as c, isAuthError as d, isBillingError as f, isThrottlingError as g, isRetryable as h, catchConflictError as i, categoriesOf as l, isNotFoundError as m, catchBillingError as n, catchThrottlingError as o, isConflictError as p, catchCategory as r, catchTransient as s, catchAuthError as t, hasCategory as u, isValidationError as v };
|
|
174
182
|
|
|
175
|
-
//# sourceMappingURL=categories-
|
|
183
|
+
//# sourceMappingURL=categories-BGUBFdH9.js.map
|
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from "./client";
|
|
2
|
-
import type { AnalyticsExportDataErrors, AnalyticsExportDataResponses, AnalyticsGetChannelStatsErrors, AnalyticsGetChannelStatsResponses, AnalyticsGetDeliveryMetricsErrors, AnalyticsGetDeliveryMetricsResponses, AnalyticsGetHourlyDistributionErrors, AnalyticsGetHourlyDistributionResponses, AnalyticsGetStatsErrors, AnalyticsGetStatsResponses, AnalyticsGetTopContactsErrors, AnalyticsGetTopContactsResponses, ApiKeyAccess, ApiKeyId, ApiKeyMailboxAccessUpdate, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, AttachmentId, AttachmentsDownloadUrlErrors, AttachmentsDownloadUrlResponses, AttachmentsGetByIdErrors, AttachmentsGetByIdResponses, AttachmentsListErrors, AttachmentsListResponses, AttachmentsRemoveErrors, AttachmentsRemoveResponses, BlockedEmailId, BrandAssets, BrandFooter, BrandsCreateErrors, BrandsCreateResponses, BrandsGetErrors, BrandsGetResponses, BrandsListErrors, BrandsListResponses, BrandsRemoveErrors, BrandsRemoveResponses, BrandsSetDefaultErrors, BrandsSetDefaultResponses, BrandsUpdateErrors, BrandsUpdateResponses, CampaignAudience, CampaignContentInput, CampaignId, CampaignPolicy, CampaignRunId, CampaignsArchiveErrors, CampaignsArchiveResponses, CampaignsCancelRunErrors, CampaignsCancelRunResponses, CampaignsCreateErrors, CampaignsCreateResponses, CampaignsGetErrors, CampaignsGetResponses, CampaignsGetRunErrors, CampaignsGetRunResponses, CampaignsListErrors, CampaignsListRecipientsErrors, CampaignsListRecipientsResponses, CampaignsListResponses, CampaignsListRunsErrors, CampaignsListRunsResponses, CampaignsPauseRunErrors, CampaignsPauseRunResponses, CampaignsResumeRunErrors, CampaignsResumeRunResponses, CampaignsScheduleRunErrors, CampaignsScheduleRunResponses, CampaignsUpdateErrors, CampaignsUpdateResponses, ContactGroupId, ContactGroupsAddMembersErrors, ContactGroupsAddMembersResponses, ContactGroupsCreateErrors, ContactGroupsCreateResponses, ContactGroupsEvaluateDynamicErrors, ContactGroupsEvaluateDynamicResponses, ContactGroupsGetByIdErrors, ContactGroupsGetByIdResponses, ContactGroupsGetMembersErrors, ContactGroupsGetMembersResponses, ContactGroupsListErrors, ContactGroupsListResponses, ContactGroupsPreviewErrors, ContactGroupsPreviewResponses, ContactGroupsRemoveErrors, ContactGroupsRemoveMembersErrors, ContactGroupsRemoveMembersResponses, ContactGroupsRemoveResponses, ContactGroupsUpdateErrors, ContactGroupsUpdateResponses, ContactId, ContactIdentityId, ContactIdentityInput, ContactPreferences, ContactProfile, ContactProfileUpdate, ContactsAddIdentityErrors, ContactsAddIdentityResponses, ContactsAddTagsErrors, ContactsAddTagsResponses, 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, ContactsRemoveIdentityErrors, ContactsRemoveIdentityResponses, ContactsRemoveResponses, ContactsRemoveTagsErrors, ContactsRemoveTagsResponses, ContactsUpdateErrors, ContactsUpdateResponses, ConversationContext, ConversationId, ConversationsAddCategoriesErrors, ConversationsAddCategoriesResponses, ConversationsAddChannelsErrors, ConversationsAddChannelsResponses, ConversationsAddContactsErrors, ConversationsAddContactsResponses, ConversationsAddTagsErrors, ConversationsAddTagsResponses, ConversationsCreateErrors, ConversationsCreateResponses, ConversationsGetByIdErrors, ConversationsGetByIdResponses, ConversationsListErrors, ConversationsListMessagesErrors, ConversationsListMessagesResponses, ConversationsListResponses, ConversationsRemoveCategoriesErrors, ConversationsRemoveCategoriesResponses, ConversationsRemoveChannelsErrors, ConversationsRemoveChannelsResponses, ConversationsRemoveContactsErrors, ConversationsRemoveContactsResponses, ConversationsRemoveTagsErrors, ConversationsRemoveTagsResponses, ConversationsUpdateErrors, ConversationsUpdateResponses, CreateMailboxAddressPayload, Cursor, CustomFieldDefinitionId, CustomFieldsCreateErrors, CustomFieldsCreateResponses, CustomFieldsListErrors, CustomFieldsListResponses, CustomFieldsRemoveErrors, CustomFieldsRemoveResponses, CustomFieldsUpdateErrors, CustomFieldsUpdateResponses, DispatchSendMessagePayload, EmailAddBlockErrors, EmailAddBlockResponses, EmailAddDomainErrors, EmailAddDomainResponses, EmailAddSenderErrors, EmailAddSenderResponses, EmailAdvanceDomainVerificationErrors, EmailAdvanceDomainVerificationResponses, EmailAttachment, EmailBccRecipients, EmailBuildCustomTrackingDomainConnectApplyUrlErrors, EmailBuildCustomTrackingDomainConnectApplyUrlResponses, EmailBuildDomainConnectApplyUrlErrors, EmailBuildDomainConnectApplyUrlResponses, EmailCancelDomainWarmingBatchErrors, EmailCancelDomainWarmingBatchResponses, EmailCcRecipients, EmailCheckBlockedErrors, EmailCheckBlockedResponses, EmailCheckSenderVerificationErrors, EmailCheckSenderVerificationResponses, EmailClearDomainDefaultSenderErrors, EmailClearDomainDefaultSenderResponses, EmailCompleteCustomTrackingDomainConnectErrors, EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteDomainConnectErrors, EmailCompleteDomainConnectResponses, EmailCompleteDomainWarmingErrors, EmailCompleteDomainWarmingResponses, EmailContent, EmailCountSuppressionsErrors, EmailCountSuppressionsResponses, 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, EmailGetReceivingStatusErrors, EmailGetReceivingStatusResponses, EmailGetRecipientTrackingPreferenceErrors, EmailGetRecipientTrackingPreferenceResponses, EmailGetSenderErrors, EmailGetSenderResponses, EmailGetStatsErrors, EmailGetStatsResponses, EmailGetTrackingDefaultsErrors, EmailGetTrackingDefaultsResponses, EmailListBlocksErrors, EmailListBlocksResponses, EmailListDomainsErrors, EmailListDomainsResponses, EmailListForwardingRulesErrors, EmailListForwardingRulesResponses, EmailListSendersErrors, EmailListSendersResponses, EmailListSuppressionsErrors, EmailListSuppressionsResponses, EmailPauseDomainWarmingErrors, EmailPauseDomainWarmingResponses, EmailReapplyOnboardingReviewErrors, EmailReapplyOnboardingReviewResponses, EmailRecheckCustomTrackingErrors, EmailRecheckCustomTrackingResponses, 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, ExtensionInstallationId, ExtensionInstallationsDisableErrors, ExtensionInstallationsDisableResponses, ExtensionInstallationsEnableErrors, ExtensionInstallationsEnableResponses, ExtensionInstallationsGetErrors, ExtensionInstallationsGetResponses, ExtensionInstallationsGetRunErrors, ExtensionInstallationsGetRunResponses, ExtensionInstallationsInstallErrors, ExtensionInstallationsInstallResponses, ExtensionInstallationsListErrors, ExtensionInstallationsListResponses, ExtensionInstallationsListRunsErrors, ExtensionInstallationsListRunsResponses, ExtensionInstallationsUninstallErrors, ExtensionInstallationsUninstallResponses, ExtensionInstallationsUpgradeErrors, ExtensionInstallationsUpgradeResponses, ExtensionsGetErrors, ExtensionsGetResponses, ExtensionsGetVersionErrors, ExtensionsGetVersionResponses, ExtensionsListErrors, ExtensionsListResponses, ExtensionsListVersionsErrors, ExtensionsListVersionsResponses, ExtensionsPublishErrors, ExtensionsPublishResponses, ExtensionVersionId, FeedbackContext, FeedbackSendErrors, FeedbackSendResponses, ForwardingConditions, IanaTimezone, JsonObject, JsonValue, MailboxActionId, MailboxDraftId, MailboxesAddThreadLabelsErrors, MailboxesAddThreadLabelsResponses, MailboxesApproveActionErrors, MailboxesApproveActionResponses, MailboxesCreateDraftErrors, MailboxesCreateDraftResponses, MailboxesCreateErrors, MailboxesCreateGrantErrors, MailboxesCreateGrantResponses, MailboxesCreateLabelErrors, MailboxesCreateLabelResponses, MailboxesCreateNoteErrors, MailboxesCreateNoteResponses, MailboxesCreatePolicyErrors, MailboxesCreatePolicyResponses, MailboxesCreateResponses, MailboxesDeleteDraftErrors, MailboxesDeleteDraftResponses, MailboxesDeleteLabelErrors, MailboxesDeleteLabelResponses, MailboxesDeleteNoteErrors, MailboxesDeleteNoteResponses, MailboxesDeletePolicyErrors, MailboxesDeletePolicyResponses, MailboxesDenyActionErrors, MailboxesDenyActionResponses, MailboxesDiscardMessageErrors, MailboxesDiscardMessageResponses, MailboxesForwardErrors, MailboxesForwardResponses, MailboxesGetAgentActivityErrors, MailboxesGetAgentActivityResponses, MailboxesGetDraftErrors, MailboxesGetDraftResponses, MailboxesGetErrors, MailboxesGetMessageAttachmentErrors, MailboxesGetMessageAttachmentResponses, MailboxesGetMessageErrors, MailboxesGetMessageRawErrors, MailboxesGetMessageRawResponses, MailboxesGetMessageResponses, MailboxesGetPolicyErrors, MailboxesGetPolicyResponses, MailboxesGetResponses, MailboxesGetThreadContentErrors, MailboxesGetThreadContentResponses, MailboxesGetThreadErrors, MailboxesGetThreadResponses, MailboxesListActionsErrors, MailboxesListActionsResponses, MailboxesListDraftsErrors, MailboxesListDraftsResponses, MailboxesListErrors, MailboxesListEventsErrors, MailboxesListEventsResponses, MailboxesListFoldersErrors, MailboxesListFoldersResponses, MailboxesListGrantsErrors, MailboxesListGrantsResponses, MailboxesListLabelsErrors, MailboxesListLabelsResponses, MailboxesListPoliciesErrors, MailboxesListPoliciesResponses, MailboxesListQuarantineErrors, MailboxesListQuarantineResponses, MailboxesListResponses, MailboxesListThreadMessagesErrors, MailboxesListThreadMessagesResponses, MailboxesListThreadNotesErrors, MailboxesListThreadNotesResponses, MailboxesListThreadsErrors, MailboxesListThreadsResponses, MailboxesPauseErrors, MailboxesPauseResponses, MailboxesReleaseMessageErrors, MailboxesReleaseMessageResponses, MailboxesRemoveErrors, MailboxesRemoveResponses, MailboxesRemoveThreadLabelsErrors, MailboxesRemoveThreadLabelsResponses, MailboxesReplyAllErrors, MailboxesReplyAllResponses, MailboxesReplyErrors, MailboxesReplyResponses, MailboxesResumeErrors, MailboxesResumeResponses, MailboxesRevokeGrantErrors, MailboxesRevokeGrantResponses, MailboxesSendDraftErrors, MailboxesSendDraftResponses, MailboxesSendMessageErrors, MailboxesSendMessageResponses, MailboxesUpdateDraftErrors, MailboxesUpdateDraftResponses, MailboxesUpdateErrors, MailboxesUpdateGrantErrors, MailboxesUpdateGrantResponses, MailboxesUpdateLabelErrors, MailboxesUpdateLabelResponses, MailboxesUpdateNoteErrors, MailboxesUpdateNoteResponses, MailboxesUpdatePolicyErrors, MailboxesUpdatePolicyResponses, MailboxesUpdateResponses, MailboxesUpdateThreadErrors, MailboxesUpdateThreadResponses, MailboxGrantId, MailboxGrantRole, MailboxId, MailboxLabelId, MailboxMetadata, MailboxMetadataPatch, MailboxNoteId, MailboxPolicyId, MailboxPolicyOutcomeKind, MailboxSendMode, MailboxThreadFolder, MailboxThreadId, MailboxThreadPriority, MediaCompleteErrors, MediaCompleteResponses, MediaCreateErrors, MediaCreateResponses, MediaDownloadUrlErrors, MediaDownloadUrlResponses, MediaGetByIdErrors, MediaGetByIdResponses, MediaId, MediaRemoveErrors, MediaRemoveResponses, MessageId, MessageMetadata, MessagesGetContentErrors, MessagesGetContentResponses, MessagesGetEmailErrors, MessagesGetEmailResponses, MessagesGetErrors, MessagesGetEventsErrors, MessagesGetEventsResponses, MessagesGetResponses, MessagesGetStatusErrors, MessagesGetStatusResponses, MessagesListDeliveriesErrors, MessagesListDeliveriesResponses, MessagesListErrors, MessagesListResponses, MessagesRemoveErrors, MessagesRemoveResponses, MessagesSendErrors, MessagesSendResponses, MessagesValidateEmailErrors, MessagesValidateEmailResponses, NamespaceId, NamespaceMetadata, NamespacesCreateErrors, NamespacesCreateResponses, NamespacesGetErrors, NamespacesGetResponses, NamespacesListErrors, NamespacesListResponses, NamespacesRemoveErrors, NamespacesRemoveResponses, NamespacesUpdateErrors, NamespacesUpdateResponses, OperationId, OperationsGetErrors, OperationsGetResponses, OperationsListErrors, OperationsListResponses, OperationsRetryErrors, OperationsRetryResponses, OrganizationsCreateErrors, OrganizationsCreateResponses, OrganizationsDeleteErrors, OrganizationsDeleteResponses, OrganizationsGetErrors, OrganizationsGetProfileErrors, OrganizationsGetProfileResponses, OrganizationsGetResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, ScheduledMessagesResumeErrors, ScheduledMessagesResumeResponses, SuppressionId, TemplateFamilyId, TemplateFromDefault, TemplateId, TemplateInputContractId, TemplateProjectId, TemplatePublicationId, TemplatesAddEntryErrors, TemplatesAddEntryResponses, TemplatesAttachFamilyMemberErrors, TemplatesAttachFamilyMemberResponses, TemplatesAttachWorkspaceResourceErrors, TemplatesAttachWorkspaceResourceResponses, TemplatesCheckWorkspaceErrors, TemplatesCheckWorkspaceResponses, TemplatesCreateErrors, TemplatesCreateFamilyErrors, TemplatesCreateFamilyFromTemplateErrors, TemplatesCreateFamilyFromTemplateResponses, TemplatesCreateFamilyResponses, TemplatesCreateResponses, TemplatesDeleteFamilyErrors, TemplatesDeleteFamilyResponses, TemplatesDetachFamilyMemberErrors, TemplatesDetachFamilyMemberResponses, TemplatesDiffWorkspaceErrors, TemplatesDiffWorkspaceResponses, TemplatesGetByIdErrors, TemplatesGetByIdResponses, TemplatesGetFamilyErrors, TemplatesGetFamilyResponses, TemplatesGetGitRepositoryErrors, TemplatesGetGitRepositoryResponses, TemplatesGetInputContractErrors, TemplatesGetInputContractResponses, TemplatesGetPublicationErrors, TemplatesGetPublicationResponses, TemplatesIssueGitCredentialErrors, TemplatesIssueGitCredentialResponses, TemplatesListErrors, TemplatesListFamiliesErrors, TemplatesListFamiliesResponses, TemplatesListInputContractsErrors, TemplatesListInputContractsResponses, TemplatesListResponses, TemplatesOpenWorkspaceErrors, TemplatesOpenWorkspaceResponses, TemplatesPatchWorkspaceErrors, TemplatesPatchWorkspaceResponses, TemplatesPublishErrors, TemplatesPublishResponses, TemplatesPutWorkspaceAssetErrors, TemplatesPutWorkspaceAssetResponses, TemplatesRemoveErrors, TemplatesRemoveResponses, TemplatesRemoveWorkspaceResourceErrors, TemplatesRemoveWorkspaceResourceResponses, TemplatesRenameFamilyErrors, TemplatesRenameFamilyResponses, TemplatesRenderWorkspaceFixtureErrors, TemplatesRenderWorkspaceFixtureResponses, TemplatesResolveWorkspaceConflictErrors, TemplatesResolveWorkspaceConflictResponses, TemplatesRestoreWorkspaceErrors, TemplatesRestoreWorkspaceResponses, TemplatesSaveWorkspaceErrors, TemplatesSaveWorkspaceResponses, TemplatesUpdateErrors, TemplatesUpdateResponses, TemplatesWorkspaceHistoryErrors, TemplatesWorkspaceHistoryResponses, TrackingRecipientEmail, UnsubscribeAddEmailsErrors, UnsubscribeAddEmailsResponses, UnsubscribeCheckSubscriptionErrors, UnsubscribeCheckSubscriptionResponses, UnsubscribeCreateErrors, UnsubscribeCreateResponses, UnsubscribeId, UnsubscribeListErrors, UnsubscribeListMembersErrors, UnsubscribeListMembersResponses, UnsubscribeListResponses, UnsubscribeRemoveEmailsErrors, UnsubscribeRemoveEmailsResponses, UnsubscribeRemoveErrors, UnsubscribeRemoveResponses, UnsubscribeSetDefaultErrors, UnsubscribeSetDefaultResponses, UnsubscribeUpdateErrors, UnsubscribeUpdateResponses, UserId, VersionCursor, 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 { AnalyticsExportDataErrors, AnalyticsExportDataResponses, AnalyticsGetChannelStatsErrors, AnalyticsGetChannelStatsResponses, AnalyticsGetDeliveryMetricsErrors, AnalyticsGetDeliveryMetricsResponses, AnalyticsGetHourlyDistributionErrors, AnalyticsGetHourlyDistributionResponses, AnalyticsGetStatsErrors, AnalyticsGetStatsResponses, AnalyticsGetTopContactsErrors, AnalyticsGetTopContactsResponses, ApiKeyAccess, ApiKeyId, ApiKeyMailboxAccessUpdate, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, AttachmentId, AttachmentsDownloadUrlErrors, AttachmentsDownloadUrlResponses, AttachmentsGetByIdErrors, AttachmentsGetByIdResponses, AttachmentsListErrors, AttachmentsListResponses, AttachmentsRemoveErrors, AttachmentsRemoveResponses, BlockedEmailId, BrandAssets, BrandFooter, BrandsCreateErrors, BrandsCreateResponses, BrandsGetErrors, BrandsGetResponses, BrandsListErrors, BrandsListResponses, BrandsRemoveErrors, BrandsRemoveResponses, BrandsSetDefaultErrors, BrandsSetDefaultResponses, BrandsUpdateErrors, BrandsUpdateResponses, CampaignAudience, CampaignContentInput, CampaignId, CampaignPolicy, CampaignRunId, CampaignsArchiveErrors, CampaignsArchiveResponses, CampaignsCancelRunErrors, CampaignsCancelRunResponses, CampaignsCreateErrors, CampaignsCreateResponses, CampaignsGetErrors, CampaignsGetResponses, CampaignsGetRunErrors, CampaignsGetRunResponses, CampaignsListErrors, CampaignsListRecipientsErrors, CampaignsListRecipientsResponses, CampaignsListResponses, CampaignsListRunsErrors, CampaignsListRunsResponses, CampaignsPauseRunErrors, CampaignsPauseRunResponses, CampaignsResumeRunErrors, CampaignsResumeRunResponses, CampaignsScheduleRunErrors, CampaignsScheduleRunResponses, CampaignsUpdateErrors, CampaignsUpdateResponses, ContactGroupId, ContactGroupsAddMembersErrors, ContactGroupsAddMembersResponses, ContactGroupsCreateErrors, ContactGroupsCreateResponses, ContactGroupsEvaluateDynamicErrors, ContactGroupsEvaluateDynamicResponses, ContactGroupsGetByIdErrors, ContactGroupsGetByIdResponses, ContactGroupsGetMembersErrors, ContactGroupsGetMembersResponses, ContactGroupsListErrors, ContactGroupsListResponses, ContactGroupsPreviewErrors, ContactGroupsPreviewResponses, ContactGroupsRemoveErrors, ContactGroupsRemoveMembersErrors, ContactGroupsRemoveMembersResponses, ContactGroupsRemoveResponses, ContactGroupsUpdateErrors, ContactGroupsUpdateResponses, ContactId, ContactIdentityId, ContactIdentityInput, ContactLookup, ContactPreferences, ContactProfile, ContactProfileUpdate, ContactsAddIdentityErrors, ContactsAddIdentityResponses, ContactsAddTagsErrors, ContactsAddTagsResponses, 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, ContactsRemoveIdentityErrors, ContactsRemoveIdentityResponses, ContactsRemoveResponses, ContactsRemoveTagsErrors, ContactsRemoveTagsResponses, ContactsUpdateErrors, ContactsUpdateResponses, ConversationContext, ConversationId, ConversationsAddCategoriesErrors, ConversationsAddCategoriesResponses, ConversationsAddChannelsErrors, ConversationsAddChannelsResponses, ConversationsAddContactsErrors, ConversationsAddContactsResponses, ConversationsAddTagsErrors, ConversationsAddTagsResponses, ConversationsCreateErrors, ConversationsCreateResponses, ConversationsGetByIdErrors, ConversationsGetByIdResponses, ConversationsListErrors, ConversationsListMessagesErrors, ConversationsListMessagesResponses, ConversationsListResponses, ConversationsRemoveCategoriesErrors, ConversationsRemoveCategoriesResponses, ConversationsRemoveChannelsErrors, ConversationsRemoveChannelsResponses, ConversationsRemoveContactsErrors, ConversationsRemoveContactsResponses, ConversationsRemoveTagsErrors, ConversationsRemoveTagsResponses, ConversationsUpdateErrors, ConversationsUpdateResponses, Cursor, CustomFieldDefinitionId, CustomFieldsCreateErrors, CustomFieldsCreateResponses, CustomFieldsListErrors, CustomFieldsListResponses, CustomFieldsRemoveErrors, CustomFieldsRemoveResponses, CustomFieldsUpdateErrors, CustomFieldsUpdateResponses, DispatchSendMessagePayload, EmailAddBlockErrors, EmailAddBlockResponses, EmailAddDomainErrors, EmailAddDomainResponses, EmailAddSenderErrors, EmailAddSenderResponses, EmailAdvanceDomainVerificationErrors, EmailAdvanceDomainVerificationResponses, EmailAttachment, EmailBccRecipients, EmailBuildCustomTrackingDomainConnectApplyUrlErrors, EmailBuildCustomTrackingDomainConnectApplyUrlResponses, EmailBuildDomainConnectApplyUrlErrors, EmailBuildDomainConnectApplyUrlResponses, EmailCancelDomainWarmingBatchErrors, EmailCancelDomainWarmingBatchResponses, EmailCcRecipients, EmailCheckBlockedErrors, EmailCheckBlockedResponses, EmailCheckSenderVerificationErrors, EmailCheckSenderVerificationResponses, EmailClearDomainDefaultSenderErrors, EmailClearDomainDefaultSenderResponses, EmailCompleteCustomTrackingDomainConnectErrors, EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteDomainConnectErrors, EmailCompleteDomainConnectResponses, EmailCompleteDomainWarmingErrors, EmailCompleteDomainWarmingResponses, EmailContent, EmailCountSuppressionsErrors, EmailCountSuppressionsResponses, 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, EmailGetReceivingStatusErrors, EmailGetReceivingStatusResponses, EmailGetRecipientTrackingPreferenceErrors, EmailGetRecipientTrackingPreferenceResponses, EmailGetSenderErrors, EmailGetSenderResponses, EmailGetStatsErrors, EmailGetStatsResponses, EmailGetTrackingDefaultsErrors, EmailGetTrackingDefaultsResponses, EmailListBlocksErrors, EmailListBlocksResponses, EmailListDomainsErrors, EmailListDomainsResponses, EmailListForwardingRulesErrors, EmailListForwardingRulesResponses, EmailListSendersErrors, EmailListSendersResponses, EmailListSuppressionsErrors, EmailListSuppressionsResponses, EmailPauseDomainWarmingErrors, EmailPauseDomainWarmingResponses, EmailReapplyOnboardingReviewErrors, EmailReapplyOnboardingReviewResponses, EmailRecheckCustomTrackingErrors, EmailRecheckCustomTrackingResponses, 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, ExtensionInstallationId, ExtensionInstallationsDisableErrors, ExtensionInstallationsDisableResponses, ExtensionInstallationsEnableErrors, ExtensionInstallationsEnableResponses, ExtensionInstallationsGetErrors, ExtensionInstallationsGetResponses, ExtensionInstallationsGetRunErrors, ExtensionInstallationsGetRunResponses, ExtensionInstallationsInstallErrors, ExtensionInstallationsInstallResponses, ExtensionInstallationsListErrors, ExtensionInstallationsListResponses, ExtensionInstallationsListRunsErrors, ExtensionInstallationsListRunsResponses, ExtensionInstallationsUninstallErrors, ExtensionInstallationsUninstallResponses, ExtensionInstallationsUpgradeErrors, ExtensionInstallationsUpgradeResponses, ExtensionsGetErrors, ExtensionsGetResponses, ExtensionsGetVersionErrors, ExtensionsGetVersionResponses, ExtensionsListErrors, ExtensionsListResponses, ExtensionsListVersionsErrors, ExtensionsListVersionsResponses, ExtensionsPublishErrors, ExtensionsPublishResponses, ExtensionVersionId, FeedbackContext, FeedbackSendErrors, FeedbackSendResponses, ForwardingConditions, IanaTimezone, JsonObject, JsonValue, MailboxActionId, MailboxAddressId, MailboxDraftId, MailboxesAddThreadLabelsErrors, MailboxesAddThreadLabelsResponses, MailboxesApproveActionErrors, MailboxesApproveActionResponses, MailboxesCancelActionErrors, MailboxesCancelActionResponses, MailboxesCopyMessageAttachmentErrors, MailboxesCopyMessageAttachmentResponses, MailboxesCreateAddressErrors, MailboxesCreateAddressResponses, MailboxesCreateDraftErrors, MailboxesCreateDraftResponses, MailboxesCreateErrors, MailboxesCreateGrantErrors, MailboxesCreateGrantResponses, MailboxesCreateLabelErrors, MailboxesCreateLabelResponses, MailboxesCreateNoteErrors, MailboxesCreateNoteResponses, MailboxesCreatePolicyErrors, MailboxesCreatePolicyResponses, MailboxesCreateResponses, MailboxesDeleteDraftErrors, MailboxesDeleteDraftResponses, MailboxesDeleteLabelErrors, MailboxesDeleteLabelResponses, MailboxesDeleteNoteErrors, MailboxesDeleteNoteResponses, MailboxesDeletePolicyErrors, MailboxesDeletePolicyResponses, MailboxesDenyActionErrors, MailboxesDenyActionResponses, MailboxesDiscardMessageErrors, MailboxesDiscardMessageResponses, MailboxesForwardErrors, MailboxesForwardResponses, MailboxesGetActionErrors, MailboxesGetActionResponses, MailboxesGetAgentActivityErrors, MailboxesGetAgentActivityResponses, MailboxesGetDraftErrors, MailboxesGetDraftResponses, MailboxesGetErrors, MailboxesGetMessageAttachmentErrors, MailboxesGetMessageAttachmentResponses, MailboxesGetMessageErrors, MailboxesGetMessageRawErrors, MailboxesGetMessageRawResponses, MailboxesGetMessageResponses, MailboxesGetPolicyErrors, MailboxesGetPolicyResponses, MailboxesGetResponses, MailboxesGetThreadContentErrors, MailboxesGetThreadContentResponses, MailboxesGetThreadErrors, MailboxesGetThreadResponses, MailboxesListActionsErrors, MailboxesListActionsResponses, MailboxesListDraftsErrors, MailboxesListDraftsResponses, MailboxesListErrors, MailboxesListEventsErrors, MailboxesListEventsResponses, MailboxesListFoldersErrors, MailboxesListFoldersResponses, MailboxesListGrantsErrors, MailboxesListGrantsResponses, MailboxesListLabelsErrors, MailboxesListLabelsResponses, MailboxesListPoliciesErrors, MailboxesListPoliciesResponses, MailboxesListQuarantineErrors, MailboxesListQuarantineResponses, MailboxesListResponses, MailboxesListThreadMessagesErrors, MailboxesListThreadMessagesResponses, MailboxesListThreadNotesErrors, MailboxesListThreadNotesResponses, MailboxesListThreadsErrors, MailboxesListThreadsResponses, MailboxesPauseErrors, MailboxesPauseResponses, MailboxesReleaseMessageErrors, MailboxesReleaseMessageResponses, MailboxesRemoveAddressErrors, MailboxesRemoveAddressResponses, MailboxesRemoveErrors, MailboxesRemoveResponses, MailboxesRemoveThreadLabelsErrors, MailboxesRemoveThreadLabelsResponses, MailboxesReplyAllErrors, MailboxesReplyAllResponses, MailboxesReplyErrors, MailboxesReplyResponses, MailboxesResumeErrors, MailboxesResumeResponses, MailboxesRetryActionErrors, MailboxesRetryActionResponses, MailboxesRevokeGrantErrors, MailboxesRevokeGrantResponses, MailboxesSendDraftErrors, MailboxesSendDraftResponses, MailboxesSendMessageErrors, MailboxesSendMessageResponses, MailboxesUpdateDraftErrors, MailboxesUpdateDraftResponses, MailboxesUpdateErrors, MailboxesUpdateGrantErrors, MailboxesUpdateGrantResponses, MailboxesUpdateLabelErrors, MailboxesUpdateLabelResponses, MailboxesUpdateNoteErrors, MailboxesUpdateNoteResponses, MailboxesUpdatePolicyErrors, MailboxesUpdatePolicyResponses, MailboxesUpdateResponses, MailboxesUpdateThreadErrors, MailboxesUpdateThreadResponses, MailboxGrantId, MailboxGrantRole, MailboxId, MailboxLabelId, MailboxMetadata, MailboxMetadataPatch, MailboxNoteId, MailboxPolicyId, MailboxPolicyOutcomeKind, MailboxSendMode, MailboxThreadFolder, MailboxThreadId, MailboxThreadPriority, MediaCompleteErrors, MediaCompleteResponses, MediaCreateErrors, MediaCreateResponses, MediaDownloadUrlErrors, MediaDownloadUrlResponses, MediaGetByIdErrors, MediaGetByIdResponses, MediaId, MediaRemoveErrors, MediaRemoveResponses, MessageId, MessageMetadata, MessagesGetContentErrors, MessagesGetContentResponses, MessagesGetEmailErrors, MessagesGetEmailResponses, MessagesGetErrors, MessagesGetEventsErrors, MessagesGetEventsResponses, MessagesGetResponses, MessagesGetStatusErrors, MessagesGetStatusResponses, MessagesListDeliveriesErrors, MessagesListDeliveriesResponses, MessagesListErrors, MessagesListResponses, MessagesRemoveErrors, MessagesRemoveResponses, MessagesSendErrors, MessagesSendResponses, MessagesValidateEmailErrors, MessagesValidateEmailResponses, NamespaceId, NamespaceMetadata, NamespacesCreateErrors, NamespacesCreateResponses, NamespacesGetErrors, NamespacesGetResponses, NamespacesListErrors, NamespacesListResponses, NamespacesRemoveErrors, NamespacesRemoveResponses, NamespacesUpdateErrors, NamespacesUpdateResponses, OperationId, OperationsGetErrors, OperationsGetResponses, OperationsListErrors, OperationsListResponses, OperationsRetryErrors, OperationsRetryResponses, OrganizationsCreateErrors, OrganizationsCreateResponses, OrganizationsDeleteErrors, OrganizationsDeleteResponses, OrganizationsGetErrors, OrganizationsGetProfileErrors, OrganizationsGetProfileResponses, OrganizationsGetResponses, OrganizationsGetTrustTierErrors, OrganizationsGetTrustTierResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, RenderLocale, RenderTimeZone, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, ScheduledMessagesResumeErrors, ScheduledMessagesResumeResponses, SubscriptionsSubscribeErrors, SubscriptionsSubscribeResponses, SuppressionId, TemplateFamilyId, TemplateFromDefault, TemplateId, TemplateInputContractId, TemplateProjectId, TemplatePublicationId, TemplatesAddEntryErrors, TemplatesAddEntryResponses, TemplatesAttachFamilyMemberErrors, TemplatesAttachFamilyMemberResponses, TemplatesAttachWorkspaceResourceErrors, TemplatesAttachWorkspaceResourceResponses, TemplatesCheckWorkspaceErrors, TemplatesCheckWorkspaceResponses, TemplatesCreateErrors, TemplatesCreateFamilyErrors, TemplatesCreateFamilyFromTemplateErrors, TemplatesCreateFamilyFromTemplateResponses, TemplatesCreateFamilyResponses, TemplatesCreateResponses, TemplatesDeleteFamilyErrors, TemplatesDeleteFamilyResponses, TemplatesDetachFamilyMemberErrors, TemplatesDetachFamilyMemberResponses, TemplatesDiffWorkspaceErrors, TemplatesDiffWorkspaceResponses, TemplatesGetByIdErrors, TemplatesGetByIdResponses, TemplatesGetFamilyErrors, TemplatesGetFamilyResponses, TemplatesGetGitRepositoryErrors, TemplatesGetGitRepositoryResponses, TemplatesGetInputContractErrors, TemplatesGetInputContractResponses, TemplatesGetPublicationErrors, TemplatesGetPublicationResponses, TemplatesIssueGitCredentialErrors, TemplatesIssueGitCredentialResponses, TemplatesListErrors, TemplatesListFamiliesErrors, TemplatesListFamiliesResponses, TemplatesListInputContractsErrors, TemplatesListInputContractsResponses, TemplatesListResponses, TemplatesOpenWorkspaceErrors, TemplatesOpenWorkspaceResponses, TemplatesPatchWorkspaceErrors, TemplatesPatchWorkspaceResponses, TemplatesPublishErrors, TemplatesPublishResponses, TemplatesPutWorkspaceAssetErrors, TemplatesPutWorkspaceAssetResponses, TemplatesRemoveErrors, TemplatesRemoveResponses, TemplatesRemoveWorkspaceResourceErrors, TemplatesRemoveWorkspaceResourceResponses, TemplatesRenameFamilyErrors, TemplatesRenameFamilyResponses, TemplatesRenderPublicationErrors, TemplatesRenderPublicationResponses, TemplatesRenderWorkspaceFixtureErrors, TemplatesRenderWorkspaceFixtureResponses, TemplatesResolveWorkspaceConflictErrors, TemplatesResolveWorkspaceConflictResponses, TemplatesRestoreWorkspaceErrors, TemplatesRestoreWorkspaceResponses, TemplatesSaveWorkspaceErrors, TemplatesSaveWorkspaceResponses, TemplatesUpdateErrors, TemplatesUpdateResponses, TemplatesWorkspaceHistoryErrors, TemplatesWorkspaceHistoryResponses, TrackingRecipientEmail, UnsubscribeAddEmailsErrors, UnsubscribeAddEmailsResponses, UnsubscribeCheckSubscriptionErrors, UnsubscribeCheckSubscriptionResponses, UnsubscribeCreateErrors, UnsubscribeCreateResponses, UnsubscribeId, UnsubscribeListErrors, UnsubscribeListMembersErrors, UnsubscribeListMembersResponses, UnsubscribeListResponses, UnsubscribeRemoveEmailsErrors, UnsubscribeRemoveEmailsResponses, UnsubscribeRemoveErrors, UnsubscribeRemoveResponses, UnsubscribeSetDefaultErrors, UnsubscribeSetDefaultResponses, UnsubscribeUpdateErrors, UnsubscribeUpdateResponses, UserId, VersionCursor, 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
|
|
@@ -1200,13 +1200,16 @@ export declare class Contacts {
|
|
|
1200
1200
|
/**
|
|
1201
1201
|
* List contacts
|
|
1202
1202
|
*
|
|
1203
|
-
* Returns contact summaries for the organization, newest first, filterable by search term, status, and creation time (`after`, `before`). Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Read
|
|
1203
|
+
* Returns contact summaries for the organization, newest first, filterable by search term, status, and creation time (`after`, `before`). `fields` is a comma-separated list of defined custom field keys to return in each summary's `customFields`; omitted keys and unselected fields are not returned. Filter by one defined custom field with `customField` and a JSON-encoded scalar `customFieldValue` (for example, `"creator"`, `42`, or `true`). Both filter parameters are required together, and unknown keys or values of the wrong type are rejected. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Read full identities, profile, and metadata with `GET /v1/contacts/{id}`.
|
|
1204
1204
|
*/
|
|
1205
1205
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1206
1206
|
limit?: string | null | undefined;
|
|
1207
1207
|
cursor?: Cursor | null | undefined;
|
|
1208
1208
|
search?: string | null | undefined;
|
|
1209
1209
|
status?: "active" | "paused" | "blocked" | "archived" | null | undefined;
|
|
1210
|
+
fields?: string | null | undefined;
|
|
1211
|
+
customField?: string | null | undefined;
|
|
1212
|
+
customFieldValue?: string | null | undefined;
|
|
1210
1213
|
after?: string | null | undefined;
|
|
1211
1214
|
before?: string | null | undefined;
|
|
1212
1215
|
}, options?: Options<never, ThrowOnError>): RequestResult<ContactsListResponses, ContactsListErrors, ThrowOnError>;
|
|
@@ -1241,14 +1244,18 @@ export declare class Contacts {
|
|
|
1241
1244
|
/**
|
|
1242
1245
|
* Find or create a contact
|
|
1243
1246
|
*
|
|
1244
|
-
* Returns
|
|
1247
|
+
* Looks up exactly one identifier through `lookup: { type, value }`. Returns `{ contact, created: false }` unchanged when it exists. Otherwise creates the lookup identity (or external ID), applies `create` attributes, and returns `{ contact, created: true }`. Additional addresses belong in `create.identities`, custom fields in `create.profile.customFields`; custom field keys must be defined and values must match their types. An external ID lookup cannot be contradicted by `create.externalId`. Creation returns HTTP 409 ConflictError if an externalId or address belongs to another contact; the conflicting field is named and no contact is created. Use the update endpoint to change an existing contact.
|
|
1245
1248
|
*/
|
|
1246
|
-
static findOrCreate<ThrowOnError extends boolean = false>(parameters
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1249
|
+
static findOrCreate<ThrowOnError extends boolean = false>(parameters: {
|
|
1250
|
+
lookup: ContactLookup;
|
|
1251
|
+
create?: {
|
|
1252
|
+
name?: string | null | undefined;
|
|
1253
|
+
displayName?: string | null | null | undefined;
|
|
1254
|
+
avatar?: string | null | null | undefined;
|
|
1255
|
+
identities?: Array<ContactIdentityInput> | null | undefined;
|
|
1256
|
+
profile?: ContactProfile | null | null | undefined;
|
|
1257
|
+
externalId?: string | null | null | undefined;
|
|
1258
|
+
} | null | undefined;
|
|
1252
1259
|
}, options?: Options<never, ThrowOnError>): RequestResult<ContactsFindOrCreateResponses, ContactsFindOrCreateErrors, ThrowOnError>;
|
|
1253
1260
|
/**
|
|
1254
1261
|
* Delete a contact
|
|
@@ -1416,6 +1423,28 @@ export declare class Contacts {
|
|
|
1416
1423
|
export declare class Contacts2 {
|
|
1417
1424
|
static contacts: typeof Contacts;
|
|
1418
1425
|
}
|
|
1426
|
+
export declare class Subscriptions {
|
|
1427
|
+
/**
|
|
1428
|
+
* Request subscription confirmation
|
|
1429
|
+
*
|
|
1430
|
+
* Sends a confirmation email from your sender. Only the recipient's explicit confirmation adds them to the active static contact group and clears the optional unsubscribe group. The link expires after seven days and can be used once. A custom published email template receives confirmUrl. Sending follows ordinary sender, admission, billing, and brand-footer settings. Requires email send authority in addition to the declared contact grants, including the optional unsubscribe preference change.
|
|
1431
|
+
*/
|
|
1432
|
+
static subscribe<ThrowOnError extends boolean = false>(parameters: {
|
|
1433
|
+
email: string;
|
|
1434
|
+
contactGroupId: ContactGroupId;
|
|
1435
|
+
from: {
|
|
1436
|
+
email: string;
|
|
1437
|
+
name?: string | null | undefined;
|
|
1438
|
+
};
|
|
1439
|
+
unsubscribeGroupId?: UnsubscribeId | null | undefined;
|
|
1440
|
+
templateSlug?: string | null | undefined;
|
|
1441
|
+
consentIp?: string | null | undefined;
|
|
1442
|
+
consentSource?: string | null | undefined;
|
|
1443
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<SubscriptionsSubscribeResponses, SubscriptionsSubscribeErrors, ThrowOnError>;
|
|
1444
|
+
}
|
|
1445
|
+
export declare class Subscriptions2 {
|
|
1446
|
+
static subscriptions: typeof Subscriptions;
|
|
1447
|
+
}
|
|
1419
1448
|
export declare class ContactGroups {
|
|
1420
1449
|
/**
|
|
1421
1450
|
* List contact groups
|
|
@@ -2011,6 +2040,20 @@ export declare class Templates {
|
|
|
2011
2040
|
id: TemplateId;
|
|
2012
2041
|
publicationId: TemplatePublicationId;
|
|
2013
2042
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesGetPublicationResponses, TemplatesGetPublicationErrors, ThrowOnError>;
|
|
2043
|
+
/**
|
|
2044
|
+
* Render a template publication
|
|
2045
|
+
*
|
|
2046
|
+
* Renders one immutable publication against the `data` you pass, formatted in the `locale` and `timeZone` you name as a send formats them, and returns the subject, preheader, HTML and plain text a send would produce. `data` is validated against the publication's input schema exactly as a send validates it; invalid input returns a validation error that names each failing field. Nothing is sent or stored. Unpublished workspace edits are never rendered: only a publication id renders.
|
|
2047
|
+
*/
|
|
2048
|
+
static renderPublication<ThrowOnError extends boolean = false>(parameters: {
|
|
2049
|
+
id: TemplateId;
|
|
2050
|
+
publicationId: TemplatePublicationId;
|
|
2051
|
+
data: {
|
|
2052
|
+
[key: string]: JsonValue;
|
|
2053
|
+
};
|
|
2054
|
+
locale?: RenderLocale | undefined;
|
|
2055
|
+
timeZone?: RenderTimeZone | undefined;
|
|
2056
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesRenderPublicationResponses, TemplatesRenderPublicationErrors, ThrowOnError>;
|
|
2014
2057
|
/**
|
|
2015
2058
|
* List a template's input contracts
|
|
2016
2059
|
*
|
|
@@ -2157,12 +2200,12 @@ export declare class Webhooks {
|
|
|
2157
2200
|
/**
|
|
2158
2201
|
* Create a webhook
|
|
2159
2202
|
*
|
|
2160
|
-
* Creates a signed webhook endpoint for Samva delivery and inbound events, stores subscriptions, and returns the endpoint and signing secret with a 201 response.
|
|
2203
|
+
* Creates a signed webhook endpoint for Samva delivery and inbound events, stores subscriptions, and returns the endpoint and signing secret with a 201 response. `mailboxIds` and `namespaceId` confine mailbox events; when both are set, every mailbox must belong to the namespace.
|
|
2161
2204
|
*/
|
|
2162
2205
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
2163
2206
|
name: string;
|
|
2164
2207
|
url: string;
|
|
2165
|
-
eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded">;
|
|
2208
|
+
eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded">;
|
|
2166
2209
|
channels?: Array<"email"> | null | undefined;
|
|
2167
2210
|
mailboxIds?: [MailboxId] | null | undefined;
|
|
2168
2211
|
namespaceId?: NamespaceId | null | undefined;
|
|
@@ -2190,13 +2233,13 @@ export declare class Webhooks {
|
|
|
2190
2233
|
/**
|
|
2191
2234
|
* Update a webhook
|
|
2192
2235
|
*
|
|
2193
|
-
* Updates a webhook's name, URL, subscribed events, channels, custom headers, or status and returns the updated endpoint.
|
|
2236
|
+
* Updates a webhook's name, URL, subscribed events, channels, custom headers, mailbox scope, or status and returns the updated endpoint. A change to `mailboxIds` or `namespaceId` is checked as the endpoint will stand afterward: every mailbox must belong to the namespace when both are set.
|
|
2194
2237
|
*/
|
|
2195
2238
|
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
2196
2239
|
id: WebhookEndpointId;
|
|
2197
2240
|
name?: string | null | undefined;
|
|
2198
2241
|
url?: string | null | undefined;
|
|
2199
|
-
eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded"> | null | undefined;
|
|
2242
|
+
eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded"> | null | undefined;
|
|
2200
2243
|
channels?: Array<"email"> | null | null | undefined;
|
|
2201
2244
|
mailboxIds?: [MailboxId] | null | null | undefined;
|
|
2202
2245
|
namespaceId?: NamespaceId | null | null | undefined;
|
|
@@ -2295,6 +2338,12 @@ export declare class Organizations {
|
|
|
2295
2338
|
* Returns your identity in the organization authorized by your credential. The ID remains stable across reconnects and display-name changes. Removing and re-adding your membership creates a new ID.
|
|
2296
2339
|
*/
|
|
2297
2340
|
static getProfile<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<OrganizationsGetProfileResponses, OrganizationsGetProfileErrors, ThrowOnError>;
|
|
2341
|
+
/**
|
|
2342
|
+
* Get organization trust tier and sending limits
|
|
2343
|
+
*
|
|
2344
|
+
* Returns the current trust tier, plan and probation sending limits, and measured probation graduation progress. Limits are additional to billing allowance, domain readiness, and enforcement. Graduation is evaluated on delivery events.
|
|
2345
|
+
*/
|
|
2346
|
+
static getTrustTier<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<OrganizationsGetTrustTierResponses, OrganizationsGetTrustTierErrors, ThrowOnError>;
|
|
2298
2347
|
/**
|
|
2299
2348
|
* Get organization usage
|
|
2300
2349
|
*
|
|
@@ -2429,17 +2478,13 @@ export declare class Mailboxes {
|
|
|
2429
2478
|
/**
|
|
2430
2479
|
* Create a mailbox
|
|
2431
2480
|
*
|
|
2432
|
-
* Creates a mailbox with
|
|
2481
|
+
* Creates a mailbox with one address and returns it with status 201; the caller gets an admin grant on it. The address must be under the organization's Samva-hosted mail domain or a verified domain with receiving enabled, and the mailbox sends from it. The slug defaults to the address's local part. Pass `slug` when that is taken or not a valid slug. The mailbox receives mail from now on; mail that arrived earlier is not added to it. Conflicts if the address or slug is already in use. Returns 402 when the organization is at its plan's mailbox allowance or at its mailbox storage allowance; incoming mail is still received past the storage allowance.
|
|
2433
2482
|
*/
|
|
2434
2483
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
2435
2484
|
namespaceId?: NamespaceId | null | undefined;
|
|
2436
|
-
|
|
2437
|
-
|
|
2438
|
-
|
|
2439
|
-
defaultFrom?: {
|
|
2440
|
-
address: string;
|
|
2441
|
-
displayName?: string | null | undefined;
|
|
2442
|
-
} | null | undefined;
|
|
2485
|
+
address: string;
|
|
2486
|
+
name: string;
|
|
2487
|
+
slug?: string | null | undefined;
|
|
2443
2488
|
metadata?: MailboxMetadata | null | undefined;
|
|
2444
2489
|
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesCreateResponses, MailboxesCreateErrors, ThrowOnError>;
|
|
2445
2490
|
/**
|
|
@@ -2465,13 +2510,32 @@ export declare class Mailboxes {
|
|
|
2465
2510
|
*/
|
|
2466
2511
|
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
2467
2512
|
id: MailboxId;
|
|
2468
|
-
|
|
2513
|
+
name?: string | null | undefined;
|
|
2469
2514
|
metadata?: MailboxMetadataPatch | null | undefined;
|
|
2470
2515
|
defaultFrom?: {
|
|
2471
2516
|
address: string;
|
|
2472
2517
|
displayName?: string | null | null | undefined;
|
|
2473
2518
|
} | null | undefined;
|
|
2474
2519
|
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesUpdateResponses, MailboxesUpdateErrors, ThrowOnError>;
|
|
2520
|
+
/**
|
|
2521
|
+
* Add an address to a mailbox
|
|
2522
|
+
*
|
|
2523
|
+
* Adds an address to a mailbox and returns the mailbox with status 201. The address follows the same rules as the address of a new mailbox: it must be under the organization's Samva-hosted mail domain or a verified domain with receiving enabled, and no mailbox may already hold it (409). Mail sent to it reaches the mailbox from now on; the mailbox keeps sending from its current default address until you change `defaultFrom`.
|
|
2524
|
+
*/
|
|
2525
|
+
static createAddress<ThrowOnError extends boolean = false>(parameters: {
|
|
2526
|
+
id: MailboxId;
|
|
2527
|
+
address: string;
|
|
2528
|
+
displayName?: string | null | undefined;
|
|
2529
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesCreateAddressResponses, MailboxesCreateAddressErrors, ThrowOnError>;
|
|
2530
|
+
/**
|
|
2531
|
+
* Remove an address from a mailbox
|
|
2532
|
+
*
|
|
2533
|
+
* Removes an address from a mailbox and returns the mailbox. Mail sent to the address stops reaching the mailbox; its existing threads and messages stay. A mailbox keeps at least one address, so removing the last one is refused (422). When the removed address was the default `From`, the mailbox sends from its oldest remaining address, without a sender name of its own.
|
|
2534
|
+
*/
|
|
2535
|
+
static removeAddress<ThrowOnError extends boolean = false>(parameters: {
|
|
2536
|
+
id: MailboxId;
|
|
2537
|
+
addressId: MailboxAddressId;
|
|
2538
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesRemoveAddressResponses, MailboxesRemoveAddressErrors, ThrowOnError>;
|
|
2475
2539
|
/**
|
|
2476
2540
|
* Pause a mailbox
|
|
2477
2541
|
*
|
|
@@ -2769,7 +2833,7 @@ export declare class Mailboxes {
|
|
|
2769
2833
|
/**
|
|
2770
2834
|
* Send a new message
|
|
2771
2835
|
*
|
|
2772
|
-
*
|
|
2836
|
+
* Records a send action and returns 202 with its current receipt and a Location for action status. An installation, grant, or policy may require approval; otherwise the send is queued. Observe the same action through acceptance and mailbox completion. A policy refusal returns 403 with the recorded receipt.
|
|
2773
2837
|
*/
|
|
2774
2838
|
static sendMessage<ThrowOnError extends boolean = false>(parameters: {
|
|
2775
2839
|
"idempotency-key"?: string | null | undefined;
|
|
@@ -2811,6 +2875,16 @@ export declare class Mailboxes {
|
|
|
2811
2875
|
messageId: MessageId;
|
|
2812
2876
|
attachmentId: AttachmentId;
|
|
2813
2877
|
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesGetMessageAttachmentResponses, MailboxesGetMessageAttachmentErrors, ThrowOnError>;
|
|
2878
|
+
/**
|
|
2879
|
+
* Copy a message attachment
|
|
2880
|
+
*
|
|
2881
|
+
* Copies one of a received message's attachments into the organization's media and returns it as a draft attachment (`mediaId`), so a draft can carry it. A draft that forwards a message saves each original attachment this way.
|
|
2882
|
+
*/
|
|
2883
|
+
static copyMessageAttachment<ThrowOnError extends boolean = false>(parameters: {
|
|
2884
|
+
id: MailboxId;
|
|
2885
|
+
messageId: MessageId;
|
|
2886
|
+
attachmentId: AttachmentId;
|
|
2887
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesCopyMessageAttachmentResponses, MailboxesCopyMessageAttachmentErrors, ThrowOnError>;
|
|
2814
2888
|
/**
|
|
2815
2889
|
* Reply to a message
|
|
2816
2890
|
*
|
|
@@ -2963,20 +3037,48 @@ export declare class Mailboxes {
|
|
|
2963
3037
|
/**
|
|
2964
3038
|
* List mailbox actions
|
|
2965
3039
|
*
|
|
2966
|
-
* Returns the actions proposed on a mailbox, newest first, filterable by `state` (`approvalRequired` lists the sends waiting for a person) and creation time (`after`, `before`). Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
3040
|
+
* Returns the actions proposed on a mailbox, newest first, filterable by `threadId`, `state` (`approvalRequired` lists the sends waiting for a person), and creation time (`after`, `before`). Filters apply together within the mailbox. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
2967
3041
|
*/
|
|
2968
3042
|
static listActions<ThrowOnError extends boolean = false>(parameters: {
|
|
2969
3043
|
id: MailboxId;
|
|
2970
3044
|
limit?: string | null | undefined;
|
|
2971
3045
|
cursor?: Cursor | null | undefined;
|
|
2972
|
-
|
|
3046
|
+
threadId?: MailboxThreadId | null | undefined;
|
|
3047
|
+
state?: "proposed" | "allowed" | "approvalRequired" | "policyDenied" | "approved" | "approvalDenied" | "executing" | "executed" | "failed" | "queued" | "accepted" | "completed" | "notSent" | "uncertain" | null | undefined;
|
|
2973
3048
|
after?: string | null | undefined;
|
|
2974
3049
|
before?: string | null | undefined;
|
|
2975
3050
|
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesListActionsResponses, MailboxesListActionsErrors, ThrowOnError>;
|
|
3051
|
+
/**
|
|
3052
|
+
* Get a mailbox action
|
|
3053
|
+
*
|
|
3054
|
+
* Returns one action with its current progress. Send actions expose their immutable approved content, deadline, problem, and accepted receipt. A caller with mailbox read access may inspect actions; send-only callers may inspect only their own proposals. Acceptance and mailbox completion do not mean recipient delivery.
|
|
3055
|
+
*/
|
|
3056
|
+
static getAction<ThrowOnError extends boolean = false>(parameters: {
|
|
3057
|
+
id: MailboxId;
|
|
3058
|
+
actionId: MailboxActionId;
|
|
3059
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesGetActionResponses, MailboxesGetActionErrors, ThrowOnError>;
|
|
3060
|
+
/**
|
|
3061
|
+
* Cancel a mailbox send
|
|
3062
|
+
*
|
|
3063
|
+
* Cancels a definitely unsent action and reopens its draft atomically. Only an authorized person who proposed the send or can approve actions may cancel. Accepted sends return 409 with their winning receipt and cannot be withdrawn. An uncertain send requires reconciliation and cannot be cancelled as unsent.
|
|
3064
|
+
*/
|
|
3065
|
+
static cancelAction<ThrowOnError extends boolean = false>(parameters: {
|
|
3066
|
+
id: MailboxId;
|
|
3067
|
+
actionId: MailboxActionId;
|
|
3068
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesCancelActionResponses, MailboxesCancelActionErrors, ThrowOnError>;
|
|
3069
|
+
/**
|
|
3070
|
+
* Resume a mailbox send
|
|
3071
|
+
*
|
|
3072
|
+
* Resumes the same action only after its previous execution is confirmed ended and safe continuation is possible. Only an authorized person who proposed the send or can approve actions may retry. Automatic waits need no manual Retry. This does not grant new approval, reset the original deadline, replace the message identity, or resubmit an accepted or uncertain send.
|
|
3073
|
+
*/
|
|
3074
|
+
static retryAction<ThrowOnError extends boolean = false>(parameters: {
|
|
3075
|
+
id: MailboxId;
|
|
3076
|
+
actionId: MailboxActionId;
|
|
3077
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesRetryActionResponses, MailboxesRetryActionErrors, ThrowOnError>;
|
|
2976
3078
|
/**
|
|
2977
3079
|
* Approve a mailbox action
|
|
2978
3080
|
*
|
|
2979
|
-
*
|
|
3081
|
+
* Records approval of a send and returns 202 while it is pending. A send is queued for automatic retry within 15 minutes of approval; repeating approval does not extend this deadline. Accepted, completed, and notSent replays return 200. No expiry applies before approval. Only a person signed in or through OAuth may approve, and never the proposer. Non-send approvals execute synchronously and return 200 with their own execution states.
|
|
2980
3082
|
*/
|
|
2981
3083
|
static approveAction<ThrowOnError extends boolean = false>(parameters: {
|
|
2982
3084
|
id: MailboxId;
|
|
@@ -2995,7 +3097,7 @@ export declare class Mailboxes {
|
|
|
2995
3097
|
/**
|
|
2996
3098
|
* List mailbox events
|
|
2997
3099
|
*
|
|
2998
|
-
* Returns
|
|
3100
|
+
* Returns mailbox audit records, newest first, filterable by when they happened (`after`, `before`). Audit event types: `mailbox.created`, `address.attached`, `address.detached`, `email.received`, `email.released`, `email.sent`, `thread.created`, `action.proposed`, `action.policy_decided`, `action.approval_requested`, `action.approval_resolved`, `action.accepted`, `action.executed`, `action.failed`. Thread and draft changes have no dedicated audit event types. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
2999
3101
|
*/
|
|
3000
3102
|
static listEvents<ThrowOnError extends boolean = false>(parameters: {
|
|
3001
3103
|
id: MailboxId;
|