samva 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/AGENTS.md +3 -2
  2. package/README.md +12 -2
  3. package/dist/{categories-B9Nw2v_F.js → categories-4u9Az4No.js} +24 -8
  4. package/dist/client/sdk.gen.d.ts +406 -74
  5. package/dist/client/types.gen.d.ts +2583 -279
  6. package/dist/{client-B7gEkvEq.js → client-DCM6U0-I.js} +2183 -772
  7. package/dist/{client-attribution-B2yJBXdZ.js → client-attribution-DYUSAa76.js} +2 -2
  8. package/dist/effect/analytics.d.ts +66 -0
  9. package/dist/effect/analytics.js +21 -0
  10. package/dist/effect/api-keys.d.ts +198 -34
  11. package/dist/effect/api-keys.js +1 -1
  12. package/dist/effect/attachments.d.ts +53 -0
  13. package/dist/effect/attachments.js +17 -0
  14. package/dist/effect/campaigns.d.ts +36 -18
  15. package/dist/effect/campaigns.js +1 -1
  16. package/dist/effect/categories.d.ts +3 -3
  17. package/dist/effect/categories.js +1 -1
  18. package/dist/effect/client.js +1 -1
  19. package/dist/effect/contact-groups.d.ts +375 -0
  20. package/dist/effect/contact-groups.js +29 -0
  21. package/dist/effect/contacts.d.ts +35 -19
  22. package/dist/effect/contacts.js +1 -1
  23. package/dist/effect/conversations.d.ts +179 -47
  24. package/dist/effect/conversations.js +1 -1
  25. package/dist/effect/custom-fields.d.ts +111 -0
  26. package/dist/effect/custom-fields.js +17 -0
  27. package/dist/effect/design.d.ts +2 -2
  28. package/dist/effect/design.js +1 -1
  29. package/dist/effect/email.d.ts +254 -118
  30. package/dist/effect/email.js +2 -2
  31. package/dist/effect/generated-metadata.d.ts +12 -4
  32. package/dist/effect/generated.d.ts +11189 -6155
  33. package/dist/effect/index.d.ts +6 -1
  34. package/dist/effect/index.js +8 -3
  35. package/dist/effect/internal/operation.d.ts +115 -27
  36. package/dist/effect/media.d.ts +5 -5
  37. package/dist/effect/media.js +1 -1
  38. package/dist/effect/messages.d.ts +303 -73
  39. package/dist/effect/messages.js +1 -1
  40. package/dist/effect/operations.d.ts +6 -6
  41. package/dist/effect/operations.js +1 -1
  42. package/dist/effect/organizations.d.ts +7 -110
  43. package/dist/effect/organizations.js +2 -4
  44. package/dist/effect/retry.js +1 -1
  45. package/dist/effect/scheduled-messages.d.ts +7 -7
  46. package/dist/effect/scheduled-messages.js +1 -1
  47. package/dist/effect/templates.d.ts +35 -307
  48. package/dist/effect/templates.js +3 -5
  49. package/dist/effect/unsubscribe-groups.d.ts +161 -0
  50. package/dist/effect/unsubscribe-groups.js +25 -0
  51. package/dist/effect/webhooks.d.ts +18 -18
  52. package/dist/effect/webhooks.js +2 -2
  53. package/dist/index.js +2 -2
  54. package/dist/{normalize-BiIJnycv.js → normalize-B79uJIeb.js} +13 -14
  55. package/dist/normalize.d.ts +3 -7
  56. package/dist/{operation-B4FjN6wq.js → operation-02YX3hY9.js} +96 -8
  57. package/dist/promises/errors.gen.d.ts +30 -41
  58. package/dist/promises/index.d.ts +18 -4
  59. package/dist/promises/index.js +2 -2
  60. package/dist/promises/types.gen.d.ts +1 -1
  61. package/dist/{promises-CP_nxUus.js → promises-8MaPNAam.js} +1209 -288
  62. package/dist/service-map.d.ts +155 -8
  63. package/package.json +28 -8
@@ -3,6 +3,66 @@ export type ClientOptions = {
3
3
  };
4
4
  export type ConversationId = string;
5
5
  export type ContactId = string;
6
+ /**
7
+ * Requested per-send engagement tracking policy. Recipient opt-out takes precedence, then explicit fields, organization defaults, and product defaults.
8
+ */
9
+ export type EmailTrackingOverrideV1 = {
10
+ /**
11
+ * Override open tracking for this send. Omit to inherit the organization default. A recipient tracking opt-out always disables tracking.
12
+ */
13
+ opens?: boolean | undefined;
14
+ /**
15
+ * Override click tracking for this send. Omit to inherit the organization default. A recipient tracking opt-out always disables tracking.
16
+ */
17
+ clicks?: boolean | undefined;
18
+ };
19
+ export type MediaId = string;
20
+ export type MessageContent = {
21
+ text?: string | null | undefined;
22
+ html?: string | null | undefined;
23
+ markdown?: string | null | undefined;
24
+ email?: {
25
+ subject?: string | null | undefined;
26
+ html?: string | null | undefined;
27
+ text?: string | null | undefined;
28
+ headers?: {
29
+ [key: string]: string;
30
+ } | null | undefined;
31
+ tracking?: EmailTrackingOverrideV1 | undefined;
32
+ attachments?: Array<{
33
+ filename: string;
34
+ content?: string | null | undefined;
35
+ mediaId?: MediaId | null | undefined;
36
+ contentType: string;
37
+ size: number;
38
+ }> | null | undefined;
39
+ } | null | undefined;
40
+ metadata?: {
41
+ [key: string]: JsonValue;
42
+ } | null | undefined;
43
+ };
44
+ export type ApiKeyId = string;
45
+ export type SubmissionCredential = {
46
+ kind: "api_key";
47
+ apiKeyId: ApiKeyId | null;
48
+ } | {
49
+ kind: "oauth";
50
+ clientId: string | null;
51
+ } | {
52
+ kind: "session";
53
+ };
54
+ export type UserId = string;
55
+ export type SubmissionClient = {
56
+ surface: "typescript-promise" | "typescript-effect" | "cli" | "mcp";
57
+ version: string;
58
+ };
59
+ export type MessageSubmission = {
60
+ origin: "direct" | "campaign" | "scheduled";
61
+ transport: "http" | null;
62
+ credential: SubmissionCredential | null;
63
+ userId: UserId | null;
64
+ client: SubmissionClient | null;
65
+ };
6
66
  export type MessageContact = {
7
67
  id: string;
8
68
  name: string;
@@ -14,6 +74,15 @@ export type MessageContact = {
14
74
  verified: boolean;
15
75
  }>;
16
76
  };
77
+ export type DeliveryErrorDetails = {
78
+ code?: string | null | undefined;
79
+ name?: string | null | undefined;
80
+ message?: string | null | undefined;
81
+ details?: {
82
+ [key: string]: string | number | null;
83
+ } | null | undefined;
84
+ retryable?: boolean | null | undefined;
85
+ };
17
86
  export type JsonObject = {
18
87
  [key: string]: JsonValue;
19
88
  };
@@ -28,7 +97,7 @@ export type Message = {
28
97
  } | null;
29
98
  channel: "email";
30
99
  direction: "outbound" | "inbound";
31
- content: JsonValue;
100
+ content: MessageContent;
32
101
  metadata: {
33
102
  [key: string]: JsonValue;
34
103
  } | null;
