samva 0.13.0 → 0.14.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 +51 -6
- package/dist/{categories-Bcwq5jPV.js → categories-BGUBFdH9.js} +9 -1
- package/dist/client/sdk.gen.d.ts +105 -18
- package/dist/client/types.gen.d.ts +786 -118
- package/dist/{client-DYPNDvVU.js → client-CZjhOKPM.js} +694 -122
- 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 +6184 -1243
- 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 +1726 -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-BrNnSMF2.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-DT02zP7q.js} +13 -5
- package/dist/{operation-B_Ty1LG-.js → operation-g8nAzmIM.js} +29 -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-BFRKhpSS.js} +941 -38
- package/dist/service-map.d.ts +35 -0
- package/package.json +7 -2
|
@@ -257,7 +257,7 @@ export type MailboxEventPage = {
|
|
|
257
257
|
};
|
|
258
258
|
export type MailboxEvent = {
|
|
259
259
|
id: MailboxEventId;
|
|
260
|
-
type: "mailbox.created" | "address.attached" | "email.received" | "email.released" | "email.sent" | "thread.created" | "
|
|
260
|
+
type: "mailbox.created" | "address.attached" | "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";
|
|
261
261
|
threadId: MailboxThreadId | null;
|
|
262
262
|
actionId: MailboxActionId | null;
|
|
263
263
|
actor: {
|
|
@@ -273,10 +273,109 @@ export type MailboxEvent = {
|
|
|
273
273
|
export type MailboxActionId = string;
|
|
274
274
|
export type MailboxThreadId = string;
|
|
275
275
|
export type MailboxEventId = string;
|
|
276
|
-
export type
|
|
276
|
+
export type MailboxSendConflictError = {
|
|
277
|
+
_tag: "MailboxSendConflictError";
|
|
278
|
+
message: string;
|
|
279
|
+
resource: string;
|
|
280
|
+
id: MailboxActionId;
|
|
281
|
+
receipt: MailboxSendReceipt;
|
|
282
|
+
};
|
|
283
|
+
export type MailboxSendReceipt = {
|
|
284
|
+
actionId: MailboxActionId;
|
|
285
|
+
draftId: MailboxDraftId | null;
|
|
286
|
+
messageId: MessageId | null;
|
|
287
|
+
threadId: MailboxThreadId | null;
|
|
288
|
+
state: "approvalRequired" | "queued" | "accepted" | "completed" | "notSent" | "uncertain";
|
|
289
|
+
acceptedAt: string | null;
|
|
290
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
291
|
+
reviewExpectedAt: string | null;
|
|
292
|
+
skippedRecipients: Array<SkippedRecipient>;
|
|
293
|
+
executeUntil: string | null;
|
|
294
|
+
retryAt: string | null;
|
|
295
|
+
problem: MailboxSendOutcome | null;
|
|
296
|
+
retryEligible: boolean;
|
|
297
|
+
decision: MailboxActionDecision | null;
|
|
298
|
+
createdAt: string;
|
|
299
|
+
updatedAt: string;
|
|
300
|
+
};
|
|
301
|
+
export type MailboxActionDecision = {
|
|
302
|
+
outcome: "allow" | "requireApproval" | "deny";
|
|
303
|
+
reason: string | null;
|
|
304
|
+
policyId: MailboxPolicyId | null;
|
|
305
|
+
source: "grant" | "installation" | "policy" | null;
|
|
306
|
+
decidedAt: string;
|
|
307
|
+
};
|
|
308
|
+
export type MailboxPolicyId = string;
|
|
309
|
+
export type MailboxSendOutcome = {
|
|
310
|
+
code: string;
|
|
311
|
+
message: string;
|
|
312
|
+
error?: MailboxSendError | null | undefined;
|
|
313
|
+
};
|
|
314
|
+
export type MailboxSendError = {
|
|
315
|
+
_tag: "SenderNotReadyError";
|
|
316
|
+
message: string;
|
|
317
|
+
sender: string;
|
|
318
|
+
retryAfterSeconds?: number | null | undefined;
|
|
319
|
+
} | {
|
|
320
|
+
_tag: "RateLimitedError";
|
|
321
|
+
message: string;
|
|
322
|
+
retryAfterSeconds: number;
|
|
323
|
+
} | {
|
|
324
|
+
_tag: "OnboardingReviewRequiredError";
|
|
325
|
+
message: string;
|
|
326
|
+
code: "review_required" | "review_in_progress" | "information_required" | "review_rejected" | "identity_review_required" | "identity_review_rejected" | "identity_changed";
|
|
327
|
+
decision: "undecided" | "approved" | "rejected";
|
|
328
|
+
stage: "collecting" | "automated_review" | "manual_review" | "information_requested" | "complete";
|
|
329
|
+
nextAction: "wait_for_review" | "provide_information" | "verify_sending_identity" | "reapply" | "contact_support";
|
|
330
|
+
identityId?: string | null | undefined;
|
|
331
|
+
} | {
|
|
332
|
+
_tag: "PaymentRequiredError";
|
|
333
|
+
message: string;
|
|
334
|
+
resource: string;
|
|
335
|
+
currentUsage: number;
|
|
336
|
+
limit: number;
|
|
337
|
+
} | {
|
|
338
|
+
_tag: "ValidationError";
|
|
339
|
+
message: string;
|
|
340
|
+
fields?: {
|
|
341
|
+
[key: string]: Array<string>;
|
|
342
|
+
} | null | undefined;
|
|
343
|
+
} | {
|
|
344
|
+
_tag: "ForbiddenError";
|
|
345
|
+
message: string;
|
|
346
|
+
} | {
|
|
347
|
+
_tag: "ResourceNotFoundError";
|
|
348
|
+
resource: string;
|
|
349
|
+
id: string;
|
|
350
|
+
message: string;
|
|
351
|
+
};
|
|
352
|
+
export type SkippedRecipient = {
|
|
353
|
+
address: string;
|
|
354
|
+
reason: "bounce" | "complaint" | "unsubscribe" | "manual" | "group-unsubscribe";
|
|
355
|
+
unsubscribeGroupId?: UnsubscribeId | null | undefined;
|
|
356
|
+
};
|
|
357
|
+
export type UnsubscribeId = string;
|
|
358
|
+
export type MessageId = string;
|
|
359
|
+
export type MailboxDraftId = string;
|
|
360
|
+
export type MailboxAction = MailboxSendAction | MailboxNonSendAction;
|
|
361
|
+
export type MailboxNonSendAction = {
|
|
277
362
|
id: MailboxActionId;
|
|
278
|
-
|
|
363
|
+
source: "humanUi" | "externalApi" | "aiSdkTool" | "extension" | "externalAgent" | "samvaManagedAgent" | "system";
|
|
364
|
+
proposedBy: {
|
|
365
|
+
kind: "user" | "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system";
|
|
366
|
+
id: string;
|
|
367
|
+
displayName?: string | null | undefined;
|
|
368
|
+
};
|
|
369
|
+
threadId: MailboxThreadId | null;
|
|
370
|
+
draftId: MailboxDraftId | null;
|
|
371
|
+
decision: MailboxActionDecision | null;
|
|
372
|
+
createdAt: string;
|
|
373
|
+
updatedAt: string;
|
|
374
|
+
type: "updateDraft" | "createNote" | "assignThread" | "changeThreadState" | "call" | "extensionRequest";
|
|
279
375
|
state: "proposed" | "allowed" | "approvalRequired" | "policyDenied" | "approved" | "approvalDenied" | "executing" | "executed" | "failed";
|
|
376
|
+
};
|
|
377
|
+
export type MailboxSendAction = {
|
|
378
|
+
id: MailboxActionId;
|
|
280
379
|
source: "humanUi" | "externalApi" | "aiSdkTool" | "extension" | "externalAgent" | "samvaManagedAgent" | "system";
|
|
281
380
|
proposedBy: {
|
|
282
381
|
kind: "user" | "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system";
|
|
@@ -288,15 +387,36 @@ export type MailboxAction = {
|
|
|
288
387
|
decision: MailboxActionDecision | null;
|
|
289
388
|
createdAt: string;
|
|
290
389
|
updatedAt: string;
|
|
390
|
+
type: "sendMessage" | "reply";
|
|
391
|
+
state: "approvalRequired" | "queued" | "accepted" | "completed" | "notSent" | "uncertain";
|
|
392
|
+
send: MailboxSendReceipt;
|
|
393
|
+
intent: MailboxSendSnapshot | null;
|
|
394
|
+
};
|
|
395
|
+
export type MailboxSendSnapshot = {
|
|
396
|
+
draftRevision: number;
|
|
397
|
+
from: string;
|
|
398
|
+
fromName: string | null;
|
|
399
|
+
to: [string, ...Array<string>];
|
|
400
|
+
cc: Array<string>;
|
|
401
|
+
bcc: Array<string>;
|
|
402
|
+
replyTo: Array<string>;
|
|
403
|
+
subject: string;
|
|
404
|
+
text: string | null;
|
|
405
|
+
html: string | null;
|
|
406
|
+
attachments: Array<EmailAttachment>;
|
|
407
|
+
threadId: MailboxThreadId | null;
|
|
408
|
+
conversationId: ConversationId | null;
|
|
409
|
+
inReplyToMessageId: MessageId | null;
|
|
291
410
|
};
|
|
292
|
-
export type
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
411
|
+
export type ConversationId = string;
|
|
412
|
+
export type EmailAttachment = {
|
|
413
|
+
filename: string;
|
|
414
|
+
content?: string | null | undefined;
|
|
415
|
+
mediaId?: MediaId | null | undefined;
|
|
416
|
+
contentType: string;
|
|
417
|
+
size: number;
|
|
297
418
|
};
|
|
298
|
-
export type
|
|
299
|
-
export type MailboxDraftId = string;
|
|
419
|
+
export type MediaId = string;
|
|
300
420
|
export type DenyMailboxActionPayload = {
|
|
301
421
|
reason: string;
|
|
302
422
|
};
|
|
@@ -304,23 +424,23 @@ export type BillingProviderError = {
|
|
|
304
424
|
_tag: "BillingProviderError";
|
|
305
425
|
message: string;
|
|
306
426
|
};
|
|
307
|
-
export type
|
|
308
|
-
_tag: "
|
|
427
|
+
export type PaymentRequiredError = {
|
|
428
|
+
_tag: "PaymentRequiredError";
|
|
309
429
|
message: string;
|
|
310
|
-
|
|
311
|
-
|
|
430
|
+
resource: string;
|
|
431
|
+
currentUsage: number;
|
|
432
|
+
limit: number;
|
|
312
433
|
};
|
|
313
434
|
export type RateLimitedError = {
|
|
314
435
|
_tag: "RateLimitedError";
|
|
315
436
|
message: string;
|
|
316
437
|
retryAfterSeconds: number;
|
|
317
438
|
};
|
|
318
|
-
export type
|
|
319
|
-
_tag: "
|
|
439
|
+
export type SenderNotReadyError = {
|
|
440
|
+
_tag: "SenderNotReadyError";
|
|
320
441
|
message: string;
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
limit: number;
|
|
442
|
+
sender: string;
|
|
443
|
+
retryAfterSeconds?: number | null | undefined;
|
|
324
444
|
};
|
|
325
445
|
export type OnboardingReviewRequiredError = {
|
|
326
446
|
_tag: "OnboardingReviewRequiredError";
|
|
@@ -331,32 +451,40 @@ export type OnboardingReviewRequiredError = {
|
|
|
331
451
|
nextAction: "wait_for_review" | "provide_information" | "verify_sending_identity" | "reapply" | "contact_support";
|
|
332
452
|
identityId?: string | null | undefined;
|
|
333
453
|
};
|
|
334
|
-
export type
|
|
335
|
-
|
|
336
|
-
|
|
454
|
+
export type MailboxSendRefusedError = {
|
|
455
|
+
_tag: "MailboxSendRefusedError";
|
|
456
|
+
message: string;
|
|
457
|
+
receipt: MailboxSendReceipt;
|
|
337
458
|
};
|
|
338
|
-
export type
|
|
459
|
+
export type MailboxPendingAction = MailboxSendAction | MailboxNonSendAction;
|
|
460
|
+
export type MailboxPendingSendReceipt = {
|
|
339
461
|
actionId: MailboxActionId;
|
|
462
|
+
draftId: MailboxDraftId | null;
|
|
340
463
|
messageId: MessageId | null;
|
|
341
|
-
threadId: MailboxThreadId;
|
|
342
|
-
|
|
343
|
-
|
|
464
|
+
threadId: MailboxThreadId | null;
|
|
465
|
+
state: "approvalRequired" | "queued" | "accepted" | "completed" | "notSent" | "uncertain";
|
|
466
|
+
acceptedAt: string | null;
|
|
467
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
344
468
|
reviewExpectedAt: string | null;
|
|
345
469
|
skippedRecipients: Array<SkippedRecipient>;
|
|
470
|
+
executeUntil: string | null;
|
|
471
|
+
retryAt: string | null;
|
|
472
|
+
problem: MailboxSendOutcome | null;
|
|
473
|
+
retryEligible: boolean;
|
|
474
|
+
decision: MailboxActionDecision | null;
|
|
346
475
|
createdAt: string;
|
|
476
|
+
updatedAt: string;
|
|
347
477
|
};
|
|
348
|
-
export type
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
unsubscribeGroupId?: UnsubscribeId | null | undefined;
|
|
478
|
+
export type MailboxActionPage = {
|
|
479
|
+
items: Array<MailboxAction>;
|
|
480
|
+
nextCursor: string | null;
|
|
352
481
|
};
|
|
353
|
-
export type UnsubscribeId = string;
|
|
354
|
-
export type MessageId = string;
|
|
355
482
|
export type MailboxDraft = {
|
|
356
483
|
id: MailboxDraftId;
|
|
357
484
|
threadId: MailboxThreadId | null;
|
|
358
485
|
inReplyToMessageId: MessageId | null;
|
|
359
486
|
state: MailboxDraftState;
|
|
487
|
+
lockedByActionId: MailboxActionId | null;
|
|
360
488
|
to: Array<string>;
|
|
361
489
|
subject: string | null;
|
|
362
490
|
createdAt: string;
|
|
@@ -368,15 +496,7 @@ export type MailboxDraft = {
|
|
|
368
496
|
text: string | null;
|
|
369
497
|
attachments: Array<EmailAttachment>;
|
|
370
498
|
};
|
|
371
|
-
export type
|
|
372
|
-
filename: string;
|
|
373
|
-
content?: string | null | undefined;
|
|
374
|
-
mediaId?: MediaId | null | undefined;
|
|
375
|
-
contentType: string;
|
|
376
|
-
size: number;
|
|
377
|
-
};
|
|
378
|
-
export type MediaId = string;
|
|
379
|
-
export type MailboxDraftState = "saved" | "approvalPending" | "sent";
|
|
499
|
+
export type MailboxDraftState = "saved" | "locked" | "sent";
|
|
380
500
|
export type UpdateMailboxDraftPayload = {
|
|
381
501
|
to?: Array<string> | null | undefined;
|
|
382
502
|
cc?: Array<string> | null | null | undefined;
|
|
@@ -407,6 +527,7 @@ export type MailboxDraftSummary = {
|
|
|
407
527
|
threadId: MailboxThreadId | null;
|
|
408
528
|
inReplyToMessageId: MessageId | null;
|
|
409
529
|
state: MailboxDraftState;
|
|
530
|
+
lockedByActionId: MailboxActionId | null;
|
|
410
531
|
to: Array<string>;
|
|
411
532
|
subject: string | null;
|
|
412
533
|
createdAt: string;
|
|
@@ -447,11 +568,18 @@ export type ReplyMailboxMessagePayload = {
|
|
|
447
568
|
html?: string | null | undefined;
|
|
448
569
|
attachments?: Array<EmailAttachment> | null | undefined;
|
|
449
570
|
};
|
|
571
|
+
export type MailboxCopiedAttachment = {
|
|
572
|
+
filename: string;
|
|
573
|
+
content?: string | null | undefined;
|
|
574
|
+
mediaId?: MediaId | null | undefined;
|
|
575
|
+
contentType: string;
|
|
576
|
+
size: number;
|
|
577
|
+
};
|
|
578
|
+
export type AttachmentId = string;
|
|
450
579
|
export type MailboxDownloadUrl = {
|
|
451
580
|
url: string;
|
|
452
581
|
expiresAt: string;
|
|
453
582
|
};
|
|
454
|
-
export type AttachmentId = string;
|
|
455
583
|
export type MailboxMessage = {
|
|
456
584
|
id: MessageId;
|
|
457
585
|
threadId: MailboxThreadId;
|
|
@@ -508,7 +636,6 @@ export type MailboxMessageSender = {
|
|
|
508
636
|
displayName?: string | null | undefined;
|
|
509
637
|
address: string;
|
|
510
638
|
};
|
|
511
|
-
export type ConversationId = string;
|
|
512
639
|
export type SendMailboxMessagePayload = {
|
|
513
640
|
to: [string, ...Array<string>];
|
|
514
641
|
cc?: Array<string> | null | undefined;
|
|
@@ -729,13 +856,13 @@ export type MailboxAgentActivity = {
|
|
|
729
856
|
count: number;
|
|
730
857
|
}>;
|
|
731
858
|
byState: Array<{
|
|
732
|
-
state: "proposed" | "allowed" | "approvalRequired" | "policyDenied" | "approved" | "approvalDenied" | "executing" | "executed" | "failed";
|
|
859
|
+
state: "proposed" | "allowed" | "approvalRequired" | "policyDenied" | "approved" | "approvalDenied" | "executing" | "executed" | "failed" | "queued" | "accepted" | "completed" | "notSent" | "uncertain";
|
|
733
860
|
count: number;
|
|
734
861
|
}>;
|
|
735
862
|
};
|
|
736
863
|
events: {
|
|
737
864
|
byType: Array<{
|
|
738
|
-
type: "mailbox.created" | "address.attached" | "email.received" | "email.released" | "email.sent" | "thread.created" | "
|
|
865
|
+
type: "mailbox.created" | "address.attached" | "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";
|
|
739
866
|
count: number;
|
|
740
867
|
}>;
|
|
741
868
|
};
|
|
@@ -1041,7 +1168,7 @@ export type WebhookEndpoint = {
|
|
|
1041
1168
|
id: WebhookEndpointId;
|
|
1042
1169
|
name: string;
|
|
1043
1170
|
url: string;
|
|
1044
|
-
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">;
|
|
1171
|
+
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">;
|
|
1045
1172
|
channels: Array<"email"> | null;
|
|
1046
1173
|
mailboxIds: Array<MailboxId> | null;
|
|
1047
1174
|
namespaceId: NamespaceId | null;
|
|
@@ -1055,7 +1182,7 @@ export type WebhookEndpoint = {
|
|
|
1055
1182
|
export type UpdateWebhookPayload = {
|
|
1056
1183
|
name?: string | null | undefined;
|
|
1057
1184
|
url?: string | null | undefined;
|
|
1058
|
-
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;
|
|
1185
|
+
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;
|
|
1059
1186
|
channels?: Array<"email"> | null | null | undefined;
|
|
1060
1187
|
mailboxIds?: [MailboxId, ...Array<MailboxId>] | null | null | undefined;
|
|
1061
1188
|
namespaceId?: NamespaceId | null | null | undefined;
|
|
@@ -1072,7 +1199,7 @@ export type WebhookEndpointListItem = {
|
|
|
1072
1199
|
id: WebhookEndpointId;
|
|
1073
1200
|
name: string;
|
|
1074
1201
|
url: string;
|
|
1075
|
-
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">;
|
|
1202
|
+
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">;
|
|
1076
1203
|
channels: Array<"email"> | null;
|
|
1077
1204
|
mailboxIds: Array<MailboxId> | null;
|
|
1078
1205
|
namespaceId: NamespaceId | null;
|
|
@@ -1094,7 +1221,7 @@ export type WebhookDeliveryCounts = {
|
|
|
1094
1221
|
export type CreateWebhookPayload = {
|
|
1095
1222
|
name: string;
|
|
1096
1223
|
url: string;
|
|
1097
|
-
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">;
|
|
1224
|
+
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">;
|
|
1098
1225
|
channels?: Array<"email"> | null | undefined;
|
|
1099
1226
|
mailboxIds?: [MailboxId, ...Array<MailboxId>] | null | undefined;
|
|
1100
1227
|
namespaceId?: NamespaceId | null | undefined;
|
|
@@ -1186,6 +1313,25 @@ export type TemplateInputContractPage = {
|
|
|
1186
1313
|
nextCursor: string | null;
|
|
1187
1314
|
};
|
|
1188
1315
|
export type VersionCursor = string;
|
|
1316
|
+
export type TemplatePublicationRender = {
|
|
1317
|
+
subject: string;
|
|
1318
|
+
preheader?: string | undefined;
|
|
1319
|
+
html: string;
|
|
1320
|
+
text: string;
|
|
1321
|
+
};
|
|
1322
|
+
export type TemplatePublicationId = string;
|
|
1323
|
+
export type RenderTemplatePublicationPayload = {
|
|
1324
|
+
/**
|
|
1325
|
+
* The input to render with, validated against the publication's input schema.
|
|
1326
|
+
*/
|
|
1327
|
+
data: {
|
|
1328
|
+
[key: string]: JsonValue;
|
|
1329
|
+
};
|
|
1330
|
+
locale?: RenderLocale | undefined;
|
|
1331
|
+
timeZone?: RenderTimeZone | undefined;
|
|
1332
|
+
};
|
|
1333
|
+
export type RenderTimeZone = string;
|
|
1334
|
+
export type RenderLocale = string;
|
|
1189
1335
|
export type BrandRenderedFooter = {
|
|
1190
1336
|
withUnsubscribe: BrandFooterBlock;
|
|
1191
1337
|
withoutUnsubscribe: BrandFooterBlock;
|
|
@@ -1194,7 +1340,6 @@ export type BrandFooterBlock = {
|
|
|
1194
1340
|
html: string;
|
|
1195
1341
|
text: string;
|
|
1196
1342
|
};
|
|
1197
|
-
export type TemplatePublicationId = string;
|
|
1198
1343
|
export type Template = {
|
|
1199
1344
|
id: TemplateId;
|
|
1200
1345
|
slug: string;
|
|
@@ -1422,6 +1567,54 @@ export type ContactGroupPage = {
|
|
|
1422
1567
|
}>;
|
|
1423
1568
|
nextCursor: string | null;
|
|
1424
1569
|
};
|
|
1570
|
+
export type DeliveryUnavailableError = {
|
|
1571
|
+
_tag: "DeliveryUnavailableError";
|
|
1572
|
+
message: string;
|
|
1573
|
+
retryAfterSeconds: number;
|
|
1574
|
+
};
|
|
1575
|
+
export type FlagDisabledError = {
|
|
1576
|
+
_tag: "FlagDisabledError";
|
|
1577
|
+
flag: string;
|
|
1578
|
+
message: string;
|
|
1579
|
+
};
|
|
1580
|
+
export type CampaignFooterRequiredError = {
|
|
1581
|
+
_tag: "CampaignFooterRequiredError";
|
|
1582
|
+
message: string;
|
|
1583
|
+
};
|
|
1584
|
+
export type BrandAddressRequiredError = {
|
|
1585
|
+
_tag: "BrandAddressRequiredError";
|
|
1586
|
+
message: string;
|
|
1587
|
+
brand: string | null;
|
|
1588
|
+
};
|
|
1589
|
+
export type ExternalServiceError = {
|
|
1590
|
+
_tag: "ExternalServiceError";
|
|
1591
|
+
message: string;
|
|
1592
|
+
};
|
|
1593
|
+
export type SubscribeResult = {
|
|
1594
|
+
success: boolean;
|
|
1595
|
+
expiresAt: string;
|
|
1596
|
+
};
|
|
1597
|
+
export type SubscribePayload = {
|
|
1598
|
+
/**
|
|
1599
|
+
* The recipient email address; confirmation proves consent for this address.
|
|
1600
|
+
*/
|
|
1601
|
+
email: string;
|
|
1602
|
+
contactGroupId: ContactGroupId;
|
|
1603
|
+
/**
|
|
1604
|
+
* Your verified email sender. The ordinary send pipeline selects its domain and customer brand.
|
|
1605
|
+
*/
|
|
1606
|
+
from: {
|
|
1607
|
+
email: string;
|
|
1608
|
+
name?: string | null | undefined;
|
|
1609
|
+
};
|
|
1610
|
+
/**
|
|
1611
|
+
* Clear this unsubscribe group after confirmation; all other opt-outs remain.
|
|
1612
|
+
*/
|
|
1613
|
+
unsubscribeGroupId?: UnsubscribeId | null | undefined;
|
|
1614
|
+
templateSlug?: string | null | undefined;
|
|
1615
|
+
consentIp?: string | null | undefined;
|
|
1616
|
+
consentSource?: string | null | undefined;
|
|
1617
|
+
};
|
|
1425
1618
|
export type ContactGroupMembershipPage = {
|
|
1426
1619
|
items: Array<{
|
|
1427
1620
|
id: ContactGroupId;
|
|
@@ -1515,6 +1708,16 @@ export type ContactProfileUpdate = {
|
|
|
1515
1708
|
location?: ContactLocation | null | null | undefined;
|
|
1516
1709
|
customFields?: ContactCustomFields | null | undefined;
|
|
1517
1710
|
};
|
|
1711
|
+
export type ContactLookup = {
|
|
1712
|
+
type: "email";
|
|
1713
|
+
value: string;
|
|
1714
|
+
} | {
|
|
1715
|
+
type: "phone";
|
|
1716
|
+
value: string;
|
|
1717
|
+
} | {
|
|
1718
|
+
type: "externalId";
|
|
1719
|
+
value: string;
|
|
1720
|
+
};
|
|
1518
1721
|
export type ContactPage = {
|
|
1519
1722
|
items: Array<ContactSummary>;
|
|
1520
1723
|
nextCursor: string | null;
|
|
@@ -1528,6 +1731,7 @@ export type ContactSummary = {
|
|
|
1528
1731
|
channels: Array<"email">;
|
|
1529
1732
|
tags: Array<string>;
|
|
1530
1733
|
lists: Array<ContactListMembership>;
|
|
1734
|
+
customFields?: ContactCustomFields | null | undefined;
|
|
1531
1735
|
lastActiveAt: string | null;
|
|
1532
1736
|
createdAt: string;
|
|
1533
1737
|
};
|
|
@@ -1616,7 +1820,7 @@ export type MessageSummary = {
|
|
|
1616
1820
|
from: string | null;
|
|
1617
1821
|
to: Array<string>;
|
|
1618
1822
|
subject: string | null;
|
|
1619
|
-
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | null;
|
|
1823
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
1620
1824
|
createdAt: string;
|
|
1621
1825
|
};
|
|
1622
1826
|
export type ConversationPage = {
|
|
@@ -1901,10 +2105,6 @@ export type SuppressionEntry = {
|
|
|
1901
2105
|
expiresAt: string | null;
|
|
1902
2106
|
createdAt: string;
|
|
1903
2107
|
};
|
|
1904
|
-
export type ExternalServiceError = {
|
|
1905
|
-
_tag: "ExternalServiceError";
|
|
1906
|
-
message: string;
|
|
1907
|
-
};
|
|
1908
2108
|
export type EmailSenderId = string;
|
|
1909
2109
|
export type EmailSenderPage = {
|
|
1910
2110
|
items: Array<{
|
|
@@ -2306,7 +2506,10 @@ export type EmailContent = {
|
|
|
2306
2506
|
timeZone?: RenderTimeZone | undefined;
|
|
2307
2507
|
inReplyToMessageId?: MessageId | null | undefined;
|
|
2308
2508
|
replyTo?: ReplyToAddresses | undefined;
|
|
2309
|
-
|
|
2509
|
+
/**
|
|
2510
|
+
* The unsubscribe group for this send. Omit to inherit the template group; null disables group inheritance for a direct send. Campaigns require a group.
|
|
2511
|
+
*/
|
|
2512
|
+
unsubscribeGroupId?: UnsubscribeId | null | null | undefined;
|
|
2310
2513
|
tracking?: EmailTrackingOverrideV1 | undefined;
|
|
2311
2514
|
footer?: EmailFooterOverride | undefined;
|
|
2312
2515
|
};
|
|
@@ -2327,28 +2530,12 @@ export type EmailTrackingOverrideV1 = {
|
|
|
2327
2530
|
clicks?: boolean | undefined;
|
|
2328
2531
|
};
|
|
2329
2532
|
export type ReplyToAddresses = Array<string> | null | null;
|
|
2330
|
-
export type RenderTimeZone = string;
|
|
2331
|
-
export type RenderLocale = string;
|
|
2332
2533
|
export type TemplateData = JsonObject | null;
|
|
2333
2534
|
export type EmailAttachments = Array<EmailAttachment> | null;
|
|
2334
2535
|
export type CampaignRunPage = {
|
|
2335
2536
|
items: Array<CampaignRun>;
|
|
2336
2537
|
nextCursor: string | null;
|
|
2337
2538
|
};
|
|
2338
|
-
export type CampaignFooterRequiredError = {
|
|
2339
|
-
_tag: "CampaignFooterRequiredError";
|
|
2340
|
-
message: string;
|
|
2341
|
-
};
|
|
2342
|
-
export type BrandAddressRequiredError = {
|
|
2343
|
-
_tag: "BrandAddressRequiredError";
|
|
2344
|
-
message: string;
|
|
2345
|
-
brand: string | null;
|
|
2346
|
-
};
|
|
2347
|
-
export type FlagDisabledError = {
|
|
2348
|
-
_tag: "FlagDisabledError";
|
|
2349
|
-
flag: string;
|
|
2350
|
-
message: string;
|
|
2351
|
-
};
|
|
2352
2539
|
export type Campaign = {
|
|
2353
2540
|
id: CampaignId;
|
|
2354
2541
|
name: string;
|
|
@@ -2400,7 +2587,10 @@ export type EmailDispatchContent = {
|
|
|
2400
2587
|
timeZone?: RenderTimeZone | undefined;
|
|
2401
2588
|
inReplyToMessageId?: MessageId | null | undefined;
|
|
2402
2589
|
replyTo?: ReplyToAddresses | undefined;
|
|
2403
|
-
|
|
2590
|
+
/**
|
|
2591
|
+
* The unsubscribe group for this send. Omit to inherit the template group; null disables group inheritance for a direct send. Campaigns require a group.
|
|
2592
|
+
*/
|
|
2593
|
+
unsubscribeGroupId?: UnsubscribeId | null | null | undefined;
|
|
2404
2594
|
tracking?: EmailTrackingOverrideV1 | undefined;
|
|
2405
2595
|
footer?: EmailFooterOverride | undefined;
|
|
2406
2596
|
};
|
|
@@ -2517,15 +2707,10 @@ export type ValidateEmailResponse = {
|
|
|
2517
2707
|
hasText: boolean;
|
|
2518
2708
|
};
|
|
2519
2709
|
};
|
|
2520
|
-
export type DeliveryUnavailableError = {
|
|
2521
|
-
_tag: "DeliveryUnavailableError";
|
|
2522
|
-
message: string;
|
|
2523
|
-
retryAfterSeconds: number;
|
|
2524
|
-
};
|
|
2525
2710
|
export type MessageReceipt = {
|
|
2526
2711
|
id: MessageId;
|
|
2527
2712
|
status: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained";
|
|
2528
|
-
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | null;
|
|
2713
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
2529
2714
|
reviewExpectedAt: string | null;
|
|
2530
2715
|
skippedRecipients: Array<SkippedRecipient>;
|
|
2531
2716
|
createdAt: string;
|
|
@@ -2557,6 +2742,8 @@ export type MessageContent = {
|
|
|
2557
2742
|
tracking?: EmailTrackingOverrideV1 | undefined;
|
|
2558
2743
|
attachments?: Array<{
|
|
2559
2744
|
filename: string;
|
|
2745
|
+
contentId?: string | null | undefined;
|
|
2746
|
+
isInline?: boolean | null | undefined;
|
|
2560
2747
|
content?: string | null | undefined;
|
|
2561
2748
|
mediaId?: MediaId | null | undefined;
|
|
2562
2749
|
contentType: string;
|
|
@@ -2575,7 +2762,7 @@ export type MessageDelivery = {
|
|
|
2575
2762
|
recipient: string | null;
|
|
2576
2763
|
status: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained";
|
|
2577
2764
|
attemptCount: number;
|
|
2578
|
-
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | null;
|
|
2765
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
2579
2766
|
nextRetryAt: string | null;
|
|
2580
2767
|
sentAt: string | null;
|
|
2581
2768
|
deliveredAt: string | null;
|
|
@@ -2611,7 +2798,7 @@ export type Message = {
|
|
|
2611
2798
|
isTest: boolean;
|
|
2612
2799
|
scheduledAt: string | null;
|
|
2613
2800
|
submission: MessageSubmission | null;
|
|
2614
|
-
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | null;
|
|
2801
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
2615
2802
|
reviewExpectedAt: string | null;
|
|
2616
2803
|
skippedRecipients: Array<SkippedRecipient>;
|
|
2617
2804
|
createdAt: string;
|
|
@@ -2980,7 +3167,7 @@ export type MessagesGetEmailResponses = {
|
|
|
2980
3167
|
scheduling: {
|
|
2981
3168
|
dueAt: string;
|
|
2982
3169
|
expiresAt: string;
|
|
2983
|
-
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | null;
|
|
3170
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
2984
3171
|
reviewExpectedAt: string | null;
|
|
2985
3172
|
} | null;
|
|
2986
3173
|
id: string;
|
|
@@ -4740,6 +4927,10 @@ export type EmailGetDomainByIdErrors = {
|
|
|
4740
4927
|
* ValidationError
|
|
4741
4928
|
*/
|
|
4742
4929
|
422: ValidationError;
|
|
4930
|
+
/**
|
|
4931
|
+
* InternalError
|
|
4932
|
+
*/
|
|
4933
|
+
500: InternalError;
|
|
4743
4934
|
/**
|
|
4744
4935
|
* GatewayTimeoutError
|
|
4745
4936
|
*/
|
|
@@ -5667,6 +5858,10 @@ export type EmailCheckSenderVerificationErrors = {
|
|
|
5667
5858
|
* ValidationError
|
|
5668
5859
|
*/
|
|
5669
5860
|
422: ValidationError;
|
|
5861
|
+
/**
|
|
5862
|
+
* InternalError
|
|
5863
|
+
*/
|
|
5864
|
+
500: InternalError;
|
|
5670
5865
|
/**
|
|
5671
5866
|
* ExternalServiceError
|
|
5672
5867
|
*/
|
|
@@ -6319,6 +6514,10 @@ export type EmailAddBlockErrors = {
|
|
|
6319
6514
|
* ValidationError
|
|
6320
6515
|
*/
|
|
6321
6516
|
422: ValidationError;
|
|
6517
|
+
/**
|
|
6518
|
+
* InternalError
|
|
6519
|
+
*/
|
|
6520
|
+
500: InternalError;
|
|
6322
6521
|
/**
|
|
6323
6522
|
* GatewayTimeoutError
|
|
6324
6523
|
*/
|
|
@@ -8129,6 +8328,9 @@ export type ContactsListData = {
|
|
|
8129
8328
|
cursor?: Cursor | null | undefined;
|
|
8130
8329
|
search?: string | null | undefined;
|
|
8131
8330
|
status?: "active" | "paused" | "blocked" | "archived" | null | undefined;
|
|
8331
|
+
fields?: string | null | undefined;
|
|
8332
|
+
customField?: string | null | undefined;
|
|
8333
|
+
customFieldValue?: string | null | undefined;
|
|
8132
8334
|
after?: string | null | undefined;
|
|
8133
8335
|
before?: string | null | undefined;
|
|
8134
8336
|
};
|
|
@@ -8270,11 +8472,15 @@ export type ContactsFindResponses = {
|
|
|
8270
8472
|
export type ContactsFindResponse = ContactsFindResponses[keyof ContactsFindResponses];
|
|
8271
8473
|
export type ContactsFindOrCreateData = {
|
|
8272
8474
|
body: {
|
|
8273
|
-
|
|
8274
|
-
|
|
8275
|
-
|
|
8276
|
-
|
|
8277
|
-
|
|
8475
|
+
lookup: ContactLookup;
|
|
8476
|
+
create?: {
|
|
8477
|
+
name?: string | null | undefined;
|
|
8478
|
+
displayName?: string | null | null | undefined;
|
|
8479
|
+
avatar?: string | null | null | undefined;
|
|
8480
|
+
identities?: Array<ContactIdentityInput> | null | undefined;
|
|
8481
|
+
profile?: ContactProfile | null | null | undefined;
|
|
8482
|
+
externalId?: string | null | null | undefined;
|
|
8483
|
+
} | null | undefined;
|
|
8278
8484
|
};
|
|
8279
8485
|
path?: never;
|
|
8280
8486
|
query?: never;
|
|
@@ -8317,9 +8523,12 @@ export type ContactsFindOrCreateErrors = {
|
|
|
8317
8523
|
export type ContactsFindOrCreateError = ContactsFindOrCreateErrors[keyof ContactsFindOrCreateErrors];
|
|
8318
8524
|
export type ContactsFindOrCreateResponses = {
|
|
8319
8525
|
/**
|
|
8320
|
-
*
|
|
8526
|
+
* Success
|
|
8321
8527
|
*/
|
|
8322
|
-
200:
|
|
8528
|
+
200: {
|
|
8529
|
+
contact: Contact;
|
|
8530
|
+
created: boolean;
|
|
8531
|
+
};
|
|
8323
8532
|
};
|
|
8324
8533
|
export type ContactsFindOrCreateResponse = ContactsFindOrCreateResponses[keyof ContactsFindOrCreateResponses];
|
|
8325
8534
|
export type ContactsRemoveData = {
|
|
@@ -9046,6 +9255,86 @@ export type ContactsGetGroupMembershipsResponses = {
|
|
|
9046
9255
|
200: ContactGroupMembershipPage;
|
|
9047
9256
|
};
|
|
9048
9257
|
export type ContactsGetGroupMembershipsResponse = ContactsGetGroupMembershipsResponses[keyof ContactsGetGroupMembershipsResponses];
|
|
9258
|
+
export type SubscriptionsSubscribeData = {
|
|
9259
|
+
body: {
|
|
9260
|
+
/**
|
|
9261
|
+
* The recipient email address; confirmation proves consent for this address.
|
|
9262
|
+
*/
|
|
9263
|
+
email: string;
|
|
9264
|
+
contactGroupId: ContactGroupId;
|
|
9265
|
+
/**
|
|
9266
|
+
* Your verified email sender. The ordinary send pipeline selects its domain and customer brand.
|
|
9267
|
+
*/
|
|
9268
|
+
from: {
|
|
9269
|
+
email: string;
|
|
9270
|
+
name?: string | null | undefined;
|
|
9271
|
+
};
|
|
9272
|
+
/**
|
|
9273
|
+
* Clear this unsubscribe group after confirmation; all other opt-outs remain.
|
|
9274
|
+
*/
|
|
9275
|
+
unsubscribeGroupId?: UnsubscribeId | null | undefined;
|
|
9276
|
+
templateSlug?: string | null | undefined;
|
|
9277
|
+
consentIp?: string | null | undefined;
|
|
9278
|
+
consentSource?: string | null | undefined;
|
|
9279
|
+
};
|
|
9280
|
+
path?: never;
|
|
9281
|
+
query?: never;
|
|
9282
|
+
url: "/v1/subscriptions";
|
|
9283
|
+
};
|
|
9284
|
+
export type SubscriptionsSubscribeErrors = {
|
|
9285
|
+
/**
|
|
9286
|
+
* UnauthorizedError
|
|
9287
|
+
*/
|
|
9288
|
+
401: UnauthorizedError;
|
|
9289
|
+
/**
|
|
9290
|
+
* PaymentRequiredError
|
|
9291
|
+
*/
|
|
9292
|
+
402: PaymentRequiredError;
|
|
9293
|
+
/**
|
|
9294
|
+
* ForbiddenError | OnboardingReviewRequiredError | FlagDisabledError
|
|
9295
|
+
*/
|
|
9296
|
+
403: ForbiddenError | OnboardingReviewRequiredError | FlagDisabledError;
|
|
9297
|
+
/**
|
|
9298
|
+
* ResourceNotFoundError
|
|
9299
|
+
*/
|
|
9300
|
+
404: ResourceNotFoundError;
|
|
9301
|
+
/**
|
|
9302
|
+
* ConflictError
|
|
9303
|
+
*/
|
|
9304
|
+
409: ConflictError;
|
|
9305
|
+
/**
|
|
9306
|
+
* ValidationError | BrandAddressRequiredError | CampaignFooterRequiredError
|
|
9307
|
+
*/
|
|
9308
|
+
422: ValidationError | BrandAddressRequiredError | CampaignFooterRequiredError;
|
|
9309
|
+
/**
|
|
9310
|
+
* RateLimitedError
|
|
9311
|
+
*/
|
|
9312
|
+
429: RateLimitedError;
|
|
9313
|
+
/**
|
|
9314
|
+
* InternalError
|
|
9315
|
+
*/
|
|
9316
|
+
500: InternalError;
|
|
9317
|
+
/**
|
|
9318
|
+
* BillingProviderError | ExternalServiceError
|
|
9319
|
+
*/
|
|
9320
|
+
502: BillingProviderError | ExternalServiceError;
|
|
9321
|
+
/**
|
|
9322
|
+
* SenderNotReadyError | DeliveryUnavailableError
|
|
9323
|
+
*/
|
|
9324
|
+
503: SenderNotReadyError | DeliveryUnavailableError;
|
|
9325
|
+
/**
|
|
9326
|
+
* GatewayTimeoutError
|
|
9327
|
+
*/
|
|
9328
|
+
504: GatewayTimeoutError;
|
|
9329
|
+
};
|
|
9330
|
+
export type SubscriptionsSubscribeError = SubscriptionsSubscribeErrors[keyof SubscriptionsSubscribeErrors];
|
|
9331
|
+
export type SubscriptionsSubscribeResponses = {
|
|
9332
|
+
/**
|
|
9333
|
+
* SubscribeResult
|
|
9334
|
+
*/
|
|
9335
|
+
200: SubscribeResult;
|
|
9336
|
+
};
|
|
9337
|
+
export type SubscriptionsSubscribeResponse = SubscriptionsSubscribeResponses[keyof SubscriptionsSubscribeResponses];
|
|
9049
9338
|
export type ContactGroupsListData = {
|
|
9050
9339
|
body?: never;
|
|
9051
9340
|
path?: never;
|
|
@@ -12581,6 +12870,62 @@ export type TemplatesGetPublicationResponses = {
|
|
|
12581
12870
|
};
|
|
12582
12871
|
};
|
|
12583
12872
|
export type TemplatesGetPublicationResponse = TemplatesGetPublicationResponses[keyof TemplatesGetPublicationResponses];
|
|
12873
|
+
export type TemplatesRenderPublicationData = {
|
|
12874
|
+
body: {
|
|
12875
|
+
/**
|
|
12876
|
+
* The input to render with, validated against the publication's input schema.
|
|
12877
|
+
*/
|
|
12878
|
+
data: {
|
|
12879
|
+
[key: string]: JsonValue;
|
|
12880
|
+
};
|
|
12881
|
+
locale?: RenderLocale | undefined;
|
|
12882
|
+
timeZone?: RenderTimeZone | undefined;
|
|
12883
|
+
};
|
|
12884
|
+
path: {
|
|
12885
|
+
id: TemplateId;
|
|
12886
|
+
publicationId: TemplatePublicationId;
|
|
12887
|
+
};
|
|
12888
|
+
query?: never;
|
|
12889
|
+
url: "/v1/templates/{id}/publications/{publicationId}/render";
|
|
12890
|
+
};
|
|
12891
|
+
export type TemplatesRenderPublicationErrors = {
|
|
12892
|
+
/**
|
|
12893
|
+
* UnauthorizedError
|
|
12894
|
+
*/
|
|
12895
|
+
401: UnauthorizedError;
|
|
12896
|
+
/**
|
|
12897
|
+
* ForbiddenError
|
|
12898
|
+
*/
|
|
12899
|
+
403: ForbiddenError;
|
|
12900
|
+
/**
|
|
12901
|
+
* ResourceNotFoundError
|
|
12902
|
+
*/
|
|
12903
|
+
404: ResourceNotFoundError;
|
|
12904
|
+
/**
|
|
12905
|
+
* ConflictError
|
|
12906
|
+
*/
|
|
12907
|
+
409: ConflictError;
|
|
12908
|
+
/**
|
|
12909
|
+
* ValidationError
|
|
12910
|
+
*/
|
|
12911
|
+
422: ValidationError;
|
|
12912
|
+
/**
|
|
12913
|
+
* InternalError
|
|
12914
|
+
*/
|
|
12915
|
+
500: InternalError;
|
|
12916
|
+
/**
|
|
12917
|
+
* GatewayTimeoutError
|
|
12918
|
+
*/
|
|
12919
|
+
504: GatewayTimeoutError;
|
|
12920
|
+
};
|
|
12921
|
+
export type TemplatesRenderPublicationError = TemplatesRenderPublicationErrors[keyof TemplatesRenderPublicationErrors];
|
|
12922
|
+
export type TemplatesRenderPublicationResponses = {
|
|
12923
|
+
/**
|
|
12924
|
+
* TemplatePublicationRender
|
|
12925
|
+
*/
|
|
12926
|
+
200: TemplatePublicationRender;
|
|
12927
|
+
};
|
|
12928
|
+
export type TemplatesRenderPublicationResponse = TemplatesRenderPublicationResponses[keyof TemplatesRenderPublicationResponses];
|
|
12584
12929
|
export type TemplatesListInputContractsData = {
|
|
12585
12930
|
body?: never;
|
|
12586
12931
|
path: {
|
|
@@ -13349,7 +13694,7 @@ export type WebhooksCreateData = {
|
|
|
13349
13694
|
body: {
|
|
13350
13695
|
name: string;
|
|
13351
13696
|
url: string;
|
|
13352
|
-
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">;
|
|
13697
|
+
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">;
|
|
13353
13698
|
channels?: Array<"email"> | null | undefined;
|
|
13354
13699
|
mailboxIds?: [MailboxId, ...Array<MailboxId>] | null | undefined;
|
|
13355
13700
|
namespaceId?: NamespaceId | null | undefined;
|
|
@@ -13503,7 +13848,7 @@ export type WebhooksUpdateData = {
|
|
|
13503
13848
|
body: {
|
|
13504
13849
|
name?: string | null | undefined;
|
|
13505
13850
|
url?: string | null | undefined;
|
|
13506
|
-
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;
|
|
13851
|
+
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;
|
|
13507
13852
|
channels?: Array<"email"> | null | null | undefined;
|
|
13508
13853
|
mailboxIds?: [MailboxId, ...Array<MailboxId>] | null | null | undefined;
|
|
13509
13854
|
namespaceId?: NamespaceId | null | null | undefined;
|
|
@@ -13978,6 +14323,79 @@ export type OrganizationsGetProfileResponses = {
|
|
|
13978
14323
|
};
|
|
13979
14324
|
};
|
|
13980
14325
|
export type OrganizationsGetProfileResponse = OrganizationsGetProfileResponses[keyof OrganizationsGetProfileResponses];
|
|
14326
|
+
export type OrganizationsGetTrustTierData = {
|
|
14327
|
+
body?: never;
|
|
14328
|
+
path?: never;
|
|
14329
|
+
query?: never;
|
|
14330
|
+
url: "/v1/organizations/trust-tier";
|
|
14331
|
+
};
|
|
14332
|
+
export type OrganizationsGetTrustTierErrors = {
|
|
14333
|
+
/**
|
|
14334
|
+
* UnauthorizedError
|
|
14335
|
+
*/
|
|
14336
|
+
401: UnauthorizedError;
|
|
14337
|
+
/**
|
|
14338
|
+
* ForbiddenError
|
|
14339
|
+
*/
|
|
14340
|
+
403: ForbiddenError;
|
|
14341
|
+
/**
|
|
14342
|
+
* ResourceNotFoundError
|
|
14343
|
+
*/
|
|
14344
|
+
404: ResourceNotFoundError;
|
|
14345
|
+
/**
|
|
14346
|
+
* ValidationError
|
|
14347
|
+
*/
|
|
14348
|
+
422: ValidationError;
|
|
14349
|
+
/**
|
|
14350
|
+
* InternalError
|
|
14351
|
+
*/
|
|
14352
|
+
500: InternalError;
|
|
14353
|
+
/**
|
|
14354
|
+
* BillingProviderError
|
|
14355
|
+
*/
|
|
14356
|
+
502: BillingProviderError;
|
|
14357
|
+
/**
|
|
14358
|
+
* GatewayTimeoutError
|
|
14359
|
+
*/
|
|
14360
|
+
504: GatewayTimeoutError;
|
|
14361
|
+
};
|
|
14362
|
+
export type OrganizationsGetTrustTierError = OrganizationsGetTrustTierErrors[keyof OrganizationsGetTrustTierErrors];
|
|
14363
|
+
export type OrganizationsGetTrustTierResponses = {
|
|
14364
|
+
/**
|
|
14365
|
+
* Success
|
|
14366
|
+
*/
|
|
14367
|
+
200: {
|
|
14368
|
+
tier: "screened" | "probation" | "established";
|
|
14369
|
+
changedAt: string;
|
|
14370
|
+
sendingLimits: {
|
|
14371
|
+
sendsPerSecond: number;
|
|
14372
|
+
dailySends: number;
|
|
14373
|
+
probation: {
|
|
14374
|
+
hourlyRecipients: number;
|
|
14375
|
+
dailyRecipients: number;
|
|
14376
|
+
domainShare: number;
|
|
14377
|
+
domainShareFloor: number;
|
|
14378
|
+
} | null;
|
|
14379
|
+
};
|
|
14380
|
+
graduation: {
|
|
14381
|
+
firstSentAt: string | null;
|
|
14382
|
+
elapsedDays: number;
|
|
14383
|
+
sent: number;
|
|
14384
|
+
delivered: number;
|
|
14385
|
+
hardBounces: number;
|
|
14386
|
+
hardBounceRate: number | null;
|
|
14387
|
+
complaints: number;
|
|
14388
|
+
holds: number;
|
|
14389
|
+
requirements: {
|
|
14390
|
+
minimumDays: number;
|
|
14391
|
+
delivered: number;
|
|
14392
|
+
maximumHardBounceRate: number;
|
|
14393
|
+
};
|
|
14394
|
+
blockers: Array<"too_recent" | "too_few_delivered" | "held" | "complaints" | "bounce_rate">;
|
|
14395
|
+
} | null;
|
|
14396
|
+
};
|
|
14397
|
+
};
|
|
14398
|
+
export type OrganizationsGetTrustTierResponse = OrganizationsGetTrustTierResponses[keyof OrganizationsGetTrustTierResponses];
|
|
13981
14399
|
export type OrganizationsGetUsageData = {
|
|
13982
14400
|
body?: never;
|
|
13983
14401
|
path?: never;
|
|
@@ -16051,17 +16469,17 @@ export type MailboxesSendMessageErrors = {
|
|
|
16051
16469
|
*/
|
|
16052
16470
|
402: PaymentRequiredError;
|
|
16053
16471
|
/**
|
|
16054
|
-
*
|
|
16472
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16055
16473
|
*/
|
|
16056
|
-
403:
|
|
16474
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16057
16475
|
/**
|
|
16058
16476
|
* ResourceNotFoundError
|
|
16059
16477
|
*/
|
|
16060
16478
|
404: ResourceNotFoundError;
|
|
16061
16479
|
/**
|
|
16062
|
-
* ConflictError
|
|
16480
|
+
* MailboxSendConflictError | ConflictError
|
|
16063
16481
|
*/
|
|
16064
|
-
409: ConflictError;
|
|
16482
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16065
16483
|
/**
|
|
16066
16484
|
* ValidationError
|
|
16067
16485
|
*/
|
|
@@ -16093,6 +16511,10 @@ export type MailboxesSendMessageResponses = {
|
|
|
16093
16511
|
* MailboxSendReceipt
|
|
16094
16512
|
*/
|
|
16095
16513
|
200: MailboxSendReceipt;
|
|
16514
|
+
/**
|
|
16515
|
+
* MailboxPendingSendReceipt
|
|
16516
|
+
*/
|
|
16517
|
+
202: MailboxPendingSendReceipt;
|
|
16096
16518
|
};
|
|
16097
16519
|
export type MailboxesSendMessageResponse = MailboxesSendMessageResponses[keyof MailboxesSendMessageResponses];
|
|
16098
16520
|
export type MailboxesGetMessageData = {
|
|
@@ -16225,6 +16647,54 @@ export type MailboxesGetMessageAttachmentResponses = {
|
|
|
16225
16647
|
200: MailboxDownloadUrl;
|
|
16226
16648
|
};
|
|
16227
16649
|
export type MailboxesGetMessageAttachmentResponse = MailboxesGetMessageAttachmentResponses[keyof MailboxesGetMessageAttachmentResponses];
|
|
16650
|
+
export type MailboxesCopyMessageAttachmentData = {
|
|
16651
|
+
body?: never;
|
|
16652
|
+
path: {
|
|
16653
|
+
id: MailboxId;
|
|
16654
|
+
messageId: MessageId;
|
|
16655
|
+
attachmentId: AttachmentId;
|
|
16656
|
+
};
|
|
16657
|
+
query?: never;
|
|
16658
|
+
url: "/v1/mailboxes/{id}/messages/{messageId}/attachments/{attachmentId}/copy";
|
|
16659
|
+
};
|
|
16660
|
+
export type MailboxesCopyMessageAttachmentErrors = {
|
|
16661
|
+
/**
|
|
16662
|
+
* UnauthorizedError
|
|
16663
|
+
*/
|
|
16664
|
+
401: UnauthorizedError;
|
|
16665
|
+
/**
|
|
16666
|
+
* ForbiddenError
|
|
16667
|
+
*/
|
|
16668
|
+
403: ForbiddenError;
|
|
16669
|
+
/**
|
|
16670
|
+
* ResourceNotFoundError
|
|
16671
|
+
*/
|
|
16672
|
+
404: ResourceNotFoundError;
|
|
16673
|
+
/**
|
|
16674
|
+
* ConflictError
|
|
16675
|
+
*/
|
|
16676
|
+
409: ConflictError;
|
|
16677
|
+
/**
|
|
16678
|
+
* ValidationError
|
|
16679
|
+
*/
|
|
16680
|
+
422: ValidationError;
|
|
16681
|
+
/**
|
|
16682
|
+
* InternalError
|
|
16683
|
+
*/
|
|
16684
|
+
500: InternalError;
|
|
16685
|
+
/**
|
|
16686
|
+
* GatewayTimeoutError
|
|
16687
|
+
*/
|
|
16688
|
+
504: GatewayTimeoutError;
|
|
16689
|
+
};
|
|
16690
|
+
export type MailboxesCopyMessageAttachmentError = MailboxesCopyMessageAttachmentErrors[keyof MailboxesCopyMessageAttachmentErrors];
|
|
16691
|
+
export type MailboxesCopyMessageAttachmentResponses = {
|
|
16692
|
+
/**
|
|
16693
|
+
* MailboxCopiedAttachment
|
|
16694
|
+
*/
|
|
16695
|
+
201: MailboxCopiedAttachment;
|
|
16696
|
+
};
|
|
16697
|
+
export type MailboxesCopyMessageAttachmentResponse = MailboxesCopyMessageAttachmentResponses[keyof MailboxesCopyMessageAttachmentResponses];
|
|
16228
16698
|
export type MailboxesReplyData = {
|
|
16229
16699
|
body: {
|
|
16230
16700
|
cc?: Array<string> | null | undefined;
|
|
@@ -16253,17 +16723,17 @@ export type MailboxesReplyErrors = {
|
|
|
16253
16723
|
*/
|
|
16254
16724
|
402: PaymentRequiredError;
|
|
16255
16725
|
/**
|
|
16256
|
-
*
|
|
16726
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16257
16727
|
*/
|
|
16258
|
-
403:
|
|
16728
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16259
16729
|
/**
|
|
16260
16730
|
* ResourceNotFoundError
|
|
16261
16731
|
*/
|
|
16262
16732
|
404: ResourceNotFoundError;
|
|
16263
16733
|
/**
|
|
16264
|
-
* ConflictError
|
|
16734
|
+
* MailboxSendConflictError | ConflictError
|
|
16265
16735
|
*/
|
|
16266
|
-
409: ConflictError;
|
|
16736
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16267
16737
|
/**
|
|
16268
16738
|
* ValidationError
|
|
16269
16739
|
*/
|
|
@@ -16295,6 +16765,10 @@ export type MailboxesReplyResponses = {
|
|
|
16295
16765
|
* MailboxSendReceipt
|
|
16296
16766
|
*/
|
|
16297
16767
|
200: MailboxSendReceipt;
|
|
16768
|
+
/**
|
|
16769
|
+
* MailboxPendingSendReceipt
|
|
16770
|
+
*/
|
|
16771
|
+
202: MailboxPendingSendReceipt;
|
|
16298
16772
|
};
|
|
16299
16773
|
export type MailboxesReplyResponse = MailboxesReplyResponses[keyof MailboxesReplyResponses];
|
|
16300
16774
|
export type MailboxesReplyAllData = {
|
|
@@ -16325,17 +16799,17 @@ export type MailboxesReplyAllErrors = {
|
|
|
16325
16799
|
*/
|
|
16326
16800
|
402: PaymentRequiredError;
|
|
16327
16801
|
/**
|
|
16328
|
-
*
|
|
16802
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16329
16803
|
*/
|
|
16330
|
-
403:
|
|
16804
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16331
16805
|
/**
|
|
16332
16806
|
* ResourceNotFoundError
|
|
16333
16807
|
*/
|
|
16334
16808
|
404: ResourceNotFoundError;
|
|
16335
16809
|
/**
|
|
16336
|
-
* ConflictError
|
|
16810
|
+
* MailboxSendConflictError | ConflictError
|
|
16337
16811
|
*/
|
|
16338
|
-
409: ConflictError;
|
|
16812
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16339
16813
|
/**
|
|
16340
16814
|
* ValidationError
|
|
16341
16815
|
*/
|
|
@@ -16367,6 +16841,10 @@ export type MailboxesReplyAllResponses = {
|
|
|
16367
16841
|
* MailboxSendReceipt
|
|
16368
16842
|
*/
|
|
16369
16843
|
200: MailboxSendReceipt;
|
|
16844
|
+
/**
|
|
16845
|
+
* MailboxPendingSendReceipt
|
|
16846
|
+
*/
|
|
16847
|
+
202: MailboxPendingSendReceipt;
|
|
16370
16848
|
};
|
|
16371
16849
|
export type MailboxesReplyAllResponse = MailboxesReplyAllResponses[keyof MailboxesReplyAllResponses];
|
|
16372
16850
|
export type MailboxesForwardData = {
|
|
@@ -16398,17 +16876,17 @@ export type MailboxesForwardErrors = {
|
|
|
16398
16876
|
*/
|
|
16399
16877
|
402: PaymentRequiredError;
|
|
16400
16878
|
/**
|
|
16401
|
-
*
|
|
16879
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16402
16880
|
*/
|
|
16403
|
-
403:
|
|
16881
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16404
16882
|
/**
|
|
16405
16883
|
* ResourceNotFoundError
|
|
16406
16884
|
*/
|
|
16407
16885
|
404: ResourceNotFoundError;
|
|
16408
16886
|
/**
|
|
16409
|
-
* ConflictError
|
|
16887
|
+
* MailboxSendConflictError | ConflictError
|
|
16410
16888
|
*/
|
|
16411
|
-
409: ConflictError;
|
|
16889
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16412
16890
|
/**
|
|
16413
16891
|
* ValidationError
|
|
16414
16892
|
*/
|
|
@@ -16440,6 +16918,10 @@ export type MailboxesForwardResponses = {
|
|
|
16440
16918
|
* MailboxSendReceipt
|
|
16441
16919
|
*/
|
|
16442
16920
|
200: MailboxSendReceipt;
|
|
16921
|
+
/**
|
|
16922
|
+
* MailboxPendingSendReceipt
|
|
16923
|
+
*/
|
|
16924
|
+
202: MailboxPendingSendReceipt;
|
|
16443
16925
|
};
|
|
16444
16926
|
export type MailboxesForwardResponse = MailboxesForwardResponses[keyof MailboxesForwardResponses];
|
|
16445
16927
|
export type MailboxesListQuarantineData = {
|
|
@@ -16849,17 +17331,17 @@ export type MailboxesSendDraftErrors = {
|
|
|
16849
17331
|
*/
|
|
16850
17332
|
402: PaymentRequiredError;
|
|
16851
17333
|
/**
|
|
16852
|
-
*
|
|
17334
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16853
17335
|
*/
|
|
16854
|
-
403:
|
|
17336
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16855
17337
|
/**
|
|
16856
17338
|
* ResourceNotFoundError
|
|
16857
17339
|
*/
|
|
16858
17340
|
404: ResourceNotFoundError;
|
|
16859
17341
|
/**
|
|
16860
|
-
* ConflictError
|
|
17342
|
+
* MailboxSendConflictError | ConflictError
|
|
16861
17343
|
*/
|
|
16862
|
-
409: ConflictError;
|
|
17344
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16863
17345
|
/**
|
|
16864
17346
|
* ValidationError
|
|
16865
17347
|
*/
|
|
@@ -16891,6 +17373,10 @@ export type MailboxesSendDraftResponses = {
|
|
|
16891
17373
|
* MailboxSendReceipt
|
|
16892
17374
|
*/
|
|
16893
17375
|
200: MailboxSendReceipt;
|
|
17376
|
+
/**
|
|
17377
|
+
* MailboxPendingSendReceipt
|
|
17378
|
+
*/
|
|
17379
|
+
202: MailboxPendingSendReceipt;
|
|
16894
17380
|
};
|
|
16895
17381
|
export type MailboxesSendDraftResponse = MailboxesSendDraftResponses[keyof MailboxesSendDraftResponses];
|
|
16896
17382
|
export type MailboxesListActionsData = {
|
|
@@ -16901,7 +17387,8 @@ export type MailboxesListActionsData = {
|
|
|
16901
17387
|
query?: {
|
|
16902
17388
|
limit?: string | null | undefined;
|
|
16903
17389
|
cursor?: Cursor | null | undefined;
|
|
16904
|
-
|
|
17390
|
+
threadId?: MailboxThreadId | null | undefined;
|
|
17391
|
+
state?: "proposed" | "allowed" | "approvalRequired" | "policyDenied" | "approved" | "approvalDenied" | "executing" | "executed" | "failed" | "queued" | "accepted" | "completed" | "notSent" | "uncertain" | null | undefined;
|
|
16905
17392
|
after?: string | null | undefined;
|
|
16906
17393
|
before?: string | null | undefined;
|
|
16907
17394
|
};
|
|
@@ -16941,6 +17428,183 @@ export type MailboxesListActionsResponses = {
|
|
|
16941
17428
|
200: MailboxActionPage;
|
|
16942
17429
|
};
|
|
16943
17430
|
export type MailboxesListActionsResponse = MailboxesListActionsResponses[keyof MailboxesListActionsResponses];
|
|
17431
|
+
export type MailboxesGetActionData = {
|
|
17432
|
+
body?: never;
|
|
17433
|
+
path: {
|
|
17434
|
+
id: MailboxId;
|
|
17435
|
+
actionId: MailboxActionId;
|
|
17436
|
+
};
|
|
17437
|
+
query?: never;
|
|
17438
|
+
url: "/v1/mailboxes/{id}/actions/{actionId}";
|
|
17439
|
+
};
|
|
17440
|
+
export type MailboxesGetActionErrors = {
|
|
17441
|
+
/**
|
|
17442
|
+
* UnauthorizedError
|
|
17443
|
+
*/
|
|
17444
|
+
401: UnauthorizedError;
|
|
17445
|
+
/**
|
|
17446
|
+
* ForbiddenError
|
|
17447
|
+
*/
|
|
17448
|
+
403: ForbiddenError;
|
|
17449
|
+
/**
|
|
17450
|
+
* ResourceNotFoundError
|
|
17451
|
+
*/
|
|
17452
|
+
404: ResourceNotFoundError;
|
|
17453
|
+
/**
|
|
17454
|
+
* ValidationError
|
|
17455
|
+
*/
|
|
17456
|
+
422: ValidationError;
|
|
17457
|
+
/**
|
|
17458
|
+
* InternalError
|
|
17459
|
+
*/
|
|
17460
|
+
500: InternalError;
|
|
17461
|
+
/**
|
|
17462
|
+
* GatewayTimeoutError
|
|
17463
|
+
*/
|
|
17464
|
+
504: GatewayTimeoutError;
|
|
17465
|
+
};
|
|
17466
|
+
export type MailboxesGetActionError = MailboxesGetActionErrors[keyof MailboxesGetActionErrors];
|
|
17467
|
+
export type MailboxesGetActionResponses = {
|
|
17468
|
+
/**
|
|
17469
|
+
* MailboxAction
|
|
17470
|
+
*/
|
|
17471
|
+
200: MailboxAction;
|
|
17472
|
+
};
|
|
17473
|
+
export type MailboxesGetActionResponse = MailboxesGetActionResponses[keyof MailboxesGetActionResponses];
|
|
17474
|
+
export type MailboxesCancelActionData = {
|
|
17475
|
+
body?: never;
|
|
17476
|
+
path: {
|
|
17477
|
+
id: MailboxId;
|
|
17478
|
+
actionId: MailboxActionId;
|
|
17479
|
+
};
|
|
17480
|
+
query?: never;
|
|
17481
|
+
url: "/v1/mailboxes/{id}/actions/{actionId}/cancel";
|
|
17482
|
+
};
|
|
17483
|
+
export type MailboxesCancelActionErrors = {
|
|
17484
|
+
/**
|
|
17485
|
+
* UnauthorizedError
|
|
17486
|
+
*/
|
|
17487
|
+
401: UnauthorizedError;
|
|
17488
|
+
/**
|
|
17489
|
+
* PaymentRequiredError
|
|
17490
|
+
*/
|
|
17491
|
+
402: PaymentRequiredError;
|
|
17492
|
+
/**
|
|
17493
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
17494
|
+
*/
|
|
17495
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
17496
|
+
/**
|
|
17497
|
+
* ResourceNotFoundError
|
|
17498
|
+
*/
|
|
17499
|
+
404: ResourceNotFoundError;
|
|
17500
|
+
/**
|
|
17501
|
+
* MailboxSendConflictError | ConflictError
|
|
17502
|
+
*/
|
|
17503
|
+
409: MailboxSendConflictError | ConflictError;
|
|
17504
|
+
/**
|
|
17505
|
+
* ValidationError
|
|
17506
|
+
*/
|
|
17507
|
+
422: ValidationError;
|
|
17508
|
+
/**
|
|
17509
|
+
* RateLimitedError
|
|
17510
|
+
*/
|
|
17511
|
+
429: RateLimitedError;
|
|
17512
|
+
/**
|
|
17513
|
+
* InternalError
|
|
17514
|
+
*/
|
|
17515
|
+
500: InternalError;
|
|
17516
|
+
/**
|
|
17517
|
+
* BillingProviderError
|
|
17518
|
+
*/
|
|
17519
|
+
502: BillingProviderError;
|
|
17520
|
+
/**
|
|
17521
|
+
* SenderNotReadyError
|
|
17522
|
+
*/
|
|
17523
|
+
503: SenderNotReadyError;
|
|
17524
|
+
/**
|
|
17525
|
+
* GatewayTimeoutError
|
|
17526
|
+
*/
|
|
17527
|
+
504: GatewayTimeoutError;
|
|
17528
|
+
};
|
|
17529
|
+
export type MailboxesCancelActionError = MailboxesCancelActionErrors[keyof MailboxesCancelActionErrors];
|
|
17530
|
+
export type MailboxesCancelActionResponses = {
|
|
17531
|
+
/**
|
|
17532
|
+
* MailboxSendReceipt
|
|
17533
|
+
*/
|
|
17534
|
+
200: MailboxSendReceipt;
|
|
17535
|
+
/**
|
|
17536
|
+
* MailboxPendingSendReceipt
|
|
17537
|
+
*/
|
|
17538
|
+
202: MailboxPendingSendReceipt;
|
|
17539
|
+
};
|
|
17540
|
+
export type MailboxesCancelActionResponse = MailboxesCancelActionResponses[keyof MailboxesCancelActionResponses];
|
|
17541
|
+
export type MailboxesRetryActionData = {
|
|
17542
|
+
body?: never;
|
|
17543
|
+
path: {
|
|
17544
|
+
id: MailboxId;
|
|
17545
|
+
actionId: MailboxActionId;
|
|
17546
|
+
};
|
|
17547
|
+
query?: never;
|
|
17548
|
+
url: "/v1/mailboxes/{id}/actions/{actionId}/retry";
|
|
17549
|
+
};
|
|
17550
|
+
export type MailboxesRetryActionErrors = {
|
|
17551
|
+
/**
|
|
17552
|
+
* UnauthorizedError
|
|
17553
|
+
*/
|
|
17554
|
+
401: UnauthorizedError;
|
|
17555
|
+
/**
|
|
17556
|
+
* PaymentRequiredError
|
|
17557
|
+
*/
|
|
17558
|
+
402: PaymentRequiredError;
|
|
17559
|
+
/**
|
|
17560
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
17561
|
+
*/
|
|
17562
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
17563
|
+
/**
|
|
17564
|
+
* ResourceNotFoundError
|
|
17565
|
+
*/
|
|
17566
|
+
404: ResourceNotFoundError;
|
|
17567
|
+
/**
|
|
17568
|
+
* MailboxSendConflictError | ConflictError
|
|
17569
|
+
*/
|
|
17570
|
+
409: MailboxSendConflictError | ConflictError;
|
|
17571
|
+
/**
|
|
17572
|
+
* ValidationError
|
|
17573
|
+
*/
|
|
17574
|
+
422: ValidationError;
|
|
17575
|
+
/**
|
|
17576
|
+
* RateLimitedError
|
|
17577
|
+
*/
|
|
17578
|
+
429: RateLimitedError;
|
|
17579
|
+
/**
|
|
17580
|
+
* InternalError
|
|
17581
|
+
*/
|
|
17582
|
+
500: InternalError;
|
|
17583
|
+
/**
|
|
17584
|
+
* BillingProviderError
|
|
17585
|
+
*/
|
|
17586
|
+
502: BillingProviderError;
|
|
17587
|
+
/**
|
|
17588
|
+
* SenderNotReadyError
|
|
17589
|
+
*/
|
|
17590
|
+
503: SenderNotReadyError;
|
|
17591
|
+
/**
|
|
17592
|
+
* GatewayTimeoutError
|
|
17593
|
+
*/
|
|
17594
|
+
504: GatewayTimeoutError;
|
|
17595
|
+
};
|
|
17596
|
+
export type MailboxesRetryActionError = MailboxesRetryActionErrors[keyof MailboxesRetryActionErrors];
|
|
17597
|
+
export type MailboxesRetryActionResponses = {
|
|
17598
|
+
/**
|
|
17599
|
+
* MailboxSendReceipt
|
|
17600
|
+
*/
|
|
17601
|
+
200: MailboxSendReceipt;
|
|
17602
|
+
/**
|
|
17603
|
+
* MailboxPendingSendReceipt
|
|
17604
|
+
*/
|
|
17605
|
+
202: MailboxPendingSendReceipt;
|
|
17606
|
+
};
|
|
17607
|
+
export type MailboxesRetryActionResponse = MailboxesRetryActionResponses[keyof MailboxesRetryActionResponses];
|
|
16944
17608
|
export type MailboxesApproveActionData = {
|
|
16945
17609
|
body?: never;
|
|
16946
17610
|
path: {
|
|
@@ -16960,17 +17624,17 @@ export type MailboxesApproveActionErrors = {
|
|
|
16960
17624
|
*/
|
|
16961
17625
|
402: PaymentRequiredError;
|
|
16962
17626
|
/**
|
|
16963
|
-
*
|
|
17627
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16964
17628
|
*/
|
|
16965
|
-
403:
|
|
17629
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16966
17630
|
/**
|
|
16967
17631
|
* ResourceNotFoundError
|
|
16968
17632
|
*/
|
|
16969
17633
|
404: ResourceNotFoundError;
|
|
16970
17634
|
/**
|
|
16971
|
-
* ConflictError
|
|
17635
|
+
* MailboxSendConflictError | ConflictError
|
|
16972
17636
|
*/
|
|
16973
|
-
409: ConflictError;
|
|
17637
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16974
17638
|
/**
|
|
16975
17639
|
* ValidationError
|
|
16976
17640
|
*/
|
|
@@ -17002,6 +17666,10 @@ export type MailboxesApproveActionResponses = {
|
|
|
17002
17666
|
* MailboxAction
|
|
17003
17667
|
*/
|
|
17004
17668
|
200: MailboxAction;
|
|
17669
|
+
/**
|
|
17670
|
+
* MailboxPendingAction
|
|
17671
|
+
*/
|
|
17672
|
+
202: MailboxPendingAction;
|
|
17005
17673
|
};
|
|
17006
17674
|
export type MailboxesApproveActionResponse = MailboxesApproveActionResponses[keyof MailboxesApproveActionResponses];
|
|
17007
17675
|
export type MailboxesDenyActionData = {
|
|
@@ -17029,9 +17697,9 @@ export type MailboxesDenyActionErrors = {
|
|
|
17029
17697
|
*/
|
|
17030
17698
|
404: ResourceNotFoundError;
|
|
17031
17699
|
/**
|
|
17032
|
-
* ConflictError
|
|
17700
|
+
* ConflictError | MailboxSendConflictError
|
|
17033
17701
|
*/
|
|
17034
|
-
409: ConflictError;
|
|
17702
|
+
409: ConflictError | MailboxSendConflictError;
|
|
17035
17703
|
/**
|
|
17036
17704
|
* ValidationError
|
|
17037
17705
|
*/
|