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
|
@@ -257,7 +257,7 @@ export type MailboxEventPage = {
|
|
|
257
257
|
};
|
|
258
258
|
export type MailboxEvent = {
|
|
259
259
|
id: MailboxEventId;
|
|
260
|
-
type: "mailbox.created" | "address.attached" | "
|
|
260
|
+
type: "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";
|
|
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" | "
|
|
865
|
+
type: "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";
|
|
739
866
|
count: number;
|
|
740
867
|
}>;
|
|
741
868
|
};
|
|
@@ -745,7 +872,7 @@ export type Mailbox = {
|
|
|
745
872
|
id: MailboxId;
|
|
746
873
|
namespaceId: NamespaceId | null;
|
|
747
874
|
slug: string;
|
|
748
|
-
|
|
875
|
+
name: string;
|
|
749
876
|
status: MailboxStatus;
|
|
750
877
|
primaryAddress: string | null;
|
|
751
878
|
createdAt: string;
|
|
@@ -771,8 +898,12 @@ export type MailboxMetadata = {
|
|
|
771
898
|
[key: string]: string;
|
|
772
899
|
};
|
|
773
900
|
export type MailboxStatus = "active" | "paused";
|
|
774
|
-
export type
|
|
901
|
+
export type CreateMailboxAddressPayload = {
|
|
902
|
+
address: string;
|
|
775
903
|
displayName?: string | null | undefined;
|
|
904
|
+
};
|
|
905
|
+
export type UpdateMailboxPayload = {
|
|
906
|
+
name?: string | null | undefined;
|
|
776
907
|
metadata?: MailboxMetadataPatch | null | undefined;
|
|
777
908
|
defaultFrom?: {
|
|
778
909
|
address: string;
|
|
@@ -784,19 +915,10 @@ export type MailboxMetadataPatch = {
|
|
|
784
915
|
};
|
|
785
916
|
export type CreateMailboxPayload = {
|
|
786
917
|
namespaceId?: NamespaceId | null | undefined;
|
|
787
|
-
displayName: string;
|
|
788
|
-
slug: string;
|
|
789
|
-
addresses: [CreateMailboxAddressPayload, ...Array<CreateMailboxAddressPayload>];
|
|
790
|
-
defaultFrom?: {
|
|
791
|
-
address: string;
|
|
792
|
-
displayName?: string | null | undefined;
|
|
793
|
-
} | null | undefined;
|
|
794
|
-
metadata?: MailboxMetadata | null | undefined;
|
|
795
|
-
};
|
|
796
|
-
export type CreateMailboxAddressPayload = {
|
|
797
918
|
address: string;
|
|
798
|
-
|
|
799
|
-
|
|
919
|
+
name: string;
|
|
920
|
+
slug?: string | null | undefined;
|
|
921
|
+
metadata?: MailboxMetadata | null | undefined;
|
|
800
922
|
};
|
|
801
923
|
export type MailboxPage = {
|
|
802
924
|
items: Array<MailboxSummary>;
|
|
@@ -806,7 +928,7 @@ export type MailboxSummary = {
|
|
|
806
928
|
id: MailboxId;
|
|
807
929
|
namespaceId: NamespaceId | null;
|
|
808
930
|
slug: string;
|
|
809
|
-
|
|
931
|
+
name: string;
|
|
810
932
|
status: MailboxStatus;
|
|
811
933
|
primaryAddress: string | null;
|
|
812
934
|
createdAt: string;
|
|
@@ -1041,7 +1163,7 @@ export type WebhookEndpoint = {
|
|
|
1041
1163
|
id: WebhookEndpointId;
|
|
1042
1164
|
name: string;
|
|
1043
1165
|
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">;
|
|
1166
|
+
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
1167
|
channels: Array<"email"> | null;
|
|
1046
1168
|
mailboxIds: Array<MailboxId> | null;
|
|
1047
1169
|
namespaceId: NamespaceId | null;
|
|
@@ -1055,7 +1177,7 @@ export type WebhookEndpoint = {
|
|
|
1055
1177
|
export type UpdateWebhookPayload = {
|
|
1056
1178
|
name?: string | null | undefined;
|
|
1057
1179
|
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;
|
|
1180
|
+
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
1181
|
channels?: Array<"email"> | null | null | undefined;
|
|
1060
1182
|
mailboxIds?: [MailboxId, ...Array<MailboxId>] | null | null | undefined;
|
|
1061
1183
|
namespaceId?: NamespaceId | null | null | undefined;
|
|
@@ -1072,7 +1194,7 @@ export type WebhookEndpointListItem = {
|
|
|
1072
1194
|
id: WebhookEndpointId;
|
|
1073
1195
|
name: string;
|
|
1074
1196
|
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">;
|
|
1197
|
+
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
1198
|
channels: Array<"email"> | null;
|
|
1077
1199
|
mailboxIds: Array<MailboxId> | null;
|
|
1078
1200
|
namespaceId: NamespaceId | null;
|
|
@@ -1094,7 +1216,7 @@ export type WebhookDeliveryCounts = {
|
|
|
1094
1216
|
export type CreateWebhookPayload = {
|
|
1095
1217
|
name: string;
|
|
1096
1218
|
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">;
|
|
1219
|
+
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
1220
|
channels?: Array<"email"> | null | undefined;
|
|
1099
1221
|
mailboxIds?: [MailboxId, ...Array<MailboxId>] | null | undefined;
|
|
1100
1222
|
namespaceId?: NamespaceId | null | undefined;
|
|
@@ -1186,6 +1308,25 @@ export type TemplateInputContractPage = {
|
|
|
1186
1308
|
nextCursor: string | null;
|
|
1187
1309
|
};
|
|
1188
1310
|
export type VersionCursor = string;
|
|
1311
|
+
export type TemplatePublicationRender = {
|
|
1312
|
+
subject: string;
|
|
1313
|
+
preheader?: string | undefined;
|
|
1314
|
+
html: string;
|
|
1315
|
+
text: string;
|
|
1316
|
+
};
|
|
1317
|
+
export type TemplatePublicationId = string;
|
|
1318
|
+
export type RenderTemplatePublicationPayload = {
|
|
1319
|
+
/**
|
|
1320
|
+
* The input to render with, validated against the publication's input schema.
|
|
1321
|
+
*/
|
|
1322
|
+
data: {
|
|
1323
|
+
[key: string]: JsonValue;
|
|
1324
|
+
};
|
|
1325
|
+
locale?: RenderLocale | undefined;
|
|
1326
|
+
timeZone?: RenderTimeZone | undefined;
|
|
1327
|
+
};
|
|
1328
|
+
export type RenderTimeZone = string;
|
|
1329
|
+
export type RenderLocale = string;
|
|
1189
1330
|
export type BrandRenderedFooter = {
|
|
1190
1331
|
withUnsubscribe: BrandFooterBlock;
|
|
1191
1332
|
withoutUnsubscribe: BrandFooterBlock;
|
|
@@ -1194,7 +1335,6 @@ export type BrandFooterBlock = {
|
|
|
1194
1335
|
html: string;
|
|
1195
1336
|
text: string;
|
|
1196
1337
|
};
|
|
1197
|
-
export type TemplatePublicationId = string;
|
|
1198
1338
|
export type Template = {
|
|
1199
1339
|
id: TemplateId;
|
|
1200
1340
|
slug: string;
|
|
@@ -1422,6 +1562,54 @@ export type ContactGroupPage = {
|
|
|
1422
1562
|
}>;
|
|
1423
1563
|
nextCursor: string | null;
|
|
1424
1564
|
};
|
|
1565
|
+
export type DeliveryUnavailableError = {
|
|
1566
|
+
_tag: "DeliveryUnavailableError";
|
|
1567
|
+
message: string;
|
|
1568
|
+
retryAfterSeconds: number;
|
|
1569
|
+
};
|
|
1570
|
+
export type FlagDisabledError = {
|
|
1571
|
+
_tag: "FlagDisabledError";
|
|
1572
|
+
flag: string;
|
|
1573
|
+
message: string;
|
|
1574
|
+
};
|
|
1575
|
+
export type CampaignFooterRequiredError = {
|
|
1576
|
+
_tag: "CampaignFooterRequiredError";
|
|
1577
|
+
message: string;
|
|
1578
|
+
};
|
|
1579
|
+
export type BrandAddressRequiredError = {
|
|
1580
|
+
_tag: "BrandAddressRequiredError";
|
|
1581
|
+
message: string;
|
|
1582
|
+
brand: string | null;
|
|
1583
|
+
};
|
|
1584
|
+
export type ExternalServiceError = {
|
|
1585
|
+
_tag: "ExternalServiceError";
|
|
1586
|
+
message: string;
|
|
1587
|
+
};
|
|
1588
|
+
export type SubscribeResult = {
|
|
1589
|
+
success: boolean;
|
|
1590
|
+
expiresAt: string;
|
|
1591
|
+
};
|
|
1592
|
+
export type SubscribePayload = {
|
|
1593
|
+
/**
|
|
1594
|
+
* The recipient email address; confirmation proves consent for this address.
|
|
1595
|
+
*/
|
|
1596
|
+
email: string;
|
|
1597
|
+
contactGroupId: ContactGroupId;
|
|
1598
|
+
/**
|
|
1599
|
+
* Your verified email sender. The ordinary send pipeline selects its domain and customer brand.
|
|
1600
|
+
*/
|
|
1601
|
+
from: {
|
|
1602
|
+
email: string;
|
|
1603
|
+
name?: string | null | undefined;
|
|
1604
|
+
};
|
|
1605
|
+
/**
|
|
1606
|
+
* Clear this unsubscribe group after confirmation; all other opt-outs remain.
|
|
1607
|
+
*/
|
|
1608
|
+
unsubscribeGroupId?: UnsubscribeId | null | undefined;
|
|
1609
|
+
templateSlug?: string | null | undefined;
|
|
1610
|
+
consentIp?: string | null | undefined;
|
|
1611
|
+
consentSource?: string | null | undefined;
|
|
1612
|
+
};
|
|
1425
1613
|
export type ContactGroupMembershipPage = {
|
|
1426
1614
|
items: Array<{
|
|
1427
1615
|
id: ContactGroupId;
|
|
@@ -1515,6 +1703,16 @@ export type ContactProfileUpdate = {
|
|
|
1515
1703
|
location?: ContactLocation | null | null | undefined;
|
|
1516
1704
|
customFields?: ContactCustomFields | null | undefined;
|
|
1517
1705
|
};
|
|
1706
|
+
export type ContactLookup = {
|
|
1707
|
+
type: "email";
|
|
1708
|
+
value: string;
|
|
1709
|
+
} | {
|
|
1710
|
+
type: "phone";
|
|
1711
|
+
value: string;
|
|
1712
|
+
} | {
|
|
1713
|
+
type: "externalId";
|
|
1714
|
+
value: string;
|
|
1715
|
+
};
|
|
1518
1716
|
export type ContactPage = {
|
|
1519
1717
|
items: Array<ContactSummary>;
|
|
1520
1718
|
nextCursor: string | null;
|
|
@@ -1528,6 +1726,7 @@ export type ContactSummary = {
|
|
|
1528
1726
|
channels: Array<"email">;
|
|
1529
1727
|
tags: Array<string>;
|
|
1530
1728
|
lists: Array<ContactListMembership>;
|
|
1729
|
+
customFields?: ContactCustomFields | null | undefined;
|
|
1531
1730
|
lastActiveAt: string | null;
|
|
1532
1731
|
createdAt: string;
|
|
1533
1732
|
};
|
|
@@ -1616,7 +1815,7 @@ export type MessageSummary = {
|
|
|
1616
1815
|
from: string | null;
|
|
1617
1816
|
to: Array<string>;
|
|
1618
1817
|
subject: string | null;
|
|
1619
|
-
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | null;
|
|
1818
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
1620
1819
|
createdAt: string;
|
|
1621
1820
|
};
|
|
1622
1821
|
export type ConversationPage = {
|
|
@@ -1901,10 +2100,6 @@ export type SuppressionEntry = {
|
|
|
1901
2100
|
expiresAt: string | null;
|
|
1902
2101
|
createdAt: string;
|
|
1903
2102
|
};
|
|
1904
|
-
export type ExternalServiceError = {
|
|
1905
|
-
_tag: "ExternalServiceError";
|
|
1906
|
-
message: string;
|
|
1907
|
-
};
|
|
1908
2103
|
export type EmailSenderId = string;
|
|
1909
2104
|
export type EmailSenderPage = {
|
|
1910
2105
|
items: Array<{
|
|
@@ -2306,7 +2501,10 @@ export type EmailContent = {
|
|
|
2306
2501
|
timeZone?: RenderTimeZone | undefined;
|
|
2307
2502
|
inReplyToMessageId?: MessageId | null | undefined;
|
|
2308
2503
|
replyTo?: ReplyToAddresses | undefined;
|
|
2309
|
-
|
|
2504
|
+
/**
|
|
2505
|
+
* The unsubscribe group for this send. Omit to inherit the template group; null disables group inheritance for a direct send. Campaigns require a group.
|
|
2506
|
+
*/
|
|
2507
|
+
unsubscribeGroupId?: UnsubscribeId | null | null | undefined;
|
|
2310
2508
|
tracking?: EmailTrackingOverrideV1 | undefined;
|
|
2311
2509
|
footer?: EmailFooterOverride | undefined;
|
|
2312
2510
|
};
|
|
@@ -2327,28 +2525,12 @@ export type EmailTrackingOverrideV1 = {
|
|
|
2327
2525
|
clicks?: boolean | undefined;
|
|
2328
2526
|
};
|
|
2329
2527
|
export type ReplyToAddresses = Array<string> | null | null;
|
|
2330
|
-
export type RenderTimeZone = string;
|
|
2331
|
-
export type RenderLocale = string;
|
|
2332
2528
|
export type TemplateData = JsonObject | null;
|
|
2333
2529
|
export type EmailAttachments = Array<EmailAttachment> | null;
|
|
2334
2530
|
export type CampaignRunPage = {
|
|
2335
2531
|
items: Array<CampaignRun>;
|
|
2336
2532
|
nextCursor: string | null;
|
|
2337
2533
|
};
|
|
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
2534
|
export type Campaign = {
|
|
2353
2535
|
id: CampaignId;
|
|
2354
2536
|
name: string;
|
|
@@ -2400,7 +2582,10 @@ export type EmailDispatchContent = {
|
|
|
2400
2582
|
timeZone?: RenderTimeZone | undefined;
|
|
2401
2583
|
inReplyToMessageId?: MessageId | null | undefined;
|
|
2402
2584
|
replyTo?: ReplyToAddresses | undefined;
|
|
2403
|
-
|
|
2585
|
+
/**
|
|
2586
|
+
* The unsubscribe group for this send. Omit to inherit the template group; null disables group inheritance for a direct send. Campaigns require a group.
|
|
2587
|
+
*/
|
|
2588
|
+
unsubscribeGroupId?: UnsubscribeId | null | null | undefined;
|
|
2404
2589
|
tracking?: EmailTrackingOverrideV1 | undefined;
|
|
2405
2590
|
footer?: EmailFooterOverride | undefined;
|
|
2406
2591
|
};
|
|
@@ -2517,15 +2702,10 @@ export type ValidateEmailResponse = {
|
|
|
2517
2702
|
hasText: boolean;
|
|
2518
2703
|
};
|
|
2519
2704
|
};
|
|
2520
|
-
export type DeliveryUnavailableError = {
|
|
2521
|
-
_tag: "DeliveryUnavailableError";
|
|
2522
|
-
message: string;
|
|
2523
|
-
retryAfterSeconds: number;
|
|
2524
|
-
};
|
|
2525
2705
|
export type MessageReceipt = {
|
|
2526
2706
|
id: MessageId;
|
|
2527
2707
|
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;
|
|
2708
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
2529
2709
|
reviewExpectedAt: string | null;
|
|
2530
2710
|
skippedRecipients: Array<SkippedRecipient>;
|
|
2531
2711
|
createdAt: string;
|
|
@@ -2557,6 +2737,8 @@ export type MessageContent = {
|
|
|
2557
2737
|
tracking?: EmailTrackingOverrideV1 | undefined;
|
|
2558
2738
|
attachments?: Array<{
|
|
2559
2739
|
filename: string;
|
|
2740
|
+
contentId?: string | null | undefined;
|
|
2741
|
+
isInline?: boolean | null | undefined;
|
|
2560
2742
|
content?: string | null | undefined;
|
|
2561
2743
|
mediaId?: MediaId | null | undefined;
|
|
2562
2744
|
contentType: string;
|
|
@@ -2575,7 +2757,7 @@ export type MessageDelivery = {
|
|
|
2575
2757
|
recipient: string | null;
|
|
2576
2758
|
status: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained";
|
|
2577
2759
|
attemptCount: number;
|
|
2578
|
-
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | null;
|
|
2760
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
2579
2761
|
nextRetryAt: string | null;
|
|
2580
2762
|
sentAt: string | null;
|
|
2581
2763
|
deliveredAt: string | null;
|
|
@@ -2611,7 +2793,7 @@ export type Message = {
|
|
|
2611
2793
|
isTest: boolean;
|
|
2612
2794
|
scheduledAt: string | null;
|
|
2613
2795
|
submission: MessageSubmission | null;
|
|
2614
|
-
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | null;
|
|
2796
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
2615
2797
|
reviewExpectedAt: string | null;
|
|
2616
2798
|
skippedRecipients: Array<SkippedRecipient>;
|
|
2617
2799
|
createdAt: string;
|
|
@@ -2980,7 +3162,7 @@ export type MessagesGetEmailResponses = {
|
|
|
2980
3162
|
scheduling: {
|
|
2981
3163
|
dueAt: string;
|
|
2982
3164
|
expiresAt: string;
|
|
2983
|
-
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | null;
|
|
3165
|
+
waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
2984
3166
|
reviewExpectedAt: string | null;
|
|
2985
3167
|
} | null;
|
|
2986
3168
|
id: string;
|
|
@@ -3055,6 +3237,9 @@ export type MessagesGetEmailResponses = {
|
|
|
3055
3237
|
expiresAt: string;
|
|
3056
3238
|
} | null;
|
|
3057
3239
|
createdAt: string;
|
|
3240
|
+
/**
|
|
3241
|
+
* When Samva's receiving server accepted the email; null for outbound email. The sender's `Date` header plays no part and stays in the raw MIME.
|
|
3242
|
+
*/
|
|
3058
3243
|
receivedAt: string | null;
|
|
3059
3244
|
processedAt: string | null;
|
|
3060
3245
|
};
|
|
@@ -4740,6 +4925,10 @@ export type EmailGetDomainByIdErrors = {
|
|
|
4740
4925
|
* ValidationError
|
|
4741
4926
|
*/
|
|
4742
4927
|
422: ValidationError;
|
|
4928
|
+
/**
|
|
4929
|
+
* InternalError
|
|
4930
|
+
*/
|
|
4931
|
+
500: InternalError;
|
|
4743
4932
|
/**
|
|
4744
4933
|
* GatewayTimeoutError
|
|
4745
4934
|
*/
|
|
@@ -5667,6 +5856,10 @@ export type EmailCheckSenderVerificationErrors = {
|
|
|
5667
5856
|
* ValidationError
|
|
5668
5857
|
*/
|
|
5669
5858
|
422: ValidationError;
|
|
5859
|
+
/**
|
|
5860
|
+
* InternalError
|
|
5861
|
+
*/
|
|
5862
|
+
500: InternalError;
|
|
5670
5863
|
/**
|
|
5671
5864
|
* ExternalServiceError
|
|
5672
5865
|
*/
|
|
@@ -6319,6 +6512,10 @@ export type EmailAddBlockErrors = {
|
|
|
6319
6512
|
* ValidationError
|
|
6320
6513
|
*/
|
|
6321
6514
|
422: ValidationError;
|
|
6515
|
+
/**
|
|
6516
|
+
* InternalError
|
|
6517
|
+
*/
|
|
6518
|
+
500: InternalError;
|
|
6322
6519
|
/**
|
|
6323
6520
|
* GatewayTimeoutError
|
|
6324
6521
|
*/
|
|
@@ -8129,6 +8326,9 @@ export type ContactsListData = {
|
|
|
8129
8326
|
cursor?: Cursor | null | undefined;
|
|
8130
8327
|
search?: string | null | undefined;
|
|
8131
8328
|
status?: "active" | "paused" | "blocked" | "archived" | null | undefined;
|
|
8329
|
+
fields?: string | null | undefined;
|
|
8330
|
+
customField?: string | null | undefined;
|
|
8331
|
+
customFieldValue?: string | null | undefined;
|
|
8132
8332
|
after?: string | null | undefined;
|
|
8133
8333
|
before?: string | null | undefined;
|
|
8134
8334
|
};
|
|
@@ -8270,11 +8470,15 @@ export type ContactsFindResponses = {
|
|
|
8270
8470
|
export type ContactsFindResponse = ContactsFindResponses[keyof ContactsFindResponses];
|
|
8271
8471
|
export type ContactsFindOrCreateData = {
|
|
8272
8472
|
body: {
|
|
8273
|
-
|
|
8274
|
-
|
|
8275
|
-
|
|
8276
|
-
|
|
8277
|
-
|
|
8473
|
+
lookup: ContactLookup;
|
|
8474
|
+
create?: {
|
|
8475
|
+
name?: string | null | undefined;
|
|
8476
|
+
displayName?: string | null | null | undefined;
|
|
8477
|
+
avatar?: string | null | null | undefined;
|
|
8478
|
+
identities?: Array<ContactIdentityInput> | null | undefined;
|
|
8479
|
+
profile?: ContactProfile | null | null | undefined;
|
|
8480
|
+
externalId?: string | null | null | undefined;
|
|
8481
|
+
} | null | undefined;
|
|
8278
8482
|
};
|
|
8279
8483
|
path?: never;
|
|
8280
8484
|
query?: never;
|
|
@@ -8317,9 +8521,12 @@ export type ContactsFindOrCreateErrors = {
|
|
|
8317
8521
|
export type ContactsFindOrCreateError = ContactsFindOrCreateErrors[keyof ContactsFindOrCreateErrors];
|
|
8318
8522
|
export type ContactsFindOrCreateResponses = {
|
|
8319
8523
|
/**
|
|
8320
|
-
*
|
|
8524
|
+
* Success
|
|
8321
8525
|
*/
|
|
8322
|
-
200:
|
|
8526
|
+
200: {
|
|
8527
|
+
contact: Contact;
|
|
8528
|
+
created: boolean;
|
|
8529
|
+
};
|
|
8323
8530
|
};
|
|
8324
8531
|
export type ContactsFindOrCreateResponse = ContactsFindOrCreateResponses[keyof ContactsFindOrCreateResponses];
|
|
8325
8532
|
export type ContactsRemoveData = {
|
|
@@ -9046,6 +9253,86 @@ export type ContactsGetGroupMembershipsResponses = {
|
|
|
9046
9253
|
200: ContactGroupMembershipPage;
|
|
9047
9254
|
};
|
|
9048
9255
|
export type ContactsGetGroupMembershipsResponse = ContactsGetGroupMembershipsResponses[keyof ContactsGetGroupMembershipsResponses];
|
|
9256
|
+
export type SubscriptionsSubscribeData = {
|
|
9257
|
+
body: {
|
|
9258
|
+
/**
|
|
9259
|
+
* The recipient email address; confirmation proves consent for this address.
|
|
9260
|
+
*/
|
|
9261
|
+
email: string;
|
|
9262
|
+
contactGroupId: ContactGroupId;
|
|
9263
|
+
/**
|
|
9264
|
+
* Your verified email sender. The ordinary send pipeline selects its domain and customer brand.
|
|
9265
|
+
*/
|
|
9266
|
+
from: {
|
|
9267
|
+
email: string;
|
|
9268
|
+
name?: string | null | undefined;
|
|
9269
|
+
};
|
|
9270
|
+
/**
|
|
9271
|
+
* Clear this unsubscribe group after confirmation; all other opt-outs remain.
|
|
9272
|
+
*/
|
|
9273
|
+
unsubscribeGroupId?: UnsubscribeId | null | undefined;
|
|
9274
|
+
templateSlug?: string | null | undefined;
|
|
9275
|
+
consentIp?: string | null | undefined;
|
|
9276
|
+
consentSource?: string | null | undefined;
|
|
9277
|
+
};
|
|
9278
|
+
path?: never;
|
|
9279
|
+
query?: never;
|
|
9280
|
+
url: "/v1/subscriptions";
|
|
9281
|
+
};
|
|
9282
|
+
export type SubscriptionsSubscribeErrors = {
|
|
9283
|
+
/**
|
|
9284
|
+
* UnauthorizedError
|
|
9285
|
+
*/
|
|
9286
|
+
401: UnauthorizedError;
|
|
9287
|
+
/**
|
|
9288
|
+
* PaymentRequiredError
|
|
9289
|
+
*/
|
|
9290
|
+
402: PaymentRequiredError;
|
|
9291
|
+
/**
|
|
9292
|
+
* ForbiddenError | OnboardingReviewRequiredError | FlagDisabledError
|
|
9293
|
+
*/
|
|
9294
|
+
403: ForbiddenError | OnboardingReviewRequiredError | FlagDisabledError;
|
|
9295
|
+
/**
|
|
9296
|
+
* ResourceNotFoundError
|
|
9297
|
+
*/
|
|
9298
|
+
404: ResourceNotFoundError;
|
|
9299
|
+
/**
|
|
9300
|
+
* ConflictError
|
|
9301
|
+
*/
|
|
9302
|
+
409: ConflictError;
|
|
9303
|
+
/**
|
|
9304
|
+
* ValidationError | BrandAddressRequiredError | CampaignFooterRequiredError
|
|
9305
|
+
*/
|
|
9306
|
+
422: ValidationError | BrandAddressRequiredError | CampaignFooterRequiredError;
|
|
9307
|
+
/**
|
|
9308
|
+
* RateLimitedError
|
|
9309
|
+
*/
|
|
9310
|
+
429: RateLimitedError;
|
|
9311
|
+
/**
|
|
9312
|
+
* InternalError
|
|
9313
|
+
*/
|
|
9314
|
+
500: InternalError;
|
|
9315
|
+
/**
|
|
9316
|
+
* BillingProviderError | ExternalServiceError
|
|
9317
|
+
*/
|
|
9318
|
+
502: BillingProviderError | ExternalServiceError;
|
|
9319
|
+
/**
|
|
9320
|
+
* SenderNotReadyError | DeliveryUnavailableError
|
|
9321
|
+
*/
|
|
9322
|
+
503: SenderNotReadyError | DeliveryUnavailableError;
|
|
9323
|
+
/**
|
|
9324
|
+
* GatewayTimeoutError
|
|
9325
|
+
*/
|
|
9326
|
+
504: GatewayTimeoutError;
|
|
9327
|
+
};
|
|
9328
|
+
export type SubscriptionsSubscribeError = SubscriptionsSubscribeErrors[keyof SubscriptionsSubscribeErrors];
|
|
9329
|
+
export type SubscriptionsSubscribeResponses = {
|
|
9330
|
+
/**
|
|
9331
|
+
* SubscribeResult
|
|
9332
|
+
*/
|
|
9333
|
+
200: SubscribeResult;
|
|
9334
|
+
};
|
|
9335
|
+
export type SubscriptionsSubscribeResponse = SubscriptionsSubscribeResponses[keyof SubscriptionsSubscribeResponses];
|
|
9049
9336
|
export type ContactGroupsListData = {
|
|
9050
9337
|
body?: never;
|
|
9051
9338
|
path?: never;
|
|
@@ -12581,6 +12868,62 @@ export type TemplatesGetPublicationResponses = {
|
|
|
12581
12868
|
};
|
|
12582
12869
|
};
|
|
12583
12870
|
export type TemplatesGetPublicationResponse = TemplatesGetPublicationResponses[keyof TemplatesGetPublicationResponses];
|
|
12871
|
+
export type TemplatesRenderPublicationData = {
|
|
12872
|
+
body: {
|
|
12873
|
+
/**
|
|
12874
|
+
* The input to render with, validated against the publication's input schema.
|
|
12875
|
+
*/
|
|
12876
|
+
data: {
|
|
12877
|
+
[key: string]: JsonValue;
|
|
12878
|
+
};
|
|
12879
|
+
locale?: RenderLocale | undefined;
|
|
12880
|
+
timeZone?: RenderTimeZone | undefined;
|
|
12881
|
+
};
|
|
12882
|
+
path: {
|
|
12883
|
+
id: TemplateId;
|
|
12884
|
+
publicationId: TemplatePublicationId;
|
|
12885
|
+
};
|
|
12886
|
+
query?: never;
|
|
12887
|
+
url: "/v1/templates/{id}/publications/{publicationId}/render";
|
|
12888
|
+
};
|
|
12889
|
+
export type TemplatesRenderPublicationErrors = {
|
|
12890
|
+
/**
|
|
12891
|
+
* UnauthorizedError
|
|
12892
|
+
*/
|
|
12893
|
+
401: UnauthorizedError;
|
|
12894
|
+
/**
|
|
12895
|
+
* ForbiddenError
|
|
12896
|
+
*/
|
|
12897
|
+
403: ForbiddenError;
|
|
12898
|
+
/**
|
|
12899
|
+
* ResourceNotFoundError
|
|
12900
|
+
*/
|
|
12901
|
+
404: ResourceNotFoundError;
|
|
12902
|
+
/**
|
|
12903
|
+
* ConflictError
|
|
12904
|
+
*/
|
|
12905
|
+
409: ConflictError;
|
|
12906
|
+
/**
|
|
12907
|
+
* ValidationError
|
|
12908
|
+
*/
|
|
12909
|
+
422: ValidationError;
|
|
12910
|
+
/**
|
|
12911
|
+
* InternalError
|
|
12912
|
+
*/
|
|
12913
|
+
500: InternalError;
|
|
12914
|
+
/**
|
|
12915
|
+
* GatewayTimeoutError
|
|
12916
|
+
*/
|
|
12917
|
+
504: GatewayTimeoutError;
|
|
12918
|
+
};
|
|
12919
|
+
export type TemplatesRenderPublicationError = TemplatesRenderPublicationErrors[keyof TemplatesRenderPublicationErrors];
|
|
12920
|
+
export type TemplatesRenderPublicationResponses = {
|
|
12921
|
+
/**
|
|
12922
|
+
* TemplatePublicationRender
|
|
12923
|
+
*/
|
|
12924
|
+
200: TemplatePublicationRender;
|
|
12925
|
+
};
|
|
12926
|
+
export type TemplatesRenderPublicationResponse = TemplatesRenderPublicationResponses[keyof TemplatesRenderPublicationResponses];
|
|
12584
12927
|
export type TemplatesListInputContractsData = {
|
|
12585
12928
|
body?: never;
|
|
12586
12929
|
path: {
|
|
@@ -13349,7 +13692,7 @@ export type WebhooksCreateData = {
|
|
|
13349
13692
|
body: {
|
|
13350
13693
|
name: string;
|
|
13351
13694
|
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">;
|
|
13695
|
+
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
13696
|
channels?: Array<"email"> | null | undefined;
|
|
13354
13697
|
mailboxIds?: [MailboxId, ...Array<MailboxId>] | null | undefined;
|
|
13355
13698
|
namespaceId?: NamespaceId | null | undefined;
|
|
@@ -13503,7 +13846,7 @@ export type WebhooksUpdateData = {
|
|
|
13503
13846
|
body: {
|
|
13504
13847
|
name?: string | null | undefined;
|
|
13505
13848
|
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;
|
|
13849
|
+
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
13850
|
channels?: Array<"email"> | null | null | undefined;
|
|
13508
13851
|
mailboxIds?: [MailboxId, ...Array<MailboxId>] | null | null | undefined;
|
|
13509
13852
|
namespaceId?: NamespaceId | null | null | undefined;
|
|
@@ -13978,6 +14321,79 @@ export type OrganizationsGetProfileResponses = {
|
|
|
13978
14321
|
};
|
|
13979
14322
|
};
|
|
13980
14323
|
export type OrganizationsGetProfileResponse = OrganizationsGetProfileResponses[keyof OrganizationsGetProfileResponses];
|
|
14324
|
+
export type OrganizationsGetTrustTierData = {
|
|
14325
|
+
body?: never;
|
|
14326
|
+
path?: never;
|
|
14327
|
+
query?: never;
|
|
14328
|
+
url: "/v1/organizations/trust-tier";
|
|
14329
|
+
};
|
|
14330
|
+
export type OrganizationsGetTrustTierErrors = {
|
|
14331
|
+
/**
|
|
14332
|
+
* UnauthorizedError
|
|
14333
|
+
*/
|
|
14334
|
+
401: UnauthorizedError;
|
|
14335
|
+
/**
|
|
14336
|
+
* ForbiddenError
|
|
14337
|
+
*/
|
|
14338
|
+
403: ForbiddenError;
|
|
14339
|
+
/**
|
|
14340
|
+
* ResourceNotFoundError
|
|
14341
|
+
*/
|
|
14342
|
+
404: ResourceNotFoundError;
|
|
14343
|
+
/**
|
|
14344
|
+
* ValidationError
|
|
14345
|
+
*/
|
|
14346
|
+
422: ValidationError;
|
|
14347
|
+
/**
|
|
14348
|
+
* InternalError
|
|
14349
|
+
*/
|
|
14350
|
+
500: InternalError;
|
|
14351
|
+
/**
|
|
14352
|
+
* BillingProviderError
|
|
14353
|
+
*/
|
|
14354
|
+
502: BillingProviderError;
|
|
14355
|
+
/**
|
|
14356
|
+
* GatewayTimeoutError
|
|
14357
|
+
*/
|
|
14358
|
+
504: GatewayTimeoutError;
|
|
14359
|
+
};
|
|
14360
|
+
export type OrganizationsGetTrustTierError = OrganizationsGetTrustTierErrors[keyof OrganizationsGetTrustTierErrors];
|
|
14361
|
+
export type OrganizationsGetTrustTierResponses = {
|
|
14362
|
+
/**
|
|
14363
|
+
* Success
|
|
14364
|
+
*/
|
|
14365
|
+
200: {
|
|
14366
|
+
tier: "screened" | "probation" | "established";
|
|
14367
|
+
changedAt: string;
|
|
14368
|
+
sendingLimits: {
|
|
14369
|
+
sendsPerSecond: number;
|
|
14370
|
+
dailySends: number;
|
|
14371
|
+
probation: {
|
|
14372
|
+
hourlyRecipients: number;
|
|
14373
|
+
dailyRecipients: number;
|
|
14374
|
+
domainShare: number;
|
|
14375
|
+
domainShareFloor: number;
|
|
14376
|
+
} | null;
|
|
14377
|
+
};
|
|
14378
|
+
graduation: {
|
|
14379
|
+
firstSentAt: string | null;
|
|
14380
|
+
elapsedDays: number;
|
|
14381
|
+
sent: number;
|
|
14382
|
+
delivered: number;
|
|
14383
|
+
hardBounces: number;
|
|
14384
|
+
hardBounceRate: number | null;
|
|
14385
|
+
complaints: number;
|
|
14386
|
+
holds: number;
|
|
14387
|
+
requirements: {
|
|
14388
|
+
minimumDays: number;
|
|
14389
|
+
delivered: number;
|
|
14390
|
+
maximumHardBounceRate: number;
|
|
14391
|
+
};
|
|
14392
|
+
blockers: Array<"too_recent" | "too_few_delivered" | "held" | "complaints" | "bounce_rate">;
|
|
14393
|
+
} | null;
|
|
14394
|
+
};
|
|
14395
|
+
};
|
|
14396
|
+
export type OrganizationsGetTrustTierResponse = OrganizationsGetTrustTierResponses[keyof OrganizationsGetTrustTierResponses];
|
|
13981
14397
|
export type OrganizationsGetUsageData = {
|
|
13982
14398
|
body?: never;
|
|
13983
14399
|
path?: never;
|
|
@@ -14542,13 +14958,9 @@ export type MailboxesListResponse = MailboxesListResponses[keyof MailboxesListRe
|
|
|
14542
14958
|
export type MailboxesCreateData = {
|
|
14543
14959
|
body: {
|
|
14544
14960
|
namespaceId?: NamespaceId | null | undefined;
|
|
14545
|
-
|
|
14546
|
-
|
|
14547
|
-
|
|
14548
|
-
defaultFrom?: {
|
|
14549
|
-
address: string;
|
|
14550
|
-
displayName?: string | null | undefined;
|
|
14551
|
-
} | null | undefined;
|
|
14961
|
+
address: string;
|
|
14962
|
+
name: string;
|
|
14963
|
+
slug?: string | null | undefined;
|
|
14552
14964
|
metadata?: MailboxMetadata | null | undefined;
|
|
14553
14965
|
};
|
|
14554
14966
|
path?: never;
|
|
@@ -14642,20 +15054,114 @@ export type MailboxesRemoveErrors = {
|
|
|
14642
15054
|
export type MailboxesRemoveError = MailboxesRemoveErrors[keyof MailboxesRemoveErrors];
|
|
14643
15055
|
export type MailboxesRemoveResponses = {
|
|
14644
15056
|
/**
|
|
14645
|
-
* SuccessResponse
|
|
15057
|
+
* SuccessResponse
|
|
15058
|
+
*/
|
|
15059
|
+
200: SuccessResponse;
|
|
15060
|
+
};
|
|
15061
|
+
export type MailboxesRemoveResponse = MailboxesRemoveResponses[keyof MailboxesRemoveResponses];
|
|
15062
|
+
export type MailboxesGetData = {
|
|
15063
|
+
body?: never;
|
|
15064
|
+
path: {
|
|
15065
|
+
id: MailboxId;
|
|
15066
|
+
};
|
|
15067
|
+
query?: never;
|
|
15068
|
+
url: "/v1/mailboxes/{id}";
|
|
15069
|
+
};
|
|
15070
|
+
export type MailboxesGetErrors = {
|
|
15071
|
+
/**
|
|
15072
|
+
* UnauthorizedError
|
|
15073
|
+
*/
|
|
15074
|
+
401: UnauthorizedError;
|
|
15075
|
+
/**
|
|
15076
|
+
* ForbiddenError
|
|
15077
|
+
*/
|
|
15078
|
+
403: ForbiddenError;
|
|
15079
|
+
/**
|
|
15080
|
+
* ResourceNotFoundError
|
|
15081
|
+
*/
|
|
15082
|
+
404: ResourceNotFoundError;
|
|
15083
|
+
/**
|
|
15084
|
+
* ValidationError
|
|
15085
|
+
*/
|
|
15086
|
+
422: ValidationError;
|
|
15087
|
+
/**
|
|
15088
|
+
* InternalError
|
|
15089
|
+
*/
|
|
15090
|
+
500: InternalError;
|
|
15091
|
+
/**
|
|
15092
|
+
* GatewayTimeoutError
|
|
15093
|
+
*/
|
|
15094
|
+
504: GatewayTimeoutError;
|
|
15095
|
+
};
|
|
15096
|
+
export type MailboxesGetError = MailboxesGetErrors[keyof MailboxesGetErrors];
|
|
15097
|
+
export type MailboxesGetResponses = {
|
|
15098
|
+
/**
|
|
15099
|
+
* Mailbox
|
|
15100
|
+
*/
|
|
15101
|
+
200: Mailbox;
|
|
15102
|
+
};
|
|
15103
|
+
export type MailboxesGetResponse = MailboxesGetResponses[keyof MailboxesGetResponses];
|
|
15104
|
+
export type MailboxesUpdateData = {
|
|
15105
|
+
body: {
|
|
15106
|
+
name?: string | null | undefined;
|
|
15107
|
+
metadata?: MailboxMetadataPatch | null | undefined;
|
|
15108
|
+
defaultFrom?: {
|
|
15109
|
+
address: string;
|
|
15110
|
+
displayName?: string | null | null | undefined;
|
|
15111
|
+
} | null | undefined;
|
|
15112
|
+
};
|
|
15113
|
+
path: {
|
|
15114
|
+
id: MailboxId;
|
|
15115
|
+
};
|
|
15116
|
+
query?: never;
|
|
15117
|
+
url: "/v1/mailboxes/{id}";
|
|
15118
|
+
};
|
|
15119
|
+
export type MailboxesUpdateErrors = {
|
|
15120
|
+
/**
|
|
15121
|
+
* UnauthorizedError
|
|
15122
|
+
*/
|
|
15123
|
+
401: UnauthorizedError;
|
|
15124
|
+
/**
|
|
15125
|
+
* ForbiddenError
|
|
15126
|
+
*/
|
|
15127
|
+
403: ForbiddenError;
|
|
15128
|
+
/**
|
|
15129
|
+
* ResourceNotFoundError
|
|
15130
|
+
*/
|
|
15131
|
+
404: ResourceNotFoundError;
|
|
15132
|
+
/**
|
|
15133
|
+
* ValidationError
|
|
15134
|
+
*/
|
|
15135
|
+
422: ValidationError;
|
|
15136
|
+
/**
|
|
15137
|
+
* InternalError
|
|
15138
|
+
*/
|
|
15139
|
+
500: InternalError;
|
|
15140
|
+
/**
|
|
15141
|
+
* GatewayTimeoutError
|
|
15142
|
+
*/
|
|
15143
|
+
504: GatewayTimeoutError;
|
|
15144
|
+
};
|
|
15145
|
+
export type MailboxesUpdateError = MailboxesUpdateErrors[keyof MailboxesUpdateErrors];
|
|
15146
|
+
export type MailboxesUpdateResponses = {
|
|
15147
|
+
/**
|
|
15148
|
+
* Mailbox
|
|
14646
15149
|
*/
|
|
14647
|
-
200:
|
|
15150
|
+
200: Mailbox;
|
|
14648
15151
|
};
|
|
14649
|
-
export type
|
|
14650
|
-
export type
|
|
14651
|
-
body
|
|
15152
|
+
export type MailboxesUpdateResponse = MailboxesUpdateResponses[keyof MailboxesUpdateResponses];
|
|
15153
|
+
export type MailboxesCreateAddressData = {
|
|
15154
|
+
body: {
|
|
15155
|
+
address: string;
|
|
15156
|
+
displayName?: string | null | undefined;
|
|
15157
|
+
};
|
|
14652
15158
|
path: {
|
|
14653
15159
|
id: MailboxId;
|
|
14654
15160
|
};
|
|
14655
15161
|
query?: never;
|
|
14656
|
-
url: "/v1/mailboxes/{id}";
|
|
15162
|
+
url: "/v1/mailboxes/{id}/addresses";
|
|
14657
15163
|
};
|
|
14658
|
-
export type
|
|
15164
|
+
export type MailboxesCreateAddressErrors = {
|
|
14659
15165
|
/**
|
|
14660
15166
|
* UnauthorizedError
|
|
14661
15167
|
*/
|
|
@@ -14668,6 +15174,10 @@ export type MailboxesGetErrors = {
|
|
|
14668
15174
|
* ResourceNotFoundError
|
|
14669
15175
|
*/
|
|
14670
15176
|
404: ResourceNotFoundError;
|
|
15177
|
+
/**
|
|
15178
|
+
* ConflictError
|
|
15179
|
+
*/
|
|
15180
|
+
409: ConflictError;
|
|
14671
15181
|
/**
|
|
14672
15182
|
* ValidationError
|
|
14673
15183
|
*/
|
|
@@ -14681,30 +15191,24 @@ export type MailboxesGetErrors = {
|
|
|
14681
15191
|
*/
|
|
14682
15192
|
504: GatewayTimeoutError;
|
|
14683
15193
|
};
|
|
14684
|
-
export type
|
|
14685
|
-
export type
|
|
15194
|
+
export type MailboxesCreateAddressError = MailboxesCreateAddressErrors[keyof MailboxesCreateAddressErrors];
|
|
15195
|
+
export type MailboxesCreateAddressResponses = {
|
|
14686
15196
|
/**
|
|
14687
|
-
*
|
|
15197
|
+
* Success
|
|
14688
15198
|
*/
|
|
14689
|
-
|
|
15199
|
+
201: Mailbox;
|
|
14690
15200
|
};
|
|
14691
|
-
export type
|
|
14692
|
-
export type
|
|
14693
|
-
body
|
|
14694
|
-
displayName?: string | null | undefined;
|
|
14695
|
-
metadata?: MailboxMetadataPatch | null | undefined;
|
|
14696
|
-
defaultFrom?: {
|
|
14697
|
-
address: string;
|
|
14698
|
-
displayName?: string | null | null | undefined;
|
|
14699
|
-
} | null | undefined;
|
|
14700
|
-
};
|
|
15201
|
+
export type MailboxesCreateAddressResponse = MailboxesCreateAddressResponses[keyof MailboxesCreateAddressResponses];
|
|
15202
|
+
export type MailboxesRemoveAddressData = {
|
|
15203
|
+
body?: never;
|
|
14701
15204
|
path: {
|
|
14702
15205
|
id: MailboxId;
|
|
15206
|
+
addressId: MailboxAddressId;
|
|
14703
15207
|
};
|
|
14704
15208
|
query?: never;
|
|
14705
|
-
url: "/v1/mailboxes/{id}";
|
|
15209
|
+
url: "/v1/mailboxes/{id}/addresses/{addressId}";
|
|
14706
15210
|
};
|
|
14707
|
-
export type
|
|
15211
|
+
export type MailboxesRemoveAddressErrors = {
|
|
14708
15212
|
/**
|
|
14709
15213
|
* UnauthorizedError
|
|
14710
15214
|
*/
|
|
@@ -14730,14 +15234,14 @@ export type MailboxesUpdateErrors = {
|
|
|
14730
15234
|
*/
|
|
14731
15235
|
504: GatewayTimeoutError;
|
|
14732
15236
|
};
|
|
14733
|
-
export type
|
|
14734
|
-
export type
|
|
15237
|
+
export type MailboxesRemoveAddressError = MailboxesRemoveAddressErrors[keyof MailboxesRemoveAddressErrors];
|
|
15238
|
+
export type MailboxesRemoveAddressResponses = {
|
|
14735
15239
|
/**
|
|
14736
15240
|
* Mailbox
|
|
14737
15241
|
*/
|
|
14738
15242
|
200: Mailbox;
|
|
14739
15243
|
};
|
|
14740
|
-
export type
|
|
15244
|
+
export type MailboxesRemoveAddressResponse = MailboxesRemoveAddressResponses[keyof MailboxesRemoveAddressResponses];
|
|
14741
15245
|
export type MailboxesPauseData = {
|
|
14742
15246
|
body?: never;
|
|
14743
15247
|
path: {
|
|
@@ -16051,17 +16555,17 @@ export type MailboxesSendMessageErrors = {
|
|
|
16051
16555
|
*/
|
|
16052
16556
|
402: PaymentRequiredError;
|
|
16053
16557
|
/**
|
|
16054
|
-
*
|
|
16558
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16055
16559
|
*/
|
|
16056
|
-
403:
|
|
16560
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16057
16561
|
/**
|
|
16058
16562
|
* ResourceNotFoundError
|
|
16059
16563
|
*/
|
|
16060
16564
|
404: ResourceNotFoundError;
|
|
16061
16565
|
/**
|
|
16062
|
-
* ConflictError
|
|
16566
|
+
* MailboxSendConflictError | ConflictError
|
|
16063
16567
|
*/
|
|
16064
|
-
409: ConflictError;
|
|
16568
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16065
16569
|
/**
|
|
16066
16570
|
* ValidationError
|
|
16067
16571
|
*/
|
|
@@ -16093,6 +16597,10 @@ export type MailboxesSendMessageResponses = {
|
|
|
16093
16597
|
* MailboxSendReceipt
|
|
16094
16598
|
*/
|
|
16095
16599
|
200: MailboxSendReceipt;
|
|
16600
|
+
/**
|
|
16601
|
+
* MailboxPendingSendReceipt
|
|
16602
|
+
*/
|
|
16603
|
+
202: MailboxPendingSendReceipt;
|
|
16096
16604
|
};
|
|
16097
16605
|
export type MailboxesSendMessageResponse = MailboxesSendMessageResponses[keyof MailboxesSendMessageResponses];
|
|
16098
16606
|
export type MailboxesGetMessageData = {
|
|
@@ -16225,6 +16733,54 @@ export type MailboxesGetMessageAttachmentResponses = {
|
|
|
16225
16733
|
200: MailboxDownloadUrl;
|
|
16226
16734
|
};
|
|
16227
16735
|
export type MailboxesGetMessageAttachmentResponse = MailboxesGetMessageAttachmentResponses[keyof MailboxesGetMessageAttachmentResponses];
|
|
16736
|
+
export type MailboxesCopyMessageAttachmentData = {
|
|
16737
|
+
body?: never;
|
|
16738
|
+
path: {
|
|
16739
|
+
id: MailboxId;
|
|
16740
|
+
messageId: MessageId;
|
|
16741
|
+
attachmentId: AttachmentId;
|
|
16742
|
+
};
|
|
16743
|
+
query?: never;
|
|
16744
|
+
url: "/v1/mailboxes/{id}/messages/{messageId}/attachments/{attachmentId}/copy";
|
|
16745
|
+
};
|
|
16746
|
+
export type MailboxesCopyMessageAttachmentErrors = {
|
|
16747
|
+
/**
|
|
16748
|
+
* UnauthorizedError
|
|
16749
|
+
*/
|
|
16750
|
+
401: UnauthorizedError;
|
|
16751
|
+
/**
|
|
16752
|
+
* ForbiddenError
|
|
16753
|
+
*/
|
|
16754
|
+
403: ForbiddenError;
|
|
16755
|
+
/**
|
|
16756
|
+
* ResourceNotFoundError
|
|
16757
|
+
*/
|
|
16758
|
+
404: ResourceNotFoundError;
|
|
16759
|
+
/**
|
|
16760
|
+
* ConflictError
|
|
16761
|
+
*/
|
|
16762
|
+
409: ConflictError;
|
|
16763
|
+
/**
|
|
16764
|
+
* ValidationError
|
|
16765
|
+
*/
|
|
16766
|
+
422: ValidationError;
|
|
16767
|
+
/**
|
|
16768
|
+
* InternalError
|
|
16769
|
+
*/
|
|
16770
|
+
500: InternalError;
|
|
16771
|
+
/**
|
|
16772
|
+
* GatewayTimeoutError
|
|
16773
|
+
*/
|
|
16774
|
+
504: GatewayTimeoutError;
|
|
16775
|
+
};
|
|
16776
|
+
export type MailboxesCopyMessageAttachmentError = MailboxesCopyMessageAttachmentErrors[keyof MailboxesCopyMessageAttachmentErrors];
|
|
16777
|
+
export type MailboxesCopyMessageAttachmentResponses = {
|
|
16778
|
+
/**
|
|
16779
|
+
* MailboxCopiedAttachment
|
|
16780
|
+
*/
|
|
16781
|
+
201: MailboxCopiedAttachment;
|
|
16782
|
+
};
|
|
16783
|
+
export type MailboxesCopyMessageAttachmentResponse = MailboxesCopyMessageAttachmentResponses[keyof MailboxesCopyMessageAttachmentResponses];
|
|
16228
16784
|
export type MailboxesReplyData = {
|
|
16229
16785
|
body: {
|
|
16230
16786
|
cc?: Array<string> | null | undefined;
|
|
@@ -16253,17 +16809,17 @@ export type MailboxesReplyErrors = {
|
|
|
16253
16809
|
*/
|
|
16254
16810
|
402: PaymentRequiredError;
|
|
16255
16811
|
/**
|
|
16256
|
-
*
|
|
16812
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16257
16813
|
*/
|
|
16258
|
-
403:
|
|
16814
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16259
16815
|
/**
|
|
16260
16816
|
* ResourceNotFoundError
|
|
16261
16817
|
*/
|
|
16262
16818
|
404: ResourceNotFoundError;
|
|
16263
16819
|
/**
|
|
16264
|
-
* ConflictError
|
|
16820
|
+
* MailboxSendConflictError | ConflictError
|
|
16265
16821
|
*/
|
|
16266
|
-
409: ConflictError;
|
|
16822
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16267
16823
|
/**
|
|
16268
16824
|
* ValidationError
|
|
16269
16825
|
*/
|
|
@@ -16295,6 +16851,10 @@ export type MailboxesReplyResponses = {
|
|
|
16295
16851
|
* MailboxSendReceipt
|
|
16296
16852
|
*/
|
|
16297
16853
|
200: MailboxSendReceipt;
|
|
16854
|
+
/**
|
|
16855
|
+
* MailboxPendingSendReceipt
|
|
16856
|
+
*/
|
|
16857
|
+
202: MailboxPendingSendReceipt;
|
|
16298
16858
|
};
|
|
16299
16859
|
export type MailboxesReplyResponse = MailboxesReplyResponses[keyof MailboxesReplyResponses];
|
|
16300
16860
|
export type MailboxesReplyAllData = {
|
|
@@ -16325,17 +16885,17 @@ export type MailboxesReplyAllErrors = {
|
|
|
16325
16885
|
*/
|
|
16326
16886
|
402: PaymentRequiredError;
|
|
16327
16887
|
/**
|
|
16328
|
-
*
|
|
16888
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16329
16889
|
*/
|
|
16330
|
-
403:
|
|
16890
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16331
16891
|
/**
|
|
16332
16892
|
* ResourceNotFoundError
|
|
16333
16893
|
*/
|
|
16334
16894
|
404: ResourceNotFoundError;
|
|
16335
16895
|
/**
|
|
16336
|
-
* ConflictError
|
|
16896
|
+
* MailboxSendConflictError | ConflictError
|
|
16337
16897
|
*/
|
|
16338
|
-
409: ConflictError;
|
|
16898
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16339
16899
|
/**
|
|
16340
16900
|
* ValidationError
|
|
16341
16901
|
*/
|
|
@@ -16367,6 +16927,10 @@ export type MailboxesReplyAllResponses = {
|
|
|
16367
16927
|
* MailboxSendReceipt
|
|
16368
16928
|
*/
|
|
16369
16929
|
200: MailboxSendReceipt;
|
|
16930
|
+
/**
|
|
16931
|
+
* MailboxPendingSendReceipt
|
|
16932
|
+
*/
|
|
16933
|
+
202: MailboxPendingSendReceipt;
|
|
16370
16934
|
};
|
|
16371
16935
|
export type MailboxesReplyAllResponse = MailboxesReplyAllResponses[keyof MailboxesReplyAllResponses];
|
|
16372
16936
|
export type MailboxesForwardData = {
|
|
@@ -16398,17 +16962,17 @@ export type MailboxesForwardErrors = {
|
|
|
16398
16962
|
*/
|
|
16399
16963
|
402: PaymentRequiredError;
|
|
16400
16964
|
/**
|
|
16401
|
-
*
|
|
16965
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16402
16966
|
*/
|
|
16403
|
-
403:
|
|
16967
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16404
16968
|
/**
|
|
16405
16969
|
* ResourceNotFoundError
|
|
16406
16970
|
*/
|
|
16407
16971
|
404: ResourceNotFoundError;
|
|
16408
16972
|
/**
|
|
16409
|
-
* ConflictError
|
|
16973
|
+
* MailboxSendConflictError | ConflictError
|
|
16410
16974
|
*/
|
|
16411
|
-
409: ConflictError;
|
|
16975
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16412
16976
|
/**
|
|
16413
16977
|
* ValidationError
|
|
16414
16978
|
*/
|
|
@@ -16440,6 +17004,10 @@ export type MailboxesForwardResponses = {
|
|
|
16440
17004
|
* MailboxSendReceipt
|
|
16441
17005
|
*/
|
|
16442
17006
|
200: MailboxSendReceipt;
|
|
17007
|
+
/**
|
|
17008
|
+
* MailboxPendingSendReceipt
|
|
17009
|
+
*/
|
|
17010
|
+
202: MailboxPendingSendReceipt;
|
|
16443
17011
|
};
|
|
16444
17012
|
export type MailboxesForwardResponse = MailboxesForwardResponses[keyof MailboxesForwardResponses];
|
|
16445
17013
|
export type MailboxesListQuarantineData = {
|
|
@@ -16849,17 +17417,17 @@ export type MailboxesSendDraftErrors = {
|
|
|
16849
17417
|
*/
|
|
16850
17418
|
402: PaymentRequiredError;
|
|
16851
17419
|
/**
|
|
16852
|
-
*
|
|
17420
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16853
17421
|
*/
|
|
16854
|
-
403:
|
|
17422
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16855
17423
|
/**
|
|
16856
17424
|
* ResourceNotFoundError
|
|
16857
17425
|
*/
|
|
16858
17426
|
404: ResourceNotFoundError;
|
|
16859
17427
|
/**
|
|
16860
|
-
* ConflictError
|
|
17428
|
+
* MailboxSendConflictError | ConflictError
|
|
16861
17429
|
*/
|
|
16862
|
-
409: ConflictError;
|
|
17430
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16863
17431
|
/**
|
|
16864
17432
|
* ValidationError
|
|
16865
17433
|
*/
|
|
@@ -16891,6 +17459,10 @@ export type MailboxesSendDraftResponses = {
|
|
|
16891
17459
|
* MailboxSendReceipt
|
|
16892
17460
|
*/
|
|
16893
17461
|
200: MailboxSendReceipt;
|
|
17462
|
+
/**
|
|
17463
|
+
* MailboxPendingSendReceipt
|
|
17464
|
+
*/
|
|
17465
|
+
202: MailboxPendingSendReceipt;
|
|
16894
17466
|
};
|
|
16895
17467
|
export type MailboxesSendDraftResponse = MailboxesSendDraftResponses[keyof MailboxesSendDraftResponses];
|
|
16896
17468
|
export type MailboxesListActionsData = {
|
|
@@ -16901,7 +17473,8 @@ export type MailboxesListActionsData = {
|
|
|
16901
17473
|
query?: {
|
|
16902
17474
|
limit?: string | null | undefined;
|
|
16903
17475
|
cursor?: Cursor | null | undefined;
|
|
16904
|
-
|
|
17476
|
+
threadId?: MailboxThreadId | null | undefined;
|
|
17477
|
+
state?: "proposed" | "allowed" | "approvalRequired" | "policyDenied" | "approved" | "approvalDenied" | "executing" | "executed" | "failed" | "queued" | "accepted" | "completed" | "notSent" | "uncertain" | null | undefined;
|
|
16905
17478
|
after?: string | null | undefined;
|
|
16906
17479
|
before?: string | null | undefined;
|
|
16907
17480
|
};
|
|
@@ -16941,6 +17514,183 @@ export type MailboxesListActionsResponses = {
|
|
|
16941
17514
|
200: MailboxActionPage;
|
|
16942
17515
|
};
|
|
16943
17516
|
export type MailboxesListActionsResponse = MailboxesListActionsResponses[keyof MailboxesListActionsResponses];
|
|
17517
|
+
export type MailboxesGetActionData = {
|
|
17518
|
+
body?: never;
|
|
17519
|
+
path: {
|
|
17520
|
+
id: MailboxId;
|
|
17521
|
+
actionId: MailboxActionId;
|
|
17522
|
+
};
|
|
17523
|
+
query?: never;
|
|
17524
|
+
url: "/v1/mailboxes/{id}/actions/{actionId}";
|
|
17525
|
+
};
|
|
17526
|
+
export type MailboxesGetActionErrors = {
|
|
17527
|
+
/**
|
|
17528
|
+
* UnauthorizedError
|
|
17529
|
+
*/
|
|
17530
|
+
401: UnauthorizedError;
|
|
17531
|
+
/**
|
|
17532
|
+
* ForbiddenError
|
|
17533
|
+
*/
|
|
17534
|
+
403: ForbiddenError;
|
|
17535
|
+
/**
|
|
17536
|
+
* ResourceNotFoundError
|
|
17537
|
+
*/
|
|
17538
|
+
404: ResourceNotFoundError;
|
|
17539
|
+
/**
|
|
17540
|
+
* ValidationError
|
|
17541
|
+
*/
|
|
17542
|
+
422: ValidationError;
|
|
17543
|
+
/**
|
|
17544
|
+
* InternalError
|
|
17545
|
+
*/
|
|
17546
|
+
500: InternalError;
|
|
17547
|
+
/**
|
|
17548
|
+
* GatewayTimeoutError
|
|
17549
|
+
*/
|
|
17550
|
+
504: GatewayTimeoutError;
|
|
17551
|
+
};
|
|
17552
|
+
export type MailboxesGetActionError = MailboxesGetActionErrors[keyof MailboxesGetActionErrors];
|
|
17553
|
+
export type MailboxesGetActionResponses = {
|
|
17554
|
+
/**
|
|
17555
|
+
* MailboxAction
|
|
17556
|
+
*/
|
|
17557
|
+
200: MailboxAction;
|
|
17558
|
+
};
|
|
17559
|
+
export type MailboxesGetActionResponse = MailboxesGetActionResponses[keyof MailboxesGetActionResponses];
|
|
17560
|
+
export type MailboxesCancelActionData = {
|
|
17561
|
+
body?: never;
|
|
17562
|
+
path: {
|
|
17563
|
+
id: MailboxId;
|
|
17564
|
+
actionId: MailboxActionId;
|
|
17565
|
+
};
|
|
17566
|
+
query?: never;
|
|
17567
|
+
url: "/v1/mailboxes/{id}/actions/{actionId}/cancel";
|
|
17568
|
+
};
|
|
17569
|
+
export type MailboxesCancelActionErrors = {
|
|
17570
|
+
/**
|
|
17571
|
+
* UnauthorizedError
|
|
17572
|
+
*/
|
|
17573
|
+
401: UnauthorizedError;
|
|
17574
|
+
/**
|
|
17575
|
+
* PaymentRequiredError
|
|
17576
|
+
*/
|
|
17577
|
+
402: PaymentRequiredError;
|
|
17578
|
+
/**
|
|
17579
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
17580
|
+
*/
|
|
17581
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
17582
|
+
/**
|
|
17583
|
+
* ResourceNotFoundError
|
|
17584
|
+
*/
|
|
17585
|
+
404: ResourceNotFoundError;
|
|
17586
|
+
/**
|
|
17587
|
+
* MailboxSendConflictError | ConflictError
|
|
17588
|
+
*/
|
|
17589
|
+
409: MailboxSendConflictError | ConflictError;
|
|
17590
|
+
/**
|
|
17591
|
+
* ValidationError
|
|
17592
|
+
*/
|
|
17593
|
+
422: ValidationError;
|
|
17594
|
+
/**
|
|
17595
|
+
* RateLimitedError
|
|
17596
|
+
*/
|
|
17597
|
+
429: RateLimitedError;
|
|
17598
|
+
/**
|
|
17599
|
+
* InternalError
|
|
17600
|
+
*/
|
|
17601
|
+
500: InternalError;
|
|
17602
|
+
/**
|
|
17603
|
+
* BillingProviderError
|
|
17604
|
+
*/
|
|
17605
|
+
502: BillingProviderError;
|
|
17606
|
+
/**
|
|
17607
|
+
* SenderNotReadyError
|
|
17608
|
+
*/
|
|
17609
|
+
503: SenderNotReadyError;
|
|
17610
|
+
/**
|
|
17611
|
+
* GatewayTimeoutError
|
|
17612
|
+
*/
|
|
17613
|
+
504: GatewayTimeoutError;
|
|
17614
|
+
};
|
|
17615
|
+
export type MailboxesCancelActionError = MailboxesCancelActionErrors[keyof MailboxesCancelActionErrors];
|
|
17616
|
+
export type MailboxesCancelActionResponses = {
|
|
17617
|
+
/**
|
|
17618
|
+
* MailboxSendReceipt
|
|
17619
|
+
*/
|
|
17620
|
+
200: MailboxSendReceipt;
|
|
17621
|
+
/**
|
|
17622
|
+
* MailboxPendingSendReceipt
|
|
17623
|
+
*/
|
|
17624
|
+
202: MailboxPendingSendReceipt;
|
|
17625
|
+
};
|
|
17626
|
+
export type MailboxesCancelActionResponse = MailboxesCancelActionResponses[keyof MailboxesCancelActionResponses];
|
|
17627
|
+
export type MailboxesRetryActionData = {
|
|
17628
|
+
body?: never;
|
|
17629
|
+
path: {
|
|
17630
|
+
id: MailboxId;
|
|
17631
|
+
actionId: MailboxActionId;
|
|
17632
|
+
};
|
|
17633
|
+
query?: never;
|
|
17634
|
+
url: "/v1/mailboxes/{id}/actions/{actionId}/retry";
|
|
17635
|
+
};
|
|
17636
|
+
export type MailboxesRetryActionErrors = {
|
|
17637
|
+
/**
|
|
17638
|
+
* UnauthorizedError
|
|
17639
|
+
*/
|
|
17640
|
+
401: UnauthorizedError;
|
|
17641
|
+
/**
|
|
17642
|
+
* PaymentRequiredError
|
|
17643
|
+
*/
|
|
17644
|
+
402: PaymentRequiredError;
|
|
17645
|
+
/**
|
|
17646
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
17647
|
+
*/
|
|
17648
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
17649
|
+
/**
|
|
17650
|
+
* ResourceNotFoundError
|
|
17651
|
+
*/
|
|
17652
|
+
404: ResourceNotFoundError;
|
|
17653
|
+
/**
|
|
17654
|
+
* MailboxSendConflictError | ConflictError
|
|
17655
|
+
*/
|
|
17656
|
+
409: MailboxSendConflictError | ConflictError;
|
|
17657
|
+
/**
|
|
17658
|
+
* ValidationError
|
|
17659
|
+
*/
|
|
17660
|
+
422: ValidationError;
|
|
17661
|
+
/**
|
|
17662
|
+
* RateLimitedError
|
|
17663
|
+
*/
|
|
17664
|
+
429: RateLimitedError;
|
|
17665
|
+
/**
|
|
17666
|
+
* InternalError
|
|
17667
|
+
*/
|
|
17668
|
+
500: InternalError;
|
|
17669
|
+
/**
|
|
17670
|
+
* BillingProviderError
|
|
17671
|
+
*/
|
|
17672
|
+
502: BillingProviderError;
|
|
17673
|
+
/**
|
|
17674
|
+
* SenderNotReadyError
|
|
17675
|
+
*/
|
|
17676
|
+
503: SenderNotReadyError;
|
|
17677
|
+
/**
|
|
17678
|
+
* GatewayTimeoutError
|
|
17679
|
+
*/
|
|
17680
|
+
504: GatewayTimeoutError;
|
|
17681
|
+
};
|
|
17682
|
+
export type MailboxesRetryActionError = MailboxesRetryActionErrors[keyof MailboxesRetryActionErrors];
|
|
17683
|
+
export type MailboxesRetryActionResponses = {
|
|
17684
|
+
/**
|
|
17685
|
+
* MailboxSendReceipt
|
|
17686
|
+
*/
|
|
17687
|
+
200: MailboxSendReceipt;
|
|
17688
|
+
/**
|
|
17689
|
+
* MailboxPendingSendReceipt
|
|
17690
|
+
*/
|
|
17691
|
+
202: MailboxPendingSendReceipt;
|
|
17692
|
+
};
|
|
17693
|
+
export type MailboxesRetryActionResponse = MailboxesRetryActionResponses[keyof MailboxesRetryActionResponses];
|
|
16944
17694
|
export type MailboxesApproveActionData = {
|
|
16945
17695
|
body?: never;
|
|
16946
17696
|
path: {
|
|
@@ -16960,17 +17710,17 @@ export type MailboxesApproveActionErrors = {
|
|
|
16960
17710
|
*/
|
|
16961
17711
|
402: PaymentRequiredError;
|
|
16962
17712
|
/**
|
|
16963
|
-
*
|
|
17713
|
+
* MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError
|
|
16964
17714
|
*/
|
|
16965
|
-
403:
|
|
17715
|
+
403: MailboxSendRefusedError | OnboardingReviewRequiredError | ForbiddenError;
|
|
16966
17716
|
/**
|
|
16967
17717
|
* ResourceNotFoundError
|
|
16968
17718
|
*/
|
|
16969
17719
|
404: ResourceNotFoundError;
|
|
16970
17720
|
/**
|
|
16971
|
-
* ConflictError
|
|
17721
|
+
* MailboxSendConflictError | ConflictError
|
|
16972
17722
|
*/
|
|
16973
|
-
409: ConflictError;
|
|
17723
|
+
409: MailboxSendConflictError | ConflictError;
|
|
16974
17724
|
/**
|
|
16975
17725
|
* ValidationError
|
|
16976
17726
|
*/
|
|
@@ -17002,6 +17752,10 @@ export type MailboxesApproveActionResponses = {
|
|
|
17002
17752
|
* MailboxAction
|
|
17003
17753
|
*/
|
|
17004
17754
|
200: MailboxAction;
|
|
17755
|
+
/**
|
|
17756
|
+
* MailboxPendingAction
|
|
17757
|
+
*/
|
|
17758
|
+
202: MailboxPendingAction;
|
|
17005
17759
|
};
|
|
17006
17760
|
export type MailboxesApproveActionResponse = MailboxesApproveActionResponses[keyof MailboxesApproveActionResponses];
|
|
17007
17761
|
export type MailboxesDenyActionData = {
|
|
@@ -17029,9 +17783,9 @@ export type MailboxesDenyActionErrors = {
|
|
|
17029
17783
|
*/
|
|
17030
17784
|
404: ResourceNotFoundError;
|
|
17031
17785
|
/**
|
|
17032
|
-
* ConflictError
|
|
17786
|
+
* ConflictError | MailboxSendConflictError
|
|
17033
17787
|
*/
|
|
17034
|
-
409: ConflictError;
|
|
17788
|
+
409: ConflictError | MailboxSendConflictError;
|
|
17035
17789
|
/**
|
|
17036
17790
|
* ValidationError
|
|
17037
17791
|
*/
|