@@ -37,17 +106,11 @@ export type Message = {
37
106
  tags: Array<string>;
38
107
  categories: Array<string>;
39
108
  isTest: boolean;
40
- isInternal: boolean;
41
- isAutomated: boolean;
42
109
  externalId: string | null;
43
110
  referenceId: string | null;
44
- apiKeyId: string | null;
45
- httpMethod: string | null;
46
- apiRequestMetadata: JsonValue | null;
47
- apiResponseMetadata: JsonValue | null;
111
+ submission: MessageSubmission | null;
48
112
  createdAt: string;
49
113
  updatedAt: string;
50
- createdBy: string | null;
51
114
  fromContact: MessageContact | null;
52
115
  toContacts: Array<MessageContact>;
53
116
  recipients: Array<{
@@ -67,7 +130,7 @@ export type Message = {
67
130
  scheduling: {
68
131
  dueAt: string;
69
132
  expiresAt: string;
70
- waitReason: "rate" | "daily-quota" | "domain-health" | "tenant-health" | "provider-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | null;
133
+ waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | null;
71
134
  } | null;
72
135
  id: string;
73
136
  messageId: string;
@@ -87,17 +150,16 @@ export type Message = {
87
150
  terminalAt: string | null;
88
151
  errorCode: string | null;
89
152
  errorMessage: string | null;
90
- errorDetails: JsonValue | null;
153
+ errorDetails: DeliveryErrorDetails | null;
91
154
  cost: string;
92
155
  currency: string;
93
156
  idempotencyKey: string | null;
94
- metadata: JsonValue | null;
95
157
  createdAt: string;
96
158
  updatedAt: string;
97
159
  }>;
98
160
  emailDeliveryDetails: Array<{
99
161
  deliveryId: string;
100
- messageIdHeader: string | null;
162
+ messageIdHeader: string;
101
163
  inReplyTo: string | null;
102
164
  references: Array<string> | null;
103
165
  subject: string;
@@ -138,23 +200,24 @@ export type PaginationMeta = {
138
200
  };
139
201
  export type InternalError = {
140
202
  _tag: "InternalError";
141
- operation: string;
142
203
  message: string;
143
204
  };
144
205
  export type ForbiddenError = {
145
206
  _tag: "ForbiddenError";
146
- operation: string;
147
207
  message: string;
148
208
  };
149
209
  export type UnauthorizedError = {
150
210
  _tag: "UnauthorizedError";
151
- operation: string;
152
211
  message: string;
153
212
  };
213
+ export type GatewayTimeoutError = {
214
+ _tag: "GatewayTimeoutError";
215
+ message: string;
216
+ retryAfterSeconds: number;
217
+ };
154
218
  export type MessageId = string;
155
219
  export type ResourceNotFoundError = {
156
220
  _tag: "ResourceNotFoundError";
157
- operation: string;
158
221
  resource: string;
159
222
  id: string;
160
223
  };
@@ -180,7 +243,6 @@ export type EmailSender = {
180
243
  email: string;
181
244
  name?: string | null | undefined;
182
245
  } | null;
183
- export type MediaId = string;
184
246
  export type EmailAttachment = {
185
247
  filename: string;
186
248
  content?: string | null | undefined;
@@ -195,19 +257,6 @@ export type TemplateId = string;
195
257
  export type TemplateData = JsonObject | null;
196
258
  export type ReplyToAddresses = Array<string> | null | null;
197
259
  export type UnsubscribeId = string;
198
- /**
199
- * Requested per-send engagement tracking policy. Recipient opt-out takes precedence, then explicit fields, organization defaults, and product defaults.
200
- */
201
- export type EmailTrackingOverrideV1 = {
202
- /**
203
- * Override open tracking for this send. Omit to inherit the organization default. A recipient tracking opt-out always disables tracking.
204
- */
205
- opens?: boolean | undefined;
206
- /**
207
- * Override click tracking for this send. Omit to inherit the organization default. A recipient tracking opt-out always disables tracking.
208
- */
209
- clicks?: boolean | undefined;
210
- };
211
260
  export type EmailFooterOverride = {
212
261
  enabled?: boolean | null | undefined;
213
262
  };
@@ -240,36 +289,30 @@ export type EmailSendMessagePayload = {
240
289
  export type SendMessagePayload = EmailSendMessagePayload;
241
290
  export type ConflictError = {
242
291
  _tag: "ConflictError";
243
- operation: string;
244
292
  message: string;
245
293
  resource: string;
246
294
  id?: string | null | undefined;
247
295
  };
248
296
  export type RateLimitedError = {
249
297
  _tag: "RateLimitedError";
250
- operation: string;
251
298
  retryAfterSeconds: number;
252
299
  };
253
300
  export type PaymentRequiredError = {
254
301
  _tag: "PaymentRequiredError";
255
- operation: string;
256
302
  resource: string;
257
303
  currentUsage: number;
258
304
  limit: number;
259
305
  };
260
306
  export type BillingProviderError = {
261
307
  _tag: "BillingProviderError";
262
- operation: string;
263
308
  message: string;
264
309
  };
265
310
  export type ExternalServiceError = {
266
311
  _tag: "ExternalServiceError";
267
- operation: string;
268
312
  message: string;
269
313
  };
270
314
  export type ValidationError = {
271
315
  _tag: "ValidationError";
272
- operation: string;
273
316
  message: string;
274
317
  fields?: {
275
318
  [key: string]: Array<string>;
@@ -277,7 +320,6 @@ export type ValidationError = {
277
320
  };
278
321
  export type OnboardingReviewRequiredError = {
279
322
  _tag: "OnboardingReviewRequiredError";
280
- operation: string;
281
323
  code: "review_required" | "review_in_progress" | "information_required" | "review_rejected" | "identity_review_required" | "identity_review_rejected" | "identity_changed";
282
324
  decision: "undecided" | "approved" | "rejected" | "exempt";
283
325
  stage: "collecting" | "automated_review" | "manual_review" | "information_requested" | "complete";
@@ -286,14 +328,12 @@ export type OnboardingReviewRequiredError = {
286
328
  };
287
329
  export type FlagDisabledError = {
288
330
  _tag: "FlagDisabledError";
289
- operation: string;
290
331
  flag: string;
291
332
  };
292
- export type WebhookEnqueueError = {
293
- _tag: "WebhookEnqueueError";
294
- operation: string;
295
- reason: string;
296
- details?: string | null | undefined;
333
+ export type DeliveryUnavailableError = {
334
+ _tag: "DeliveryUnavailableError";
335
+ message: string;
336
+ retryAfterSeconds: number;
297
337
  };
298
338
  export type ValidateEmailResponse = {
299
339
  valid: true;
@@ -327,7 +367,7 @@ export type Operation = {
327
367
  status: "pending" | "running" | "succeeded" | "failed";
328
368
  phase: "accepted" | "dispatching" | "provisioning" | "deleting" | "finalizing" | "completed";
329
369
  error: {
330
- code: "validation-failed" | "conflict" | "capacity-unavailable" | "provider-rejected" | "provider-unavailable" | "timed-out" | "internal";
370
+ code: "validation-failed" | "conflict" | "capacity-unavailable" | "rejected" | "unavailable" | "timed-out" | "internal";
331
371
  message: string;
332
372
  } | null;
333
373
  createdAt: string;
@@ -436,6 +476,7 @@ export type CampaignLatestRun = {
436
476
  dispatchedCount: number;
437
477
  failedCount: number;
438
478
  skippedCount: number;
479
+ estimatedCompletionAt: string | null;
439
480
  };
440
481
  export type Campaign = {
441
482
  id: CampaignId;
@@ -452,6 +493,26 @@ export type Campaign = {
452
493
  createdAt: string;
453
494
  updatedAt: string;
454
495
  };
496
+ /**
497
+ * Daily email sends for the last 14 calendar days in the organization's own timezone, oldest first and zero-filled. Always fourteen entries; an entity that has never sent reports fourteen zeroes.
498
+ */
499
+ export type SendsSeries = Array<number>;
500
+ export type CampaignListItem = {
501
+ id: CampaignId;
502
+ name: string;
503
+ channel: "email";
504
+ content: CampaignContent;
505
+ audience: CampaignAudience;
506
+ policy: CampaignPolicy;
507
+ definition: CampaignDefinitionSummary;
508
+ latestRun: CampaignLatestRun | null;
509
+ createdBy: string | null;
510
+ actorEmail: string;
511
+ memberRole: string;
512
+ createdAt: string;
513
+ updatedAt: string;
514
+ series: SendsSeries;
515
+ };
455
516
  export type EmailDomainId = string;
456
517
  export type CampaignRun = {
457
518
  id: CampaignRunId;
@@ -468,6 +529,7 @@ export type CampaignRun = {
468
529
  dispatchedCount: number;
469
530
  failedCount: number;
470
531
  skippedCount: number;
532
+ estimatedCompletionAt: string | null;
471
533
  failureReason: string | null;
472
534
  holdReason: string | null;
473
535
  holdDomainId: EmailDomainId | null;
@@ -487,6 +549,7 @@ export type IdentityClearanceStatus = {
487
549
  identityId: string;
488
550
  decision: "undecided" | "approved" | "rejected";
489
551
  generation: number;
552
+ canSend: boolean;
490
553
  code: "review_required" | "review_in_progress" | "information_required" | "review_rejected" | "identity_review_required" | "identity_review_rejected" | "identity_changed" | null;
491
554
  nextAction: "wait_for_review" | "provide_information" | "verify_sending_identity" | "reapply" | "contact_support" | null;
492
555
  updatedAt: string;
@@ -529,15 +592,19 @@ export type EmailRecipientTrackingPreference = {
529
592
  updatedAt: string | null;
530
593
  };
531
594
  export type EmailSenderId = string;
595
+ /**
596
+ * Bounce and complaint rates over the last 24 hours, as fractions between 0 and 1, with `windowSends`, the deliveries they were divided by, plus `sendingStatus`, which says whether the organization can currently send. The window matches the one the sending-pause rule reads. Below 200 sends that rule ignores the window entirely, so a rate over a smaller `windowSends` is a quotient rather than a reading. These are not a lifetime record; an identity with no traffic in the window reports zeroes.
597
+ */
532
598
  export type DeliverabilityFacts = {
533
599
  bounceRate: number;
534
600
  complaintRate: number;
601
+ windowSends: number;
535
602
  sendingStatus: "enabled" | "disabled" | "reinstated" | "unknown";
536
603
  };
537
604
  export type EmailDomainDetailed = {
538
605
  id: EmailDomainId;
539
606
  domain: string;
540
- phase: "dns-setup" | "provider-setup" | "provider-verification" | "ready" | "degraded" | "failed";
607
+ phase: "dns-setup" | "provisioning" | "verifying" | "ready" | "degraded" | "failed";
541
608
  dkimSelector?: string | null | undefined;
542
609
  dkimPublicKey?: string | null | undefined;
543
610
  dnsRecords: Array<{
@@ -557,11 +624,15 @@ export type EmailDomainDetailed = {
557
624
  };
558
625
  export type EmailChannelError = {
559
626
  _tag: "EmailChannelError";
560
- operation: string;
561
627
  reason: "transport" | "rejected" | "rate_limited" | "auth";
562
628
  message: string;
563
629
  statusCode?: number | null | undefined;
564
630
  };
631
+ export type EmailDomainProvisioningExecution = {
632
+ status: "none" | "running" | "succeeded" | "failed";
633
+ generation: number;
634
+ revision: number;
635
+ };
565
636
  export type EmailDkimRotation = {
566
637
  id: string;
567
638
  domainId: EmailDomainId;
@@ -579,15 +650,24 @@ export type EmailDkimRotation = {
579
650
  value: string;
580
651
  };
581
652
  /**
582
- * Earliest minimum retention horizon only. The former public key remains published indefinitely until a separately approved retirement verifies at least two actual former-record TTLs have elapsed.
653
+ * The earliest time the former DKIM record may be removed. Keep it published at least until then so mail signed with the former key still verifies.
583
654
  */
584
655
  minimumRetainUntil: string | null;
585
656
  };
586
657
  export type EmailDomainVerification = {
587
658
  domainId: EmailDomainId;
588
659
  domain: string;
589
- phase: "dns-setup" | "provider-setup" | "provider-verification" | "ready" | "degraded" | "failed";
590
- records: Array<{
660
+ phase: "dns-setup" | "provisioning" | "verifying" | "ready" | "degraded" | "failed";
661
+ dns: {
662
+ observed: boolean;
663
+ total: number;
664
+ satisfied: number;
665
+ missing: number;
666
+ mismatch: number;
667
+ unknown: number;
668
+ };
669
+ requirements: Array<{
670
+ key: string;
591
671
  record: {
592
672
  type: "A" | "AAAA" | "CNAME" | "MX" | "NS" | "SOA" | "PTR" | "SRV" | "TXT" | "CAA";
593
673
  name: string;
@@ -596,13 +676,29 @@ export type EmailDomainVerification = {
596
676
  description?: string | null | undefined;
597
677
  priority?: number | null | undefined;
598
678
  };
599
- status: "unchecked" | "missing" | "mismatch" | "found";
600
- observedValues: Array<string>;
601
- checkedAt?: string | null | undefined;
602
- resolutionFailure?: {
603
- code?: string | null | undefined;
604
- message: string;
605
- } | null | undefined;
679
+ status: "satisfied" | "missing" | "mismatch" | "unknown";
680
+ evidence: Array<{
681
+ _tag: "PublicDns";
682
+ resolver: string;
683
+ status: "satisfied" | "missing" | "mismatch" | "unknown";
684
+ values: Array<string>;
685
+ detail: string | null;
686
+ observedAt: string;
687
+ } | {
688
+ _tag: "Provider";
689
+ provider: string;
690
+ status: "satisfied" | "missing" | "mismatch" | "unknown";
691
+ values: Array<string>;
692
+ detail: string | null;
693
+ observedAt: string;
694
+ } | {
695
+ _tag: "Host";
696
+ source: string;
697
+ status: "ok" | "pending" | "failed";
698
+ label: string;
699
+ detail: string | null;
700
+ observedAt: string;
701
+ }>;
606
702
  }>;
607
703
  provider: {
608
704
  identity: "pending" | "verified" | "failed" | "unknown";
@@ -617,27 +713,28 @@ export type EmailDomainVerification = {
617
713
  message: string;
618
714
  failedAt: string;
619
715
  } | null;
716
+ provisioning: EmailDomainProvisioningExecution;
620
717
  health: {
621
- actionOwner: "customer" | "samva" | "provider" | "none";
718
+ actionOwner: "customer" | "samva" | "upstream" | "none";
622
719
  action: string;
623
720
  freshness: "current" | "stale" | "unknown";
624
721
  observedAt: string | null;
625
722
  staleAt: string | null;
626
723
  nextRetryAt: string | null;
627
- reason: "ready" | "dns-action-required" | "dns-unavailable" | "provider-pending" | "provider-failed" | "samva-repair" | "signing-custody-action-required" | "provider-ownership-action-required" | "inactive" | "observation-stale" | "observation-unknown";
724
+ reason: "ready" | "dns-action-required" | "dns-unavailable" | "verification-pending" | "verification-failed" | "samva-repair" | "signing-custody-action-required" | "ownership-conflict" | "inactive" | "observation-stale" | "observation-unknown";
628
725
  };
629
726
  /**
630
- * Stored domain, tenant and workspace health. Ready does not guarantee send acceptance or report configuration-set/account pauses.
727
+ * Whether the domain, the organization, and its sending account are healthy enough to send, as last observed. Ready does not guarantee that a particular send is accepted.
631
728
  */
632
729
  sending: {
633
- actionOwner: "customer" | "samva" | "provider" | "none";
730
+ actionOwner: "customer" | "samva" | "upstream" | "none";
634
731
  action: string;
635
732
  freshness: "current" | "stale" | "unknown";
636
733
  observedAt: string | null;
637
734
  staleAt: string | null;
638
735
  nextRetryAt: string | null;
639
736
  status: "ready" | "blocked" | "unknown";
640
- reason: "domain-not-ready" | "domain-observation-stale" | "operator-paused" | "provider-paused" | "tenant-health-stale" | "tenant-health-unknown" | "ready";
737
+ reason: "domain-not-ready" | "domain-observation-stale" | "operator-paused" | "sending-paused" | "sending-status-stale" | "sending-status-unknown" | "ready";
641
738
  };
642
739
  dmarc: {
643
740
  status: "valid" | "missing" | "invalid" | "multiple" | "unknown";
@@ -663,7 +760,7 @@ export type DomainConnectApplyUrlResult = {
663
760
  url: string;
664
761
  };
665
762
  export type DomainConnectCompleteResult = {
666
- status: "applied" | "cancelled" | "invalid";
763
+ status: "applied" | "cancelled" | "failed" | "invalid";
667
764
  };
668
765
  export type SuccessResult = {
669
766
  success: boolean;
@@ -693,7 +790,7 @@ export type CustomTrackingStatus = {
693
790
  } | null;
694
791
  };
695
792
  export type CustomTrackingDomainConnectCompleteResult = {
696
- status: "applied" | "cancelled" | "stale" | "invalid";
793
+ status: "applied" | "cancelled" | "failed" | "stale" | "invalid";
697
794
  };
698
795
  export type SuppressionId = string;
699
796
  export type SuppressionEntry = {
@@ -1055,6 +1152,11 @@ export type ContactActivitySummary = {
1055
1152
  totalInteractions: number;
1056
1153
  lastActiveAt: string | null;
1057
1154
  };
1155
+ export type ContactListMembership = {
1156
+ id: ContactGroupId;
1157
+ name: string;
1158
+ color: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null;
1159
+ };
1058
1160
  export type ContactListItem = {
1059
1161
  id: ContactId;
1060
1162
  organizationId: OrganizationId;
@@ -1078,6 +1180,7 @@ export type ContactListItem = {
1078
1180
  createdBy: ContactId | null;
1079
1181
  lastModifiedBy: ContactId | null;
1080
1182
  engagement: ContactActivitySummary;
1183
+ lists: Array<ContactListMembership>;
1081
1184
  };
1082
1185
  export type Contact = {
1083
1186
  id: ContactId;
@@ -1106,30 +1209,17 @@ export type BulkUpdateResult = {
1106
1209
  updated: number;
1107
1210
  failed: number;
1108
1211
  };
1212
+ export type CustomFieldDefinitionId = string;
1213
+ export type AnalyticsQueryError = {
1214
+ _tag: "AnalyticsQueryError";
1215
+ message: string;
1216
+ };
1109
1217
  export type TemplateProjectId = string;
1110
1218
  export type TemplateFamilyId = string;
1111
1219
  export type TemplateFromDefault = {
1112
1220
  email: string;
1113
1221
  name?: string | null | undefined;
1114
1222
  };
1115
- export type UserId = string;
1116
- export type TemplateCompliance = {
1117
- metaStatus?: string | null | undefined;
1118
- submittedAt?: string | null | null | undefined;
1119
- qualityScore?: string | null | undefined;
1120
- rejectedReason?: string | null | undefined;
1121
- lastSyncedAt?: string | null | undefined;
1122
- approvalStatus?: "draft" | "pending" | "approved" | "published" | "rejected" | "archived" | null | undefined;
1123
- approvedBy?: UserId | null | undefined;
1124
- approvedAt?: string | null | undefined;
1125
- approvalNotes?: string | null | undefined;
1126
- regulatoryRequirements?: Array<{
1127
- region: string;
1128
- requirement: string;
1129
- status: "compliant" | "non_compliant" | "pending";
1130
- notes?: string | null | undefined;
1131
- }> | null | undefined;
1132
- };
1133
1223
  export type Template = {
1134
1224
  id: TemplateId;
1135
1225
  organizationId: OrganizationId;
@@ -1159,7 +1249,6 @@ export type Template = {
1159
1249
  inputSchema: {
1160
1250
  [key: string]: JsonValue;
1161
1251
  } | null;
1162
- compliance: TemplateCompliance | null;
1163
1252
  usageCount: number;
1164
1253
  lastUsedAt: string | null;
1165
1254
  status: string;
@@ -1170,21 +1259,6 @@ export type Template = {
1170
1259
  createdAt: string;
1171
1260
  updatedAt: string;
1172
1261
  };
1173
- export type TemplateSummary = {
1174
- id: TemplateId;
1175
- name: string;
1176
- slug: string;
1177
- channel: "email";
1178
- description: string | null;
1179
- category: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null;
1180
- status: "draft" | "pending" | "approved" | "published" | "rejected" | "archived";
1181
- usageCount: number;
1182
- lastUsedAt: string | null;
1183
- workspaceRevision: string | null;
1184
- previewFixture: string | null;
1185
- createdAt: string;
1186
- updatedAt: string;
1187
- };
1188
1262
  export type TemplateFamily = {
1189
1263
  id: TemplateFamilyId;
1190
1264
  organizationId: OrganizationId;
@@ -1270,9 +1344,9 @@ export type Design = {
1270
1344
  } | null | undefined;
1271
1345
  } | null | undefined;
1272
1346
  assets?: {
1273
- logoUrl?: string | null | undefined;
1274
- logoDarkUrl?: string | null | undefined;
1275
- iconUrl?: string | null | undefined;
1347
+ logoUrl?: string | null | null | undefined;
1348
+ logoDarkUrl?: string | null | null | undefined;
1349
+ iconUrl?: string | null | null | undefined;
1276
1350
  } | null | undefined;
1277
1351
  footer?: {
1278
1352
  companyName?: string | null | undefined;
@@ -1300,7 +1374,7 @@ export type DesignSettings = {
1300
1374
  export type CreateWebhookPayload = {
1301
1375
  name: string;
1302
1376
  url: string;
1303
- eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
1377
+ eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
1304
1378
  channels?: Array<"email"> | null | undefined;
1305
1379
  headers?: {
1306
1380
  [key: string]: string;
@@ -1311,7 +1385,7 @@ export type WebhookEndpoint = {
1311
1385
  id: WebhookEndpointId;
1312
1386
  name: string;
1313
1387
  url: string;
1314
- eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
1388
+ eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
1315
1389
  channels: Array<"email"> | null;
1316
1390
  status: "active" | "disabled";
1317
1391
  hasCustomHeaders: boolean;
@@ -1331,7 +1405,7 @@ export type WebhookEndpointListItem = {
1331
1405
  id: WebhookEndpointId;
1332
1406
  name: string;
1333
1407
  url: string;
1334
- eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
1408
+ eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
1335
1409
  channels: Array<"email"> | null;
1336
1410
  status: "active" | "disabled";
1337
1411
  hasCustomHeaders: boolean;
@@ -1344,7 +1418,7 @@ export type WebhookEndpointListItem = {
1344
1418
  export type UpdateWebhookPayload = {
1345
1419
  name?: string | null | undefined;
1346
1420
  url?: string | null | undefined;
1347
- eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated"> | null | undefined;
1421
+ eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated"> | null | undefined;
1348
1422
  channels?: Array<"email"> | null | null | undefined;
1349
1423
  headers?: {
1350
1424
  [key: string]: string;
@@ -1379,10 +1453,8 @@ export type Organization = {
1379
1453
  billingAccountId: string;
1380
1454
  name: string;
1381
1455
  slug: string;
1382
- defaultCurrency: string;
1383
1456
  countryCode: string;
1384
1457
  timezone: string;
1385
- billingEmail: string | null;
1386
1458
  plan: string;
1387
1459
  isActive: boolean;
1388
1460
  createdAt: string;
@@ -1403,9 +1475,32 @@ export type Organization = {
1403
1475
  teamMembersUsed: number;
1404
1476
  messagesResetAt: string | null;
1405
1477
  };
1406
- export type ApiKeyPermissions = {
1407
- [key: string]: Array<string>;
1408
- } | null;
1478
+ export type ApiKeyResourceAccess = {
1479
+ messages?: "read" | "write" | null | undefined;
1480
+ email?: "read" | "write" | null | undefined;
1481
+ domains?: "read" | "write" | null | undefined;
1482
+ phoneNumbers?: "read" | "write" | null | undefined;
1483
+ contacts?: "read" | "write" | null | undefined;
1484
+ conversations?: "read" | "write" | null | undefined;
1485
+ templates?: "read" | "write" | null | undefined;
1486
+ competitors?: "read" | "write" | null | undefined;
1487
+ webhooks?: "read" | "write" | null | undefined;
1488
+ apiKeys?: "read" | "write" | null | undefined;
1489
+ organization?: "read" | "write" | null | undefined;
1490
+ billing?: "read" | "write" | null | undefined;
1491
+ analytics?: "read" | "write" | null | undefined;
1492
+ };
1493
+ export type ApiKeyAccess = {
1494
+ mode: "full";
1495
+ } | {
1496
+ mode: "restricted";
1497
+ resources: ApiKeyResourceAccess;
1498
+ };
1499
+ export type ApiKeyOwner = {
1500
+ id: string;
1501
+ name: string;
1502
+ email: string;
1503
+ };
1409
1504
  export type ApiKeyWithSecret = {
1410
1505
  id: string;
1411
1506
  name: string;
@@ -1416,8 +1511,8 @@ export type ApiKeyWithSecret = {
1416
1511
  expiresAt: string | null;
1417
1512
  lastUsedAt: string | null;
1418
1513
  isActive: boolean;
1419
- permissions?: ApiKeyPermissions | undefined;
1420
- roleName?: string | null | undefined;
1514
+ access: ApiKeyAccess;
1515
+ owner: ApiKeyOwner | null;
1421
1516
  };
1422
1517
  export type ApiKey = {
1423
1518
  id: string;
@@ -1429,10 +1524,9 @@ export type ApiKey = {
1429
1524
  expiresAt: string | null;
1430
1525
  lastUsedAt: string | null;
1431
1526
  isActive: boolean;
1432
- permissions?: ApiKeyPermissions | undefined;
1433
- roleName?: string | null | undefined;
1527
+ access: ApiKeyAccess;
1528
+ owner: ApiKeyOwner | null;
1434
1529
  };
1435
- export type ApiKeyId = string;
1436
1530
  export type JsonValue = string | number | boolean | null | Array<JsonValue> | {
1437
1531
  [key: string]: JsonValue;
1438
1532
  };
@@ -1447,6 +1541,7 @@ export type MessagesListData = {
1447
1541
  status?: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained" | null | undefined;
1448
1542
  conversationId?: ConversationId | null | undefined;
1449
1543
  contactId?: ContactId | null | undefined;
1544
+ from?: string | null | undefined;
1450
1545
  startDate?: string | null | undefined;
1451
1546
  endDate?: string | null | undefined;
1452
1547
  };
@@ -1465,6 +1560,10 @@ export type MessagesListErrors = {
1465
1560
  * InternalError
1466
1561
  */
1467
1562
  500: InternalError;
1563
+ /**
1564
+ * GatewayTimeoutError
1565
+ */
1566
+ 504: GatewayTimeoutError;
1468
1567
  };
1469
1568
  export type MessagesListError = MessagesListErrors[keyof MessagesListErrors];
1470
1569
  export type MessagesListResponses = {
@@ -1498,7 +1597,7 @@ export type MessagesSendErrors = {
1498
1597
  /**
1499
1598
  * ForbiddenError | OnboardingReviewRequiredError | FlagDisabledError
1500
1599
  */
1501
- 403: OnboardingReviewRequiredError | FlagDisabledError | ForbiddenError;
1600
+ 403: ForbiddenError | OnboardingReviewRequiredError | FlagDisabledError;
1502
1601
  /**
1503
1602
  * ResourceNotFoundError
1504
1603
  */
@@ -1516,13 +1615,21 @@ export type MessagesSendErrors = {
1516
1615
  */
1517
1616
  429: RateLimitedError;
1518
1617
  /**
1519
- * InternalError | WebhookEnqueueError
1618
+ * InternalError
1520
1619
  */
1521
- 500: InternalError | WebhookEnqueueError;
1620
+ 500: InternalError;
1522
1621
  /**
1523
1622
  * BillingProviderError | ExternalServiceError
1524
1623
  */
1525
1624
  502: BillingProviderError | ExternalServiceError;
1625
+ /**
1626
+ * DeliveryUnavailableError
1627
+ */
1628
+ 503: DeliveryUnavailableError;
1629
+ /**
1630
+ * GatewayTimeoutError
1631
+ */
1632
+ 504: GatewayTimeoutError;
1526
1633
  };
1527
1634
  export type MessagesSendError = MessagesSendErrors[keyof MessagesSendErrors];
1528
1635
  export type MessagesSendResponses = {
@@ -1557,6 +1664,10 @@ export type MessagesRemoveErrors = {
1557
1664
  * InternalError
1558
1665
  */
1559
1666
  500: InternalError;
1667
+ /**
1668
+ * GatewayTimeoutError
1669
+ */
1670
+ 504: GatewayTimeoutError;
1560
1671
  };
1561
1672
  export type MessagesRemoveError = MessagesRemoveErrors[keyof MessagesRemoveErrors];
1562
1673
  export type MessagesRemoveResponses = {
@@ -1594,6 +1705,10 @@ export type MessagesGetErrors = {
1594
1705
  * InternalError
1595
1706
  */
1596
1707
  500: InternalError;
1708
+ /**
1709
+ * GatewayTimeoutError
1710
+ */
1711
+ 504: GatewayTimeoutError;
1597
1712
  };
1598
1713
  export type MessagesGetError = MessagesGetErrors[keyof MessagesGetErrors];
1599
1714
  export type MessagesGetResponses = {
@@ -1631,6 +1746,10 @@ export type MessagesGetEmailErrors = {
1631
1746
  * InternalError
1632
1747
  */
1633
1748
  500: InternalError;
1749
+ /**
1750
+ * GatewayTimeoutError
1751
+ */
1752
+ 504: GatewayTimeoutError;
1634
1753
  };
1635
1754
  export type MessagesGetEmailError = MessagesGetEmailErrors[keyof MessagesGetEmailErrors];
1636
1755
  export type MessagesGetEmailResponses = {
@@ -1642,7 +1761,7 @@ export type MessagesGetEmailResponses = {
1642
1761
  scheduling: {
1643
1762
  dueAt: string;
1644
1763
  expiresAt: string;
1645
- waitReason: "rate" | "daily-quota" | "domain-health" | "tenant-health" | "provider-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | null;
1764
+ waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | null;
1646
1765
  } | null;
1647
1766
  id: string;
1648
1767
  messageId: string;
@@ -1662,11 +1781,10 @@ export type MessagesGetEmailResponses = {
1662
1781
  terminalAt: string | null;
1663
1782
  errorCode: string | null;
1664
1783
  errorMessage: string | null;
1665
- errorDetails: JsonValue | null;
1784
+ errorDetails: DeliveryErrorDetails | null;
1666
1785
  cost: string;
1667
1786
  currency: string;
1668
1787
  idempotencyKey: string | null;
1669
- metadata: JsonValue | null;
1670
1788
  createdAt: string;
1671
1789
  updatedAt: string;
1672
1790
  }>;
@@ -1758,6 +1876,10 @@ export type MessagesValidateEmailErrors = {
1758
1876
  * InternalError
1759
1877
  */
1760
1878
  500: InternalError;
1879
+ /**
1880
+ * GatewayTimeoutError
1881
+ */
1882
+ 504: GatewayTimeoutError;
1761
1883
  };
1762
1884
  export type MessagesValidateEmailError = MessagesValidateEmailErrors[keyof MessagesValidateEmailErrors];
1763
1885
  export type MessagesValidateEmailResponses = {
@@ -1792,6 +1914,10 @@ export type MessagesGetStatusErrors = {
1792
1914
  * InternalError
1793
1915
  */
1794
1916
  500: InternalError;
1917
+ /**
1918
+ * GatewayTimeoutError
1919
+ */
1920
+ 504: GatewayTimeoutError;
1795
1921
  };
1796
1922
  export type MessagesGetStatusError = MessagesGetStatusErrors[keyof MessagesGetStatusErrors];
1797
1923
  export type MessagesGetStatusResponses = {
@@ -1830,6 +1956,10 @@ export type MessagesGetEventsErrors = {
1830
1956
  * InternalError
1831
1957
  */
1832
1958
  500: InternalError;
1959
+ /**
1960
+ * GatewayTimeoutError
1961
+ */
1962
+ 504: GatewayTimeoutError;
1833
1963
  };
1834
1964
  export type MessagesGetEventsError = MessagesGetEventsErrors[keyof MessagesGetEventsErrors];
1835
1965
  export type MessagesGetEventsResponses = {
@@ -1872,6 +2002,10 @@ export type OperationsListErrors = {
1872
2002
  * InternalError
1873
2003
  */
1874
2004
  500: InternalError;
2005
+ /**
2006
+ * GatewayTimeoutError
2007
+ */
2008
+ 504: GatewayTimeoutError;
1875
2009
  };
1876
2010
  export type OperationsListError = OperationsListErrors[keyof OperationsListErrors];
1877
2011
  export type OperationsListResponses = {
@@ -1913,6 +2047,10 @@ export type OperationsGetErrors = {
1913
2047
  * InternalError
1914
2048
  */
1915
2049
  500: InternalError;
2050
+ /**
2051
+ * GatewayTimeoutError
2052
+ */
2053
+ 504: GatewayTimeoutError;
1916
2054
  };
1917
2055
  export type OperationsGetError = OperationsGetErrors[keyof OperationsGetErrors];
1918
2056
  export type OperationsGetResponses = {
@@ -1951,6 +2089,10 @@ export type OperationsRetryErrors = {
1951
2089
  * InternalError
1952
2090
  */
1953
2091
  500: InternalError;
2092
+ /**
2093
+ * GatewayTimeoutError
2094
+ */
2095
+ 504: GatewayTimeoutError;
1954
2096
  };
1955
2097
  export type OperationsRetryError = OperationsRetryErrors[keyof OperationsRetryErrors];
1956
2098
  export type OperationsRetryResponses = {
@@ -1983,6 +2125,10 @@ export type ScheduledMessagesListErrors = {
1983
2125
  * InternalError
1984
2126
  */
1985
2127
  500: InternalError;
2128
+ /**
2129
+ * GatewayTimeoutError
2130
+ */
2131
+ 504: GatewayTimeoutError;
1986
2132
  };
1987
2133
  export type ScheduledMessagesListError = ScheduledMessagesListErrors[keyof ScheduledMessagesListErrors];
1988
2134
  export type ScheduledMessagesListResponses = {
@@ -2032,6 +2178,10 @@ export type ScheduledMessagesCreateErrors = {
2032
2178
  * ExternalServiceError
2033
2179
  */
2034
2180
  502: ExternalServiceError;
2181
+ /**
2182
+ * GatewayTimeoutError
2183
+ */
2184
+ 504: GatewayTimeoutError;
2035
2185
  };
2036
2186
  export type ScheduledMessagesCreateError = ScheduledMessagesCreateErrors[keyof ScheduledMessagesCreateErrors];
2037
2187
  export type ScheduledMessagesCreateResponses = {
@@ -2066,6 +2216,10 @@ export type ScheduledMessagesGetErrors = {
2066
2216
  * InternalError
2067
2217
  */
2068
2218
  500: InternalError;
2219
+ /**
2220
+ * GatewayTimeoutError
2221
+ */
2222
+ 504: GatewayTimeoutError;
2069
2223
  };
2070
2224
  export type ScheduledMessagesGetError = ScheduledMessagesGetErrors[keyof ScheduledMessagesGetErrors];
2071
2225
  export type ScheduledMessagesGetResponses = {
@@ -2104,6 +2258,10 @@ export type ScheduledMessagesCancelErrors = {
2104
2258
  * InternalError
2105
2259
  */
2106
2260
  500: InternalError;
2261
+ /**
2262
+ * GatewayTimeoutError
2263
+ */
2264
+ 504: GatewayTimeoutError;
2107
2265
  };
2108
2266
  export type ScheduledMessagesCancelError = ScheduledMessagesCancelErrors[keyof ScheduledMessagesCancelErrors];
2109
2267
  export type ScheduledMessagesCancelResponses = {
@@ -2158,6 +2316,10 @@ export type ScheduledMessagesResumeErrors = {
2158
2316
  * ExternalServiceError
2159
2317
  */
2160
2318
  502: ExternalServiceError;
2319
+ /**
2320
+ * GatewayTimeoutError
2321
+ */
2322
+ 504: GatewayTimeoutError;
2161
2323
  };
2162
2324
  export type ScheduledMessagesResumeError = ScheduledMessagesResumeErrors[keyof ScheduledMessagesResumeErrors];
2163
2325
  export type ScheduledMessagesResumeResponses = {
@@ -2190,6 +2352,10 @@ export type CampaignsListErrors = {
2190
2352
  * InternalError
2191
2353
  */
2192
2354
  500: InternalError;
2355
+ /**
2356
+ * GatewayTimeoutError
2357
+ */
2358
+ 504: GatewayTimeoutError;
2193
2359
  };
2194
2360
  export type CampaignsListError = CampaignsListErrors[keyof CampaignsListErrors];
2195
2361
  export type CampaignsListResponses = {
@@ -2197,7 +2363,7 @@ export type CampaignsListResponses = {
2197
2363
  * Success
2198
2364
  */
2199
2365
  200: {
2200
- items: Array<Campaign>;
2366
+ items: Array<CampaignListItem>;
2201
2367
  pagination: PaginationMeta;
2202
2368
  };
2203
2369
  };
@@ -2231,6 +2397,10 @@ export type CampaignsCreateErrors = {
2231
2397
  * InternalError
2232
2398
  */
2233
2399
  500: InternalError;
2400
+ /**
2401
+ * GatewayTimeoutError
2402
+ */
2403
+ 504: GatewayTimeoutError;
2234
2404
  };
2235
2405
  export type CampaignsCreateError = CampaignsCreateErrors[keyof CampaignsCreateErrors];
2236
2406
  export type CampaignsCreateResponses = {
@@ -2269,6 +2439,10 @@ export type CampaignsArchiveErrors = {
2269
2439
  * InternalError
2270
2440
  */
2271
2441
  500: InternalError;
2442
+ /**
2443
+ * GatewayTimeoutError
2444
+ */
2445
+ 504: GatewayTimeoutError;
2272
2446
  };
2273
2447
  export type CampaignsArchiveError = CampaignsArchiveErrors[keyof CampaignsArchiveErrors];
2274
2448
  export type CampaignsArchiveResponses = {
@@ -2303,6 +2477,10 @@ export type CampaignsGetErrors = {
2303
2477
  * InternalError
2304
2478
  */
2305
2479
  500: InternalError;
2480
+ /**
2481
+ * GatewayTimeoutError
2482
+ */
2483
+ 504: GatewayTimeoutError;
2306
2484
  };
2307
2485
  export type CampaignsGetError = CampaignsGetErrors[keyof CampaignsGetErrors];
2308
2486
  export type CampaignsGetResponses = {
@@ -2350,6 +2528,10 @@ export type CampaignsUpdateErrors = {
2350
2528
  * InternalError
2351
2529
  */
2352
2530
  500: InternalError;
2531
+ /**
2532
+ * GatewayTimeoutError
2533
+ */
2534
+ 504: GatewayTimeoutError;
2353
2535
  };
2354
2536
  export type CampaignsUpdateError = CampaignsUpdateErrors[keyof CampaignsUpdateErrors];
2355
2537
  export type CampaignsUpdateResponses = {
@@ -2388,6 +2570,10 @@ export type CampaignsListRunsErrors = {
2388
2570
  * InternalError
2389
2571
  */
2390
2572
  500: InternalError;
2573
+ /**
2574
+ * GatewayTimeoutError
2575
+ */
2576
+ 504: GatewayTimeoutError;
2391
2577
  };
2392
2578
  export type CampaignsListRunsError = CampaignsListRunsErrors[keyof CampaignsListRunsErrors];
2393
2579
  export type CampaignsListRunsResponses = {
@@ -2440,6 +2626,10 @@ export type CampaignsScheduleRunErrors = {
2440
2626
  * ExternalServiceError
2441
2627
  */
2442
2628
  502: ExternalServiceError;
2629
+ /**
2630
+ * GatewayTimeoutError
2631
+ */
2632
+ 504: GatewayTimeoutError;
2443
2633
  };
2444
2634
  export type CampaignsScheduleRunError = CampaignsScheduleRunErrors[keyof CampaignsScheduleRunErrors];
2445
2635
  export type CampaignsScheduleRunResponses = {
@@ -2475,6 +2665,10 @@ export type CampaignsGetRunErrors = {
2475
2665
  * InternalError
2476
2666
  */
2477
2667
  500: InternalError;
2668
+ /**
2669
+ * GatewayTimeoutError
2670
+ */
2671
+ 504: GatewayTimeoutError;
2478
2672
  };
2479
2673
  export type CampaignsGetRunError = CampaignsGetRunErrors[keyof CampaignsGetRunErrors];
2480
2674
  export type CampaignsGetRunResponses = {
@@ -2518,6 +2712,10 @@ export type CampaignsPauseRunErrors = {
2518
2712
  * ExternalServiceError
2519
2713
  */
2520
2714
  502: ExternalServiceError;
2715
+ /**
2716
+ * GatewayTimeoutError
2717
+ */
2718
+ 504: GatewayTimeoutError;
2521
2719
  };
2522
2720
  export type CampaignsPauseRunError = CampaignsPauseRunErrors[keyof CampaignsPauseRunErrors];
2523
2721
  export type CampaignsPauseRunResponses = {
@@ -2561,6 +2759,10 @@ export type CampaignsResumeRunErrors = {
2561
2759
  * ExternalServiceError
2562
2760
  */
2563
2761
  502: ExternalServiceError;
2762
+ /**
2763
+ * GatewayTimeoutError
2764
+ */
2765
+ 504: GatewayTimeoutError;
2564
2766
  };
2565
2767
  export type CampaignsResumeRunError = CampaignsResumeRunErrors[keyof CampaignsResumeRunErrors];
2566
2768
  export type CampaignsResumeRunResponses = {
@@ -2604,6 +2806,10 @@ export type CampaignsCancelRunErrors = {
2604
2806
  * ExternalServiceError
2605
2807
  */
2606
2808
  502: ExternalServiceError;
2809
+ /**
2810
+ * GatewayTimeoutError
2811
+ */
2812
+ 504: GatewayTimeoutError;
2607
2813
  };
2608
2814
  export type CampaignsCancelRunError = CampaignsCancelRunErrors[keyof CampaignsCancelRunErrors];
2609
2815
  export type CampaignsCancelRunResponses = {
@@ -2643,6 +2849,10 @@ export type CampaignsListRecipientsErrors = {
2643
2849
  * InternalError
2644
2850
  */
2645
2851
  500: InternalError;
2852
+ /**
2853
+ * GatewayTimeoutError
2854
+ */
2855
+ 504: GatewayTimeoutError;
2646
2856
  };
2647
2857
  export type CampaignsListRecipientsError = CampaignsListRecipientsErrors[keyof CampaignsListRecipientsErrors];
2648
2858
  export type CampaignsListRecipientsResponses = {
@@ -2684,6 +2894,10 @@ export type EmailGetOnboardingReviewErrors = {
2684
2894
  * InternalError
2685
2895
  */
2686
2896
  500: InternalError;
2897
+ /**
2898
+ * GatewayTimeoutError
2899
+ */
2900
+ 504: GatewayTimeoutError;
2687
2901
  };
2688
2902
  export type EmailGetOnboardingReviewError = EmailGetOnboardingReviewErrors[keyof EmailGetOnboardingReviewErrors];
2689
2903
  export type EmailGetOnboardingReviewResponses = {
@@ -2718,6 +2932,10 @@ export type EmailReapplyOnboardingReviewErrors = {
2718
2932
  * InternalError
2719
2933
  */
2720
2934
  500: InternalError;
2935
+ /**
2936
+ * GatewayTimeoutError
2937
+ */
2938
+ 504: GatewayTimeoutError;
2721
2939
  };
2722
2940
  export type EmailReapplyOnboardingReviewError = EmailReapplyOnboardingReviewErrors[keyof EmailReapplyOnboardingReviewErrors];
2723
2941
  export type EmailReapplyOnboardingReviewResponses = {
@@ -2754,6 +2972,10 @@ export type EmailRespondToOnboardingInformationRequestErrors = {
2754
2972
  * InternalError
2755
2973
  */
2756
2974
  500: InternalError;
2975
+ /**
2976
+ * GatewayTimeoutError
2977
+ */
2978
+ 504: GatewayTimeoutError;
2757
2979
  };
2758
2980
  export type EmailRespondToOnboardingInformationRequestError = EmailRespondToOnboardingInformationRequestErrors[keyof EmailRespondToOnboardingInformationRequestErrors];
2759
2981
  export type EmailRespondToOnboardingInformationRequestResponses = {
@@ -2786,6 +3008,10 @@ export type EmailGetTrackingDefaultsErrors = {
2786
3008
  * InternalError
2787
3009
  */
2788
3010
  500: InternalError;
3011
+ /**
3012
+ * GatewayTimeoutError
3013
+ */
3014
+ 504: GatewayTimeoutError;
2789
3015
  };
2790
3016
  export type EmailGetTrackingDefaultsError = EmailGetTrackingDefaultsErrors[keyof EmailGetTrackingDefaultsErrors];
2791
3017
  export type EmailGetTrackingDefaultsResponses = {
@@ -2825,6 +3051,10 @@ export type EmailUpdateTrackingDefaultsErrors = {
2825
3051
  * InternalError
2826
3052
  */
2827
3053
  500: InternalError;
3054
+ /**
3055
+ * GatewayTimeoutError
3056
+ */
3057
+ 504: GatewayTimeoutError;
2828
3058
  };
2829
3059
  export type EmailUpdateTrackingDefaultsError = EmailUpdateTrackingDefaultsErrors[keyof EmailUpdateTrackingDefaultsErrors];
2830
3060
  export type EmailUpdateTrackingDefaultsResponses = {
@@ -2859,6 +3089,10 @@ export type EmailGetRecipientTrackingPreferenceErrors = {
2859
3089
  * InternalError
2860
3090
  */
2861
3091
  500: InternalError;
3092
+ /**
3093
+ * GatewayTimeoutError
3094
+ */
3095
+ 504: GatewayTimeoutError;
2862
3096
  };
2863
3097
  export type EmailGetRecipientTrackingPreferenceError = EmailGetRecipientTrackingPreferenceErrors[keyof EmailGetRecipientTrackingPreferenceErrors];
2864
3098
  export type EmailGetRecipientTrackingPreferenceResponses = {
@@ -2894,6 +3128,10 @@ export type EmailUpdateRecipientTrackingPreferenceErrors = {
2894
3128
  * InternalError
2895
3129
  */
2896
3130
  500: InternalError;
3131
+ /**
3132
+ * GatewayTimeoutError
3133
+ */
3134
+ 504: GatewayTimeoutError;
2897
3135
  };
2898
3136
  export type EmailUpdateRecipientTrackingPreferenceError = EmailUpdateRecipientTrackingPreferenceErrors[keyof EmailUpdateRecipientTrackingPreferenceErrors];
2899
3137
  export type EmailUpdateRecipientTrackingPreferenceResponses = {
@@ -2925,6 +3163,10 @@ export type EmailListDomainsErrors = {
2925
3163
  * InternalError
2926
3164
  */
2927
3165
  500: InternalError;
3166
+ /**
3167
+ * GatewayTimeoutError
3168
+ */
3169
+ 504: GatewayTimeoutError;
2928
3170
  };
2929
3171
  export type EmailListDomainsError = EmailListDomainsErrors[keyof EmailListDomainsErrors];
2930
3172
  export type EmailListDomainsResponses = {
@@ -2935,11 +3177,13 @@ export type EmailListDomainsResponses = {
2935
3177
  items: Array<{
2936
3178
  id: EmailDomainId;
2937
3179
  domain: string;
2938
- phase: "dns-setup" | "provider-setup" | "provider-verification" | "ready" | "degraded" | "failed";
3180
+ phase: "dns-setup" | "provisioning" | "verifying" | "ready" | "degraded" | "failed";
2939
3181
  dkimSelector?: string | null | undefined;
2940
3182
  dkimPublicKey?: string | null | undefined;
2941
3183
  isDefault: boolean;
2942
3184
  defaultSenderId: EmailSenderId | null;
3185
+ deliverability: DeliverabilityFacts;
3186
+ series: SendsSeries;
2943
3187
  createdAt: string;
2944
3188
  updatedAt: string;
2945
3189
  }>;
@@ -2980,6 +3224,10 @@ export type EmailAddDomainErrors = {
2980
3224
  * ValidationError
2981
3225
  */
2982
3226
  422: ValidationError;
3227
+ /**
3228
+ * RateLimitedError
3229
+ */
3230
+ 429: RateLimitedError;
2983
3231
  /**
2984
3232
  * InternalError
2985
3233
  */
@@ -2988,6 +3236,10 @@ export type EmailAddDomainErrors = {
2988
3236
  * EmailChannelError | BillingProviderError
2989
3237
  */
2990
3238
  502: EmailChannelError | BillingProviderError;
3239
+ /**
3240
+ * GatewayTimeoutError
3241
+ */
3242
+ 504: GatewayTimeoutError;
2991
3243
  };
2992
3244
  export type EmailAddDomainError = EmailAddDomainErrors[keyof EmailAddDomainErrors];
2993
3245
  export type EmailAddDomainResponses = {
@@ -3022,6 +3274,10 @@ export type EmailGetDomainVerificationErrors = {
3022
3274
  * InternalError
3023
3275
  */
3024
3276
  500: InternalError;
3277
+ /**
3278
+ * GatewayTimeoutError
3279
+ */
3280
+ 504: GatewayTimeoutError;
3025
3281
  };
3026
3282
  export type EmailGetDomainVerificationError = EmailGetDomainVerificationErrors[keyof EmailGetDomainVerificationErrors];
3027
3283
  export type EmailGetDomainVerificationResponses = {
@@ -3072,6 +3328,10 @@ export type EmailAdvanceDomainVerificationErrors = {
3072
3328
  * EmailChannelError
3073
3329
  */
3074
3330
  502: EmailChannelError;
3331
+ /**
3332
+ * GatewayTimeoutError
3333
+ */
3334
+ 504: GatewayTimeoutError;
3075
3335
  };
3076
3336
  export type EmailAdvanceDomainVerificationError = EmailAdvanceDomainVerificationErrors[keyof EmailAdvanceDomainVerificationErrors];
3077
3337
  export type EmailAdvanceDomainVerificationResponses = {
@@ -3117,6 +3377,10 @@ export type EmailRotateDomainDkimErrors = {
3117
3377
  * EmailChannelError
3118
3378
  */
3119
3379
  502: EmailChannelError;
3380
+ /**
3381
+ * GatewayTimeoutError
3382
+ */
3383
+ 504: GatewayTimeoutError;
3120
3384
  };
3121
3385
  export type EmailRotateDomainDkimError = EmailRotateDomainDkimErrors[keyof EmailRotateDomainDkimErrors];
3122
3386
  export type EmailRotateDomainDkimResponses = {
@@ -3155,6 +3419,10 @@ export type EmailRemoveDomainErrors = {
3155
3419
  * EmailChannelError | BillingProviderError
3156
3420
  */
3157
3421
  502: EmailChannelError | BillingProviderError;
3422
+ /**
3423
+ * GatewayTimeoutError
3424
+ */
3425
+ 504: GatewayTimeoutError;
3158
3426
  };
3159
3427
  export type EmailRemoveDomainError = EmailRemoveDomainErrors[keyof EmailRemoveDomainErrors];
3160
3428
  export type EmailRemoveDomainResponses = {
@@ -3185,6 +3453,10 @@ export type EmailGetDomainByIdErrors = {
3185
3453
  * ResourceNotFoundError
3186
3454
  */
3187
3455
  404: ResourceNotFoundError;
3456
+ /**
3457
+ * GatewayTimeoutError
3458
+ */
3459
+ 504: GatewayTimeoutError;
3188
3460
  };
3189
3461
  export type EmailGetDomainByIdError = EmailGetDomainByIdErrors[keyof EmailGetDomainByIdErrors];
3190
3462
  export type EmailGetDomainByIdResponses = {
@@ -3217,6 +3489,10 @@ export type EmailDetectRegistrarErrors = {
3217
3489
  * InternalError
3218
3490
  */
3219
3491
  500: InternalError;
3492
+ /**
3493
+ * GatewayTimeoutError
3494
+ */
3495
+ 504: GatewayTimeoutError;
3220
3496
  };
3221
3497
  export type EmailDetectRegistrarError = EmailDetectRegistrarErrors[keyof EmailDetectRegistrarErrors];
3222
3498
  export type EmailDetectRegistrarResponses = {
@@ -3258,6 +3534,10 @@ export type EmailGetDomainConnectErrors = {
3258
3534
  * InternalError
3259
3535
  */
3260
3536
  500: InternalError;
3537
+ /**
3538
+ * GatewayTimeoutError
3539
+ */
3540
+ 504: GatewayTimeoutError;
3261
3541
  };
3262
3542
  export type EmailGetDomainConnectError = EmailGetDomainConnectErrors[keyof EmailGetDomainConnectErrors];
3263
3543
  export type EmailGetDomainConnectResponses = {
@@ -3290,6 +3570,10 @@ export type EmailBuildDomainConnectApplyUrlErrors = {
3290
3570
  * ResourceNotFoundError
3291
3571
  */
3292
3572
  404: ResourceNotFoundError;
3573
+ /**
3574
+ * ConflictError
3575
+ */
3576
+ 409: ConflictError;
3293
3577
  /**
3294
3578
  * ValidationError
3295
3579
  */
@@ -3302,6 +3586,10 @@ export type EmailBuildDomainConnectApplyUrlErrors = {
3302
3586
  * EmailChannelError
3303
3587
  */
3304
3588
  502: EmailChannelError;
3589
+ /**
3590
+ * GatewayTimeoutError
3591
+ */
3592
+ 504: GatewayTimeoutError;
3305
3593
  };
3306
3594
  export type EmailBuildDomainConnectApplyUrlError = EmailBuildDomainConnectApplyUrlErrors[keyof EmailBuildDomainConnectApplyUrlErrors];
3307
3595
  export type EmailBuildDomainConnectApplyUrlResponses = {
@@ -3315,6 +3603,7 @@ export type EmailCompleteDomainConnectData = {
3315
3603
  body: {
3316
3604
  state: string;
3317
3605
  error?: string | null | undefined;
3606
+ errorDescription?: string | null | undefined;
3318
3607
  };
3319
3608
  path: {
3320
3609
  id: EmailDomainId;
@@ -3343,6 +3632,10 @@ export type EmailCompleteDomainConnectErrors = {
3343
3632
  * EmailChannelError
3344
3633
  */
3345
3634
  502: EmailChannelError;
3635
+ /**
3636
+ * GatewayTimeoutError
3637
+ */
3638
+ 504: GatewayTimeoutError;
3346
3639
  };
3347
3640
  export type EmailCompleteDomainConnectError = EmailCompleteDomainConnectErrors[keyof EmailCompleteDomainConnectErrors];
3348
3641
  export type EmailCompleteDomainConnectResponses = {
@@ -3386,6 +3679,10 @@ export type EmailEnableReceivingErrors = {
3386
3679
  * InternalError
3387
3680
  */
3388
3681
  500: InternalError;
3682
+ /**
3683
+ * GatewayTimeoutError
3684
+ */
3685
+ 504: GatewayTimeoutError;
3389
3686
  };
3390
3687
  export type EmailEnableReceivingError = EmailEnableReceivingErrors[keyof EmailEnableReceivingErrors];
3391
3688
  export type EmailEnableReceivingResponses = {
@@ -3394,7 +3691,6 @@ export type EmailEnableReceivingResponses = {
3394
3691
  */
3395
3692
  200: {
3396
3693
  success: true;
3397
- ruleName: string;
3398
3694
  recipients: Array<string>;
3399
3695
  };
3400
3696
  };
@@ -3428,6 +3724,10 @@ export type EmailSetDefaultDomainErrors = {
3428
3724
  * InternalError
3429
3725
  */
3430
3726
  500: InternalError;
3727
+ /**
3728
+ * GatewayTimeoutError
3729
+ */
3730
+ 504: GatewayTimeoutError;
3431
3731
  };
3432
3732
  export type EmailSetDefaultDomainError = EmailSetDefaultDomainErrors[keyof EmailSetDefaultDomainErrors];
3433
3733
  export type EmailSetDefaultDomainResponses = {
@@ -3462,6 +3762,10 @@ export type EmailClearDomainDefaultSenderErrors = {
3462
3762
  * InternalError
3463
3763
  */
3464
3764
  500: InternalError;
3765
+ /**
3766
+ * GatewayTimeoutError
3767
+ */
3768
+ 504: GatewayTimeoutError;
3465
3769
  };
3466
3770
  export type EmailClearDomainDefaultSenderError = EmailClearDomainDefaultSenderErrors[keyof EmailClearDomainDefaultSenderErrors];
3467
3771
  export type EmailClearDomainDefaultSenderResponses = {
@@ -3502,6 +3806,10 @@ export type EmailSetDomainDefaultSenderErrors = {
3502
3806
  * InternalError
3503
3807
  */
3504
3808
  500: InternalError;
3809
+ /**
3810
+ * GatewayTimeoutError
3811
+ */
3812
+ 504: GatewayTimeoutError;
3505
3813
  };
3506
3814
  export type EmailSetDomainDefaultSenderError = EmailSetDomainDefaultSenderErrors[keyof EmailSetDomainDefaultSenderErrors];
3507
3815
  export type EmailSetDomainDefaultSenderResponses = {
@@ -3542,6 +3850,10 @@ export type EmailUpdateDomainConfigErrors = {
3542
3850
  * InternalError
3543
3851
  */
3544
3852
  500: InternalError;
3853
+ /**
3854
+ * GatewayTimeoutError
3855
+ */
3856
+ 504: GatewayTimeoutError;
3545
3857
  };
3546
3858
  export type EmailUpdateDomainConfigError = EmailUpdateDomainConfigErrors[keyof EmailUpdateDomainConfigErrors];
3547
3859
  export type EmailUpdateDomainConfigResponses = {
@@ -3587,6 +3899,10 @@ export type EmailDisableCustomTrackingErrors = {
3587
3899
  * EmailChannelError
3588
3900
  */
3589
3901
  502: EmailChannelError;
3902
+ /**
3903
+ * GatewayTimeoutError
3904
+ */
3905
+ 504: GatewayTimeoutError;
3590
3906
  };
3591
3907
  export type EmailDisableCustomTrackingError = EmailDisableCustomTrackingErrors[keyof EmailDisableCustomTrackingErrors];
3592
3908
  export type EmailDisableCustomTrackingResponses = {
@@ -3617,6 +3933,10 @@ export type EmailGetCustomTrackingErrors = {
3617
3933
  * InternalError
3618
3934
  */
3619
3935
  500: InternalError;
3936
+ /**
3937
+ * GatewayTimeoutError
3938
+ */
3939
+ 504: GatewayTimeoutError;
3620
3940
  };
3621
3941
  export type EmailGetCustomTrackingError = EmailGetCustomTrackingErrors[keyof EmailGetCustomTrackingErrors];
3622
3942
  export type EmailGetCustomTrackingResponses = {
@@ -3661,6 +3981,10 @@ export type EmailEnableCustomTrackingErrors = {
3661
3981
  * EmailChannelError | BillingProviderError
3662
3982
  */
3663
3983
  502: EmailChannelError | BillingProviderError;
3984
+ /**
3985
+ * GatewayTimeoutError
3986
+ */
3987
+ 504: GatewayTimeoutError;
3664
3988
  };
3665
3989
  export type EmailEnableCustomTrackingError = EmailEnableCustomTrackingErrors[keyof EmailEnableCustomTrackingErrors];
3666
3990
  export type EmailEnableCustomTrackingResponses = {
@@ -3695,6 +4019,10 @@ export type EmailGetCustomTrackingDomainConnectErrors = {
3695
4019
  * InternalError
3696
4020
  */
3697
4021
  500: InternalError;
4022
+ /**
4023
+ * GatewayTimeoutError
4024
+ */
4025
+ 504: GatewayTimeoutError;
3698
4026
  };
3699
4027
  export type EmailGetCustomTrackingDomainConnectError = EmailGetCustomTrackingDomainConnectErrors[keyof EmailGetCustomTrackingDomainConnectErrors];
3700
4028
  export type EmailGetCustomTrackingDomainConnectResponses = {
@@ -3725,6 +4053,10 @@ export type EmailBuildCustomTrackingDomainConnectApplyUrlErrors = {
3725
4053
  * ResourceNotFoundError
3726
4054
  */
3727
4055
  404: ResourceNotFoundError;
4056
+ /**
4057
+ * ConflictError
4058
+ */
4059
+ 409: ConflictError;
3728
4060
  /**
3729
4061
  * ValidationError
3730
4062
  */
@@ -3737,6 +4069,10 @@ export type EmailBuildCustomTrackingDomainConnectApplyUrlErrors = {
3737
4069
  * EmailChannelError
3738
4070
  */
3739
4071
  502: EmailChannelError;
4072
+ /**
4073
+ * GatewayTimeoutError
4074
+ */
4075
+ 504: GatewayTimeoutError;
3740
4076
  };
3741
4077
  export type EmailBuildCustomTrackingDomainConnectApplyUrlError = EmailBuildCustomTrackingDomainConnectApplyUrlErrors[keyof EmailBuildCustomTrackingDomainConnectApplyUrlErrors];
3742
4078
  export type EmailBuildCustomTrackingDomainConnectApplyUrlResponses = {
@@ -3750,6 +4086,7 @@ export type EmailCompleteCustomTrackingDomainConnectData = {
3750
4086
  body: {
3751
4087
  state: string;
3752
4088
  error?: string | null | undefined;
4089
+ errorDescription?: string | null | undefined;
3753
4090
  };
3754
4091
  path: {
3755
4092
  id: EmailDomainId;
@@ -3770,6 +4107,10 @@ export type EmailCompleteCustomTrackingDomainConnectErrors = {
3770
4107
  * InternalError
3771
4108
  */
3772
4109
  500: InternalError;
4110
+ /**
4111
+ * GatewayTimeoutError
4112
+ */
4113
+ 504: GatewayTimeoutError;
3773
4114
  };
3774
4115
  export type EmailCompleteCustomTrackingDomainConnectError = EmailCompleteCustomTrackingDomainConnectErrors[keyof EmailCompleteCustomTrackingDomainConnectErrors];
3775
4116
  export type EmailCompleteCustomTrackingDomainConnectResponses = {
@@ -3804,6 +4145,10 @@ export type EmailListSendersErrors = {
3804
4145
  * InternalError
3805
4146
  */
3806
4147
  500: InternalError;
4148
+ /**
4149
+ * GatewayTimeoutError
4150
+ */
4151
+ 504: GatewayTimeoutError;
3807
4152
  };
3808
4153
  export type EmailListSendersError = EmailListSendersErrors[keyof EmailListSendersErrors];
3809
4154
  export type EmailListSendersResponses = {
@@ -3825,6 +4170,7 @@ export type EmailListSendersResponses = {
3825
4170
  isDefault: boolean;
3826
4171
  replyToEmails: Array<string> | null;
3827
4172
  deliverability: DeliverabilityFacts;
4173
+ series: SendsSeries;
3828
4174
  isActive: boolean;
3829
4175
  createdAt: string;
3830
4176
  updatedAt: string;
@@ -3876,6 +4222,10 @@ export type EmailAddSenderErrors = {
3876
4222
  * ExternalServiceError
3877
4223
  */
3878
4224
  502: ExternalServiceError;
4225
+ /**
4226
+ * GatewayTimeoutError
4227
+ */
4228
+ 504: GatewayTimeoutError;
3879
4229
  };
3880
4230
  export type EmailAddSenderError = EmailAddSenderErrors[keyof EmailAddSenderErrors];
3881
4231
  export type EmailAddSenderResponses = {
@@ -3917,6 +4267,10 @@ export type EmailCheckSenderVerificationErrors = {
3917
4267
  * ExternalServiceError
3918
4268
  */
3919
4269
  502: ExternalServiceError;
4270
+ /**
4271
+ * GatewayTimeoutError
4272
+ */
4273
+ 504: GatewayTimeoutError;
3920
4274
  };
3921
4275
  export type EmailCheckSenderVerificationError = EmailCheckSenderVerificationErrors[keyof EmailCheckSenderVerificationErrors];
3922
4276
  export type EmailCheckSenderVerificationResponses = {
@@ -3960,6 +4314,10 @@ export type EmailRemoveSenderErrors = {
3960
4314
  * InternalError
3961
4315
  */
3962
4316
  500: InternalError;
4317
+ /**
4318
+ * GatewayTimeoutError
4319
+ */
4320
+ 504: GatewayTimeoutError;
3963
4321
  };
3964
4322
  export type EmailRemoveSenderError = EmailRemoveSenderErrors[keyof EmailRemoveSenderErrors];
3965
4323
  export type EmailRemoveSenderResponses = {
@@ -3994,6 +4352,10 @@ export type EmailGetSenderErrors = {
3994
4352
  * InternalError
3995
4353
  */
3996
4354
  500: InternalError;
4355
+ /**
4356
+ * GatewayTimeoutError
4357
+ */
4358
+ 504: GatewayTimeoutError;
3997
4359
  };
3998
4360
  export type EmailGetSenderError = EmailGetSenderErrors[keyof EmailGetSenderErrors];
3999
4361
  export type EmailGetSenderResponses = {
@@ -4014,6 +4376,7 @@ export type EmailGetSenderResponses = {
4014
4376
  isDefault: boolean;
4015
4377
  replyToEmails: Array<string> | null;
4016
4378
  deliverability: DeliverabilityFacts;
4379
+ series: SendsSeries;
4017
4380
  isActive: boolean;
4018
4381
  createdAt: string;
4019
4382
  updatedAt: string;
@@ -4049,7 +4412,11 @@ export type EmailSetDefaultSenderErrors = {
4049
4412
  * InternalError
4050
4413
  */
4051
4414
  500: InternalError;
4052
- };
4415
+ /**
4416
+ * GatewayTimeoutError
4417
+ */
4418
+ 504: GatewayTimeoutError;
4419
+ };
4053
4420
  export type EmailSetDefaultSenderError = EmailSetDefaultSenderErrors[keyof EmailSetDefaultSenderErrors];
4054
4421
  export type EmailSetDefaultSenderResponses = {
4055
4422
  /**
@@ -4080,6 +4447,10 @@ export type EmailGetStatsErrors = {
4080
4447
  * InternalError
4081
4448
  */
4082
4449
  500: InternalError;
4450
+ /**
4451
+ * GatewayTimeoutError
4452
+ */
4453
+ 504: GatewayTimeoutError;
4083
4454
  };
4084
4455
  export type EmailGetStatsError = EmailGetStatsErrors[keyof EmailGetStatsErrors];
4085
4456
  export type EmailGetStatsResponses = {
@@ -4127,6 +4498,10 @@ export type EmailEnableCatchAllErrors = {
4127
4498
  * ExternalServiceError
4128
4499
  */
4129
4500
  502: ExternalServiceError;
4501
+ /**
4502
+ * GatewayTimeoutError
4503
+ */
4504
+ 504: GatewayTimeoutError;
4130
4505
  };
4131
4506
  export type EmailEnableCatchAllError = EmailEnableCatchAllErrors[keyof EmailEnableCatchAllErrors];
4132
4507
  export type EmailEnableCatchAllResponses = {
@@ -4135,7 +4510,6 @@ export type EmailEnableCatchAllResponses = {
4135
4510
  */
4136
4511
  201: {
4137
4512
  success: true;
4138
- receiptRuleName: string;
4139
4513
  };
4140
4514
  };
4141
4515
  export type EmailEnableCatchAllResponse = EmailEnableCatchAllResponses[keyof EmailEnableCatchAllResponses];
@@ -4172,6 +4546,10 @@ export type EmailDisableCatchAllErrors = {
4172
4546
  * ExternalServiceError
4173
4547
  */
4174
4548
  502: ExternalServiceError;
4549
+ /**
4550
+ * GatewayTimeoutError
4551
+ */
4552
+ 504: GatewayTimeoutError;
4175
4553
  };
4176
4554
  export type EmailDisableCatchAllError = EmailDisableCatchAllErrors[keyof EmailDisableCatchAllErrors];
4177
4555
  export type EmailDisableCatchAllResponses = {
@@ -4208,6 +4586,10 @@ export type EmailGetCatchAllConfigErrors = {
4208
4586
  * InternalError
4209
4587
  */
4210
4588
  500: InternalError;
4589
+ /**
4590
+ * GatewayTimeoutError
4591
+ */
4592
+ 504: GatewayTimeoutError;
4211
4593
  };
4212
4594
  export type EmailGetCatchAllConfigError = EmailGetCatchAllConfigErrors[keyof EmailGetCatchAllConfigErrors];
4213
4595
  export type EmailGetCatchAllConfigResponses = {
@@ -4217,7 +4599,6 @@ export type EmailGetCatchAllConfigResponses = {
4217
4599
  200: {
4218
4600
  enabled: boolean;
4219
4601
  endpointId: WebhookEndpointId | null;
4220
- receiptRuleName: string | null;
4221
4602
  emailCount: number;
4222
4603
  lastEmailAt: string | null;
4223
4604
  };
@@ -4253,6 +4634,10 @@ export type EmailUpdateCatchAllConfigErrors = {
4253
4634
  * InternalError
4254
4635
  */
4255
4636
  500: InternalError;
4637
+ /**
4638
+ * GatewayTimeoutError
4639
+ */
4640
+ 504: GatewayTimeoutError;
4256
4641
  };
4257
4642
  export type EmailUpdateCatchAllConfigError = EmailUpdateCatchAllConfigErrors[keyof EmailUpdateCatchAllConfigErrors];
4258
4643
  export type EmailUpdateCatchAllConfigResponses = {
@@ -4291,6 +4676,10 @@ export type EmailGetCatchAllStatsErrors = {
4291
4676
  * InternalError
4292
4677
  */
4293
4678
  500: InternalError;
4679
+ /**
4680
+ * GatewayTimeoutError
4681
+ */
4682
+ 504: GatewayTimeoutError;
4294
4683
  };
4295
4684
  export type EmailGetCatchAllStatsError = EmailGetCatchAllStatsErrors[keyof EmailGetCatchAllStatsErrors];
4296
4685
  export type EmailGetCatchAllStatsResponses = {
@@ -4336,6 +4725,10 @@ export type EmailListSuppressionsErrors = {
4336
4725
  * InternalError
4337
4726
  */
4338
4727
  500: InternalError;
4728
+ /**
4729
+ * GatewayTimeoutError
4730
+ */
4731
+ 504: GatewayTimeoutError;
4339
4732
  };
4340
4733
  export type EmailListSuppressionsError = EmailListSuppressionsErrors[keyof EmailListSuppressionsErrors];
4341
4734
  export type EmailListSuppressionsResponses = {
@@ -4377,6 +4770,10 @@ export type EmailRemoveSuppressionErrors = {
4377
4770
  * EmailChannelError
4378
4771
  */
4379
4772
  502: EmailChannelError;
4773
+ /**
4774
+ * GatewayTimeoutError
4775
+ */
4776
+ 504: GatewayTimeoutError;
4380
4777
  };
4381
4778
  export type EmailRemoveSuppressionError = EmailRemoveSuppressionErrors[keyof EmailRemoveSuppressionErrors];
4382
4779
  export type EmailRemoveSuppressionResponses = {
@@ -4410,6 +4807,10 @@ export type EmailListBlocksErrors = {
4410
4807
  * InternalError
4411
4808
  */
4412
4809
  500: InternalError;
4810
+ /**
4811
+ * GatewayTimeoutError
4812
+ */
4813
+ 504: GatewayTimeoutError;
4413
4814
  };
4414
4815
  export type EmailListBlocksError = EmailListBlocksErrors[keyof EmailListBlocksErrors];
4415
4816
  export type EmailListBlocksResponses = {
@@ -4462,6 +4863,10 @@ export type EmailAddBlockErrors = {
4462
4863
  * ValidationError
4463
4864
  */
4464
4865
  422: ValidationError;
4866
+ /**
4867
+ * GatewayTimeoutError
4868
+ */
4869
+ 504: GatewayTimeoutError;
4465
4870
  };
4466
4871
  export type EmailAddBlockError = EmailAddBlockErrors[keyof EmailAddBlockErrors];
4467
4872
  export type EmailAddBlockResponses = {
@@ -4505,6 +4910,10 @@ export type EmailRemoveBlockErrors = {
4505
4910
  * InternalError
4506
4911
  */
4507
4912
  500: InternalError;
4913
+ /**
4914
+ * GatewayTimeoutError
4915
+ */
4916
+ 504: GatewayTimeoutError;
4508
4917
  };
4509
4918
  export type EmailRemoveBlockError = EmailRemoveBlockErrors[keyof EmailRemoveBlockErrors];
4510
4919
  export type EmailRemoveBlockResponses = {
@@ -4544,6 +4953,10 @@ export type EmailUpdateBlockErrors = {
4544
4953
  * InternalError
4545
4954
  */
4546
4955
  500: InternalError;
4956
+ /**
4957
+ * GatewayTimeoutError
4958
+ */
4959
+ 504: GatewayTimeoutError;
4547
4960
  };
4548
4961
  export type EmailUpdateBlockError = EmailUpdateBlockErrors[keyof EmailUpdateBlockErrors];
4549
4962
  export type EmailUpdateBlockResponses = {
@@ -4588,6 +5001,10 @@ export type EmailGetBlockLogsErrors = {
4588
5001
  * InternalError
4589
5002
  */
4590
5003
  500: InternalError;
5004
+ /**
5005
+ * GatewayTimeoutError
5006
+ */
5007
+ 504: GatewayTimeoutError;
4591
5008
  };
4592
5009
  export type EmailGetBlockLogsError = EmailGetBlockLogsErrors[keyof EmailGetBlockLogsErrors];
4593
5010
  export type EmailGetBlockLogsResponses = {
@@ -4603,10 +5020,9 @@ export type EmailGetBlockLogsResponses = {
4603
5020
  blockType: "email" | "domain";
4604
5021
  blockValue: string;
4605
5022
  blockReason: string;
4606
- spfResult: string | null;
4607
- dkimResult: string | null;
4608
- dmarcResult: string | null;
4609
- spamScore: number | null;
5023
+ spfResult: "pass" | "fail" | "softfail" | "neutral" | "none" | "policy" | "temperror" | "permerror" | null;
5024
+ dkimResult: "pass" | "fail" | "softfail" | "neutral" | "none" | "policy" | "temperror" | "permerror" | null;
5025
+ dmarcResult: "pass" | "fail" | "softfail" | "neutral" | "none" | "policy" | "temperror" | "permerror" | null;
4610
5026
  blockedAt: string;
4611
5027
  }>;
4612
5028
  total: number;
@@ -4634,6 +5050,10 @@ export type EmailCheckBlockedErrors = {
4634
5050
  * InternalError
4635
5051
  */
4636
5052
  500: InternalError;
5053
+ /**
5054
+ * GatewayTimeoutError
5055
+ */
5056
+ 504: GatewayTimeoutError;
4637
5057
  };
4638
5058
  export type EmailCheckBlockedError = EmailCheckBlockedErrors[keyof EmailCheckBlockedErrors];
4639
5059
  export type EmailCheckBlockedResponses = {
@@ -4677,6 +5097,10 @@ export type EmailListForwardingRulesErrors = {
4677
5097
  * InternalError
4678
5098
  */
4679
5099
  500: InternalError;
5100
+ /**
5101
+ * GatewayTimeoutError
5102
+ */
5103
+ 504: GatewayTimeoutError;
4680
5104
  };
4681
5105
  export type EmailListForwardingRulesError = EmailListForwardingRulesErrors[keyof EmailListForwardingRulesErrors];
4682
5106
  export type EmailListForwardingRulesResponses = {
@@ -4743,6 +5167,10 @@ export type EmailCreateForwardingRuleErrors = {
4743
5167
  * InternalError
4744
5168
  */
4745
5169
  500: InternalError;
5170
+ /**
5171
+ * GatewayTimeoutError
5172
+ */
5173
+ 504: GatewayTimeoutError;
4746
5174
  };
4747
5175
  export type EmailCreateForwardingRuleError = EmailCreateForwardingRuleErrors[keyof EmailCreateForwardingRuleErrors];
4748
5176
  export type EmailCreateForwardingRuleResponses = {
@@ -4784,6 +5212,10 @@ export type EmailDeleteForwardingRuleErrors = {
4784
5212
  * InternalError
4785
5213
  */
4786
5214
  500: InternalError;
5215
+ /**
5216
+ * GatewayTimeoutError
5217
+ */
5218
+ 504: GatewayTimeoutError;
4787
5219
  };
4788
5220
  export type EmailDeleteForwardingRuleError = EmailDeleteForwardingRuleErrors[keyof EmailDeleteForwardingRuleErrors];
4789
5221
  export type EmailDeleteForwardingRuleResponses = {
@@ -4832,6 +5264,10 @@ export type EmailUpdateForwardingRuleErrors = {
4832
5264
  * InternalError
4833
5265
  */
4834
5266
  500: InternalError;
5267
+ /**
5268
+ * GatewayTimeoutError
5269
+ */
5270
+ 504: GatewayTimeoutError;
4835
5271
  };
4836
5272
  export type EmailUpdateForwardingRuleError = EmailUpdateForwardingRuleErrors[keyof EmailUpdateForwardingRuleErrors];
4837
5273
  export type EmailUpdateForwardingRuleResponses = {
@@ -4874,6 +5310,10 @@ export type EmailGetForwardingLogErrors = {
4874
5310
  * InternalError
4875
5311
  */
4876
5312
  500: InternalError;
5313
+ /**
5314
+ * GatewayTimeoutError
5315
+ */
5316
+ 504: GatewayTimeoutError;
4877
5317
  };
4878
5318
  export type EmailGetForwardingLogError = EmailGetForwardingLogErrors[keyof EmailGetForwardingLogErrors];
4879
5319
  export type EmailGetForwardingLogResponses = {
@@ -4928,6 +5368,10 @@ export type EmailGetDomainWarmingErrors = {
4928
5368
  * InternalError
4929
5369
  */
4930
5370
  500: InternalError;
5371
+ /**
5372
+ * GatewayTimeoutError
5373
+ */
5374
+ 504: GatewayTimeoutError;
4931
5375
  };
4932
5376
  export type EmailGetDomainWarmingError = EmailGetDomainWarmingErrors[keyof EmailGetDomainWarmingErrors];
4933
5377
  export type EmailGetDomainWarmingResponses = {
@@ -4975,6 +5419,10 @@ export type EmailCreateDomainWarmingPlanErrors = {
4975
5419
  * InternalError
4976
5420
  */
4977
5421
  500: InternalError;
5422
+ /**
5423
+ * GatewayTimeoutError
5424
+ */
5425
+ 504: GatewayTimeoutError;
4978
5426
  };
4979
5427
  export type EmailCreateDomainWarmingPlanError = EmailCreateDomainWarmingPlanErrors[keyof EmailCreateDomainWarmingPlanErrors];
4980
5428
  export type EmailCreateDomainWarmingPlanResponses = {
@@ -5021,6 +5469,10 @@ export type EmailUpdateDomainWarmingPolicyErrors = {
5021
5469
  * InternalError
5022
5470
  */
5023
5471
  500: InternalError;
5472
+ /**
5473
+ * GatewayTimeoutError
5474
+ */
5475
+ 504: GatewayTimeoutError;
5024
5476
  };
5025
5477
  export type EmailUpdateDomainWarmingPolicyError = EmailUpdateDomainWarmingPolicyErrors[keyof EmailUpdateDomainWarmingPolicyErrors];
5026
5478
  export type EmailUpdateDomainWarmingPolicyResponses = {
@@ -5060,6 +5512,10 @@ export type EmailCancelDomainWarmingBatchErrors = {
5060
5512
  * InternalError
5061
5513
  */
5062
5514
  500: InternalError;
5515
+ /**
5516
+ * GatewayTimeoutError
5517
+ */
5518
+ 504: GatewayTimeoutError;
5063
5519
  };
5064
5520
  export type EmailCancelDomainWarmingBatchError = EmailCancelDomainWarmingBatchErrors[keyof EmailCancelDomainWarmingBatchErrors];
5065
5521
  export type EmailCancelDomainWarmingBatchResponses = {
@@ -5100,6 +5556,10 @@ export type EmailPauseDomainWarmingErrors = {
5100
5556
  * InternalError
5101
5557
  */
5102
5558
  500: InternalError;
5559
+ /**
5560
+ * GatewayTimeoutError
5561
+ */
5562
+ 504: GatewayTimeoutError;
5103
5563
  };
5104
5564
  export type EmailPauseDomainWarmingError = EmailPauseDomainWarmingErrors[keyof EmailPauseDomainWarmingErrors];
5105
5565
  export type EmailPauseDomainWarmingResponses = {
@@ -5140,6 +5600,10 @@ export type EmailResumeDomainWarmingErrors = {
5140
5600
  * InternalError
5141
5601
  */
5142
5602
  500: InternalError;
5603
+ /**
5604
+ * GatewayTimeoutError
5605
+ */
5606
+ 504: GatewayTimeoutError;
5143
5607
  };
5144
5608
  export type EmailResumeDomainWarmingError = EmailResumeDomainWarmingErrors[keyof EmailResumeDomainWarmingErrors];
5145
5609
  export type EmailResumeDomainWarmingResponses = {
@@ -5180,6 +5644,10 @@ export type EmailCompleteDomainWarmingErrors = {
5180
5644
  * InternalError
5181
5645
  */
5182
5646
  500: InternalError;
5647
+ /**
5648
+ * GatewayTimeoutError
5649
+ */
5650
+ 504: GatewayTimeoutError;
5183
5651
  };
5184
5652
  export type EmailCompleteDomainWarmingError = EmailCompleteDomainWarmingErrors[keyof EmailCompleteDomainWarmingErrors];
5185
5653
  export type EmailCompleteDomainWarmingResponses = {
@@ -5218,6 +5686,10 @@ export type MediaCreateErrors = {
5218
5686
  * InternalError
5219
5687
  */
5220
5688
  500: InternalError;
5689
+ /**
5690
+ * GatewayTimeoutError
5691
+ */
5692
+ 504: GatewayTimeoutError;
5221
5693
  };
5222
5694
  export type MediaCreateError = MediaCreateErrors[keyof MediaCreateErrors];
5223
5695
  export type MediaCreateResponses = {
@@ -5256,6 +5728,10 @@ export type MediaCompleteErrors = {
5256
5728
  * InternalError
5257
5729
  */
5258
5730
  500: InternalError;
5731
+ /**
5732
+ * GatewayTimeoutError
5733
+ */
5734
+ 504: GatewayTimeoutError;
5259
5735
  };
5260
5736
  export type MediaCompleteError = MediaCompleteErrors[keyof MediaCompleteErrors];
5261
5737
  export type MediaCompleteResponses = {
@@ -5294,6 +5770,10 @@ export type MediaRemoveErrors = {
5294
5770
  * InternalError
5295
5771
  */
5296
5772
  500: InternalError;
5773
+ /**
5774
+ * GatewayTimeoutError
5775
+ */
5776
+ 504: GatewayTimeoutError;
5297
5777
  };
5298
5778
  export type MediaRemoveError = MediaRemoveErrors[keyof MediaRemoveErrors];
5299
5779
  export type MediaRemoveResponses = {
@@ -5328,6 +5808,10 @@ export type MediaGetByIdErrors = {
5328
5808
  * InternalError
5329
5809
  */
5330
5810
  500: InternalError;
5811
+ /**
5812
+ * GatewayTimeoutError
5813
+ */
5814
+ 504: GatewayTimeoutError;
5331
5815
  };
5332
5816
  export type MediaGetByIdError = MediaGetByIdErrors[keyof MediaGetByIdErrors];
5333
5817
  export type MediaGetByIdResponses = {
@@ -5366,6 +5850,10 @@ export type MediaDownloadUrlErrors = {
5366
5850
  * InternalError
5367
5851
  */
5368
5852
  500: InternalError;
5853
+ /**
5854
+ * GatewayTimeoutError
5855
+ */
5856
+ 504: GatewayTimeoutError;
5369
5857
  };
5370
5858
  export type MediaDownloadUrlError = MediaDownloadUrlErrors[keyof MediaDownloadUrlErrors];
5371
5859
  export type MediaDownloadUrlResponses = {
@@ -5375,6 +5863,200 @@ export type MediaDownloadUrlResponses = {
5375
5863
  200: MediaDownloadUrl;
5376
5864
  };
5377
5865
  export type MediaDownloadUrlResponse = MediaDownloadUrlResponses[keyof MediaDownloadUrlResponses];
5866
+ export type AttachmentsRemoveData = {
5867
+ body?: never;
5868
+ path: {
5869
+ id: AttachmentId;
5870
+ };
5871
+ query?: never;
5872
+ url: "/v1/attachments/{id}";
5873
+ };
5874
+ export type AttachmentsRemoveErrors = {
5875
+ /**
5876
+ * UnauthorizedError
5877
+ */
5878
+ 401: UnauthorizedError;
5879
+ /**
5880
+ * ForbiddenError
5881
+ */
5882
+ 403: ForbiddenError;
5883
+ /**
5884
+ * ResourceNotFoundError
5885
+ */
5886
+ 404: ResourceNotFoundError;
5887
+ /**
5888
+ * InternalError
5889
+ */
5890
+ 500: InternalError;
5891
+ /**
5892
+ * GatewayTimeoutError
5893
+ */
5894
+ 504: GatewayTimeoutError;
5895
+ };
5896
+ export type AttachmentsRemoveError = AttachmentsRemoveErrors[keyof AttachmentsRemoveErrors];
5897
+ export type AttachmentsRemoveResponses = {
5898
+ /**
5899
+ * Success
5900
+ */
5901
+ 200: {
5902
+ success: boolean;
5903
+ deletedId: AttachmentId;
5904
+ };
5905
+ };
5906
+ export type AttachmentsRemoveResponse = AttachmentsRemoveResponses[keyof AttachmentsRemoveResponses];
5907
+ export type AttachmentsGetByIdData = {
5908
+ body?: never;
5909
+ path: {
5910
+ id: AttachmentId;
5911
+ };
5912
+ query?: never;
5913
+ url: "/v1/attachments/{id}";
5914
+ };
5915
+ export type AttachmentsGetByIdErrors = {
5916
+ /**
5917
+ * UnauthorizedError
5918
+ */
5919
+ 401: UnauthorizedError;
5920
+ /**
5921
+ * ForbiddenError
5922
+ */
5923
+ 403: ForbiddenError;
5924
+ /**
5925
+ * ResourceNotFoundError
5926
+ */
5927
+ 404: ResourceNotFoundError;
5928
+ /**
5929
+ * InternalError
5930
+ */
5931
+ 500: InternalError;
5932
+ /**
5933
+ * GatewayTimeoutError
5934
+ */
5935
+ 504: GatewayTimeoutError;
5936
+ };
5937
+ export type AttachmentsGetByIdError = AttachmentsGetByIdErrors[keyof AttachmentsGetByIdErrors];
5938
+ export type AttachmentsGetByIdResponses = {
5939
+ /**
5940
+ * Success
5941
+ */
5942
+ 200: {
5943
+ id: AttachmentId;
5944
+ messageId: MessageId;
5945
+ organizationId: OrganizationId;
5946
+ filename: string;
5947
+ contentType: string;
5948
+ size: number;
5949
+ contentId: string | null;
5950
+ isInline: boolean;
5951
+ createdAt: string;
5952
+ };
5953
+ };
5954
+ export type AttachmentsGetByIdResponse = AttachmentsGetByIdResponses[keyof AttachmentsGetByIdResponses];
5955
+ export type AttachmentsListData = {
5956
+ body?: never;
5957
+ path?: never;
5958
+ query: {
5959
+ messageId: MessageId;
5960
+ };
5961
+ url: "/v1/attachments";
5962
+ };
5963
+ export type AttachmentsListErrors = {
5964
+ /**
5965
+ * UnauthorizedError
5966
+ */
5967
+ 401: UnauthorizedError;
5968
+ /**
5969
+ * ForbiddenError
5970
+ */
5971
+ 403: ForbiddenError;
5972
+ /**
5973
+ * ResourceNotFoundError
5974
+ */
5975
+ 404: ResourceNotFoundError;
5976
+ /**
5977
+ * InternalError
5978
+ */
5979
+ 500: InternalError;
5980
+ /**
5981
+ * GatewayTimeoutError
5982
+ */
5983
+ 504: GatewayTimeoutError;
5984
+ };
5985
+ export type AttachmentsListError = AttachmentsListErrors[keyof AttachmentsListErrors];
5986
+ export type AttachmentsListResponses = {
5987
+ /**
5988
+ * Success
5989
+ */
5990
+ 200: {
5991
+ attachments: Array<{
5992
+ id: AttachmentId;
5993
+ messageId: MessageId;
5994
+ organizationId: OrganizationId;
5995
+ filename: string;
5996
+ contentType: string;
5997
+ size: number;
5998
+ contentId: string | null;
5999
+ isInline: boolean;
6000
+ createdAt: string;
6001
+ }>;
6002
+ total: number;
6003
+ };
6004
+ };
6005
+ export type AttachmentsListResponse = AttachmentsListResponses[keyof AttachmentsListResponses];
6006
+ export type AttachmentsDownloadUrlData = {
6007
+ body?: never;
6008
+ path: {
6009
+ id: AttachmentId;
6010
+ };
6011
+ query?: {
6012
+ expiresIn?: string | null | undefined;
6013
+ };
6014
+ url: "/v1/attachments/{id}/download-url";
6015
+ };
6016
+ export type AttachmentsDownloadUrlErrors = {
6017
+ /**
6018
+ * UnauthorizedError
6019
+ */
6020
+ 401: UnauthorizedError;
6021
+ /**
6022
+ * ForbiddenError
6023
+ */
6024
+ 403: ForbiddenError;
6025
+ /**
6026
+ * ResourceNotFoundError
6027
+ */
6028
+ 404: ResourceNotFoundError;
6029
+ /**
6030
+ * InternalError
6031
+ */
6032
+ 500: InternalError;
6033
+ /**
6034
+ * GatewayTimeoutError
6035
+ */
6036
+ 504: GatewayTimeoutError;
6037
+ };
6038
+ export type AttachmentsDownloadUrlError = AttachmentsDownloadUrlErrors[keyof AttachmentsDownloadUrlErrors];
6039
+ export type AttachmentsDownloadUrlResponses = {
6040
+ /**
6041
+ * Success
6042
+ */
6043
+ 200: {
6044
+ url: string;
6045
+ expiresAt: string;
6046
+ attachment: {
6047
+ id: AttachmentId;
6048
+ messageId: MessageId;
6049
+ organizationId: OrganizationId;
6050
+ filename: string;
6051
+ contentType: string;
6052
+ size: number;
6053
+ contentId: string | null;
6054
+ isInline: boolean;
6055
+ createdAt: string;
6056
+ };
6057
+ };
6058
+ };
6059
+ export type AttachmentsDownloadUrlResponse = AttachmentsDownloadUrlResponses[keyof AttachmentsDownloadUrlResponses];
5378
6060
  export type ConversationsListData = {
5379
6061
  body?: never;
5380
6062
  path?: never;
@@ -5402,6 +6084,10 @@ export type ConversationsListErrors = {
5402
6084
  * InternalError
5403
6085
  */
5404
6086
  500: InternalError;
6087
+ /**
6088
+ * GatewayTimeoutError
6089
+ */
6090
+ 504: GatewayTimeoutError;
5405
6091
  };
5406
6092
  export type ConversationsListError = ConversationsListErrors[keyof ConversationsListErrors];
5407
6093
  export type ConversationsListResponses = {
@@ -5458,6 +6144,10 @@ export type ConversationsCreateErrors = {
5458
6144
  * InternalError
5459
6145
  */
5460
6146
  500: InternalError;
6147
+ /**
6148
+ * GatewayTimeoutError
6149
+ */
6150
+ 504: GatewayTimeoutError;
5461
6151
  };
5462
6152
  export type ConversationsCreateError = ConversationsCreateErrors[keyof ConversationsCreateErrors];
5463
6153
  export type ConversationsCreateResponses = {
@@ -5492,6 +6182,10 @@ export type ConversationsGetByIdErrors = {
5492
6182
  * InternalError
5493
6183
  */
5494
6184
  500: InternalError;
6185
+ /**
6186
+ * GatewayTimeoutError
6187
+ */
6188
+ 504: GatewayTimeoutError;
5495
6189
  };
5496
6190
  export type ConversationsGetByIdError = ConversationsGetByIdErrors[keyof ConversationsGetByIdErrors];
5497
6191
  export type ConversationsGetByIdResponses = {
@@ -5551,6 +6245,10 @@ export type ConversationsUpdateErrors = {
5551
6245
  * InternalError
5552
6246
  */
5553
6247
  500: InternalError;
6248
+ /**
6249
+ * GatewayTimeoutError
6250
+ */
6251
+ 504: GatewayTimeoutError;
5554
6252
  };
5555
6253
  export type ConversationsUpdateError = ConversationsUpdateErrors[keyof ConversationsUpdateErrors];
5556
6254
  export type ConversationsUpdateResponses = {
@@ -5588,6 +6286,10 @@ export type ConversationsListMessagesErrors = {
5588
6286
  * InternalError
5589
6287
  */
5590
6288
  500: InternalError;
6289
+ /**
6290
+ * GatewayTimeoutError
6291
+ */
6292
+ 504: GatewayTimeoutError;
5591
6293
  };
5592
6294
  export type ConversationsListMessagesError = ConversationsListMessagesErrors[keyof ConversationsListMessagesErrors];
5593
6295
  export type ConversationsListMessagesResponses = {
@@ -5631,6 +6333,10 @@ export type ConversationsRemoveContactsErrors = {
5631
6333
  * InternalError
5632
6334
  */
5633
6335
  500: InternalError;
6336
+ /**
6337
+ * GatewayTimeoutError
6338
+ */
6339
+ 504: GatewayTimeoutError;
5634
6340
  };
5635
6341
  export type ConversationsRemoveContactsError = ConversationsRemoveContactsErrors[keyof ConversationsRemoveContactsErrors];
5636
6342
  export type ConversationsRemoveContactsResponses = {
@@ -5671,6 +6377,10 @@ export type ConversationsAddContactsErrors = {
5671
6377
  * InternalError
5672
6378
  */
5673
6379
  500: InternalError;
6380
+ /**
6381
+ * GatewayTimeoutError
6382
+ */
6383
+ 504: GatewayTimeoutError;
5674
6384
  };
5675
6385
  export type ConversationsAddContactsError = ConversationsAddContactsErrors[keyof ConversationsAddContactsErrors];
5676
6386
  export type ConversationsAddContactsResponses = {
@@ -5707,6 +6417,10 @@ export type ContactsListErrors = {
5707
6417
  * InternalError
5708
6418
  */
5709
6419
  500: InternalError;
6420
+ /**
6421
+ * GatewayTimeoutError
6422
+ */
6423
+ 504: GatewayTimeoutError;
5710
6424
  };
5711
6425
  export type ContactsListError = ContactsListErrors[keyof ContactsListErrors];
5712
6426
  export type ContactsListResponses = {
@@ -5768,6 +6482,10 @@ export type ContactsCreateErrors = {
5768
6482
  * BillingProviderError
5769
6483
  */
5770
6484
  502: BillingProviderError;
6485
+ /**
6486
+ * GatewayTimeoutError
6487
+ */
6488
+ 504: GatewayTimeoutError;
5771
6489
  };
5772
6490
  export type ContactsCreateError = ContactsCreateErrors[keyof ContactsCreateErrors];
5773
6491
  export type ContactsCreateResponses = {
@@ -5808,6 +6526,10 @@ export type ContactsFindErrors = {
5808
6526
  * InternalError
5809
6527
  */
5810
6528
  500: InternalError;
6529
+ /**
6530
+ * GatewayTimeoutError
6531
+ */
6532
+ 504: GatewayTimeoutError;
5811
6533
  };
5812
6534
  export type ContactsFindError = ContactsFindErrors[keyof ContactsFindErrors];
5813
6535
  export type ContactsFindResponses = {
@@ -5858,6 +6580,10 @@ export type ContactsFindOrCreateErrors = {
5858
6580
  * BillingProviderError
5859
6581
  */
5860
6582
  502: BillingProviderError;
6583
+ /**
6584
+ * GatewayTimeoutError
6585
+ */
6586
+ 504: GatewayTimeoutError;
5861
6587
  };
5862
6588
  export type ContactsFindOrCreateError = ContactsFindOrCreateErrors[keyof ContactsFindOrCreateErrors];
5863
6589
  export type ContactsFindOrCreateResponses = {
@@ -5896,6 +6622,10 @@ export type ContactsRemoveErrors = {
5896
6622
  * BillingProviderError
5897
6623
  */
5898
6624
  502: BillingProviderError;
6625
+ /**
6626
+ * GatewayTimeoutError
6627
+ */
6628
+ 504: GatewayTimeoutError;
5899
6629
  };
5900
6630
  export type ContactsRemoveError = ContactsRemoveErrors[keyof ContactsRemoveErrors];
5901
6631
  export type ContactsRemoveResponses = {
@@ -5932,6 +6662,10 @@ export type ContactsGetErrors = {
5932
6662
  * InternalError
5933
6663
  */
5934
6664
  500: InternalError;
6665
+ /**
6666
+ * GatewayTimeoutError
6667
+ */
6668
+ 504: GatewayTimeoutError;
5935
6669
  };
5936
6670
  export type ContactsGetError = ContactsGetErrors[keyof ContactsGetErrors];
5937
6671
  export type ContactsGetResponses = {
@@ -5996,6 +6730,10 @@ export type ContactsUpdateErrors = {
5996
6730
  * BillingProviderError
5997
6731
  */
5998
6732
  502: BillingProviderError;
6733
+ /**
6734
+ * GatewayTimeoutError
6735
+ */
6736
+ 504: GatewayTimeoutError;
5999
6737
  };
6000
6738
  export type ContactsUpdateError = ContactsUpdateErrors[keyof ContactsUpdateErrors];
6001
6739
  export type ContactsUpdateResponses = {
@@ -6030,6 +6768,10 @@ export type ContactsGetEngagementErrors = {
6030
6768
  * InternalError
6031
6769
  */
6032
6770
  500: InternalError;
6771
+ /**
6772
+ * GatewayTimeoutError
6773
+ */
6774
+ 504: GatewayTimeoutError;
6033
6775
  };
6034
6776
  export type ContactsGetEngagementError = ContactsGetEngagementErrors[keyof ContactsGetEngagementErrors];
6035
6777
  export type ContactsGetEngagementResponses = {
@@ -6092,6 +6834,10 @@ export type ContactsBulkImportErrors = {
6092
6834
  * BillingProviderError
6093
6835
  */
6094
6836
  502: BillingProviderError;
6837
+ /**
6838
+ * GatewayTimeoutError
6839
+ */
6840
+ 504: GatewayTimeoutError;
6095
6841
  };
6096
6842
  export type ContactsBulkImportError = ContactsBulkImportErrors[keyof ContactsBulkImportErrors];
6097
6843
  export type ContactsBulkImportResponses = {
@@ -6138,6 +6884,10 @@ export type ContactsBulkDeleteErrors = {
6138
6884
  * BillingProviderError
6139
6885
  */
6140
6886
  502: BillingProviderError;
6887
+ /**
6888
+ * GatewayTimeoutError
6889
+ */
6890
+ 504: GatewayTimeoutError;
6141
6891
  };
6142
6892
  export type ContactsBulkDeleteError = ContactsBulkDeleteErrors[keyof ContactsBulkDeleteErrors];
6143
6893
  export type ContactsBulkDeleteResponses = {
@@ -6173,6 +6923,10 @@ export type ContactsBulkUpdateTagsErrors = {
6173
6923
  * InternalError
6174
6924
  */
6175
6925
  500: InternalError;
6926
+ /**
6927
+ * GatewayTimeoutError
6928
+ */
6929
+ 504: GatewayTimeoutError;
6176
6930
  };
6177
6931
  export type ContactsBulkUpdateTagsError = ContactsBulkUpdateTagsErrors[keyof ContactsBulkUpdateTagsErrors];
6178
6932
  export type ContactsBulkUpdateTagsResponses = {
@@ -6212,6 +6966,10 @@ export type ContactsBulkUpdateStatusErrors = {
6212
6966
  * BillingProviderError
6213
6967
  */
6214
6968
  502: BillingProviderError;
6969
+ /**
6970
+ * GatewayTimeoutError
6971
+ */
6972
+ 504: GatewayTimeoutError;
6215
6973
  };
6216
6974
  export type ContactsBulkUpdateStatusError = ContactsBulkUpdateStatusErrors[keyof ContactsBulkUpdateStatusErrors];
6217
6975
  export type ContactsBulkUpdateStatusResponses = {
@@ -6249,32 +7007,1443 @@ export type ContactsExportErrors = {
6249
7007
  * InternalError
6250
7008
  */
6251
7009
  500: InternalError;
7010
+ /**
7011
+ * GatewayTimeoutError
7012
+ */
7013
+ 504: GatewayTimeoutError;
7014
+ };
7015
+ export type ContactsExportError = ContactsExportErrors[keyof ContactsExportErrors];
7016
+ export type ContactsExportResponses = {
7017
+ /**
7018
+ * Success
7019
+ */
7020
+ 200: {
7021
+ data: string;
7022
+ format: "json" | "csv";
7023
+ count: number;
7024
+ };
7025
+ };
7026
+ export type ContactsExportResponse = ContactsExportResponses[keyof ContactsExportResponses];
7027
+ export type ContactsGetActivityTimelineData = {
7028
+ body?: never;
7029
+ path: {
7030
+ id: ContactId;
7031
+ };
7032
+ query?: {
7033
+ page?: string | null | undefined;
7034
+ limit?: string | null | undefined;
7035
+ channel?: "email" | null | undefined;
7036
+ };
7037
+ url: "/v1/contacts/{id}/activity";
7038
+ };
7039
+ export type ContactsGetActivityTimelineErrors = {
7040
+ /**
7041
+ * UnauthorizedError
7042
+ */
7043
+ 401: UnauthorizedError;
7044
+ /**
7045
+ * ForbiddenError
7046
+ */
7047
+ 403: ForbiddenError;
7048
+ /**
7049
+ * ResourceNotFoundError
7050
+ */
7051
+ 404: ResourceNotFoundError;
7052
+ /**
7053
+ * InternalError
7054
+ */
7055
+ 500: InternalError;
7056
+ /**
7057
+ * GatewayTimeoutError
7058
+ */
7059
+ 504: GatewayTimeoutError;
7060
+ };
7061
+ export type ContactsGetActivityTimelineError = ContactsGetActivityTimelineErrors[keyof ContactsGetActivityTimelineErrors];
7062
+ export type ContactsGetActivityTimelineResponses = {
7063
+ /**
7064
+ * Success
7065
+ */
7066
+ 200: {
7067
+ items: Array<{
7068
+ id: MessageId;
7069
+ channel: string;
7070
+ direction: string;
7071
+ status: string;
7072
+ subject: string | null;
7073
+ snippet: string | null;
7074
+ createdAt: string;
7075
+ conversationId: ConversationId | null;
7076
+ }>;
7077
+ pagination: PaginationMeta;
7078
+ };
7079
+ };
7080
+ export type ContactsGetActivityTimelineResponse = ContactsGetActivityTimelineResponses[keyof ContactsGetActivityTimelineResponses];
7081
+ export type ContactsGetGroupMembershipsData = {
7082
+ body?: never;
7083
+ path: {
7084
+ id: ContactId;
7085
+ };
7086
+ query?: never;
7087
+ url: "/v1/contacts/{id}/groups";
7088
+ };
7089
+ export type ContactsGetGroupMembershipsErrors = {
7090
+ /**
7091
+ * UnauthorizedError
7092
+ */
7093
+ 401: UnauthorizedError;
7094
+ /**
7095
+ * ForbiddenError
7096
+ */
7097
+ 403: ForbiddenError;
7098
+ /**
7099
+ * ResourceNotFoundError
7100
+ */
7101
+ 404: ResourceNotFoundError;
7102
+ /**
7103
+ * InternalError
7104
+ */
7105
+ 500: InternalError;
7106
+ /**
7107
+ * GatewayTimeoutError
7108
+ */
7109
+ 504: GatewayTimeoutError;
7110
+ };
7111
+ export type ContactsGetGroupMembershipsError = ContactsGetGroupMembershipsErrors[keyof ContactsGetGroupMembershipsErrors];
7112
+ export type ContactsGetGroupMembershipsResponses = {
7113
+ /**
7114
+ * Success
7115
+ */
7116
+ 200: {
7117
+ groups: Array<{
7118
+ id: ContactGroupId;
7119
+ name: string;
7120
+ type: string;
7121
+ color: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null;
7122
+ role: string;
7123
+ joinedAt: string;
7124
+ }>;
7125
+ };
7126
+ };
7127
+ export type ContactsGetGroupMembershipsResponse = ContactsGetGroupMembershipsResponses[keyof ContactsGetGroupMembershipsResponses];
7128
+ export type ContactGroupsListData = {
7129
+ body?: never;
7130
+ path?: never;
7131
+ query?: {
7132
+ page?: string | null | undefined;
7133
+ limit?: string | null | undefined;
7134
+ type?: "static" | "dynamic" | "smart" | Array<"static" | "dynamic" | "smart"> | null | undefined;
7135
+ isActive?: string | null | undefined;
7136
+ };
7137
+ url: "/v1/contact-groups";
7138
+ };
7139
+ export type ContactGroupsListErrors = {
7140
+ /**
7141
+ * UnauthorizedError
7142
+ */
7143
+ 401: UnauthorizedError;
7144
+ /**
7145
+ * ForbiddenError
7146
+ */
7147
+ 403: ForbiddenError;
7148
+ /**
7149
+ * InternalError
7150
+ */
7151
+ 500: InternalError;
7152
+ /**
7153
+ * GatewayTimeoutError
7154
+ */
7155
+ 504: GatewayTimeoutError;
7156
+ };
7157
+ export type ContactGroupsListError = ContactGroupsListErrors[keyof ContactGroupsListErrors];
7158
+ export type ContactGroupsListResponses = {
7159
+ /**
7160
+ * Success
7161
+ */
7162
+ 200: {
7163
+ items: Array<{
7164
+ id: ContactGroupId;
7165
+ organizationId: OrganizationId;
7166
+ name: string;
7167
+ description: string | null;
7168
+ type: "static" | "dynamic" | "smart";
7169
+ criteria: {
7170
+ [key: string]: JsonValue;
7171
+ } | null;
7172
+ /**
7173
+ * The list's label color, one of six families, or null for the neutral chip. Customer-chosen and purely presentational; it carries no meaning the API enforces.
7174
+ */
7175
+ color: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null;
7176
+ icon: string | null;
7177
+ parentGroupId: ContactGroupId | null;
7178
+ contactCount: number;
7179
+ lastCalculatedAt: string | null;
7180
+ isActive: boolean;
7181
+ createdAt: string;
7182
+ updatedAt: string;
7183
+ }>;
7184
+ pagination: PaginationMeta;
7185
+ };
7186
+ };
7187
+ export type ContactGroupsListResponse = ContactGroupsListResponses[keyof ContactGroupsListResponses];
7188
+ export type ContactGroupsCreateData = {
7189
+ body: {
7190
+ name: string;
7191
+ description?: string | null | null | undefined;
7192
+ type?: "static" | "dynamic" | "smart" | null | undefined;
7193
+ criteria?: {
7194
+ [key: string]: JsonValue;
7195
+ } | null | null | undefined;
7196
+ color?: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null | null | undefined;
7197
+ icon?: string | null | null | undefined;
7198
+ parentGroupId?: ContactGroupId | null | null | undefined;
7199
+ isActive?: boolean | null | undefined;
7200
+ };
7201
+ path?: never;
7202
+ query?: never;
7203
+ url: "/v1/contact-groups";
7204
+ };
7205
+ export type ContactGroupsCreateErrors = {
7206
+ /**
7207
+ * UnauthorizedError
7208
+ */
7209
+ 401: UnauthorizedError;
7210
+ /**
7211
+ * ForbiddenError
7212
+ */
7213
+ 403: ForbiddenError;
7214
+ /**
7215
+ * ValidationError
7216
+ */
7217
+ 422: ValidationError;
7218
+ /**
7219
+ * InternalError
7220
+ */
7221
+ 500: InternalError;
7222
+ /**
7223
+ * GatewayTimeoutError
7224
+ */
7225
+ 504: GatewayTimeoutError;
7226
+ };
7227
+ export type ContactGroupsCreateError = ContactGroupsCreateErrors[keyof ContactGroupsCreateErrors];
7228
+ export type ContactGroupsCreateResponses = {
7229
+ /**
7230
+ * Success
7231
+ */
7232
+ 201: {
7233
+ id: ContactGroupId;
7234
+ organizationId: OrganizationId;
7235
+ name: string;
7236
+ description: string | null;
7237
+ type: "static" | "dynamic" | "smart";
7238
+ criteria: {
7239
+ [key: string]: JsonValue;
7240
+ } | null;
7241
+ /**
7242
+ * The list's label color, one of six families, or null for the neutral chip. Customer-chosen and purely presentational; it carries no meaning the API enforces.
7243
+ */
7244
+ color: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null;
7245
+ icon: string | null;
7246
+ parentGroupId: ContactGroupId | null;
7247
+ contactCount: number;
7248
+ lastCalculatedAt: string | null;
7249
+ isActive: boolean;
7250
+ createdAt: string;
7251
+ updatedAt: string;
7252
+ };
7253
+ };
7254
+ export type ContactGroupsCreateResponse = ContactGroupsCreateResponses[keyof ContactGroupsCreateResponses];
7255
+ export type ContactGroupsRemoveData = {
7256
+ body?: never;
7257
+ path: {
7258
+ id: ContactGroupId;
7259
+ };
7260
+ query?: never;
7261
+ url: "/v1/contact-groups/{id}";
7262
+ };
7263
+ export type ContactGroupsRemoveErrors = {
7264
+ /**
7265
+ * UnauthorizedError
7266
+ */
7267
+ 401: UnauthorizedError;
7268
+ /**
7269
+ * ForbiddenError
7270
+ */
7271
+ 403: ForbiddenError;
7272
+ /**
7273
+ * ResourceNotFoundError
7274
+ */
7275
+ 404: ResourceNotFoundError;
7276
+ /**
7277
+ * InternalError
7278
+ */
7279
+ 500: InternalError;
7280
+ /**
7281
+ * GatewayTimeoutError
7282
+ */
7283
+ 504: GatewayTimeoutError;
7284
+ };
7285
+ export type ContactGroupsRemoveError = ContactGroupsRemoveErrors[keyof ContactGroupsRemoveErrors];
7286
+ export type ContactGroupsRemoveResponses = {
7287
+ /**
7288
+ * Success
7289
+ */
7290
+ 200: {
7291
+ success: boolean;
7292
+ };
7293
+ };
7294
+ export type ContactGroupsRemoveResponse = ContactGroupsRemoveResponses[keyof ContactGroupsRemoveResponses];
7295
+ export type ContactGroupsGetByIdData = {
7296
+ body?: never;
7297
+ path: {
7298
+ id: ContactGroupId;
7299
+ };
7300
+ query?: never;
7301
+ url: "/v1/contact-groups/{id}";
7302
+ };
7303
+ export type ContactGroupsGetByIdErrors = {
7304
+ /**
7305
+ * UnauthorizedError
7306
+ */
7307
+ 401: UnauthorizedError;
7308
+ /**
7309
+ * ForbiddenError
7310
+ */
7311
+ 403: ForbiddenError;
7312
+ /**
7313
+ * ResourceNotFoundError
7314
+ */
7315
+ 404: ResourceNotFoundError;
7316
+ /**
7317
+ * InternalError
7318
+ */
7319
+ 500: InternalError;
7320
+ /**
7321
+ * GatewayTimeoutError
7322
+ */
7323
+ 504: GatewayTimeoutError;
7324
+ };
7325
+ export type ContactGroupsGetByIdError = ContactGroupsGetByIdErrors[keyof ContactGroupsGetByIdErrors];
7326
+ export type ContactGroupsGetByIdResponses = {
7327
+ /**
7328
+ * Success
7329
+ */
7330
+ 200: {
7331
+ id: ContactGroupId;
7332
+ organizationId: OrganizationId;
7333
+ name: string;
7334
+ description: string | null;
7335
+ type: "static" | "dynamic" | "smart";
7336
+ criteria: {
7337
+ [key: string]: JsonValue;
7338
+ } | null;
7339
+ /**
7340
+ * The list's label color, one of six families, or null for the neutral chip. Customer-chosen and purely presentational; it carries no meaning the API enforces.
7341
+ */
7342
+ color: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null;
7343
+ icon: string | null;
7344
+ parentGroupId: ContactGroupId | null;
7345
+ contactCount: number;
7346
+ lastCalculatedAt: string | null;
7347
+ isActive: boolean;
7348
+ createdAt: string;
7349
+ updatedAt: string;
7350
+ };
7351
+ };
7352
+ export type ContactGroupsGetByIdResponse = ContactGroupsGetByIdResponses[keyof ContactGroupsGetByIdResponses];
7353
+ export type ContactGroupsUpdateData = {
7354
+ body: {
7355
+ name?: string | null | undefined;
7356
+ description?: string | null | null | undefined;
7357
+ type?: "static" | "dynamic" | "smart" | null | undefined;
7358
+ criteria?: {
7359
+ [key: string]: JsonValue;
7360
+ } | null | null | undefined;
7361
+ color?: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null | null | undefined;
7362
+ icon?: string | null | null | undefined;
7363
+ parentGroupId?: ContactGroupId | null | null | undefined;
7364
+ isActive?: boolean | null | undefined;
7365
+ };
7366
+ path: {
7367
+ id: ContactGroupId;
7368
+ };
7369
+ query?: never;
7370
+ url: "/v1/contact-groups/{id}";
7371
+ };
7372
+ export type ContactGroupsUpdateErrors = {
7373
+ /**
7374
+ * UnauthorizedError
7375
+ */
7376
+ 401: UnauthorizedError;
7377
+ /**
7378
+ * ForbiddenError
7379
+ */
7380
+ 403: ForbiddenError;
7381
+ /**
7382
+ * ResourceNotFoundError
7383
+ */
7384
+ 404: ResourceNotFoundError;
7385
+ /**
7386
+ * ValidationError
7387
+ */
7388
+ 422: ValidationError;
7389
+ /**
7390
+ * InternalError
7391
+ */
7392
+ 500: InternalError;
7393
+ /**
7394
+ * GatewayTimeoutError
7395
+ */
7396
+ 504: GatewayTimeoutError;
7397
+ };
7398
+ export type ContactGroupsUpdateError = ContactGroupsUpdateErrors[keyof ContactGroupsUpdateErrors];
7399
+ export type ContactGroupsUpdateResponses = {
7400
+ /**
7401
+ * Success
7402
+ */
7403
+ 200: {
7404
+ id: ContactGroupId;
7405
+ organizationId: OrganizationId;
7406
+ name: string;
7407
+ description: string | null;
7408
+ type: "static" | "dynamic" | "smart";
7409
+ criteria: {
7410
+ [key: string]: JsonValue;
7411
+ } | null;
7412
+ /**
7413
+ * The list's label color, one of six families, or null for the neutral chip. Customer-chosen and purely presentational; it carries no meaning the API enforces.
7414
+ */
7415
+ color: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null;
7416
+ icon: string | null;
7417
+ parentGroupId: ContactGroupId | null;
7418
+ contactCount: number;
7419
+ lastCalculatedAt: string | null;
7420
+ isActive: boolean;
7421
+ createdAt: string;
7422
+ updatedAt: string;
7423
+ };
7424
+ };
7425
+ export type ContactGroupsUpdateResponse = ContactGroupsUpdateResponses[keyof ContactGroupsUpdateResponses];
7426
+ export type ContactGroupsRemoveMembersData = {
7427
+ body: {
7428
+ contactIds: [ContactId, ContactId];
7429
+ };
7430
+ path: {
7431
+ groupId: ContactGroupId;
7432
+ };
7433
+ query?: never;
7434
+ url: "/v1/contact-groups/{groupId}/members";
7435
+ };
7436
+ export type ContactGroupsRemoveMembersErrors = {
7437
+ /**
7438
+ * UnauthorizedError
7439
+ */
7440
+ 401: UnauthorizedError;
7441
+ /**
7442
+ * ForbiddenError
7443
+ */
7444
+ 403: ForbiddenError;
7445
+ /**
7446
+ * ResourceNotFoundError
7447
+ */
7448
+ 404: ResourceNotFoundError;
7449
+ /**
7450
+ * InternalError
7451
+ */
7452
+ 500: InternalError;
7453
+ /**
7454
+ * GatewayTimeoutError
7455
+ */
7456
+ 504: GatewayTimeoutError;
7457
+ };
7458
+ export type ContactGroupsRemoveMembersError = ContactGroupsRemoveMembersErrors[keyof ContactGroupsRemoveMembersErrors];
7459
+ export type ContactGroupsRemoveMembersResponses = {
7460
+ /**
7461
+ * Success
7462
+ */
7463
+ 200: {
7464
+ removed: number;
7465
+ };
7466
+ };
7467
+ export type ContactGroupsRemoveMembersResponse = ContactGroupsRemoveMembersResponses[keyof ContactGroupsRemoveMembersResponses];
7468
+ export type ContactGroupsGetMembersData = {
7469
+ body?: never;
7470
+ path: {
7471
+ groupId: ContactGroupId;
7472
+ };
7473
+ query?: {
7474
+ page?: string | null | undefined;
7475
+ limit?: string | null | undefined;
7476
+ };
7477
+ url: "/v1/contact-groups/{groupId}/members";
7478
+ };
7479
+ export type ContactGroupsGetMembersErrors = {
7480
+ /**
7481
+ * UnauthorizedError
7482
+ */
7483
+ 401: UnauthorizedError;
7484
+ /**
7485
+ * ForbiddenError
7486
+ */
7487
+ 403: ForbiddenError;
7488
+ /**
7489
+ * ResourceNotFoundError
7490
+ */
7491
+ 404: ResourceNotFoundError;
7492
+ /**
7493
+ * InternalError
7494
+ */
7495
+ 500: InternalError;
7496
+ /**
7497
+ * GatewayTimeoutError
7498
+ */
7499
+ 504: GatewayTimeoutError;
7500
+ };
7501
+ export type ContactGroupsGetMembersError = ContactGroupsGetMembersErrors[keyof ContactGroupsGetMembersErrors];
7502
+ export type ContactGroupsGetMembersResponses = {
7503
+ /**
7504
+ * Success
7505
+ */
7506
+ 200: {
7507
+ items: Array<{
7508
+ id: string;
7509
+ organizationId: OrganizationId;
7510
+ groupId: ContactGroupId;
7511
+ contactId: ContactId;
7512
+ role: "member" | "moderator" | "admin";
7513
+ joinedAt: string;
7514
+ joinedBy: ContactId | null;
7515
+ expiresAt: string | null;
7516
+ contact: {
7517
+ id: ContactId;
7518
+ name: string;
7519
+ displayName: string | null;
7520
+ type: string;
7521
+ identities?: Array<ContactIdentity> | null | undefined;
7522
+ } | null;
7523
+ }>;
7524
+ pagination: PaginationMeta;
7525
+ };
7526
+ };
7527
+ export type ContactGroupsGetMembersResponse = ContactGroupsGetMembersResponses[keyof ContactGroupsGetMembersResponses];
7528
+ export type ContactGroupsAddMembersData = {
7529
+ body: {
7530
+ contactIds: [ContactId, ContactId];
7531
+ role?: "member" | "moderator" | "admin" | null | undefined;
7532
+ };
7533
+ path: {
7534
+ groupId: ContactGroupId;
7535
+ };
7536
+ query?: never;
7537
+ url: "/v1/contact-groups/{groupId}/members";
7538
+ };
7539
+ export type ContactGroupsAddMembersErrors = {
7540
+ /**
7541
+ * UnauthorizedError
7542
+ */
7543
+ 401: UnauthorizedError;
7544
+ /**
7545
+ * ForbiddenError
7546
+ */
7547
+ 403: ForbiddenError;
7548
+ /**
7549
+ * ResourceNotFoundError
7550
+ */
7551
+ 404: ResourceNotFoundError;
7552
+ /**
7553
+ * InternalError
7554
+ */
7555
+ 500: InternalError;
7556
+ /**
7557
+ * GatewayTimeoutError
7558
+ */
7559
+ 504: GatewayTimeoutError;
7560
+ };
7561
+ export type ContactGroupsAddMembersError = ContactGroupsAddMembersErrors[keyof ContactGroupsAddMembersErrors];
7562
+ export type ContactGroupsAddMembersResponses = {
7563
+ /**
7564
+ * Success
7565
+ */
7566
+ 200: {
7567
+ added: number;
7568
+ skipped: number;
7569
+ };
7570
+ };
7571
+ export type ContactGroupsAddMembersResponse = ContactGroupsAddMembersResponses[keyof ContactGroupsAddMembersResponses];
7572
+ export type ContactGroupsEvaluateDynamicData = {
7573
+ body?: never;
7574
+ path: {
7575
+ groupId: ContactGroupId;
7576
+ };
7577
+ query?: never;
7578
+ url: "/v1/contact-groups/{groupId}/evaluate";
7579
+ };
7580
+ export type ContactGroupsEvaluateDynamicErrors = {
7581
+ /**
7582
+ * UnauthorizedError
7583
+ */
7584
+ 401: UnauthorizedError;
7585
+ /**
7586
+ * ForbiddenError
7587
+ */
7588
+ 403: ForbiddenError;
7589
+ /**
7590
+ * ResourceNotFoundError
7591
+ */
7592
+ 404: ResourceNotFoundError;
7593
+ /**
7594
+ * ValidationError
7595
+ */
7596
+ 422: ValidationError;
7597
+ /**
7598
+ * InternalError
7599
+ */
7600
+ 500: InternalError;
7601
+ /**
7602
+ * GatewayTimeoutError
7603
+ */
7604
+ 504: GatewayTimeoutError;
7605
+ };
7606
+ export type ContactGroupsEvaluateDynamicError = ContactGroupsEvaluateDynamicErrors[keyof ContactGroupsEvaluateDynamicErrors];
7607
+ export type ContactGroupsEvaluateDynamicResponses = {
7608
+ /**
7609
+ * Success
7610
+ */
7611
+ 200: {
7612
+ added: number;
7613
+ removed: number;
7614
+ total: number;
7615
+ };
7616
+ };
7617
+ export type ContactGroupsEvaluateDynamicResponse = ContactGroupsEvaluateDynamicResponses[keyof ContactGroupsEvaluateDynamicResponses];
7618
+ export type ContactGroupsPreviewData = {
7619
+ body: {
7620
+ criteria: {
7621
+ contactTypes?: Array<string> | null | undefined;
7622
+ capabilities?: Array<string> | null | undefined;
7623
+ tags?: Array<string> | null | undefined;
7624
+ channels?: Array<string> | null | undefined;
7625
+ match?: "all" | "any" | null | undefined;
7626
+ conditions?: Array<{
7627
+ field: string;
7628
+ operator: string;
7629
+ value: JsonValue;
7630
+ }> | null | undefined;
7631
+ };
7632
+ };
7633
+ path?: never;
7634
+ query?: never;
7635
+ url: "/v1/contact-groups/preview";
7636
+ };
7637
+ export type ContactGroupsPreviewErrors = {
7638
+ /**
7639
+ * UnauthorizedError
7640
+ */
7641
+ 401: UnauthorizedError;
7642
+ /**
7643
+ * ForbiddenError
7644
+ */
7645
+ 403: ForbiddenError;
7646
+ /**
7647
+ * ValidationError
7648
+ */
7649
+ 422: ValidationError;
7650
+ /**
7651
+ * InternalError
7652
+ */
7653
+ 500: InternalError;
7654
+ /**
7655
+ * GatewayTimeoutError
7656
+ */
7657
+ 504: GatewayTimeoutError;
7658
+ };
7659
+ export type ContactGroupsPreviewError = ContactGroupsPreviewErrors[keyof ContactGroupsPreviewErrors];
7660
+ export type ContactGroupsPreviewResponses = {
7661
+ /**
7662
+ * Success
7663
+ */
7664
+ 200: {
7665
+ count: number;
7666
+ sample: Array<{
7667
+ id: ContactId;
7668
+ name: string;
7669
+ type: string;
7670
+ status: string;
7671
+ }>;
7672
+ };
7673
+ };
7674
+ export type ContactGroupsPreviewResponse = ContactGroupsPreviewResponses[keyof ContactGroupsPreviewResponses];
7675
+ export type CustomFieldsListData = {
7676
+ body?: never;
7677
+ path?: never;
7678
+ query?: {
7679
+ page?: string | null | undefined;
7680
+ limit?: string | null | undefined;
7681
+ };
7682
+ url: "/v1/custom-fields";
7683
+ };
7684
+ export type CustomFieldsListErrors = {
7685
+ /**
7686
+ * UnauthorizedError
7687
+ */
7688
+ 401: UnauthorizedError;
7689
+ /**
7690
+ * ForbiddenError
7691
+ */
7692
+ 403: ForbiddenError;
7693
+ /**
7694
+ * InternalError
7695
+ */
7696
+ 500: InternalError;
7697
+ /**
7698
+ * GatewayTimeoutError
7699
+ */
7700
+ 504: GatewayTimeoutError;
7701
+ };
7702
+ export type CustomFieldsListError = CustomFieldsListErrors[keyof CustomFieldsListErrors];
7703
+ export type CustomFieldsListResponses = {
7704
+ /**
7705
+ * Success
7706
+ */
7707
+ 200: {
7708
+ items: Array<{
7709
+ id: CustomFieldDefinitionId;
7710
+ organizationId: OrganizationId;
7711
+ key: string;
7712
+ label: string;
7713
+ type: "text" | "number" | "boolean" | "date" | "select";
7714
+ options: Array<string> | null;
7715
+ defaultValue: string | null;
7716
+ isRequired: boolean;
7717
+ sortOrder: number;
7718
+ createdAt: string;
7719
+ updatedAt: string;
7720
+ }>;
7721
+ pagination: PaginationMeta;
7722
+ };
7723
+ };
7724
+ export type CustomFieldsListResponse = CustomFieldsListResponses[keyof CustomFieldsListResponses];
7725
+ export type CustomFieldsCreateData = {
7726
+ body: {
7727
+ key: string;
7728
+ label: string;
7729
+ type: "text" | "number" | "boolean" | "date" | "select";
7730
+ options?: Array<string> | null | undefined;
7731
+ defaultValue?: string | null | null | undefined;
7732
+ isRequired?: boolean | null | undefined;
7733
+ sortOrder?: number | null | undefined;
7734
+ };
7735
+ path?: never;
7736
+ query?: never;
7737
+ url: "/v1/custom-fields";
7738
+ };
7739
+ export type CustomFieldsCreateErrors = {
7740
+ /**
7741
+ * UnauthorizedError
7742
+ */
7743
+ 401: UnauthorizedError;
7744
+ /**
7745
+ * ForbiddenError
7746
+ */
7747
+ 403: ForbiddenError;
7748
+ /**
7749
+ * ConflictError
7750
+ */
7751
+ 409: ConflictError;
7752
+ /**
7753
+ * ValidationError
7754
+ */
7755
+ 422: ValidationError;
7756
+ /**
7757
+ * InternalError
7758
+ */
7759
+ 500: InternalError;
7760
+ /**
7761
+ * GatewayTimeoutError
7762
+ */
7763
+ 504: GatewayTimeoutError;
7764
+ };
7765
+ export type CustomFieldsCreateError = CustomFieldsCreateErrors[keyof CustomFieldsCreateErrors];
7766
+ export type CustomFieldsCreateResponses = {
7767
+ /**
7768
+ * Success
7769
+ */
7770
+ 201: {
7771
+ id: CustomFieldDefinitionId;
7772
+ organizationId: OrganizationId;
7773
+ key: string;
7774
+ label: string;
7775
+ type: "text" | "number" | "boolean" | "date" | "select";
7776
+ options: Array<string> | null;
7777
+ defaultValue: string | null;
7778
+ isRequired: boolean;
7779
+ sortOrder: number;
7780
+ createdAt: string;
7781
+ updatedAt: string;
7782
+ };
7783
+ };
7784
+ export type CustomFieldsCreateResponse = CustomFieldsCreateResponses[keyof CustomFieldsCreateResponses];
7785
+ export type CustomFieldsRemoveData = {
7786
+ body?: never;
7787
+ path: {
7788
+ id: CustomFieldDefinitionId;
7789
+ };
7790
+ query?: never;
7791
+ url: "/v1/custom-fields/{id}";
7792
+ };
7793
+ export type CustomFieldsRemoveErrors = {
7794
+ /**
7795
+ * UnauthorizedError
7796
+ */
7797
+ 401: UnauthorizedError;
7798
+ /**
7799
+ * ForbiddenError
7800
+ */
7801
+ 403: ForbiddenError;
7802
+ /**
7803
+ * ResourceNotFoundError
7804
+ */
7805
+ 404: ResourceNotFoundError;
7806
+ /**
7807
+ * InternalError
7808
+ */
7809
+ 500: InternalError;
7810
+ /**
7811
+ * GatewayTimeoutError
7812
+ */
7813
+ 504: GatewayTimeoutError;
7814
+ };
7815
+ export type CustomFieldsRemoveError = CustomFieldsRemoveErrors[keyof CustomFieldsRemoveErrors];
7816
+ export type CustomFieldsRemoveResponses = {
7817
+ /**
7818
+ * Success
7819
+ */
7820
+ 200: {
7821
+ success: boolean;
7822
+ };
7823
+ };
7824
+ export type CustomFieldsRemoveResponse = CustomFieldsRemoveResponses[keyof CustomFieldsRemoveResponses];
7825
+ export type CustomFieldsUpdateData = {
7826
+ body: {
7827
+ label?: string | null | undefined;
7828
+ options?: Array<string> | null | undefined;
7829
+ defaultValue?: string | null | null | undefined;
7830
+ isRequired?: boolean | null | undefined;
7831
+ sortOrder?: number | null | undefined;
7832
+ };
7833
+ path: {
7834
+ id: CustomFieldDefinitionId;
7835
+ };
7836
+ query?: never;
7837
+ url: "/v1/custom-fields/{id}";
7838
+ };
7839
+ export type CustomFieldsUpdateErrors = {
7840
+ /**
7841
+ * UnauthorizedError
7842
+ */
7843
+ 401: UnauthorizedError;
7844
+ /**
7845
+ * ForbiddenError
7846
+ */
7847
+ 403: ForbiddenError;
7848
+ /**
7849
+ * ResourceNotFoundError
7850
+ */
7851
+ 404: ResourceNotFoundError;
7852
+ /**
7853
+ * ValidationError
7854
+ */
7855
+ 422: ValidationError;
7856
+ /**
7857
+ * InternalError
7858
+ */
7859
+ 500: InternalError;
7860
+ /**
7861
+ * GatewayTimeoutError
7862
+ */
7863
+ 504: GatewayTimeoutError;
7864
+ };
7865
+ export type CustomFieldsUpdateError = CustomFieldsUpdateErrors[keyof CustomFieldsUpdateErrors];
7866
+ export type CustomFieldsUpdateResponses = {
7867
+ /**
7868
+ * Success
7869
+ */
7870
+ 200: {
7871
+ id: CustomFieldDefinitionId;
7872
+ organizationId: OrganizationId;
7873
+ key: string;
7874
+ label: string;
7875
+ type: "text" | "number" | "boolean" | "date" | "select";
7876
+ options: Array<string> | null;
7877
+ defaultValue: string | null;
7878
+ isRequired: boolean;
7879
+ sortOrder: number;
7880
+ createdAt: string;
7881
+ updatedAt: string;
7882
+ };
7883
+ };
7884
+ export type CustomFieldsUpdateResponse = CustomFieldsUpdateResponses[keyof CustomFieldsUpdateResponses];
7885
+ export type UnsubscribeListData = {
7886
+ body?: never;
7887
+ path?: never;
7888
+ query?: {
7889
+ page?: string | null | undefined;
7890
+ limit?: string | null | undefined;
7891
+ };
7892
+ url: "/v1/unsubscribe-groups";
7893
+ };
7894
+ export type UnsubscribeListErrors = {
7895
+ /**
7896
+ * UnauthorizedError
7897
+ */
7898
+ 401: UnauthorizedError;
7899
+ /**
7900
+ * ForbiddenError
7901
+ */
7902
+ 403: ForbiddenError;
7903
+ /**
7904
+ * InternalError
7905
+ */
7906
+ 500: InternalError;
7907
+ /**
7908
+ * GatewayTimeoutError
7909
+ */
7910
+ 504: GatewayTimeoutError;
7911
+ };
7912
+ export type UnsubscribeListError = UnsubscribeListErrors[keyof UnsubscribeListErrors];
7913
+ export type UnsubscribeListResponses = {
7914
+ /**
7915
+ * Success
7916
+ */
7917
+ 200: {
7918
+ items: Array<{
7919
+ id: UnsubscribeId;
7920
+ organizationId: string;
7921
+ name: string;
7922
+ description: string | null;
7923
+ memberCount: number;
7924
+ createdAt: string;
7925
+ updatedAt: string;
7926
+ }>;
7927
+ pagination: PaginationMeta;
7928
+ };
7929
+ };
7930
+ export type UnsubscribeListResponse = UnsubscribeListResponses[keyof UnsubscribeListResponses];
7931
+ export type UnsubscribeCreateData = {
7932
+ body: {
7933
+ name: string;
7934
+ description?: string | null | null | undefined;
7935
+ };
7936
+ path?: never;
7937
+ query?: never;
7938
+ url: "/v1/unsubscribe-groups";
7939
+ };
7940
+ export type UnsubscribeCreateErrors = {
7941
+ /**
7942
+ * UnauthorizedError
7943
+ */
7944
+ 401: UnauthorizedError;
7945
+ /**
7946
+ * ForbiddenError
7947
+ */
7948
+ 403: ForbiddenError;
7949
+ /**
7950
+ * InternalError
7951
+ */
7952
+ 500: InternalError;
7953
+ /**
7954
+ * GatewayTimeoutError
7955
+ */
7956
+ 504: GatewayTimeoutError;
7957
+ };
7958
+ export type UnsubscribeCreateError = UnsubscribeCreateErrors[keyof UnsubscribeCreateErrors];
7959
+ export type UnsubscribeCreateResponses = {
7960
+ /**
7961
+ * Success
7962
+ */
7963
+ 201: {
7964
+ id: UnsubscribeId;
7965
+ organizationId: string;
7966
+ name: string;
7967
+ description: string | null;
7968
+ memberCount: number;
7969
+ createdAt: string;
7970
+ updatedAt: string;
7971
+ };
7972
+ };
7973
+ export type UnsubscribeCreateResponse = UnsubscribeCreateResponses[keyof UnsubscribeCreateResponses];
7974
+ export type UnsubscribeRemoveData = {
7975
+ body?: never;
7976
+ path: {
7977
+ id: UnsubscribeId;
7978
+ };
7979
+ query?: never;
7980
+ url: "/v1/unsubscribe-groups/{id}";
7981
+ };
7982
+ export type UnsubscribeRemoveErrors = {
7983
+ /**
7984
+ * UnauthorizedError
7985
+ */
7986
+ 401: UnauthorizedError;
7987
+ /**
7988
+ * ForbiddenError
7989
+ */
7990
+ 403: ForbiddenError;
7991
+ /**
7992
+ * ResourceNotFoundError
7993
+ */
7994
+ 404: ResourceNotFoundError;
7995
+ /**
7996
+ * InternalError
7997
+ */
7998
+ 500: InternalError;
7999
+ /**
8000
+ * GatewayTimeoutError
8001
+ */
8002
+ 504: GatewayTimeoutError;
8003
+ };
8004
+ export type UnsubscribeRemoveError = UnsubscribeRemoveErrors[keyof UnsubscribeRemoveErrors];
8005
+ export type UnsubscribeRemoveResponses = {
8006
+ /**
8007
+ * Success
8008
+ */
8009
+ 200: {
8010
+ success: boolean;
8011
+ };
8012
+ };
8013
+ export type UnsubscribeRemoveResponse = UnsubscribeRemoveResponses[keyof UnsubscribeRemoveResponses];
8014
+ export type UnsubscribeUpdateData = {
8015
+ body: {
8016
+ name?: string | null | undefined;
8017
+ description?: string | null | null | undefined;
8018
+ };
8019
+ path: {
8020
+ id: UnsubscribeId;
8021
+ };
8022
+ query?: never;
8023
+ url: "/v1/unsubscribe-groups/{id}";
8024
+ };
8025
+ export type UnsubscribeUpdateErrors = {
8026
+ /**
8027
+ * UnauthorizedError
8028
+ */
8029
+ 401: UnauthorizedError;
8030
+ /**
8031
+ * ForbiddenError
8032
+ */
8033
+ 403: ForbiddenError;
8034
+ /**
8035
+ * ResourceNotFoundError
8036
+ */
8037
+ 404: ResourceNotFoundError;
8038
+ /**
8039
+ * InternalError
8040
+ */
8041
+ 500: InternalError;
8042
+ /**
8043
+ * GatewayTimeoutError
8044
+ */
8045
+ 504: GatewayTimeoutError;
8046
+ };
8047
+ export type UnsubscribeUpdateError = UnsubscribeUpdateErrors[keyof UnsubscribeUpdateErrors];
8048
+ export type UnsubscribeUpdateResponses = {
8049
+ /**
8050
+ * Success
8051
+ */
8052
+ 200: {
8053
+ id: UnsubscribeId;
8054
+ organizationId: string;
8055
+ name: string;
8056
+ description: string | null;
8057
+ memberCount: number;
8058
+ createdAt: string;
8059
+ updatedAt: string;
8060
+ };
8061
+ };
8062
+ export type UnsubscribeUpdateResponse = UnsubscribeUpdateResponses[keyof UnsubscribeUpdateResponses];
8063
+ export type UnsubscribeRemoveEmailsData = {
8064
+ body: {
8065
+ emails: Array<string>;
8066
+ };
8067
+ path: {
8068
+ groupId: UnsubscribeId;
8069
+ };
8070
+ query?: never;
8071
+ url: "/v1/unsubscribe-groups/{groupId}/members";
8072
+ };
8073
+ export type UnsubscribeRemoveEmailsErrors = {
8074
+ /**
8075
+ * UnauthorizedError
8076
+ */
8077
+ 401: UnauthorizedError;
8078
+ /**
8079
+ * ForbiddenError
8080
+ */
8081
+ 403: ForbiddenError;
8082
+ /**
8083
+ * ResourceNotFoundError
8084
+ */
8085
+ 404: ResourceNotFoundError;
8086
+ /**
8087
+ * InternalError
8088
+ */
8089
+ 500: InternalError;
8090
+ /**
8091
+ * GatewayTimeoutError
8092
+ */
8093
+ 504: GatewayTimeoutError;
8094
+ };
8095
+ export type UnsubscribeRemoveEmailsError = UnsubscribeRemoveEmailsErrors[keyof UnsubscribeRemoveEmailsErrors];
8096
+ export type UnsubscribeRemoveEmailsResponses = {
8097
+ /**
8098
+ * Success
8099
+ */
8100
+ 200: {
8101
+ removed: number;
8102
+ };
8103
+ };
8104
+ export type UnsubscribeRemoveEmailsResponse = UnsubscribeRemoveEmailsResponses[keyof UnsubscribeRemoveEmailsResponses];
8105
+ export type UnsubscribeListMembersData = {
8106
+ body?: never;
8107
+ path: {
8108
+ groupId: UnsubscribeId;
8109
+ };
8110
+ query?: {
8111
+ page?: string | null | undefined;
8112
+ limit?: string | null | undefined;
8113
+ };
8114
+ url: "/v1/unsubscribe-groups/{groupId}/members";
8115
+ };
8116
+ export type UnsubscribeListMembersErrors = {
8117
+ /**
8118
+ * UnauthorizedError
8119
+ */
8120
+ 401: UnauthorizedError;
8121
+ /**
8122
+ * ForbiddenError
8123
+ */
8124
+ 403: ForbiddenError;
8125
+ /**
8126
+ * ResourceNotFoundError
8127
+ */
8128
+ 404: ResourceNotFoundError;
8129
+ /**
8130
+ * InternalError
8131
+ */
8132
+ 500: InternalError;
8133
+ /**
8134
+ * GatewayTimeoutError
8135
+ */
8136
+ 504: GatewayTimeoutError;
8137
+ };
8138
+ export type UnsubscribeListMembersError = UnsubscribeListMembersErrors[keyof UnsubscribeListMembersErrors];
8139
+ export type UnsubscribeListMembersResponses = {
8140
+ /**
8141
+ * Success
8142
+ */
8143
+ 200: {
8144
+ items: Array<{
8145
+ id: string;
8146
+ email: string;
8147
+ contactId: string | null;
8148
+ source: "link" | "api" | "manual" | "complaint";
8149
+ unsubscribedAt: string;
8150
+ createdAt: string;
8151
+ }>;
8152
+ pagination: PaginationMeta;
8153
+ };
8154
+ };
8155
+ export type UnsubscribeListMembersResponse = UnsubscribeListMembersResponses[keyof UnsubscribeListMembersResponses];
8156
+ export type UnsubscribeAddEmailsData = {
8157
+ body: {
8158
+ emails: Array<string>;
8159
+ source?: "link" | "api" | "manual" | "complaint" | null | undefined;
8160
+ };
8161
+ path: {
8162
+ groupId: UnsubscribeId;
8163
+ };
8164
+ query?: never;
8165
+ url: "/v1/unsubscribe-groups/{groupId}/members";
8166
+ };
8167
+ export type UnsubscribeAddEmailsErrors = {
8168
+ /**
8169
+ * UnauthorizedError
8170
+ */
8171
+ 401: UnauthorizedError;
8172
+ /**
8173
+ * ForbiddenError
8174
+ */
8175
+ 403: ForbiddenError;
8176
+ /**
8177
+ * ResourceNotFoundError
8178
+ */
8179
+ 404: ResourceNotFoundError;
8180
+ /**
8181
+ * InternalError
8182
+ */
8183
+ 500: InternalError;
8184
+ /**
8185
+ * GatewayTimeoutError
8186
+ */
8187
+ 504: GatewayTimeoutError;
8188
+ };
8189
+ export type UnsubscribeAddEmailsError = UnsubscribeAddEmailsErrors[keyof UnsubscribeAddEmailsErrors];
8190
+ export type UnsubscribeAddEmailsResponses = {
8191
+ /**
8192
+ * Success
8193
+ */
8194
+ 200: {
8195
+ added: number;
8196
+ skipped: number;
8197
+ };
8198
+ };
8199
+ export type UnsubscribeAddEmailsResponse = UnsubscribeAddEmailsResponses[keyof UnsubscribeAddEmailsResponses];
8200
+ export type UnsubscribeCheckSubscriptionData = {
8201
+ body?: never;
8202
+ path?: never;
8203
+ query: {
8204
+ email: string;
8205
+ groupIds?: string | null | undefined;
8206
+ };
8207
+ url: "/v1/unsubscribe-groups/check";
8208
+ };
8209
+ export type UnsubscribeCheckSubscriptionErrors = {
8210
+ /**
8211
+ * UnauthorizedError
8212
+ */
8213
+ 401: UnauthorizedError;
8214
+ /**
8215
+ * ForbiddenError
8216
+ */
8217
+ 403: ForbiddenError;
8218
+ /**
8219
+ * ValidationError
8220
+ */
8221
+ 422: ValidationError;
8222
+ /**
8223
+ * InternalError
8224
+ */
8225
+ 500: InternalError;
8226
+ /**
8227
+ * GatewayTimeoutError
8228
+ */
8229
+ 504: GatewayTimeoutError;
8230
+ };
8231
+ export type UnsubscribeCheckSubscriptionError = UnsubscribeCheckSubscriptionErrors[keyof UnsubscribeCheckSubscriptionErrors];
8232
+ export type UnsubscribeCheckSubscriptionResponses = {
8233
+ /**
8234
+ * Success
8235
+ */
8236
+ 200: {
8237
+ email: string;
8238
+ unsubscribedGroups: Array<{
8239
+ groupId: string;
8240
+ groupName: string;
8241
+ unsubscribedAt: string;
8242
+ }>;
8243
+ };
8244
+ };
8245
+ export type UnsubscribeCheckSubscriptionResponse = UnsubscribeCheckSubscriptionResponses[keyof UnsubscribeCheckSubscriptionResponses];
8246
+ export type AnalyticsGetStatsData = {
8247
+ body?: never;
8248
+ path?: never;
8249
+ query?: {
8250
+ startDate?: string | null | undefined;
8251
+ endDate?: string | null | undefined;
8252
+ groupBy?: "day" | "week" | "month" | null | undefined;
8253
+ channel?: "email" | null | undefined;
8254
+ };
8255
+ url: "/v1/analytics/stats";
8256
+ };
8257
+ export type AnalyticsGetStatsErrors = {
8258
+ /**
8259
+ * AnalyticsQueryError
8260
+ */
8261
+ 400: AnalyticsQueryError;
8262
+ /**
8263
+ * UnauthorizedError
8264
+ */
8265
+ 401: UnauthorizedError;
8266
+ /**
8267
+ * ForbiddenError
8268
+ */
8269
+ 403: ForbiddenError;
8270
+ /**
8271
+ * InternalError
8272
+ */
8273
+ 500: InternalError;
8274
+ /**
8275
+ * GatewayTimeoutError
8276
+ */
8277
+ 504: GatewayTimeoutError;
8278
+ };
8279
+ export type AnalyticsGetStatsError = AnalyticsGetStatsErrors[keyof AnalyticsGetStatsErrors];
8280
+ export type AnalyticsGetStatsResponses = {
8281
+ /**
8282
+ * Success
8283
+ */
8284
+ 200: {
8285
+ volumeHistory: Array<{
8286
+ date: string;
8287
+ email: number;
8288
+ }>;
8289
+ };
8290
+ };
8291
+ export type AnalyticsGetStatsResponse = AnalyticsGetStatsResponses[keyof AnalyticsGetStatsResponses];
8292
+ export type AnalyticsGetChannelStatsData = {
8293
+ body?: never;
8294
+ path?: never;
8295
+ query?: {
8296
+ startDate?: string | null | undefined;
8297
+ endDate?: string | null | undefined;
8298
+ };
8299
+ url: "/v1/analytics/channel-stats";
8300
+ };
8301
+ export type AnalyticsGetChannelStatsErrors = {
8302
+ /**
8303
+ * AnalyticsQueryError
8304
+ */
8305
+ 400: AnalyticsQueryError;
8306
+ /**
8307
+ * UnauthorizedError
8308
+ */
8309
+ 401: UnauthorizedError;
8310
+ /**
8311
+ * ForbiddenError
8312
+ */
8313
+ 403: ForbiddenError;
8314
+ /**
8315
+ * InternalError
8316
+ */
8317
+ 500: InternalError;
8318
+ /**
8319
+ * GatewayTimeoutError
8320
+ */
8321
+ 504: GatewayTimeoutError;
8322
+ };
8323
+ export type AnalyticsGetChannelStatsError = AnalyticsGetChannelStatsErrors[keyof AnalyticsGetChannelStatsErrors];
8324
+ export type AnalyticsGetChannelStatsResponses = {
8325
+ /**
8326
+ * Success
8327
+ */
8328
+ 200: {
8329
+ email: {
8330
+ sent: number;
8331
+ deliveryRate: number;
8332
+ uniqueOpenedMessages: number;
8333
+ openTrackingEligibleDeliveredMessages: number;
8334
+ uniqueMessageOpenRate: number;
8335
+ uniqueClickedMessages: number;
8336
+ clickTrackingEligibleDeliveredMessages: number;
8337
+ uniqueMessageClickRate: number;
8338
+ bounceRate: number;
8339
+ };
8340
+ };
8341
+ };
8342
+ export type AnalyticsGetChannelStatsResponse = AnalyticsGetChannelStatsResponses[keyof AnalyticsGetChannelStatsResponses];
8343
+ export type AnalyticsGetTopContactsData = {
8344
+ body?: never;
8345
+ path?: never;
8346
+ query?: {
8347
+ startDate?: string | null | undefined;
8348
+ endDate?: string | null | undefined;
8349
+ limit?: string | null | undefined;
8350
+ sortBy?: "sent" | "received" | "total" | null | undefined;
8351
+ };
8352
+ url: "/v1/analytics/top-contacts";
8353
+ };
8354
+ export type AnalyticsGetTopContactsErrors = {
8355
+ /**
8356
+ * AnalyticsQueryError
8357
+ */
8358
+ 400: AnalyticsQueryError;
8359
+ /**
8360
+ * UnauthorizedError
8361
+ */
8362
+ 401: UnauthorizedError;
8363
+ /**
8364
+ * ForbiddenError
8365
+ */
8366
+ 403: ForbiddenError;
8367
+ /**
8368
+ * InternalError
8369
+ */
8370
+ 500: InternalError;
8371
+ /**
8372
+ * GatewayTimeoutError
8373
+ */
8374
+ 504: GatewayTimeoutError;
8375
+ };
8376
+ export type AnalyticsGetTopContactsError = AnalyticsGetTopContactsErrors[keyof AnalyticsGetTopContactsErrors];
8377
+ export type AnalyticsGetTopContactsResponses = {
8378
+ /**
8379
+ * Success
8380
+ */
8381
+ 200: Array<{
8382
+ id: string;
8383
+ name: string | null;
8384
+ email: string | null;
8385
+ phone: string | null;
8386
+ messageCount: number;
8387
+ }>;
8388
+ };
8389
+ export type AnalyticsGetTopContactsResponse = AnalyticsGetTopContactsResponses[keyof AnalyticsGetTopContactsResponses];
8390
+ export type AnalyticsGetHourlyDistributionData = {
8391
+ body?: never;
8392
+ path?: never;
8393
+ query?: {
8394
+ startDate?: string | null | undefined;
8395
+ endDate?: string | null | undefined;
8396
+ };
8397
+ url: "/v1/analytics/hourly-distribution";
8398
+ };
8399
+ export type AnalyticsGetHourlyDistributionErrors = {
8400
+ /**
8401
+ * AnalyticsQueryError
8402
+ */
8403
+ 400: AnalyticsQueryError;
8404
+ /**
8405
+ * UnauthorizedError
8406
+ */
8407
+ 401: UnauthorizedError;
8408
+ /**
8409
+ * ForbiddenError
8410
+ */
8411
+ 403: ForbiddenError;
8412
+ /**
8413
+ * InternalError
8414
+ */
8415
+ 500: InternalError;
8416
+ /**
8417
+ * GatewayTimeoutError
8418
+ */
8419
+ 504: GatewayTimeoutError;
6252
8420
  };
6253
- export type ContactsExportError = ContactsExportErrors[keyof ContactsExportErrors];
6254
- export type ContactsExportResponses = {
8421
+ export type AnalyticsGetHourlyDistributionError = AnalyticsGetHourlyDistributionErrors[keyof AnalyticsGetHourlyDistributionErrors];
8422
+ export type AnalyticsGetHourlyDistributionResponses = {
6255
8423
  /**
6256
8424
  * Success
6257
8425
  */
6258
- 200: {
6259
- data: string;
6260
- format: "json" | "csv";
8426
+ 200: Array<{
8427
+ hour: string;
6261
8428
  count: number;
6262
- };
8429
+ }>;
6263
8430
  };
6264
- export type ContactsExportResponse = ContactsExportResponses[keyof ContactsExportResponses];
6265
- export type ContactsGetActivityTimelineData = {
8431
+ export type AnalyticsGetHourlyDistributionResponse = AnalyticsGetHourlyDistributionResponses[keyof AnalyticsGetHourlyDistributionResponses];
8432
+ export type AnalyticsGetDeliveryMetricsData = {
6266
8433
  body?: never;
6267
- path: {
6268
- id: ContactId;
6269
- };
8434
+ path?: never;
6270
8435
  query?: {
6271
- page?: string | null | undefined;
6272
- limit?: string | null | undefined;
8436
+ startDate?: string | null | undefined;
8437
+ endDate?: string | null | undefined;
6273
8438
  channel?: "email" | null | undefined;
6274
8439
  };
6275
- url: "/v1/contacts/{id}/activity";
8440
+ url: "/v1/analytics/delivery-metrics";
6276
8441
  };
6277
- export type ContactsGetActivityTimelineErrors = {
8442
+ export type AnalyticsGetDeliveryMetricsErrors = {
8443
+ /**
8444
+ * AnalyticsQueryError
8445
+ */
8446
+ 400: AnalyticsQueryError;
6278
8447
  /**
6279
8448
  * UnauthorizedError
6280
8449
  */
@@ -6283,44 +8452,44 @@ export type ContactsGetActivityTimelineErrors = {
6283
8452
  * ForbiddenError
6284
8453
  */
6285
8454
  403: ForbiddenError;
6286
- /**
6287
- * ResourceNotFoundError
6288
- */
6289
- 404: ResourceNotFoundError;
6290
8455
  /**
6291
8456
  * InternalError
6292
8457
  */
6293
8458
  500: InternalError;
8459
+ /**
8460
+ * GatewayTimeoutError
8461
+ */
8462
+ 504: GatewayTimeoutError;
6294
8463
  };
6295
- export type ContactsGetActivityTimelineError = ContactsGetActivityTimelineErrors[keyof ContactsGetActivityTimelineErrors];
6296
- export type ContactsGetActivityTimelineResponses = {
8464
+ export type AnalyticsGetDeliveryMetricsError = AnalyticsGetDeliveryMetricsErrors[keyof AnalyticsGetDeliveryMetricsErrors];
8465
+ export type AnalyticsGetDeliveryMetricsResponses = {
6297
8466
  /**
6298
8467
  * Success
6299
8468
  */
6300
8469
  200: {
6301
- items: Array<{
6302
- id: MessageId;
6303
- channel: string;
6304
- direction: string;
6305
- status: string;
6306
- subject: string | null;
6307
- snippet: string | null;
6308
- createdAt: string;
6309
- conversationId: ConversationId | null;
6310
- }>;
6311
- pagination: PaginationMeta;
8470
+ deliveredRate: number;
8471
+ failedRate: number;
8472
+ pendingRate: number;
8473
+ avgDeliveryTimeMs: number;
6312
8474
  };
6313
8475
  };
6314
- export type ContactsGetActivityTimelineResponse = ContactsGetActivityTimelineResponses[keyof ContactsGetActivityTimelineResponses];
6315
- export type ContactsGetGroupMembershipsData = {
6316
- body?: never;
6317
- path: {
6318
- id: ContactId;
8476
+ export type AnalyticsGetDeliveryMetricsResponse = AnalyticsGetDeliveryMetricsResponses[keyof AnalyticsGetDeliveryMetricsResponses];
8477
+ export type AnalyticsExportDataData = {
8478
+ body: {
8479
+ startDate: string;
8480
+ endDate: string;
8481
+ format?: "csv" | "json" | null | undefined;
8482
+ includeChannels?: Array<"email"> | null | undefined;
6319
8483
  };
8484
+ path?: never;
6320
8485
  query?: never;
6321
- url: "/v1/contacts/{id}/groups";
8486
+ url: "/v1/analytics/export";
6322
8487
  };
6323
- export type ContactsGetGroupMembershipsErrors = {
8488
+ export type AnalyticsExportDataErrors = {
8489
+ /**
8490
+ * AnalyticsQueryError
8491
+ */
8492
+ 400: AnalyticsQueryError;
6324
8493
  /**
6325
8494
  * UnauthorizedError
6326
8495
  */
@@ -6329,31 +8498,27 @@ export type ContactsGetGroupMembershipsErrors = {
6329
8498
  * ForbiddenError
6330
8499
  */
6331
8500
  403: ForbiddenError;
6332
- /**
6333
- * ResourceNotFoundError
6334
- */
6335
- 404: ResourceNotFoundError;
6336
8501
  /**
6337
8502
  * InternalError
6338
8503
  */
6339
8504
  500: InternalError;
8505
+ /**
8506
+ * GatewayTimeoutError
8507
+ */
8508
+ 504: GatewayTimeoutError;
6340
8509
  };
6341
- export type ContactsGetGroupMembershipsError = ContactsGetGroupMembershipsErrors[keyof ContactsGetGroupMembershipsErrors];
6342
- export type ContactsGetGroupMembershipsResponses = {
8510
+ export type AnalyticsExportDataError = AnalyticsExportDataErrors[keyof AnalyticsExportDataErrors];
8511
+ export type AnalyticsExportDataResponses = {
6343
8512
  /**
6344
8513
  * Success
6345
8514
  */
6346
8515
  200: {
6347
- groups: Array<{
6348
- id: ContactGroupId;
6349
- name: string;
6350
- type: string;
6351
- role: string;
6352
- joinedAt: string;
6353
- }>;
8516
+ content: string;
8517
+ mimeType: string;
8518
+ filename: string;
6354
8519
  };
6355
8520
  };
6356
- export type ContactsGetGroupMembershipsResponse = ContactsGetGroupMembershipsResponses[keyof ContactsGetGroupMembershipsResponses];
8521
+ export type AnalyticsExportDataResponse = AnalyticsExportDataResponses[keyof AnalyticsExportDataResponses];
6357
8522
  export type TemplatesListData = {
6358
8523
  body?: never;
6359
8524
  path?: never;
@@ -6382,6 +8547,10 @@ export type TemplatesListErrors = {
6382
8547
  * InternalError
6383
8548
  */
6384
8549
  500: InternalError;
8550
+ /**
8551
+ * GatewayTimeoutError
8552
+ */
8553
+ 504: GatewayTimeoutError;
6385
8554
  };
6386
8555
  export type TemplatesListError = TemplatesListErrors[keyof TemplatesListErrors];
6387
8556
  export type TemplatesListResponses = {
@@ -6430,6 +8599,10 @@ export type TemplatesCreateErrors = {
6430
8599
  * InternalError
6431
8600
  */
6432
8601
  500: InternalError;
8602
+ /**
8603
+ * GatewayTimeoutError
8604
+ */
8605
+ 504: GatewayTimeoutError;
6433
8606
  };
6434
8607
  export type TemplatesCreateError = TemplatesCreateErrors[keyof TemplatesCreateErrors];
6435
8608
  export type TemplatesCreateResponses = {
@@ -6439,59 +8612,6 @@ export type TemplatesCreateResponses = {
6439
8612
  201: Template;
6440
8613
  };
6441
8614
  export type TemplatesCreateResponse = TemplatesCreateResponses[keyof TemplatesCreateResponses];
6442
- export type TemplatesListDashboardData = {
6443
- body?: never;
6444
- path?: never;
6445
- query: {
6446
- page?: string | null | undefined;
6447
- limit?: string | null | undefined;
6448
- allowedChannels: "email" | Array<"email">;
6449
- category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | undefined;
6450
- channel?: "email" | null | undefined;
6451
- status?: "draft" | "pending" | "approved" | "published" | "rejected" | "archived" | null | undefined;
6452
- search?: string | null | undefined;
6453
- sortBy?: "name" | "createdAt" | "updatedAt" | "usageCount" | "lastUsedAt" | null | undefined;
6454
- sortOrder?: "asc" | "desc" | null | undefined;
6455
- };
6456
- url: "/v1/templates/dashboard";
6457
- };
6458
- export type TemplatesListDashboardErrors = {
6459
- /**
6460
- * UnauthorizedError
6461
- */
6462
- 401: UnauthorizedError;
6463
- /**
6464
- * ForbiddenError
6465
- */
6466
- 403: ForbiddenError;
6467
- /**
6468
- * InternalError
6469
- */
6470
- 500: InternalError;
6471
- };
6472
- export type TemplatesListDashboardError = TemplatesListDashboardErrors[keyof TemplatesListDashboardErrors];
6473
- export type TemplatesListDashboardResponses = {
6474
- /**
6475
- * Success
6476
- */
6477
- 200: {
6478
- items: Array<{
6479
- kind: "family";
6480
- id: TemplateFamilyId;
6481
- name: string;
6482
- members: Array<TemplateSummary>;
6483
- usageCount: number;
6484
- lastUsedAt: string | null;
6485
- createdAt: string;
6486
- updatedAt: string;
6487
- } | {
6488
- kind: "template";
6489
- template: TemplateSummary;
6490
- }>;
6491
- pagination: PaginationMeta;
6492
- };
6493
- };
6494
- export type TemplatesListDashboardResponse = TemplatesListDashboardResponses[keyof TemplatesListDashboardResponses];
6495
8615
  export type TemplatesListFamiliesData = {
6496
8616
  body?: never;
6497
8617
  path?: never;
@@ -6514,6 +8634,10 @@ export type TemplatesListFamiliesErrors = {
6514
8634
  * InternalError
6515
8635
  */
6516
8636
  500: InternalError;
8637
+ /**
8638
+ * GatewayTimeoutError
8639
+ */
8640
+ 504: GatewayTimeoutError;
6517
8641
  };
6518
8642
  export type TemplatesListFamiliesError = TemplatesListFamiliesErrors[keyof TemplatesListFamiliesErrors];
6519
8643
  export type TemplatesListFamiliesResponses = {
@@ -6551,6 +8675,10 @@ export type TemplatesCreateFamilyErrors = {
6551
8675
  * InternalError
6552
8676
  */
6553
8677
  500: InternalError;
8678
+ /**
8679
+ * GatewayTimeoutError
8680
+ */
8681
+ 504: GatewayTimeoutError;
6554
8682
  };
6555
8683
  export type TemplatesCreateFamilyError = TemplatesCreateFamilyErrors[keyof TemplatesCreateFamilyErrors];
6556
8684
  export type TemplatesCreateFamilyResponses = {
@@ -6585,6 +8713,10 @@ export type TemplatesDeleteFamilyErrors = {
6585
8713
  * InternalError
6586
8714
  */
6587
8715
  500: InternalError;
8716
+ /**
8717
+ * GatewayTimeoutError
8718
+ */
8719
+ 504: GatewayTimeoutError;
6588
8720
  };
6589
8721
  export type TemplatesDeleteFamilyError = TemplatesDeleteFamilyErrors[keyof TemplatesDeleteFamilyErrors];
6590
8722
  export type TemplatesDeleteFamilyResponses = {
@@ -6619,6 +8751,10 @@ export type TemplatesGetFamilyErrors = {
6619
8751
  * InternalError
6620
8752
  */
6621
8753
  500: InternalError;
8754
+ /**
8755
+ * GatewayTimeoutError
8756
+ */
8757
+ 504: GatewayTimeoutError;
6622
8758
  };
6623
8759
  export type TemplatesGetFamilyError = TemplatesGetFamilyErrors[keyof TemplatesGetFamilyErrors];
6624
8760
  export type TemplatesGetFamilyResponses = {
@@ -6659,6 +8795,10 @@ export type TemplatesRenameFamilyErrors = {
6659
8795
  * InternalError
6660
8796
  */
6661
8797
  500: InternalError;
8798
+ /**
8799
+ * GatewayTimeoutError
8800
+ */
8801
+ 504: GatewayTimeoutError;
6662
8802
  };
6663
8803
  export type TemplatesRenameFamilyError = TemplatesRenameFamilyErrors[keyof TemplatesRenameFamilyErrors];
6664
8804
  export type TemplatesRenameFamilyResponses = {
@@ -6703,6 +8843,10 @@ export type TemplatesCreateFamilyFromTemplateErrors = {
6703
8843
  * InternalError
6704
8844
  */
6705
8845
  500: InternalError;
8846
+ /**
8847
+ * GatewayTimeoutError
8848
+ */
8849
+ 504: GatewayTimeoutError;
6706
8850
  };
6707
8851
  export type TemplatesCreateFamilyFromTemplateError = TemplatesCreateFamilyFromTemplateErrors[keyof TemplatesCreateFamilyFromTemplateErrors];
6708
8852
  export type TemplatesCreateFamilyFromTemplateResponses = {
@@ -6742,6 +8886,10 @@ export type TemplatesDetachFamilyMemberErrors = {
6742
8886
  * InternalError
6743
8887
  */
6744
8888
  500: InternalError;
8889
+ /**
8890
+ * GatewayTimeoutError
8891
+ */
8892
+ 504: GatewayTimeoutError;
6745
8893
  };
6746
8894
  export type TemplatesDetachFamilyMemberError = TemplatesDetachFamilyMemberErrors[keyof TemplatesDetachFamilyMemberErrors];
6747
8895
  export type TemplatesDetachFamilyMemberResponses = {
@@ -6785,6 +8933,10 @@ export type TemplatesAttachFamilyMemberErrors = {
6785
8933
  * InternalError
6786
8934
  */
6787
8935
  500: InternalError;
8936
+ /**
8937
+ * GatewayTimeoutError
8938
+ */
8939
+ 504: GatewayTimeoutError;
6788
8940
  };
6789
8941
  export type TemplatesAttachFamilyMemberError = TemplatesAttachFamilyMemberErrors[keyof TemplatesAttachFamilyMemberErrors];
6790
8942
  export type TemplatesAttachFamilyMemberResponses = {
@@ -6819,6 +8971,10 @@ export type TemplatesRemoveErrors = {
6819
8971
  * InternalError
6820
8972
  */
6821
8973
  500: InternalError;
8974
+ /**
8975
+ * GatewayTimeoutError
8976
+ */
8977
+ 504: GatewayTimeoutError;
6822
8978
  };
6823
8979
  export type TemplatesRemoveError = TemplatesRemoveErrors[keyof TemplatesRemoveErrors];
6824
8980
  export type TemplatesRemoveResponses = {
@@ -6853,6 +9009,10 @@ export type TemplatesGetByIdErrors = {
6853
9009
  * InternalError
6854
9010
  */
6855
9011
  500: InternalError;
9012
+ /**
9013
+ * GatewayTimeoutError
9014
+ */
9015
+ 504: GatewayTimeoutError;
6856
9016
  };
6857
9017
  export type TemplatesGetByIdError = TemplatesGetByIdErrors[keyof TemplatesGetByIdErrors];
6858
9018
  export type TemplatesGetByIdResponses = {
@@ -6905,6 +9065,10 @@ export type TemplatesUpdateErrors = {
6905
9065
  * InternalError
6906
9066
  */
6907
9067
  500: InternalError;
9068
+ /**
9069
+ * GatewayTimeoutError
9070
+ */
9071
+ 504: GatewayTimeoutError;
6908
9072
  };
6909
9073
  export type TemplatesUpdateError = TemplatesUpdateErrors[keyof TemplatesUpdateErrors];
6910
9074
  export type TemplatesUpdateResponses = {
@@ -6950,6 +9114,10 @@ export type TemplatesPatchWorkspaceErrors = {
6950
9114
  * InternalError
6951
9115
  */
6952
9116
  500: InternalError;
9117
+ /**
9118
+ * GatewayTimeoutError
9119
+ */
9120
+ 504: GatewayTimeoutError;
6953
9121
  };
6954
9122
  export type TemplatesPatchWorkspaceError = TemplatesPatchWorkspaceErrors[keyof TemplatesPatchWorkspaceErrors];
6955
9123
  export type TemplatesPatchWorkspaceResponses = {
@@ -7068,6 +9236,10 @@ export type TemplatesOpenWorkspaceErrors = {
7068
9236
  * InternalError
7069
9237
  */
7070
9238
  500: InternalError;
9239
+ /**
9240
+ * GatewayTimeoutError
9241
+ */
9242
+ 504: GatewayTimeoutError;
7071
9243
  };
7072
9244
  export type TemplatesOpenWorkspaceError = TemplatesOpenWorkspaceErrors[keyof TemplatesOpenWorkspaceErrors];
7073
9245
  export type TemplatesOpenWorkspaceResponses = {
@@ -7188,6 +9360,10 @@ export type TemplatesDiffWorkspaceErrors = {
7188
9360
  * InternalError
7189
9361
  */
7190
9362
  500: InternalError;
9363
+ /**
9364
+ * GatewayTimeoutError
9365
+ */
9366
+ 504: GatewayTimeoutError;
7191
9367
  };
7192
9368
  export type TemplatesDiffWorkspaceError = TemplatesDiffWorkspaceErrors[keyof TemplatesDiffWorkspaceErrors];
7193
9369
  export type TemplatesDiffWorkspaceResponses = {
@@ -7245,6 +9421,10 @@ export type TemplatesReconcileWorkspaceErrors = {
7245
9421
  * InternalError
7246
9422
  */
7247
9423
  500: InternalError;
9424
+ /**
9425
+ * GatewayTimeoutError
9426
+ */
9427
+ 504: GatewayTimeoutError;
7248
9428
  };
7249
9429
  export type TemplatesReconcileWorkspaceError = TemplatesReconcileWorkspaceErrors[keyof TemplatesReconcileWorkspaceErrors];
7250
9430
  export type TemplatesReconcileWorkspaceResponses = {
@@ -7370,6 +9550,10 @@ export type TemplatesResolveWorkspaceConflictErrors = {
7370
9550
  * InternalError
7371
9551
  */
7372
9552
  500: InternalError;
9553
+ /**
9554
+ * GatewayTimeoutError
9555
+ */
9556
+ 504: GatewayTimeoutError;
7373
9557
  };
7374
9558
  export type TemplatesResolveWorkspaceConflictError = TemplatesResolveWorkspaceConflictErrors[keyof TemplatesResolveWorkspaceConflictErrors];
7375
9559
  export type TemplatesResolveWorkspaceConflictResponses = {
@@ -7493,6 +9677,10 @@ export type TemplatesSaveWorkspaceErrors = {
7493
9677
  * InternalError
7494
9678
  */
7495
9679
  500: InternalError;
9680
+ /**
9681
+ * GatewayTimeoutError
9682
+ */
9683
+ 504: GatewayTimeoutError;
7496
9684
  };
7497
9685
  export type TemplatesSaveWorkspaceError = TemplatesSaveWorkspaceErrors[keyof TemplatesSaveWorkspaceErrors];
7498
9686
  export type TemplatesSaveWorkspaceResponses = {
@@ -7589,6 +9777,10 @@ export type TemplatesRestoreWorkspaceErrors = {
7589
9777
  * InternalError
7590
9778
  */
7591
9779
  500: InternalError;
9780
+ /**
9781
+ * GatewayTimeoutError
9782
+ */
9783
+ 504: GatewayTimeoutError;
7592
9784
  };
7593
9785
  export type TemplatesRestoreWorkspaceError = TemplatesRestoreWorkspaceErrors[keyof TemplatesRestoreWorkspaceErrors];
7594
9786
  export type TemplatesRestoreWorkspaceResponses = {
@@ -7715,6 +9907,10 @@ export type TemplatesWorkspaceHistoryErrors = {
7715
9907
  * InternalError
7716
9908
  */
7717
9909
  500: InternalError;
9910
+ /**
9911
+ * GatewayTimeoutError
9912
+ */
9913
+ 504: GatewayTimeoutError;
7718
9914
  };
7719
9915
  export type TemplatesWorkspaceHistoryError = TemplatesWorkspaceHistoryErrors[keyof TemplatesWorkspaceHistoryErrors];
7720
9916
  export type TemplatesWorkspaceHistoryResponses = {
@@ -7769,6 +9965,10 @@ export type TemplatesCheckWorkspaceErrors = {
7769
9965
  * InternalError
7770
9966
  */
7771
9967
  500: InternalError;
9968
+ /**
9969
+ * GatewayTimeoutError
9970
+ */
9971
+ 504: GatewayTimeoutError;
7772
9972
  };
7773
9973
  export type TemplatesCheckWorkspaceError = TemplatesCheckWorkspaceErrors[keyof TemplatesCheckWorkspaceErrors];
7774
9974
  export type TemplatesCheckWorkspaceResponses = {
@@ -7876,6 +10076,10 @@ export type TemplatesRenderWorkspaceFixtureErrors = {
7876
10076
  * InternalError
7877
10077
  */
7878
10078
  500: InternalError;
10079
+ /**
10080
+ * GatewayTimeoutError
10081
+ */
10082
+ 504: GatewayTimeoutError;
7879
10083
  };
7880
10084
  export type TemplatesRenderWorkspaceFixtureError = TemplatesRenderWorkspaceFixtureErrors[keyof TemplatesRenderWorkspaceFixtureErrors];
7881
10085
  export type TemplatesRenderWorkspaceFixtureResponses = {
@@ -8011,6 +10215,10 @@ export type TemplatesPublishErrors = {
8011
10215
  * InternalError
8012
10216
  */
8013
10217
  500: InternalError;
10218
+ /**
10219
+ * GatewayTimeoutError
10220
+ */
10221
+ 504: GatewayTimeoutError;
8014
10222
  };
8015
10223
  export type TemplatesPublishError = TemplatesPublishErrors[keyof TemplatesPublishErrors];
8016
10224
  export type TemplatesPublishResponses = {
@@ -8158,6 +10366,10 @@ export type TemplatesGetPublicationErrors = {
8158
10366
  * InternalError
8159
10367
  */
8160
10368
  500: InternalError;
10369
+ /**
10370
+ * GatewayTimeoutError
10371
+ */
10372
+ 504: GatewayTimeoutError;
8161
10373
  };
8162
10374
  export type TemplatesGetPublicationError = TemplatesGetPublicationErrors[keyof TemplatesGetPublicationErrors];
8163
10375
  export type TemplatesGetPublicationResponses = {
@@ -8304,6 +10516,10 @@ export type TemplatesListInputContractsErrors = {
8304
10516
  * InternalError
8305
10517
  */
8306
10518
  500: InternalError;
10519
+ /**
10520
+ * GatewayTimeoutError
10521
+ */
10522
+ 504: GatewayTimeoutError;
8307
10523
  };
8308
10524
  export type TemplatesListInputContractsError = TemplatesListInputContractsErrors[keyof TemplatesListInputContractsErrors];
8309
10525
  export type TemplatesListInputContractsResponses = {
@@ -8349,6 +10565,10 @@ export type TemplatesGetInputContractErrors = {
8349
10565
  * InternalError
8350
10566
  */
8351
10567
  500: InternalError;
10568
+ /**
10569
+ * GatewayTimeoutError
10570
+ */
10571
+ 504: GatewayTimeoutError;
8352
10572
  };
8353
10573
  export type TemplatesGetInputContractError = TemplatesGetInputContractErrors[keyof TemplatesGetInputContractErrors];
8354
10574
  export type TemplatesGetInputContractResponses = {
@@ -8397,6 +10617,10 @@ export type TemplatesGetGitRepositoryErrors = {
8397
10617
  * InternalError
8398
10618
  */
8399
10619
  500: InternalError;
10620
+ /**
10621
+ * GatewayTimeoutError
10622
+ */
10623
+ 504: GatewayTimeoutError;
8400
10624
  };
8401
10625
  export type TemplatesGetGitRepositoryError = TemplatesGetGitRepositoryErrors[keyof TemplatesGetGitRepositoryErrors];
8402
10626
  export type TemplatesGetGitRepositoryResponses = {
@@ -8440,6 +10664,10 @@ export type TemplatesIssueGitCredentialErrors = {
8440
10664
  * InternalError
8441
10665
  */
8442
10666
  500: InternalError;
10667
+ /**
10668
+ * GatewayTimeoutError
10669
+ */
10670
+ 504: GatewayTimeoutError;
8443
10671
  };
8444
10672
  export type TemplatesIssueGitCredentialError = TemplatesIssueGitCredentialErrors[keyof TemplatesIssueGitCredentialErrors];
8445
10673
  export type TemplatesIssueGitCredentialResponses = {
@@ -8495,6 +10723,10 @@ export type TemplatesAttachWorkspaceResourceErrors = {
8495
10723
  * InternalError
8496
10724
  */
8497
10725
  500: InternalError;
10726
+ /**
10727
+ * GatewayTimeoutError
10728
+ */
10729
+ 504: GatewayTimeoutError;
8498
10730
  };
8499
10731
  export type TemplatesAttachWorkspaceResourceError = TemplatesAttachWorkspaceResourceErrors[keyof TemplatesAttachWorkspaceResourceErrors];
8500
10732
  export type TemplatesAttachWorkspaceResourceResponses = {
@@ -8612,6 +10844,10 @@ export type TemplatesRemoveWorkspaceResourceErrors = {
8612
10844
  * InternalError
8613
10845
  */
8614
10846
  500: InternalError;
10847
+ /**
10848
+ * GatewayTimeoutError
10849
+ */
10850
+ 504: GatewayTimeoutError;
8615
10851
  };
8616
10852
  export type TemplatesRemoveWorkspaceResourceError = TemplatesRemoveWorkspaceResourceErrors[keyof TemplatesRemoveWorkspaceResourceErrors];
8617
10853
  export type TemplatesRemoveWorkspaceResourceResponses = {
@@ -8715,6 +10951,10 @@ export type DesignGetErrors = {
8715
10951
  * InternalError
8716
10952
  */
8717
10953
  500: InternalError;
10954
+ /**
10955
+ * GatewayTimeoutError
10956
+ */
10957
+ 504: GatewayTimeoutError;
8718
10958
  };
8719
10959
  export type DesignGetError = DesignGetErrors[keyof DesignGetErrors];
8720
10960
  export type DesignGetResponses = {
@@ -8749,6 +10989,10 @@ export type DesignUpdateErrors = {
8749
10989
  * InternalError
8750
10990
  */
8751
10991
  500: InternalError;
10992
+ /**
10993
+ * GatewayTimeoutError
10994
+ */
10995
+ 504: GatewayTimeoutError;
8752
10996
  };
8753
10997
  export type DesignUpdateError = DesignUpdateErrors[keyof DesignUpdateErrors];
8754
10998
  export type DesignUpdateResponses = {
@@ -8782,6 +11026,10 @@ export type WebhooksListErrors = {
8782
11026
  * InternalError
8783
11027
  */
8784
11028
  500: InternalError;
11029
+ /**
11030
+ * GatewayTimeoutError
11031
+ */
11032
+ 504: GatewayTimeoutError;
8785
11033
  };
8786
11034
  export type WebhooksListError = WebhooksListErrors[keyof WebhooksListErrors];
8787
11035
  export type WebhooksListResponses = {
@@ -8798,7 +11046,7 @@ export type WebhooksCreateData = {
8798
11046
  body: {
8799
11047
  name: string;
8800
11048
  url: string;
8801
- eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
11049
+ eventTypes: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated">;
8802
11050
  channels?: Array<"email"> | null | undefined;
8803
11051
  headers?: {
8804
11052
  [key: string]: string;
@@ -8838,6 +11086,10 @@ export type WebhooksCreateErrors = {
8838
11086
  * BillingProviderError
8839
11087
  */
8840
11088
  502: BillingProviderError;
11089
+ /**
11090
+ * GatewayTimeoutError
11091
+ */
11092
+ 504: GatewayTimeoutError;
8841
11093
  };
8842
11094
  export type WebhooksCreateError = WebhooksCreateErrors[keyof WebhooksCreateErrors];
8843
11095
  export type WebhooksCreateResponses = {
@@ -8879,6 +11131,10 @@ export type WebhooksRemoveErrors = {
8879
11131
  * BillingProviderError
8880
11132
  */
8881
11133
  502: BillingProviderError;
11134
+ /**
11135
+ * GatewayTimeoutError
11136
+ */
11137
+ 504: GatewayTimeoutError;
8882
11138
  };
8883
11139
  export type WebhooksRemoveError = WebhooksRemoveErrors[keyof WebhooksRemoveErrors];
8884
11140
  export type WebhooksRemoveResponses = {
@@ -8913,6 +11169,10 @@ export type WebhooksGetErrors = {
8913
11169
  * InternalError
8914
11170
  */
8915
11171
  500: InternalError;
11172
+ /**
11173
+ * GatewayTimeoutError
11174
+ */
11175
+ 504: GatewayTimeoutError;
8916
11176
  };
8917
11177
  export type WebhooksGetError = WebhooksGetErrors[keyof WebhooksGetErrors];
8918
11178
  export type WebhooksGetResponses = {
@@ -8926,7 +11186,7 @@ export type WebhooksUpdateData = {
8926
11186
  body: {
8927
11187
  name?: string | null | undefined;
8928
11188
  url?: string | null | undefined;
8929
- eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated"> | null | undefined;
11189
+ eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated"> | null | undefined;
8930
11190
  channels?: Array<"email"> | null | null | undefined;
8931
11191
  headers?: {
8932
11192
  [key: string]: string;
@@ -8964,6 +11224,10 @@ export type WebhooksUpdateErrors = {
8964
11224
  * InternalError
8965
11225
  */
8966
11226
  500: InternalError;
11227
+ /**
11228
+ * GatewayTimeoutError
11229
+ */
11230
+ 504: GatewayTimeoutError;
8967
11231
  };
8968
11232
  export type WebhooksUpdateError = WebhooksUpdateErrors[keyof WebhooksUpdateErrors];
8969
11233
  export type WebhooksUpdateResponses = {
@@ -9002,6 +11266,10 @@ export type WebhooksTestErrors = {
9002
11266
  * InternalError
9003
11267
  */
9004
11268
  500: InternalError;
11269
+ /**
11270
+ * GatewayTimeoutError
11271
+ */
11272
+ 504: GatewayTimeoutError;
9005
11273
  };
9006
11274
  export type WebhooksTestError = WebhooksTestErrors[keyof WebhooksTestErrors];
9007
11275
  export type WebhooksTestResponses = {
@@ -9042,6 +11310,10 @@ export type WebhooksGetLogsErrors = {
9042
11310
  * InternalError
9043
11311
  */
9044
11312
  500: InternalError;
11313
+ /**
11314
+ * GatewayTimeoutError
11315
+ */
11316
+ 504: GatewayTimeoutError;
9045
11317
  };
9046
11318
  export type WebhooksGetLogsError = WebhooksGetLogsErrors[keyof WebhooksGetLogsErrors];
9047
11319
  export type WebhooksGetLogsResponses = {
@@ -9109,6 +11381,10 @@ export type WebhooksGetStatsErrors = {
9109
11381
  * InternalError
9110
11382
  */
9111
11383
  500: InternalError;
11384
+ /**
11385
+ * GatewayTimeoutError
11386
+ */
11387
+ 504: GatewayTimeoutError;
9112
11388
  };
9113
11389
  export type WebhooksGetStatsError = WebhooksGetStatsErrors[keyof WebhooksGetStatsErrors];
9114
11390
  export type WebhooksGetStatsResponses = {
@@ -9148,6 +11424,10 @@ export type WebhooksRetryDeliveryErrors = {
9148
11424
  * InternalError
9149
11425
  */
9150
11426
  500: InternalError;
11427
+ /**
11428
+ * GatewayTimeoutError
11429
+ */
11430
+ 504: GatewayTimeoutError;
9151
11431
  };
9152
11432
  export type WebhooksRetryDeliveryError = WebhooksRetryDeliveryErrors[keyof WebhooksRetryDeliveryErrors];
9153
11433
  export type WebhooksRetryDeliveryResponses = {
@@ -9191,6 +11471,10 @@ export type WebhooksRegenerateSecretErrors = {
9191
11471
  * InternalError
9192
11472
  */
9193
11473
  500: InternalError;
11474
+ /**
11475
+ * GatewayTimeoutError
11476
+ */
11477
+ 504: GatewayTimeoutError;
9194
11478
  };
9195
11479
  export type WebhooksRegenerateSecretError = WebhooksRegenerateSecretErrors[keyof WebhooksRegenerateSecretErrors];
9196
11480
  export type WebhooksRegenerateSecretResponses = {
@@ -9235,6 +11519,10 @@ export type OrganizationsCreateErrors = {
9235
11519
  * BillingProviderError
9236
11520
  */
9237
11521
  502: BillingProviderError;
11522
+ /**
11523
+ * GatewayTimeoutError
11524
+ */
11525
+ 504: GatewayTimeoutError;
9238
11526
  };
9239
11527
  export type OrganizationsCreateError = OrganizationsCreateErrors[keyof OrganizationsCreateErrors];
9240
11528
  export type OrganizationsCreateResponses = {
@@ -9267,6 +11555,10 @@ export type OrganizationsGetErrors = {
9267
11555
  * InternalError
9268
11556
  */
9269
11557
  500: InternalError;
11558
+ /**
11559
+ * GatewayTimeoutError
11560
+ */
11561
+ 504: GatewayTimeoutError;
9270
11562
  };
9271
11563
  export type OrganizationsGetError = OrganizationsGetErrors[keyof OrganizationsGetErrors];
9272
11564
  export type OrganizationsGetResponses = {
@@ -9280,9 +11572,7 @@ export type OrganizationsUpdateData = {
9280
11572
  body: {
9281
11573
  name?: string | null | undefined;
9282
11574
  slug?: string | null | undefined;
9283
- billingEmail?: string | null | undefined;
9284
11575
  countryCode?: string | null | undefined;
9285
- currency?: string | null | undefined;
9286
11576
  timezone?: IanaTimezone | null | undefined;
9287
11577
  isActive?: boolean | null | undefined;
9288
11578
  metadata?: {
@@ -9318,6 +11608,10 @@ export type OrganizationsUpdateErrors = {
9318
11608
  * InternalError
9319
11609
  */
9320
11610
  500: InternalError;
11611
+ /**
11612
+ * GatewayTimeoutError
11613
+ */
11614
+ 504: GatewayTimeoutError;
9321
11615
  };
9322
11616
  export type OrganizationsUpdateError = OrganizationsUpdateErrors[keyof OrganizationsUpdateErrors];
9323
11617
  export type OrganizationsUpdateResponses = {
@@ -9348,6 +11642,10 @@ export type OrganizationsGetUsageErrors = {
9348
11642
  * InternalError
9349
11643
  */
9350
11644
  500: InternalError;
11645
+ /**
11646
+ * GatewayTimeoutError
11647
+ */
11648
+ 504: GatewayTimeoutError;
9351
11649
  };
9352
11650
  export type OrganizationsGetUsageError = OrganizationsGetUsageErrors[keyof OrganizationsGetUsageErrors];
9353
11651
  export type OrganizationsGetUsageResponses = {
@@ -9363,6 +11661,7 @@ export type OrganizationsGetUsageResponses = {
9363
11661
  };
9364
11662
  billing: {
9365
11663
  currency: string;
11664
+ planName: string | null;
9366
11665
  includedEmails: number | null;
9367
11666
  usedEmails: number | null;
9368
11667
  overageEmails: number | null;
@@ -9403,6 +11702,10 @@ export type OrganizationsDeleteErrors = {
9403
11702
  * InternalError
9404
11703
  */
9405
11704
  500: InternalError;
11705
+ /**
11706
+ * GatewayTimeoutError
11707
+ */
11708
+ 504: GatewayTimeoutError;
9406
11709
  };
9407
11710
  export type OrganizationsDeleteError = OrganizationsDeleteErrors[keyof OrganizationsDeleteErrors];
9408
11711
  export type OrganizationsDeleteResponses = {
@@ -9412,44 +11715,6 @@ export type OrganizationsDeleteResponses = {
9412
11715
  202: OperationAccepted;
9413
11716
  };
9414
11717
  export type OrganizationsDeleteResponse = OrganizationsDeleteResponses[keyof OrganizationsDeleteResponses];
9415
- export type OrganizationsBootstrapData = {
9416
- body: {
9417
- name: string;
9418
- };
9419
- path?: never;
9420
- query?: never;
9421
- url: "/v1/organizations/bootstrap";
9422
- };
9423
- export type OrganizationsBootstrapErrors = {
9424
- /**
9425
- * UnauthorizedError
9426
- */
9427
- 401: UnauthorizedError;
9428
- /**
9429
- * ForbiddenError
9430
- */
9431
- 403: ForbiddenError;
9432
- /**
9433
- * ValidationError
9434
- */
9435
- 422: ValidationError;
9436
- /**
9437
- * InternalError
9438
- */
9439
- 500: InternalError;
9440
- /**
9441
- * BillingProviderError
9442
- */
9443
- 502: BillingProviderError;
9444
- };
9445
- export type OrganizationsBootstrapError = OrganizationsBootstrapErrors[keyof OrganizationsBootstrapErrors];
9446
- export type OrganizationsBootstrapResponses = {
9447
- /**
9448
- * Organization
9449
- */
9450
- 200: Organization;
9451
- };
9452
- export type OrganizationsBootstrapResponse = OrganizationsBootstrapResponses[keyof OrganizationsBootstrapResponses];
9453
11718
  export type ApiKeysListData = {
9454
11719
  body?: never;
9455
11720
  path?: never;
@@ -9474,6 +11739,10 @@ export type ApiKeysListErrors = {
9474
11739
  * InternalError
9475
11740
  */
9476
11741
  500: InternalError;
11742
+ /**
11743
+ * GatewayTimeoutError
11744
+ */
11745
+ 504: GatewayTimeoutError;
9477
11746
  };
9478
11747
  export type ApiKeysListError = ApiKeysListErrors[keyof ApiKeysListErrors];
9479
11748
  export type ApiKeysListResponses = {
@@ -9491,7 +11760,10 @@ export type ApiKeysCreateData = {
9491
11760
  name: string;
9492
11761
  description?: string | null | undefined;
9493
11762
  expiresAt?: string | null | undefined;
9494
- permissions?: ApiKeyPermissions | undefined;
11763
+ /**
11764
+ * Defaults to full access. A restricted API key creating a key defaults to its own grants and cannot issue full access.
11765
+ */
11766
+ access?: ApiKeyAccess | null | undefined;
9495
11767
  };
9496
11768
  path?: never;
9497
11769
  query?: never;
@@ -9526,6 +11798,10 @@ export type ApiKeysCreateErrors = {
9526
11798
  * BillingProviderError
9527
11799
  */
9528
11800
  502: BillingProviderError;
11801
+ /**
11802
+ * GatewayTimeoutError
11803
+ */
11804
+ 504: GatewayTimeoutError;
9529
11805
  };
9530
11806
  export type ApiKeysCreateError = ApiKeysCreateErrors[keyof ApiKeysCreateErrors];
9531
11807
  export type ApiKeysCreateResponses = {
@@ -9564,6 +11840,10 @@ export type ApiKeysRevokeErrors = {
9564
11840
  * BillingProviderError
9565
11841
  */
9566
11842
  502: BillingProviderError;
11843
+ /**
11844
+ * GatewayTimeoutError
11845
+ */
11846
+ 504: GatewayTimeoutError;
9567
11847
  };
9568
11848
  export type ApiKeysRevokeError = ApiKeysRevokeErrors[keyof ApiKeysRevokeErrors];
9569
11849
  export type ApiKeysRevokeResponses = {
@@ -9598,6 +11878,10 @@ export type ApiKeysGetErrors = {
9598
11878
  * InternalError
9599
11879
  */
9600
11880
  500: InternalError;
11881
+ /**
11882
+ * GatewayTimeoutError
11883
+ */
11884
+ 504: GatewayTimeoutError;
9601
11885
  };
9602
11886
  export type ApiKeysGetError = ApiKeysGetErrors[keyof ApiKeysGetErrors];
9603
11887
  export type ApiKeysGetResponses = {
@@ -9635,6 +11919,10 @@ export type ApiKeysUpdateErrors = {
9635
11919
  * InternalError
9636
11920
  */
9637
11921
  500: InternalError;
11922
+ /**
11923
+ * GatewayTimeoutError
11924
+ */
11925
+ 504: GatewayTimeoutError;
9638
11926
  };
9639
11927
  export type ApiKeysUpdateError = ApiKeysUpdateErrors[keyof ApiKeysUpdateErrors];
9640
11928
  export type ApiKeysUpdateResponses = {
@@ -9673,6 +11961,10 @@ export type ApiKeysRotateErrors = {
9673
11961
  * InternalError
9674
11962
  */
9675
11963
  500: InternalError;
11964
+ /**
11965
+ * GatewayTimeoutError
11966
+ */
11967
+ 504: GatewayTimeoutError;
9676
11968
  };
9677
11969
  export type ApiKeysRotateError = ApiKeysRotateErrors[keyof ApiKeysRotateErrors];
9678
11970
  export type ApiKeysRotateResponses = {
@@ -9711,6 +12003,10 @@ export type ApiKeysRemoveErrors = {
9711
12003
  * BillingProviderError
9712
12004
  */
9713
12005
  502: BillingProviderError;
12006
+ /**
12007
+ * GatewayTimeoutError
12008
+ */
12009
+ 504: GatewayTimeoutError;
9714
12010
  };
9715
12011
  export type ApiKeysRemoveError = ApiKeysRemoveErrors[keyof ApiKeysRemoveErrors];
9716
12012
  export type ApiKeysRemoveResponses = {
@@ -9747,6 +12043,10 @@ export type ApiKeysGetStatsErrors = {
9747
12043
  * InternalError
9748
12044
  */
9749
12045
  500: InternalError;
12046
+ /**
12047
+ * GatewayTimeoutError
12048
+ */
12049
+ 504: GatewayTimeoutError;
9750
12050
  };
9751
12051
  export type ApiKeysGetStatsError = ApiKeysGetStatsErrors[keyof ApiKeysGetStatsErrors];
9752
12052
  export type ApiKeysGetStatsResponses = {
@@ -9792,6 +12092,10 @@ export type ApiKeysGetActivityErrors = {
9792
12092
  * InternalError
9793
12093
  */
9794
12094
  500: InternalError;
12095
+ /**
12096
+ * GatewayTimeoutError
12097
+ */
12098
+ 504: GatewayTimeoutError;
9795
12099
  };
9796
12100
  export type ApiKeysGetActivityError = ApiKeysGetActivityErrors[keyof ApiKeysGetActivityErrors];
9797
12101
  export type ApiKeysGetActivityResponses = {