samva 0.1.1 → 0.2.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 (35) hide show
  1. package/dist/client/sdk.gen.d.ts +120 -184
  2. package/dist/client/types.gen.d.ts +811 -418
  3. package/dist/{client-DVALvDUe.js → client-BqkU-sFv.js} +937 -576
  4. package/dist/effect/api-keys.js +1 -1
  5. package/dist/effect/campaigns.d.ts +98 -7
  6. package/dist/effect/campaigns.js +1 -1
  7. package/dist/effect/client.js +1 -1
  8. package/dist/effect/contacts.d.ts +16 -94
  9. package/dist/effect/contacts.js +1 -1
  10. package/dist/effect/conversations.d.ts +65 -50
  11. package/dist/effect/conversations.js +1 -1
  12. package/dist/effect/design.js +1 -1
  13. package/dist/effect/email.d.ts +107 -67
  14. package/dist/effect/email.js +20 -18
  15. package/dist/effect/generated.d.ts +11823 -11603
  16. package/dist/effect/index.js +1 -1
  17. package/dist/effect/messages.js +1 -1
  18. package/dist/effect/operations.d.ts +3 -3
  19. package/dist/effect/operations.js +1 -1
  20. package/dist/effect/organizations.d.ts +1 -1
  21. package/dist/effect/organizations.js +1 -1
  22. package/dist/effect/scheduled-messages.d.ts +0 -48
  23. package/dist/effect/scheduled-messages.js +1 -1
  24. package/dist/effect/templates.d.ts +262 -1018
  25. package/dist/effect/templates.js +26 -18
  26. package/dist/effect/webhooks.d.ts +6 -6
  27. package/dist/effect/webhooks.js +2 -2
  28. package/dist/index.js +1 -1
  29. package/dist/{operation-UtKNITtG.js → operation-Ccqh_yxb.js} +48 -25
  30. package/dist/promises/index.d.ts +3 -1
  31. package/dist/promises/index.js +1 -1
  32. package/dist/promises/types.gen.d.ts +1 -1
  33. package/dist/{promises-QxEfMTho.js → promises-Dgv8UmCC.js} +319 -153
  34. package/dist/service-map.d.ts +66 -40
  35. package/package.json +4 -4
@@ -388,7 +388,7 @@ export type Operation = {
388
388
  status: "pending" | "running" | "succeeded" | "failed";
389
389
  phase: "accepted" | "dispatching" | "provisioning" | "deleting" | "finalizing" | "completed";
390
390
  error: {
391
- code: "validation-failed" | "conflict" | "capacity-unavailable" | "provider-unavailable" | "timed-out" | "internal";
391
+ code: "validation-failed" | "conflict" | "capacity-unavailable" | "provider-rejected" | "provider-unavailable" | "timed-out" | "internal";
392
392
  message: string;
393
393
  } | null;
394
394
  createdAt: string;
@@ -473,15 +473,7 @@ export type ScheduledMessage = {
473
473
  status: "pending" | "dispatching" | "dispatched" | "cancelled" | "failed";
474
474
  scheduledFor: string;
475
475
  timezone: string;
476
- send: SendMessagePayload | {
477
- kind: "editor-session-snapshot";
478
- channel: "email" | "sms" | "whatsapp";
479
- sessionId: string;
480
- revision: string;
481
- templateId: TemplateId;
482
- templateVersion: number;
483
- isTest: boolean;
484
- };
476
+ send: SendMessagePayload;
485
477
  messageId: MessageId | null;
486
478
  idempotencyKey: string | null;
487
479
  referenceId: string | null;
@@ -547,6 +539,21 @@ export type WhatsAppCampaignContent = {
547
539
  metadata?: CampaignContentMetadata | undefined;
548
540
  };
549
541
  export type CampaignContent = EmailCampaignContent | SmsCampaignContent | WhatsAppCampaignContent;
542
+ export type CampaignDefinitionSummary = {
543
+ state: "editable" | "frozen" | "archived";
544
+ frozenAt: string | null;
545
+ };
546
+ export type CampaignRunId = string;
547
+ export type CampaignLatestRun = {
548
+ id: CampaignRunId;
549
+ status: "scheduled" | "resolving" | "dispatching" | "paused" | "completed" | "cancelled" | "failed";
550
+ scheduledFor: string;
551
+ completedAt: string | null;
552
+ totalRecipients: number;
553
+ dispatchedCount: number;
554
+ failedCount: number;
555
+ skippedCount: number;
556
+ };
550
557
  export type Campaign = {
551
558
  id: CampaignId;
552
559
  name: string;
@@ -554,14 +561,14 @@ export type Campaign = {
554
561
  content: CampaignContent;
555
562
  audience: CampaignAudience;
556
563
  policy: CampaignPolicy;
557
- status: "draft" | "archived";
564
+ definition: CampaignDefinitionSummary;
565
+ latestRun: CampaignLatestRun | null;
558
566
  createdBy: string;
559
567
  actorEmail: string;
560
568
  memberRole: string;
561
569
  createdAt: string;
562
570
  updatedAt: string;
563
571
  };
564
- export type CampaignRunId = string;
565
572
  export type CampaignRun = {
566
573
  id: CampaignRunId;
567
574
  campaignId: CampaignId;
@@ -612,7 +619,7 @@ export type DeliverabilityFacts = {
612
619
  export type EmailDomain = {
613
620
  id: EmailDomainId;
614
621
  domain: string;
615
- status: "pending" | "verified" | "failed";
622
+ phase: "dns-setup" | "provider-setup" | "provider-verification" | "ready" | "degraded" | "failed";
616
623
  dkimSelector?: string | null | undefined;
617
624
  dkimPublicKey?: string | null | undefined;
618
625
  dnsRecords: Array<{
@@ -637,39 +644,84 @@ export type EmailChannelError = {
637
644
  message: string;
638
645
  statusCode?: number | null | undefined;
639
646
  };
640
- export type EmailDomainVerificationStatusResponse = {
647
+ export type EmailDomainVerification = {
648
+ domainId: EmailDomainId;
641
649
  domain: string;
642
- isVerified: boolean;
643
- verificationStatus: string;
644
- mailFromStatus?: string | null | undefined;
650
+ phase: "dns-setup" | "provider-setup" | "provider-verification" | "ready" | "degraded" | "failed";
651
+ records: Array<{
652
+ record: {
653
+ type: "A" | "AAAA" | "CNAME" | "MX" | "NS" | "SOA" | "PTR" | "SRV" | "TXT" | "CAA";
654
+ name: string;
655
+ value: string;
656
+ ttl?: string | null | undefined;
657
+ description?: string | null | undefined;
658
+ priority?: number | null | undefined;
659
+ };
660
+ status: "unchecked" | "missing" | "mismatch" | "found";
661
+ observedValues: Array<string>;
662
+ checkedAt?: string | null | undefined;
663
+ resolutionFailure?: {
664
+ code?: string | null | undefined;
665
+ message: string;
666
+ } | null | undefined;
667
+ }>;
668
+ provider: {
669
+ identity: "pending" | "verified" | "failed" | "unknown";
670
+ dkim?: "pending" | "verified" | "failed" | "unknown" | null | undefined;
671
+ mailFrom?: "pending" | "verified" | "failed" | "unknown" | null | undefined;
672
+ } | null;
673
+ operationId: OperationId | null;
674
+ checkedAt: string | null;
675
+ nextCheckAt: string | null;
676
+ failure: {
677
+ code: string;
678
+ message: string;
679
+ failedAt: string;
680
+ } | null;
681
+ };
682
+ export type DomainConnectEligibility = {
683
+ eligible: false;
684
+ reason: "no-record" | "no-settings" | "no-sync" | "no-template" | "unavailable";
685
+ } | {
686
+ eligible: true;
687
+ providerName?: string | null | undefined;
688
+ };
689
+ export type DomainConnectApplyUrlResult = {
690
+ url: string;
691
+ };
692
+ export type DomainConnectCompleteResult = {
693
+ status: "applied" | "cancelled" | "invalid";
645
694
  };
646
695
  export type SuccessResult = {
647
696
  success: boolean;
648
697
  message: string;
649
698
  };
650
699
  export type WebhookEndpointId = string;
651
- export type BrandedTrackingDnsRecord = {
700
+ export type CustomTrackingDnsRecord = {
652
701
  name: string;
653
702
  type: string;
654
703
  value: string;
655
704
  };
656
- export type BrandedTrackingStatus = {
705
+ export type CustomTrackingStatus = {
657
706
  enabled: boolean;
658
- brandedTracking: {
707
+ customTracking: {
659
708
  status: "pending" | "caa-blocked" | "active" | "teardown-scheduled" | "disabled";
660
709
  label: string;
661
710
  hostname: string;
662
711
  region: string;
663
712
  sslStatus: string | null;
664
713
  dnsRecords: {
665
- tracking: BrandedTrackingDnsRecord | null;
666
- dcvDelegation: BrandedTrackingDnsRecord | null;
714
+ tracking: CustomTrackingDnsRecord | null;
715
+ dcvDelegation: CustomTrackingDnsRecord | null;
667
716
  };
668
717
  caaBlocked: boolean;
669
718
  verificationErrors: Array<string>;
670
719
  teardownScheduledAt: string | null;
671
720
  } | null;
672
721
  };
722
+ export type CustomTrackingDomainConnectCompleteResult = {
723
+ status: "applied" | "cancelled" | "stale" | "invalid";
724
+ };
673
725
  export type SuppressionId = string;
674
726
  export type SuppressionEntry = {
675
727
  id: SuppressionId;
@@ -692,6 +744,7 @@ export type ForwardingConditions = {
692
744
  };
693
745
  export type EmailForwardingRuleId = string;
694
746
  export type OrganizationId = string;
747
+ export type Arrays = Array<"sms" | "whatsapp" | "email">;
695
748
  export type UnknownRecord = {
696
749
  [key: string]: JsonValue;
697
750
  };
@@ -700,6 +753,7 @@ export type ConversationMetadata = {
700
753
  tags?: Array<string> | null | undefined;
701
754
  customFields?: UnknownRecord | null | undefined;
702
755
  };
756
+ export type Union = ConversationMetadata | null;
703
757
  export type ActorId = string;
704
758
  export type ActorTracking = {
705
759
  allActorIds: Array<ActorId>;
@@ -737,6 +791,9 @@ export type ConversationContext = {
737
791
  workflowData?: UnknownRecord | null | undefined;
738
792
  } | null | undefined;
739
793
  };
794
+ export type Union1 = ConversationContext | null;
795
+ export type Arrays1 = Array<string>;
796
+ export type Arrays2 = Array<string>;
740
797
  export type Conversation = {
741
798
  id: ConversationId;
742
799
  organizationId: OrganizationId;
@@ -744,19 +801,59 @@ export type Conversation = {
744
801
  description: string | null;
745
802
  externalId: string | null;
746
803
  parentConversationId: ConversationId | null;
747
- channels: Array<"sms" | "whatsapp" | "email">;
804
+ channels: Arrays;
748
805
  primaryChannel: "sms" | "whatsapp" | "email";
749
806
  status: "active" | "waiting" | "resolved" | "escalated" | "archived";
750
807
  statusReason: string | null;
751
808
  priority: number;
752
809
  urgency: "low" | "medium" | "high" | "critical";
753
810
  complexity: "simple" | "moderate" | "complex";
754
- metadata: ConversationMetadata | null;
811
+ metadata: Union;
755
812
  actorTracking: ActorTracking;
756
813
  metrics: ConversationMetrics;
757
- context: ConversationContext | null;
758
- tags: Array<string>;
759
- categories: Array<string>;
814
+ context: Union1;
815
+ tags: Arrays1;
816
+ categories: Arrays2;
817
+ isTest: boolean;
818
+ isInternal: boolean;
819
+ isPrivate: boolean;
820
+ startedAt: string;
821
+ lastActivityAt: string;
822
+ lastHumanActivityAt: string | null;
823
+ resolvedAt: string | null;
824
+ archivedAt: string | null;
825
+ resolvedBy: ActorId | null;
826
+ resolutionType: "automated" | "human_assisted" | "escalated" | "abandoned" | "timeout" | null;
827
+ resolutionNotes: string | null;
828
+ createdAt: string;
829
+ updatedAt: string;
830
+ createdBy: ActorId | null;
831
+ };
832
+ export type ConversationParticipant = {
833
+ actorId: ActorId;
834
+ actorType: "contact" | "system" | "sender_identity" | "agent" | "user";
835
+ contact: MessageContact;
836
+ };
837
+ export type ConversationDetail = {
838
+ id: ConversationId;
839
+ organizationId: OrganizationId;
840
+ title: string | null;
841
+ description: string | null;
842
+ externalId: string | null;
843
+ parentConversationId: ConversationId | null;
844
+ channels: Arrays;
845
+ primaryChannel: "sms" | "whatsapp" | "email";
846
+ status: "active" | "waiting" | "resolved" | "escalated" | "archived";
847
+ statusReason: string | null;
848
+ priority: number;
849
+ urgency: "low" | "medium" | "high" | "critical";
850
+ complexity: "simple" | "moderate" | "complex";
851
+ metadata: Union;
852
+ actorTracking: ActorTracking;
853
+ metrics: ConversationMetrics;
854
+ context: Union1;
855
+ tags: Arrays1;
856
+ categories: Arrays2;
760
857
  isTest: boolean;
761
858
  isInternal: boolean;
762
859
  isPrivate: boolean;
@@ -771,6 +868,7 @@ export type Conversation = {
771
868
  createdAt: string;
772
869
  updatedAt: string;
773
870
  createdBy: ActorId | null;
871
+ participants: Array<ConversationParticipant>;
774
872
  };
775
873
  export type ConversationContacts = {
776
874
  contactIds: [ContactId, ContactId];
@@ -780,6 +878,7 @@ export type ContactIdentity = {
780
878
  identifier: string;
781
879
  verified: boolean;
782
880
  };
881
+ export type Arrays3 = Array<ContactIdentity>;
783
882
  export type HumanProfile = {
784
883
  firstName?: string | null | undefined;
785
884
  lastName?: string | null | undefined;
@@ -797,6 +896,9 @@ export type HumanProfile = {
797
896
  source?: "api" | "import" | "manual" | "form" | null | undefined;
798
897
  sourceDetails?: UnknownRecord | null | undefined;
799
898
  };
899
+ export type Union2 = HumanProfile | null;
900
+ export type Arrays4 = Array<string>;
901
+ export type Arrays5 = Array<string>;
800
902
  export type ContactAccessConfig = {
801
903
  paymentRequired?: {
802
904
  amount: number;
@@ -821,6 +923,7 @@ export type ContactAccessConfig = {
821
923
  outOfOfficeMessage?: string | null | undefined;
822
924
  } | null | undefined;
823
925
  };
926
+ export type Union3 = ContactAccessConfig | null;
824
927
  export type ContactPreferences = {
825
928
  preferredChannels?: Array<"sms" | "whatsapp" | "email"> | null | undefined;
826
929
  language?: string | null | undefined;
@@ -840,6 +943,36 @@ export type ContactPreferences = {
840
943
  maxMessageLength?: number | null | undefined;
841
944
  } | null | undefined;
842
945
  };
946
+ export type Union4 = ContactPreferences | null;
947
+ export type Union5 = JsonObject | null;
948
+ export type ContactActivitySummary = {
949
+ totalInteractions: number;
950
+ lastActiveAt: string | null;
951
+ };
952
+ export type ContactListItem = {
953
+ id: ContactId;
954
+ organizationId: OrganizationId;
955
+ type: "human" | "system";
956
+ name: string;
957
+ displayName: string | null;
958
+ avatar: string | null;
959
+ identities: Arrays3;
960
+ humanProfile: Union2;
961
+ capabilities: Arrays4;
962
+ tags: Arrays5;
963
+ accessLevel: "public" | "authenticated" | "vip" | "internal";
964
+ accessConfig: Union3;
965
+ preferences: Union4;
966
+ status: "active" | "paused" | "blocked" | "archived";
967
+ statusReason: string | null;
968
+ externalId: string | null;
969
+ metadata: Union5;
970
+ createdAt: string;
971
+ updatedAt: string;
972
+ createdBy: ContactId | null;
973
+ lastModifiedBy: ContactId | null;
974
+ engagement: ContactActivitySummary;
975
+ };
843
976
  export type Contact = {
844
977
  id: ContactId;
845
978
  organizationId: OrganizationId;
@@ -847,18 +980,17 @@ export type Contact = {
847
980
  name: string;
848
981
  displayName: string | null;
849
982
  avatar: string | null;
850
- identities: Array<ContactIdentity>;
851
- humanProfile: HumanProfile | null;
852
- capabilities: Array<string>;
853
- tags: Array<string>;
854
- engagement: UnknownRecord;
983
+ identities: Arrays3;
984
+ humanProfile: Union2;
985
+ capabilities: Arrays4;
986
+ tags: Arrays5;
855
987
  accessLevel: "public" | "authenticated" | "vip" | "internal";
856
- accessConfig: ContactAccessConfig | null;
857
- preferences: ContactPreferences | null;
988
+ accessConfig: Union3;
989
+ preferences: Union4;
858
990
  status: "active" | "paused" | "blocked" | "archived";
859
991
  statusReason: string | null;
860
992
  externalId: string | null;
861
- metadata: JsonObject | null;
993
+ metadata: Union5;
862
994
  createdAt: string;
863
995
  updatedAt: string;
864
996
  createdBy: ContactId | null;
@@ -994,7 +1126,6 @@ export type Template = {
994
1126
  opens?: boolean | null | undefined;
995
1127
  clicks?: boolean | null | undefined;
996
1128
  } | null | undefined;
997
- source: string | null;
998
1129
  email: {
999
1130
  subject: string;
1000
1131
  preheader: string | null;
@@ -1071,7 +1202,6 @@ export type Template = {
1071
1202
  isActive: boolean;
1072
1203
  isDefault: boolean;
1073
1204
  version: number;
1074
- publishedSource?: string | null | null | undefined;
1075
1205
  publishedAt?: string | null | null | undefined;
1076
1206
  publishedBy?: string | null | null | undefined;
1077
1207
  createdAt: string;
@@ -1161,11 +1291,6 @@ export type UpdateTemplatePayload = {
1161
1291
  category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | null | undefined;
1162
1292
  fromDefault?: TemplateFromDefault | null | null | undefined;
1163
1293
  replyToDefault?: Array<string> | null | null | undefined;
1164
- source?: string | null | undefined;
1165
- subject?: string | null | undefined;
1166
- headers?: {
1167
- [key: string]: string;
1168
- } | null | null | undefined;
1169
1294
  variableSchema?: Array<TemplateVariable> | null | null | undefined;
1170
1295
  compliance?: TemplateCompliance | null | null | undefined;
1171
1296
  performance?: TemplatePerformance | null | null | undefined;
@@ -1175,7 +1300,39 @@ export type UpdateTemplatePayload = {
1175
1300
  version?: number | null | undefined;
1176
1301
  };
1177
1302
  };
1303
+ export type Objects1 = {
1304
+ userId: UserId;
1305
+ via: "api" | "mcp" | "agent";
1306
+ };
1307
+ export type Objects = {
1308
+ templateId: TemplateId;
1309
+ organizationId: OrganizationId;
1310
+ channel: "sms" | "whatsapp" | "email";
1311
+ source: string;
1312
+ revision: string;
1313
+ sourceDigest: string;
1314
+ createdAt: string;
1315
+ updatedAt: string;
1316
+ createdBy: Objects1;
1317
+ updatedBy: Objects1;
1318
+ };
1319
+ export type Objects2 = {
1320
+ revision: string;
1321
+ variables?: {
1322
+ [key: string]: JsonValue;
1323
+ } | null | undefined;
1324
+ };
1325
+ export type Objects3 = {
1326
+ channel: "email" | "sms" | "whatsapp";
1327
+ subject?: string | null | undefined;
1328
+ html?: string | null | undefined;
1329
+ text: string;
1330
+ missingVariables: Array<string>;
1331
+ };
1178
1332
  export type TemplateSourceVersionId = string;
1333
+ export type Objects4 = {
1334
+ versionId: string;
1335
+ };
1179
1336
  export type DesignSettings = {
1180
1337
  design: Design | null;
1181
1338
  footerCompleteness: {
@@ -1185,7 +1342,7 @@ export type DesignSettings = {
1185
1342
  export type CreateWebhookPayload = {
1186
1343
  name: string;
1187
1344
  url: string;
1188
- 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">;
1345
+ 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">;
1189
1346
  channels?: Array<"sms" | "whatsapp" | "email"> | null | undefined;
1190
1347
  headers?: {
1191
1348
  [key: string]: string;
@@ -1196,7 +1353,7 @@ export type WebhookEndpoint = {
1196
1353
  id: WebhookEndpointId;
1197
1354
  name: string;
1198
1355
  url: string;
1199
- 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">;
1356
+ 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">;
1200
1357
  channels: Array<"sms" | "whatsapp" | "email"> | null;
1201
1358
  status: "active" | "disabled";
1202
1359
  hasCustomHeaders: boolean;
@@ -1208,7 +1365,7 @@ export type WebhookEndpoint = {
1208
1365
  export type UpdateWebhookPayload = {
1209
1366
  name?: string | null | undefined;
1210
1367
  url?: string | null | undefined;
1211
- 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"> | null | undefined;
1368
+ eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated"> | null | undefined;
1212
1369
  channels?: Array<"sms" | "whatsapp" | "email"> | null | null | undefined;
1213
1370
  headers?: {
1214
1371
  [key: string]: string;
@@ -2561,7 +2718,7 @@ export type EmailListDomainsResponses = {
2561
2718
  items: Array<{
2562
2719
  id: EmailDomainId;
2563
2720
  domain: string;
2564
- status: "pending" | "verified" | "failed";
2721
+ phase: "dns-setup" | "provider-setup" | "provider-verification" | "ready" | "degraded" | "failed";
2565
2722
  dkimSelector?: string | null | undefined;
2566
2723
  dkimPublicKey?: string | null | undefined;
2567
2724
  isDefault: boolean;
@@ -2615,60 +2772,15 @@ export type EmailAddDomainResponses = {
2615
2772
  201: EmailDomain;
2616
2773
  };
2617
2774
  export type EmailAddDomainResponse = EmailAddDomainResponses[keyof EmailAddDomainResponses];
2618
- export type EmailProvisionDomainData = {
2619
- body: {
2620
- domain: string;
2621
- };
2622
- headers: {
2623
- "idempotency-key": string;
2624
- };
2625
- path?: never;
2626
- query?: never;
2627
- url: "/v1/email/domain-operations";
2628
- };
2629
- export type EmailProvisionDomainErrors = {
2630
- /**
2631
- * UnauthorizedError
2632
- */
2633
- 401: UnauthorizedError;
2634
- /**
2635
- * ForbiddenError
2636
- */
2637
- 403: ForbiddenError;
2638
- /**
2639
- * ConflictError
2640
- */
2641
- 409: ConflictError;
2642
- /**
2643
- * ValidationError
2644
- */
2645
- 422: ValidationError;
2646
- /**
2647
- * InternalError
2648
- */
2649
- 500: InternalError;
2650
- /**
2651
- * EmailChannelError
2652
- */
2653
- 502: EmailChannelError;
2654
- };
2655
- export type EmailProvisionDomainError = EmailProvisionDomainErrors[keyof EmailProvisionDomainErrors];
2656
- export type EmailProvisionDomainResponses = {
2657
- /**
2658
- * OperationAccepted
2659
- */
2660
- 202: OperationAccepted;
2661
- };
2662
- export type EmailProvisionDomainResponse = EmailProvisionDomainResponses[keyof EmailProvisionDomainResponses];
2663
- export type EmailVerifyDomainData = {
2775
+ export type EmailGetDomainVerificationData = {
2664
2776
  body?: never;
2665
2777
  path: {
2666
2778
  id: EmailDomainId;
2667
2779
  };
2668
2780
  query?: never;
2669
- url: "/v1/email/domains/{id}/verify";
2781
+ url: "/v1/email/domains/{id}/verification";
2670
2782
  };
2671
- export type EmailVerifyDomainErrors = {
2783
+ export type EmailGetDomainVerificationErrors = {
2672
2784
  /**
2673
2785
  * UnauthorizedError
2674
2786
  */
@@ -2685,22 +2797,16 @@ export type EmailVerifyDomainErrors = {
2685
2797
  * InternalError
2686
2798
  */
2687
2799
  500: InternalError;
2688
- /**
2689
- * EmailChannelError
2690
- */
2691
- 502: EmailChannelError;
2692
2800
  };
2693
- export type EmailVerifyDomainError = EmailVerifyDomainErrors[keyof EmailVerifyDomainErrors];
2694
- export type EmailVerifyDomainResponses = {
2801
+ export type EmailGetDomainVerificationError = EmailGetDomainVerificationErrors[keyof EmailGetDomainVerificationErrors];
2802
+ export type EmailGetDomainVerificationResponses = {
2695
2803
  /**
2696
- * Success
2804
+ * EmailDomainVerification
2697
2805
  */
2698
- 200: {
2699
- success: true;
2700
- };
2806
+ 200: EmailDomainVerification;
2701
2807
  };
2702
- export type EmailVerifyDomainResponse = EmailVerifyDomainResponses[keyof EmailVerifyDomainResponses];
2703
- export type EmailCheckDomainVerificationData = {
2808
+ export type EmailGetDomainVerificationResponse = EmailGetDomainVerificationResponses[keyof EmailGetDomainVerificationResponses];
2809
+ export type EmailAdvanceDomainVerificationData = {
2704
2810
  body?: never;
2705
2811
  path: {
2706
2812
  id: EmailDomainId;
@@ -2708,7 +2814,7 @@ export type EmailCheckDomainVerificationData = {
2708
2814
  query?: never;
2709
2815
  url: "/v1/email/domains/{id}/verification";
2710
2816
  };
2711
- export type EmailCheckDomainVerificationErrors = {
2817
+ export type EmailAdvanceDomainVerificationErrors = {
2712
2818
  /**
2713
2819
  * UnauthorizedError
2714
2820
  */
@@ -2721,6 +2827,18 @@ export type EmailCheckDomainVerificationErrors = {
2721
2827
  * ResourceNotFoundError
2722
2828
  */
2723
2829
  404: ResourceNotFoundError;
2830
+ /**
2831
+ * ConflictError
2832
+ */
2833
+ 409: ConflictError;
2834
+ /**
2835
+ * ValidationError
2836
+ */
2837
+ 422: ValidationError;
2838
+ /**
2839
+ * RateLimitedError
2840
+ */
2841
+ 429: RateLimitedError;
2724
2842
  /**
2725
2843
  * InternalError
2726
2844
  */
@@ -2730,14 +2848,14 @@ export type EmailCheckDomainVerificationErrors = {
2730
2848
  */
2731
2849
  502: EmailChannelError;
2732
2850
  };
2733
- export type EmailCheckDomainVerificationError = EmailCheckDomainVerificationErrors[keyof EmailCheckDomainVerificationErrors];
2734
- export type EmailCheckDomainVerificationResponses = {
2851
+ export type EmailAdvanceDomainVerificationError = EmailAdvanceDomainVerificationErrors[keyof EmailAdvanceDomainVerificationErrors];
2852
+ export type EmailAdvanceDomainVerificationResponses = {
2735
2853
  /**
2736
- * EmailDomainVerificationStatusResponse
2854
+ * EmailDomainVerification
2737
2855
  */
2738
- 200: EmailDomainVerificationStatusResponse;
2856
+ 200: EmailDomainVerification;
2739
2857
  };
2740
- export type EmailCheckDomainVerificationResponse = EmailCheckDomainVerificationResponses[keyof EmailCheckDomainVerificationResponses];
2858
+ export type EmailAdvanceDomainVerificationResponse = EmailAdvanceDomainVerificationResponses[keyof EmailAdvanceDomainVerificationResponses];
2741
2859
  export type EmailRemoveDomainData = {
2742
2860
  body?: never;
2743
2861
  path: {
@@ -2848,7 +2966,9 @@ export type EmailGetDomainConnectData = {
2848
2966
  path: {
2849
2967
  id: EmailDomainId;
2850
2968
  };
2851
- query?: never;
2969
+ query: {
2970
+ mode: "send-only" | "send-and-receive";
2971
+ };
2852
2972
  url: "/v1/email/domains/{id}/domain-connect";
2853
2973
  };
2854
2974
  export type EmailGetDomainConnectErrors = {
@@ -2872,18 +2992,14 @@ export type EmailGetDomainConnectErrors = {
2872
2992
  export type EmailGetDomainConnectError = EmailGetDomainConnectErrors[keyof EmailGetDomainConnectErrors];
2873
2993
  export type EmailGetDomainConnectResponses = {
2874
2994
  /**
2875
- * Success
2995
+ * DomainConnectEligibility
2876
2996
  */
2877
- 200: {
2878
- eligible: boolean;
2879
- reason?: string | null | undefined;
2880
- providerName?: string | null | undefined;
2881
- };
2997
+ 200: DomainConnectEligibility;
2882
2998
  };
2883
2999
  export type EmailGetDomainConnectResponse = EmailGetDomainConnectResponses[keyof EmailGetDomainConnectResponses];
2884
3000
  export type EmailBuildDomainConnectApplyUrlData = {
2885
3001
  body: {
2886
- inbound?: boolean | null | undefined;
3002
+ mode: "send-only" | "send-and-receive";
2887
3003
  };
2888
3004
  path: {
2889
3005
  id: EmailDomainId;
@@ -2920,11 +3036,9 @@ export type EmailBuildDomainConnectApplyUrlErrors = {
2920
3036
  export type EmailBuildDomainConnectApplyUrlError = EmailBuildDomainConnectApplyUrlErrors[keyof EmailBuildDomainConnectApplyUrlErrors];
2921
3037
  export type EmailBuildDomainConnectApplyUrlResponses = {
2922
3038
  /**
2923
- * Success
3039
+ * DomainConnectApplyUrlResult
2924
3040
  */
2925
- 200: {
2926
- url: string;
2927
- };
3041
+ 200: DomainConnectApplyUrlResult;
2928
3042
  };
2929
3043
  export type EmailBuildDomainConnectApplyUrlResponse = EmailBuildDomainConnectApplyUrlResponses[keyof EmailBuildDomainConnectApplyUrlResponses];
2930
3044
  export type EmailCompleteDomainConnectData = {
@@ -2963,11 +3077,9 @@ export type EmailCompleteDomainConnectErrors = {
2963
3077
  export type EmailCompleteDomainConnectError = EmailCompleteDomainConnectErrors[keyof EmailCompleteDomainConnectErrors];
2964
3078
  export type EmailCompleteDomainConnectResponses = {
2965
3079
  /**
2966
- * Success
3080
+ * DomainConnectCompleteResult
2967
3081
  */
2968
- 200: {
2969
- status: "applied" | "cancelled" | "invalid";
2970
- };
3082
+ 200: DomainConnectCompleteResult;
2971
3083
  };
2972
3084
  export type EmailCompleteDomainConnectResponse = EmailCompleteDomainConnectResponses[keyof EmailCompleteDomainConnectResponses];
2973
3085
  export type EmailEnableReceivingData = {
@@ -3017,39 +3129,6 @@ export type EmailEnableReceivingResponses = {
3017
3129
  };
3018
3130
  };
3019
3131
  export type EmailEnableReceivingResponse = EmailEnableReceivingResponses[keyof EmailEnableReceivingResponses];
3020
- export type EmailGetDomainStatusData = {
3021
- body?: never;
3022
- path: {
3023
- id: EmailDomainId;
3024
- };
3025
- query?: never;
3026
- url: "/v1/email/domains/{id}/status";
3027
- };
3028
- export type EmailGetDomainStatusErrors = {
3029
- /**
3030
- * UnauthorizedError
3031
- */
3032
- 401: UnauthorizedError;
3033
- /**
3034
- * ForbiddenError
3035
- */
3036
- 403: ForbiddenError;
3037
- /**
3038
- * ResourceNotFoundError
3039
- */
3040
- 404: ResourceNotFoundError;
3041
- };
3042
- export type EmailGetDomainStatusError = EmailGetDomainStatusErrors[keyof EmailGetDomainStatusErrors];
3043
- export type EmailGetDomainStatusResponses = {
3044
- /**
3045
- * Success
3046
- */
3047
- 200: {
3048
- domain: string;
3049
- status: "pending" | "verified" | "failed";
3050
- };
3051
- };
3052
- export type EmailGetDomainStatusResponse = EmailGetDomainStatusResponses[keyof EmailGetDomainStatusResponses];
3053
3132
  export type EmailSetDefaultDomainData = {
3054
3133
  body?: never;
3055
3134
  path: {
@@ -3209,15 +3288,15 @@ export type EmailUpdateDomainConfigResponses = {
3209
3288
  };
3210
3289
  };
3211
3290
  export type EmailUpdateDomainConfigResponse = EmailUpdateDomainConfigResponses[keyof EmailUpdateDomainConfigResponses];
3212
- export type EmailDisableBrandedTrackingData = {
3291
+ export type EmailDisableCustomTrackingData = {
3213
3292
  body?: never;
3214
3293
  path: {
3215
3294
  id: EmailDomainId;
3216
3295
  };
3217
3296
  query?: never;
3218
- url: "/v1/email/domains/{id}/branded-tracking";
3297
+ url: "/v1/email/domains/{id}/custom-tracking";
3219
3298
  };
3220
- export type EmailDisableBrandedTrackingErrors = {
3299
+ export type EmailDisableCustomTrackingErrors = {
3221
3300
  /**
3222
3301
  * UnauthorizedError
3223
3302
  */
@@ -3239,23 +3318,23 @@ export type EmailDisableBrandedTrackingErrors = {
3239
3318
  */
3240
3319
  502: EmailChannelError;
3241
3320
  };
3242
- export type EmailDisableBrandedTrackingError = EmailDisableBrandedTrackingErrors[keyof EmailDisableBrandedTrackingErrors];
3243
- export type EmailDisableBrandedTrackingResponses = {
3321
+ export type EmailDisableCustomTrackingError = EmailDisableCustomTrackingErrors[keyof EmailDisableCustomTrackingErrors];
3322
+ export type EmailDisableCustomTrackingResponses = {
3244
3323
  /**
3245
3324
  * SuccessResult
3246
3325
  */
3247
3326
  200: SuccessResult;
3248
3327
  };
3249
- export type EmailDisableBrandedTrackingResponse = EmailDisableBrandedTrackingResponses[keyof EmailDisableBrandedTrackingResponses];
3250
- export type EmailGetBrandedTrackingData = {
3328
+ export type EmailDisableCustomTrackingResponse = EmailDisableCustomTrackingResponses[keyof EmailDisableCustomTrackingResponses];
3329
+ export type EmailGetCustomTrackingData = {
3251
3330
  body?: never;
3252
3331
  path: {
3253
3332
  id: EmailDomainId;
3254
3333
  };
3255
3334
  query?: never;
3256
- url: "/v1/email/domains/{id}/branded-tracking";
3335
+ url: "/v1/email/domains/{id}/custom-tracking";
3257
3336
  };
3258
- export type EmailGetBrandedTrackingErrors = {
3337
+ export type EmailGetCustomTrackingErrors = {
3259
3338
  /**
3260
3339
  * UnauthorizedError
3261
3340
  */
@@ -3269,15 +3348,15 @@ export type EmailGetBrandedTrackingErrors = {
3269
3348
  */
3270
3349
  500: InternalError;
3271
3350
  };
3272
- export type EmailGetBrandedTrackingError = EmailGetBrandedTrackingErrors[keyof EmailGetBrandedTrackingErrors];
3273
- export type EmailGetBrandedTrackingResponses = {
3351
+ export type EmailGetCustomTrackingError = EmailGetCustomTrackingErrors[keyof EmailGetCustomTrackingErrors];
3352
+ export type EmailGetCustomTrackingResponses = {
3274
3353
  /**
3275
- * BrandedTrackingStatus
3354
+ * CustomTrackingStatus
3276
3355
  */
3277
- 200: BrandedTrackingStatus;
3356
+ 200: CustomTrackingStatus;
3278
3357
  };
3279
- export type EmailGetBrandedTrackingResponse = EmailGetBrandedTrackingResponses[keyof EmailGetBrandedTrackingResponses];
3280
- export type EmailEnableBrandedTrackingData = {
3358
+ export type EmailGetCustomTrackingResponse = EmailGetCustomTrackingResponses[keyof EmailGetCustomTrackingResponses];
3359
+ export type EmailEnableCustomTrackingData = {
3281
3360
  body: {
3282
3361
  label?: string | null | undefined;
3283
3362
  };
@@ -3285,9 +3364,9 @@ export type EmailEnableBrandedTrackingData = {
3285
3364
  id: EmailDomainId;
3286
3365
  };
3287
3366
  query?: never;
3288
- url: "/v1/email/domains/{id}/branded-tracking";
3367
+ url: "/v1/email/domains/{id}/custom-tracking";
3289
3368
  };
3290
- export type EmailEnableBrandedTrackingErrors = {
3369
+ export type EmailEnableCustomTrackingErrors = {
3291
3370
  /**
3292
3371
  * UnauthorizedError
3293
3372
  */
@@ -3313,27 +3392,23 @@ export type EmailEnableBrandedTrackingErrors = {
3313
3392
  */
3314
3393
  502: EmailChannelError | BillingProviderError;
3315
3394
  };
3316
- export type EmailEnableBrandedTrackingError = EmailEnableBrandedTrackingErrors[keyof EmailEnableBrandedTrackingErrors];
3317
- export type EmailEnableBrandedTrackingResponses = {
3395
+ export type EmailEnableCustomTrackingError = EmailEnableCustomTrackingErrors[keyof EmailEnableCustomTrackingErrors];
3396
+ export type EmailEnableCustomTrackingResponses = {
3318
3397
  /**
3319
- * BrandedTrackingStatus
3398
+ * CustomTrackingStatus
3320
3399
  */
3321
- 200: BrandedTrackingStatus;
3400
+ 200: CustomTrackingStatus;
3322
3401
  };
3323
- export type EmailEnableBrandedTrackingResponse = EmailEnableBrandedTrackingResponses[keyof EmailEnableBrandedTrackingResponses];
3324
- export type EmailListSendersData = {
3402
+ export type EmailEnableCustomTrackingResponse = EmailEnableCustomTrackingResponses[keyof EmailEnableCustomTrackingResponses];
3403
+ export type EmailGetCustomTrackingDomainConnectData = {
3325
3404
  body?: never;
3326
- path?: never;
3327
- query?: {
3328
- page?: string | null | undefined;
3329
- limit?: string | null | undefined;
3330
- verificationStatus?: "pending" | "verified" | "failed" | null | undefined;
3331
- isActive?: string | null | undefined;
3332
- isDefault?: string | null | undefined;
3405
+ path: {
3406
+ id: EmailDomainId;
3333
3407
  };
3334
- url: "/v1/email/senders";
3408
+ query?: never;
3409
+ url: "/v1/email/domains/{id}/custom-tracking/domain-connect";
3335
3410
  };
3336
- export type EmailListSendersErrors = {
3411
+ export type EmailGetCustomTrackingDomainConnectErrors = {
3337
3412
  /**
3338
3413
  * UnauthorizedError
3339
3414
  */
@@ -3342,49 +3417,32 @@ export type EmailListSendersErrors = {
3342
3417
  * ForbiddenError
3343
3418
  */
3344
3419
  403: ForbiddenError;
3420
+ /**
3421
+ * ResourceNotFoundError
3422
+ */
3423
+ 404: ResourceNotFoundError;
3345
3424
  /**
3346
3425
  * InternalError
3347
3426
  */
3348
3427
  500: InternalError;
3349
3428
  };
3350
- export type EmailListSendersError = EmailListSendersErrors[keyof EmailListSendersErrors];
3351
- export type EmailListSendersResponses = {
3429
+ export type EmailGetCustomTrackingDomainConnectError = EmailGetCustomTrackingDomainConnectErrors[keyof EmailGetCustomTrackingDomainConnectErrors];
3430
+ export type EmailGetCustomTrackingDomainConnectResponses = {
3352
3431
  /**
3353
- * Success
3432
+ * DomainConnectEligibility
3354
3433
  */
3355
- 200: {
3356
- items: Array<{
3357
- id: EmailSenderId;
3358
- organizationId: string;
3359
- email: string;
3360
- name: string | null;
3361
- domainId: EmailDomainId | null;
3362
- verificationStatus: "pending" | "verified" | "failed";
3363
- verifiedAt: string | null;
3364
- verificationToken: string | null;
3365
- isDefault: boolean;
3366
- replyToEmails: Array<string> | null;
3367
- deliverability: DeliverabilityFacts;
3368
- isActive: boolean;
3369
- createdAt: string;
3370
- updatedAt: string;
3371
- }>;
3372
- pagination: PaginationMeta;
3373
- };
3434
+ 200: DomainConnectEligibility;
3374
3435
  };
3375
- export type EmailListSendersResponse = EmailListSendersResponses[keyof EmailListSendersResponses];
3376
- export type EmailAddSenderData = {
3377
- body: {
3378
- email: string;
3379
- domainId?: EmailDomainId | null | undefined;
3380
- name?: string | null | null | undefined;
3381
- replyToEmails?: Array<string> | null | null | undefined;
3436
+ export type EmailGetCustomTrackingDomainConnectResponse = EmailGetCustomTrackingDomainConnectResponses[keyof EmailGetCustomTrackingDomainConnectResponses];
3437
+ export type EmailBuildCustomTrackingDomainConnectApplyUrlData = {
3438
+ body?: never;
3439
+ path: {
3440
+ id: EmailDomainId;
3382
3441
  };
3383
- path?: never;
3384
3442
  query?: never;
3385
- url: "/v1/email/senders";
3443
+ url: "/v1/email/domains/{id}/custom-tracking/domain-connect/apply-url";
3386
3444
  };
3387
- export type EmailAddSenderErrors = {
3445
+ export type EmailBuildCustomTrackingDomainConnectApplyUrlErrors = {
3388
3446
  /**
3389
3447
  * UnauthorizedError
3390
3448
  */
@@ -3397,10 +3455,6 @@ export type EmailAddSenderErrors = {
3397
3455
  * ResourceNotFoundError
3398
3456
  */
3399
3457
  404: ResourceNotFoundError;
3400
- /**
3401
- * ConflictError
3402
- */
3403
- 409: ConflictError;
3404
3458
  /**
3405
3459
  * ValidationError
3406
3460
  */
@@ -3410,9 +3464,143 @@ export type EmailAddSenderErrors = {
3410
3464
  */
3411
3465
  500: InternalError;
3412
3466
  /**
3413
- * ExternalServiceError
3467
+ * EmailChannelError
3414
3468
  */
3415
- 502: ExternalServiceError;
3469
+ 502: EmailChannelError;
3470
+ };
3471
+ export type EmailBuildCustomTrackingDomainConnectApplyUrlError = EmailBuildCustomTrackingDomainConnectApplyUrlErrors[keyof EmailBuildCustomTrackingDomainConnectApplyUrlErrors];
3472
+ export type EmailBuildCustomTrackingDomainConnectApplyUrlResponses = {
3473
+ /**
3474
+ * DomainConnectApplyUrlResult
3475
+ */
3476
+ 200: DomainConnectApplyUrlResult;
3477
+ };
3478
+ export type EmailBuildCustomTrackingDomainConnectApplyUrlResponse = EmailBuildCustomTrackingDomainConnectApplyUrlResponses[keyof EmailBuildCustomTrackingDomainConnectApplyUrlResponses];
3479
+ export type EmailCompleteCustomTrackingDomainConnectData = {
3480
+ body: {
3481
+ state: string;
3482
+ error?: string | null | undefined;
3483
+ };
3484
+ path: {
3485
+ id: EmailDomainId;
3486
+ };
3487
+ query?: never;
3488
+ url: "/v1/email/domains/{id}/custom-tracking/domain-connect/complete";
3489
+ };
3490
+ export type EmailCompleteCustomTrackingDomainConnectErrors = {
3491
+ /**
3492
+ * UnauthorizedError
3493
+ */
3494
+ 401: UnauthorizedError;
3495
+ /**
3496
+ * ForbiddenError
3497
+ */
3498
+ 403: ForbiddenError;
3499
+ /**
3500
+ * InternalError
3501
+ */
3502
+ 500: InternalError;
3503
+ };
3504
+ export type EmailCompleteCustomTrackingDomainConnectError = EmailCompleteCustomTrackingDomainConnectErrors[keyof EmailCompleteCustomTrackingDomainConnectErrors];
3505
+ export type EmailCompleteCustomTrackingDomainConnectResponses = {
3506
+ /**
3507
+ * CustomTrackingDomainConnectCompleteResult
3508
+ */
3509
+ 200: CustomTrackingDomainConnectCompleteResult;
3510
+ };
3511
+ export type EmailCompleteCustomTrackingDomainConnectResponse = EmailCompleteCustomTrackingDomainConnectResponses[keyof EmailCompleteCustomTrackingDomainConnectResponses];
3512
+ export type EmailListSendersData = {
3513
+ body?: never;
3514
+ path?: never;
3515
+ query?: {
3516
+ page?: string | null | undefined;
3517
+ limit?: string | null | undefined;
3518
+ verificationStatus?: "pending" | "verified" | "failed" | null | undefined;
3519
+ isActive?: string | null | undefined;
3520
+ isDefault?: string | null | undefined;
3521
+ };
3522
+ url: "/v1/email/senders";
3523
+ };
3524
+ export type EmailListSendersErrors = {
3525
+ /**
3526
+ * UnauthorizedError
3527
+ */
3528
+ 401: UnauthorizedError;
3529
+ /**
3530
+ * ForbiddenError
3531
+ */
3532
+ 403: ForbiddenError;
3533
+ /**
3534
+ * InternalError
3535
+ */
3536
+ 500: InternalError;
3537
+ };
3538
+ export type EmailListSendersError = EmailListSendersErrors[keyof EmailListSendersErrors];
3539
+ export type EmailListSendersResponses = {
3540
+ /**
3541
+ * Success
3542
+ */
3543
+ 200: {
3544
+ items: Array<{
3545
+ id: EmailSenderId;
3546
+ organizationId: string;
3547
+ email: string;
3548
+ name: string | null;
3549
+ domainId: EmailDomainId | null;
3550
+ verificationStatus: "pending" | "verified" | "failed";
3551
+ verifiedAt: string | null;
3552
+ verificationToken: string | null;
3553
+ isDefault: boolean;
3554
+ replyToEmails: Array<string> | null;
3555
+ deliverability: DeliverabilityFacts;
3556
+ isActive: boolean;
3557
+ createdAt: string;
3558
+ updatedAt: string;
3559
+ }>;
3560
+ pagination: PaginationMeta;
3561
+ };
3562
+ };
3563
+ export type EmailListSendersResponse = EmailListSendersResponses[keyof EmailListSendersResponses];
3564
+ export type EmailAddSenderData = {
3565
+ body: {
3566
+ email: string;
3567
+ domainId?: EmailDomainId | null | undefined;
3568
+ name?: string | null | null | undefined;
3569
+ replyToEmails?: Array<string> | null | null | undefined;
3570
+ };
3571
+ path?: never;
3572
+ query?: never;
3573
+ url: "/v1/email/senders";
3574
+ };
3575
+ export type EmailAddSenderErrors = {
3576
+ /**
3577
+ * UnauthorizedError
3578
+ */
3579
+ 401: UnauthorizedError;
3580
+ /**
3581
+ * ForbiddenError
3582
+ */
3583
+ 403: ForbiddenError;
3584
+ /**
3585
+ * ResourceNotFoundError
3586
+ */
3587
+ 404: ResourceNotFoundError;
3588
+ /**
3589
+ * ConflictError
3590
+ */
3591
+ 409: ConflictError;
3592
+ /**
3593
+ * ValidationError
3594
+ */
3595
+ 422: ValidationError;
3596
+ /**
3597
+ * InternalError
3598
+ */
3599
+ 500: InternalError;
3600
+ /**
3601
+ * ExternalServiceError
3602
+ */
3603
+ 502: ExternalServiceError;
3416
3604
  };
3417
3605
  export type EmailAddSenderError = EmailAddSenderErrors[keyof EmailAddSenderErrors];
3418
3606
  export type EmailAddSenderResponses = {
@@ -4504,9 +4692,9 @@ export type ConversationsGetByIdErrors = {
4504
4692
  export type ConversationsGetByIdError = ConversationsGetByIdErrors[keyof ConversationsGetByIdErrors];
4505
4693
  export type ConversationsGetByIdResponses = {
4506
4694
  /**
4507
- * Conversation
4695
+ * ConversationDetail
4508
4696
  */
4509
- 200: Conversation;
4697
+ 200: ConversationDetail;
4510
4698
  };
4511
4699
  export type ConversationsGetByIdResponse = ConversationsGetByIdResponses[keyof ConversationsGetByIdResponses];
4512
4700
  export type ConversationsUpdateData = {
@@ -4722,7 +4910,7 @@ export type ContactsListResponses = {
4722
4910
  * Success
4723
4911
  */
4724
4912
  200: {
4725
- items: Array<Contact>;
4913
+ items: Array<ContactListItem>;
4726
4914
  pagination: PaginationMeta;
4727
4915
  };
4728
4916
  };
@@ -4737,39 +4925,6 @@ export type ContactsCreateData = {
4737
4925
  humanProfile?: HumanProfile | null | null | undefined;
4738
4926
  capabilities?: Array<string> | null | undefined;
4739
4927
  tags?: Array<string> | null | undefined;
4740
- engagement?: {
4741
- totalInteractions: number;
4742
- lastActiveAt: string;
4743
- averageResponseTime: number;
4744
- satisfactionScore?: number | null | undefined;
4745
- channels: {
4746
- sms?: {
4747
- sent: number;
4748
- received: number;
4749
- failed: number;
4750
- lastAt?: string | null | undefined;
4751
- } | null | undefined;
4752
- whatsapp?: {
4753
- sent: number;
4754
- received: number;
4755
- failed: number;
4756
- lastAt?: string | null | undefined;
4757
- } | null | undefined;
4758
- email?: {
4759
- sent: number;
4760
- received: number;
4761
- failed: number;
4762
- bounced: number;
4763
- lastAt?: string | null | undefined;
4764
- } | null | undefined;
4765
- };
4766
- performance?: {
4767
- successRate: number;
4768
- escalationRate: number;
4769
- resolutionRate: number;
4770
- averageHandlingTime: number;
4771
- } | null | undefined;
4772
- } | null | undefined;
4773
4928
  accessLevel?: "public" | "authenticated" | "vip" | "internal" | null | undefined;
4774
4929
  accessConfig?: ContactAccessConfig | null | null | undefined;
4775
4930
  preferences?: ContactPreferences | null | null | undefined;
@@ -4994,39 +5149,6 @@ export type ContactsUpdateData = {
4994
5149
  humanProfile?: HumanProfile | null | null | undefined;
4995
5150
  capabilities?: Array<string> | null | undefined;
4996
5151
  tags?: Array<string> | null | undefined;
4997
- engagement?: {
4998
- totalInteractions: number;
4999
- lastActiveAt: string;
5000
- averageResponseTime: number;
5001
- satisfactionScore?: number | null | undefined;
5002
- channels: {
5003
- sms?: {
5004
- sent: number;
5005
- received: number;
5006
- failed: number;
5007
- lastAt?: string | null | undefined;
5008
- } | null | undefined;
5009
- whatsapp?: {
5010
- sent: number;
5011
- received: number;
5012
- failed: number;
5013
- lastAt?: string | null | undefined;
5014
- } | null | undefined;
5015
- email?: {
5016
- sent: number;
5017
- received: number;
5018
- failed: number;
5019
- bounced: number;
5020
- lastAt?: string | null | undefined;
5021
- } | null | undefined;
5022
- };
5023
- performance?: {
5024
- successRate: number;
5025
- escalationRate: number;
5026
- resolutionRate: number;
5027
- averageHandlingTime: number;
5028
- } | null | undefined;
5029
- } | null | undefined;
5030
5152
  accessLevel?: "public" | "authenticated" | "vip" | "internal" | null | undefined;
5031
5153
  accessConfig?: ContactAccessConfig | null | null | undefined;
5032
5154
  preferences?: ContactPreferences | null | null | undefined;
@@ -6000,11 +6122,6 @@ export type TemplatesUpdateData = {
6000
6122
  category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | null | undefined;
6001
6123
  fromDefault?: TemplateFromDefault | null | null | undefined;
6002
6124
  replyToDefault?: Array<string> | null | null | undefined;
6003
- source?: string | null | undefined;
6004
- subject?: string | null | undefined;
6005
- headers?: {
6006
- [key: string]: string;
6007
- } | null | null | undefined;
6008
6125
  variableSchema?: Array<TemplateVariable> | null | null | undefined;
6009
6126
  compliance?: TemplateCompliance | null | null | undefined;
6010
6127
  performance?: TemplatePerformance | null | null | undefined;
@@ -6092,21 +6209,57 @@ export type TemplatesApproveResponses = {
6092
6209
  200: Template;
6093
6210
  };
6094
6211
  export type TemplatesApproveResponse = TemplatesApproveResponses[keyof TemplatesApproveResponses];
6095
- export type TemplatesRenderData = {
6212
+ export type TemplateDocumentsBootstrapData = {
6096
6213
  body: {
6097
- data: {
6098
- variables?: {
6099
- [key: string]: string;
6100
- } | null | undefined;
6101
- };
6214
+ templateId: TemplateId;
6102
6215
  };
6216
+ path?: never;
6217
+ query?: never;
6218
+ url: "/v1/template-documents/bootstrap";
6219
+ };
6220
+ export type TemplateDocumentsBootstrapErrors = {
6221
+ /**
6222
+ * UnauthorizedError
6223
+ */
6224
+ 401: UnauthorizedError;
6225
+ /**
6226
+ * ForbiddenError
6227
+ */
6228
+ 403: ForbiddenError;
6229
+ /**
6230
+ * ResourceNotFoundError
6231
+ */
6232
+ 404: ResourceNotFoundError;
6233
+ /**
6234
+ * ConflictError
6235
+ */
6236
+ 409: ConflictError;
6237
+ /**
6238
+ * ValidationError
6239
+ */
6240
+ 422: ValidationError;
6241
+ /**
6242
+ * InternalError
6243
+ */
6244
+ 500: InternalError;
6245
+ };
6246
+ export type TemplateDocumentsBootstrapError = TemplateDocumentsBootstrapErrors[keyof TemplateDocumentsBootstrapErrors];
6247
+ export type TemplateDocumentsBootstrapResponses = {
6248
+ /**
6249
+ * Success
6250
+ */
6251
+ 200: Objects;
6252
+ };
6253
+ export type TemplateDocumentsBootstrapResponse = TemplateDocumentsBootstrapResponses[keyof TemplateDocumentsBootstrapResponses];
6254
+ export type TemplateDocumentsGetData = {
6255
+ body?: never;
6103
6256
  path: {
6104
- id: TemplateId;
6257
+ templateId: TemplateId;
6105
6258
  };
6106
6259
  query?: never;
6107
- url: "/v1/templates/{id}/render";
6260
+ url: "/v1/template-documents/{templateId}";
6108
6261
  };
6109
- export type TemplatesRenderErrors = {
6262
+ export type TemplateDocumentsGetErrors = {
6110
6263
  /**
6111
6264
  * UnauthorizedError
6112
6265
  */
@@ -6119,6 +6272,10 @@ export type TemplatesRenderErrors = {
6119
6272
  * ResourceNotFoundError
6120
6273
  */
6121
6274
  404: ResourceNotFoundError;
6275
+ /**
6276
+ * ConflictError
6277
+ */
6278
+ 409: ConflictError;
6122
6279
  /**
6123
6280
  * ValidationError
6124
6281
  */
@@ -6128,47 +6285,70 @@ export type TemplatesRenderErrors = {
6128
6285
  */
6129
6286
  500: InternalError;
6130
6287
  };
6131
- export type TemplatesRenderError = TemplatesRenderErrors[keyof TemplatesRenderErrors];
6132
- export type TemplatesRenderResponses = {
6288
+ export type TemplateDocumentsGetError = TemplateDocumentsGetErrors[keyof TemplateDocumentsGetErrors];
6289
+ export type TemplateDocumentsGetResponses = {
6133
6290
  /**
6134
6291
  * Success
6135
6292
  */
6136
- 200: {
6137
- channel: "sms" | "whatsapp" | "email";
6138
- rendered: {
6139
- subject?: string | null | undefined;
6140
- html?: string | null | undefined;
6141
- text: string;
6142
- };
6143
- sms?: {
6144
- encoding: string | null;
6145
- estimatedSegments: number | null;
6146
- } | null | undefined;
6147
- whatsapp?: {
6148
- name: string;
6149
- language: string;
6150
- category: string;
6151
- headerContent?: string | null | undefined;
6152
- bodyContent: string;
6153
- footerContent?: string | null | undefined;
6154
- buttons: Array<{
6155
- [key: string]: JsonValue;
6156
- }>;
6157
- } | null | undefined;
6158
- missingVariables: Array<string>;
6159
- errors: Array<string>;
6293
+ 200: Objects;
6294
+ };
6295
+ export type TemplateDocumentsGetResponse = TemplateDocumentsGetResponses[keyof TemplateDocumentsGetResponses];
6296
+ export type TemplateDocumentsReplaceData = {
6297
+ body: {
6298
+ expectedRevision: string;
6299
+ source: string;
6160
6300
  };
6301
+ path: {
6302
+ templateId: TemplateId;
6303
+ };
6304
+ query?: never;
6305
+ url: "/v1/template-documents/{templateId}/source";
6161
6306
  };
6162
- export type TemplatesRenderResponse = TemplatesRenderResponses[keyof TemplatesRenderResponses];
6163
- export type TemplatesDuplicateData = {
6164
- body?: never;
6307
+ export type TemplateDocumentsReplaceErrors = {
6308
+ /**
6309
+ * UnauthorizedError
6310
+ */
6311
+ 401: UnauthorizedError;
6312
+ /**
6313
+ * ForbiddenError
6314
+ */
6315
+ 403: ForbiddenError;
6316
+ /**
6317
+ * ResourceNotFoundError
6318
+ */
6319
+ 404: ResourceNotFoundError;
6320
+ /**
6321
+ * ConflictError
6322
+ */
6323
+ 409: ConflictError;
6324
+ /**
6325
+ * ValidationError
6326
+ */
6327
+ 422: ValidationError;
6328
+ /**
6329
+ * InternalError
6330
+ */
6331
+ 500: InternalError;
6332
+ };
6333
+ export type TemplateDocumentsReplaceError = TemplateDocumentsReplaceErrors[keyof TemplateDocumentsReplaceErrors];
6334
+ export type TemplateDocumentsReplaceResponses = {
6335
+ /**
6336
+ * Success
6337
+ */
6338
+ 200: Objects;
6339
+ };
6340
+ export type TemplateDocumentsReplaceResponse = TemplateDocumentsReplaceResponses[keyof TemplateDocumentsReplaceResponses];
6341
+ export type TemplateDocumentsSaveData = {
6342
+ body: {
6343
+ revision: string;
6344
+ };
6165
6345
  path: {
6166
- id: TemplateId;
6346
+ templateId: TemplateId;
6167
6347
  };
6168
6348
  query?: never;
6169
- url: "/v1/templates/{id}/duplicate";
6349
+ url: "/v1/template-documents/{templateId}/save";
6170
6350
  };
6171
- export type TemplatesDuplicateErrors = {
6351
+ export type TemplateDocumentsSaveErrors = {
6172
6352
  /**
6173
6353
  * UnauthorizedError
6174
6354
  */
@@ -6185,28 +6365,45 @@ export type TemplatesDuplicateErrors = {
6185
6365
  * ConflictError
6186
6366
  */
6187
6367
  409: ConflictError;
6368
+ /**
6369
+ * ValidationError
6370
+ */
6371
+ 422: ValidationError;
6188
6372
  /**
6189
6373
  * InternalError
6190
6374
  */
6191
6375
  500: InternalError;
6192
6376
  };
6193
- export type TemplatesDuplicateError = TemplatesDuplicateErrors[keyof TemplatesDuplicateErrors];
6194
- export type TemplatesDuplicateResponses = {
6377
+ export type TemplateDocumentsSaveError = TemplateDocumentsSaveErrors[keyof TemplateDocumentsSaveErrors];
6378
+ export type TemplateDocumentsSaveResponses = {
6195
6379
  /**
6196
6380
  * Success
6197
6381
  */
6198
- 201: Template;
6382
+ 200: {
6383
+ id: string;
6384
+ templateId: TemplateId;
6385
+ documentRevision: string;
6386
+ sourceDigest: string;
6387
+ compilerVersion: string;
6388
+ createdAt: string;
6389
+ versionId: string;
6390
+ };
6199
6391
  };
6200
- export type TemplatesDuplicateResponse = TemplatesDuplicateResponses[keyof TemplatesDuplicateResponses];
6201
- export type TemplatesPublishData = {
6202
- body?: never;
6392
+ export type TemplateDocumentsSaveResponse = TemplateDocumentsSaveResponses[keyof TemplateDocumentsSaveResponses];
6393
+ export type TemplateDocumentsRenderData = {
6394
+ body: {
6395
+ revision: string;
6396
+ variables?: {
6397
+ [key: string]: JsonValue;
6398
+ } | null | undefined;
6399
+ };
6203
6400
  path: {
6204
- id: TemplateId;
6401
+ templateId: TemplateId;
6205
6402
  };
6206
6403
  query?: never;
6207
- url: "/v1/templates/{id}/publish";
6404
+ url: "/v1/template-documents/{templateId}/render";
6208
6405
  };
6209
- export type TemplatesPublishErrors = {
6406
+ export type TemplateDocumentsRenderErrors = {
6210
6407
  /**
6211
6408
  * UnauthorizedError
6212
6409
  */
@@ -6232,23 +6429,28 @@ export type TemplatesPublishErrors = {
6232
6429
  */
6233
6430
  500: InternalError;
6234
6431
  };
6235
- export type TemplatesPublishError = TemplatesPublishErrors[keyof TemplatesPublishErrors];
6236
- export type TemplatesPublishResponses = {
6432
+ export type TemplateDocumentsRenderError = TemplateDocumentsRenderErrors[keyof TemplateDocumentsRenderErrors];
6433
+ export type TemplateDocumentsRenderResponses = {
6237
6434
  /**
6238
- * Template
6435
+ * Success
6239
6436
  */
6240
- 200: Template;
6437
+ 200: Objects3;
6241
6438
  };
6242
- export type TemplatesPublishResponse = TemplatesPublishResponses[keyof TemplatesPublishResponses];
6243
- export type TemplatesUnpublishData = {
6244
- body?: never;
6439
+ export type TemplateDocumentsRenderResponse = TemplateDocumentsRenderResponses[keyof TemplateDocumentsRenderResponses];
6440
+ export type TemplateDocumentsSpamCheckData = {
6441
+ body: {
6442
+ revision: string;
6443
+ variables?: {
6444
+ [key: string]: JsonValue;
6445
+ } | null | undefined;
6446
+ };
6245
6447
  path: {
6246
- id: TemplateId;
6448
+ templateId: TemplateId;
6247
6449
  };
6248
6450
  query?: never;
6249
- url: "/v1/templates/{id}/unpublish";
6451
+ url: "/v1/template-documents/{templateId}/spam-check";
6250
6452
  };
6251
- export type TemplatesUnpublishErrors = {
6453
+ export type TemplateDocumentsSpamCheckErrors = {
6252
6454
  /**
6253
6455
  * UnauthorizedError
6254
6456
  */
@@ -6261,6 +6463,10 @@ export type TemplatesUnpublishErrors = {
6261
6463
  * ResourceNotFoundError
6262
6464
  */
6263
6465
  404: ResourceNotFoundError;
6466
+ /**
6467
+ * ConflictError
6468
+ */
6469
+ 409: ConflictError;
6264
6470
  /**
6265
6471
  * ValidationError
6266
6472
  */
@@ -6270,23 +6476,165 @@ export type TemplatesUnpublishErrors = {
6270
6476
  */
6271
6477
  500: InternalError;
6272
6478
  };
6273
- export type TemplatesUnpublishError = TemplatesUnpublishErrors[keyof TemplatesUnpublishErrors];
6274
- export type TemplatesUnpublishResponses = {
6479
+ export type TemplateDocumentsSpamCheckError = TemplateDocumentsSpamCheckErrors[keyof TemplateDocumentsSpamCheckErrors];
6480
+ export type TemplateDocumentsSpamCheckResponses = {
6275
6481
  /**
6276
- * Template
6482
+ * Success
6277
6483
  */
6278
- 200: Template;
6484
+ 200: {
6485
+ score: number;
6486
+ severity: "low" | "medium" | "high";
6487
+ issues: Array<{
6488
+ rule: string;
6489
+ description: string;
6490
+ severity: "low" | "medium" | "high";
6491
+ score: number;
6492
+ }>;
6493
+ recommendations: Array<string>;
6494
+ };
6495
+ };
6496
+ export type TemplateDocumentsSpamCheckResponse = TemplateDocumentsSpamCheckResponses[keyof TemplateDocumentsSpamCheckResponses];
6497
+ export type TemplateDocumentsTestSendData = {
6498
+ body: {
6499
+ revision: string;
6500
+ to: string;
6501
+ variables?: {
6502
+ [key: string]: JsonValue;
6503
+ } | null | undefined;
6504
+ };
6505
+ path: {
6506
+ templateId: TemplateId;
6507
+ };
6508
+ query?: never;
6509
+ url: "/v1/template-documents/{templateId}/send-test";
6510
+ };
6511
+ export type TemplateDocumentsTestSendErrors = {
6512
+ /**
6513
+ * UnauthorizedError
6514
+ */
6515
+ 401: UnauthorizedError;
6516
+ /**
6517
+ * PaymentRequiredError
6518
+ */
6519
+ 402: PaymentRequiredError;
6520
+ /**
6521
+ * ForbiddenError
6522
+ */
6523
+ 403: ForbiddenError;
6524
+ /**
6525
+ * ResourceNotFoundError
6526
+ */
6527
+ 404: ResourceNotFoundError;
6528
+ /**
6529
+ * ConflictError
6530
+ */
6531
+ 409: ConflictError;
6532
+ /**
6533
+ * ValidationError
6534
+ */
6535
+ 422: ValidationError;
6536
+ /**
6537
+ * InternalError | WebhookEnqueueError
6538
+ */
6539
+ 500: InternalError | WebhookEnqueueError;
6540
+ /**
6541
+ * BillingProviderError
6542
+ */
6543
+ 502: BillingProviderError;
6544
+ };
6545
+ export type TemplateDocumentsTestSendError = TemplateDocumentsTestSendErrors[keyof TemplateDocumentsTestSendErrors];
6546
+ export type TemplateDocumentsTestSendResponses = {
6547
+ /**
6548
+ * Success
6549
+ */
6550
+ 200: {
6551
+ messageId: string;
6552
+ status: string;
6553
+ rendered: Objects3;
6554
+ };
6555
+ };
6556
+ export type TemplateDocumentsTestSendResponse = TemplateDocumentsTestSendResponses[keyof TemplateDocumentsTestSendResponses];
6557
+ export type TemplateDocumentsSendData = {
6558
+ body: {
6559
+ revision: string;
6560
+ to: Array<{
6561
+ address: string;
6562
+ name?: string | null | undefined;
6563
+ }>;
6564
+ variables?: {
6565
+ [key: string]: JsonValue;
6566
+ } | null | undefined;
6567
+ schedule?: string | null | null | undefined;
6568
+ };
6569
+ path: {
6570
+ templateId: TemplateId;
6571
+ };
6572
+ query?: never;
6573
+ url: "/v1/template-documents/{templateId}/send";
6574
+ };
6575
+ export type TemplateDocumentsSendErrors = {
6576
+ /**
6577
+ * UnauthorizedError
6578
+ */
6579
+ 401: UnauthorizedError;
6580
+ /**
6581
+ * PaymentRequiredError
6582
+ */
6583
+ 402: PaymentRequiredError;
6584
+ /**
6585
+ * ForbiddenError | FlagDisabledError
6586
+ */
6587
+ 403: ForbiddenError | FlagDisabledError;
6588
+ /**
6589
+ * ResourceNotFoundError
6590
+ */
6591
+ 404: ResourceNotFoundError;
6592
+ /**
6593
+ * ConflictError
6594
+ */
6595
+ 409: ConflictError;
6596
+ /**
6597
+ * ValidationError
6598
+ */
6599
+ 422: ValidationError;
6600
+ /**
6601
+ * RateLimitedError
6602
+ */
6603
+ 429: RateLimitedError;
6604
+ /**
6605
+ * InternalError | WebhookEnqueueError
6606
+ */
6607
+ 500: InternalError | WebhookEnqueueError;
6608
+ /**
6609
+ * ExternalServiceError | BillingProviderError
6610
+ */
6611
+ 502: ExternalServiceError | BillingProviderError;
6612
+ };
6613
+ export type TemplateDocumentsSendError = TemplateDocumentsSendErrors[keyof TemplateDocumentsSendErrors];
6614
+ export type TemplateDocumentsSendResponses = {
6615
+ /**
6616
+ * Success
6617
+ */
6618
+ 200: {
6619
+ kind: "sent";
6620
+ messageId: string;
6621
+ acceptedAt: string;
6622
+ } | {
6623
+ kind: "scheduled";
6624
+ scheduledMessageId: string;
6625
+ scheduledFor: string;
6626
+ };
6279
6627
  };
6280
- export type TemplatesUnpublishResponse = TemplatesUnpublishResponses[keyof TemplatesUnpublishResponses];
6281
- export type TemplatesVersionHistoryData = {
6628
+ export type TemplateDocumentsSendResponse = TemplateDocumentsSendResponses[keyof TemplateDocumentsSendResponses];
6629
+ export type TemplateDocumentsVersionsData = {
6282
6630
  body?: never;
6283
6631
  path: {
6284
- id: TemplateId;
6632
+ templateId: TemplateId;
6285
6633
  };
6286
6634
  query?: never;
6287
- url: "/v1/templates/{id}/versions";
6635
+ url: "/v1/template-documents/{templateId}/versions";
6288
6636
  };
6289
- export type TemplatesVersionHistoryErrors = {
6637
+ export type TemplateDocumentsVersionsErrors = {
6290
6638
  /**
6291
6639
  * UnauthorizedError
6292
6640
  */
@@ -6299,41 +6647,50 @@ export type TemplatesVersionHistoryErrors = {
6299
6647
  * ResourceNotFoundError
6300
6648
  */
6301
6649
  404: ResourceNotFoundError;
6650
+ /**
6651
+ * ConflictError
6652
+ */
6653
+ 409: ConflictError;
6654
+ /**
6655
+ * ValidationError
6656
+ */
6657
+ 422: ValidationError;
6302
6658
  /**
6303
6659
  * InternalError
6304
6660
  */
6305
6661
  500: InternalError;
6306
6662
  };
6307
- export type TemplatesVersionHistoryError = TemplatesVersionHistoryErrors[keyof TemplatesVersionHistoryErrors];
6308
- export type TemplatesVersionHistoryResponses = {
6663
+ export type TemplateDocumentsVersionsError = TemplateDocumentsVersionsErrors[keyof TemplateDocumentsVersionsErrors];
6664
+ export type TemplateDocumentsVersionsResponses = {
6309
6665
  /**
6310
6666
  * Success
6311
6667
  */
6312
6668
  200: {
6313
6669
  versions: Array<{
6314
- id: string;
6670
+ versionId: TemplateSourceVersionId;
6315
6671
  version: number;
6316
6672
  status: string;
6317
6673
  isCurrent: boolean;
6318
- source: string | null;
6674
+ materializationId: string;
6675
+ documentRevision: string;
6676
+ sourceDigest: string;
6677
+ compilerVersion: string;
6319
6678
  publishedAt: string | null;
6320
- publishedBy: string | null;
6679
+ archivedAt: string | null;
6321
6680
  createdAt: string;
6322
- updatedAt: string;
6323
6681
  }>;
6324
6682
  };
6325
6683
  };
6326
- export type TemplatesVersionHistoryResponse = TemplatesVersionHistoryResponses[keyof TemplatesVersionHistoryResponses];
6327
- export type TemplatesRestoreVersionData = {
6684
+ export type TemplateDocumentsVersionsResponse = TemplateDocumentsVersionsResponses[keyof TemplateDocumentsVersionsResponses];
6685
+ export type TemplateDocumentsPublishData = {
6328
6686
  body?: never;
6329
6687
  path: {
6330
- id: TemplateId;
6331
- versionId: TemplateSourceVersionId;
6688
+ templateId: TemplateId;
6332
6689
  };
6333
6690
  query?: never;
6334
- url: "/v1/templates/{id}/versions/{versionId}/restore";
6691
+ url: "/v1/template-documents/{templateId}/publish";
6335
6692
  };
6336
- export type TemplatesRestoreVersionErrors = {
6693
+ export type TemplateDocumentsPublishErrors = {
6337
6694
  /**
6338
6695
  * UnauthorizedError
6339
6696
  */
@@ -6350,35 +6707,32 @@ export type TemplatesRestoreVersionErrors = {
6350
6707
  * ConflictError
6351
6708
  */
6352
6709
  409: ConflictError;
6710
+ /**
6711
+ * ValidationError
6712
+ */
6713
+ 422: ValidationError;
6353
6714
  /**
6354
6715
  * InternalError
6355
6716
  */
6356
6717
  500: InternalError;
6357
6718
  };
6358
- export type TemplatesRestoreVersionError = TemplatesRestoreVersionErrors[keyof TemplatesRestoreVersionErrors];
6359
- export type TemplatesRestoreVersionResponses = {
6719
+ export type TemplateDocumentsPublishError = TemplateDocumentsPublishErrors[keyof TemplateDocumentsPublishErrors];
6720
+ export type TemplateDocumentsPublishResponses = {
6360
6721
  /**
6361
- * Template
6722
+ * Success
6362
6723
  */
6363
- 200: Template;
6724
+ 200: Objects4;
6364
6725
  };
6365
- export type TemplatesRestoreVersionResponse = TemplatesRestoreVersionResponses[keyof TemplatesRestoreVersionResponses];
6366
- export type TemplatesSpamCheckData = {
6367
- body: {
6726
+ export type TemplateDocumentsPublishResponse = TemplateDocumentsPublishResponses[keyof TemplateDocumentsPublishResponses];
6727
+ export type TemplateDocumentsUnpublishData = {
6728
+ body?: never;
6729
+ path: {
6368
6730
  templateId: TemplateId;
6369
- inputs?: {
6370
- [key: string]: JsonValue;
6371
- } | null | undefined;
6372
- } | {
6373
- subject: string;
6374
- html: string;
6375
- text: string;
6376
6731
  };
6377
- path?: never;
6378
6732
  query?: never;
6379
- url: "/v1/templates/spam-check";
6733
+ url: "/v1/template-documents/{templateId}/unpublish";
6380
6734
  };
6381
- export type TemplatesSpamCheckErrors = {
6735
+ export type TemplateDocumentsUnpublishErrors = {
6382
6736
  /**
6383
6737
  * UnauthorizedError
6384
6738
  */
@@ -6391,6 +6745,10 @@ export type TemplatesSpamCheckErrors = {
6391
6745
  * ResourceNotFoundError
6392
6746
  */
6393
6747
  404: ResourceNotFoundError;
6748
+ /**
6749
+ * ConflictError
6750
+ */
6751
+ 409: ConflictError;
6394
6752
  /**
6395
6753
  * ValidationError
6396
6754
  */
@@ -6400,24 +6758,59 @@ export type TemplatesSpamCheckErrors = {
6400
6758
  */
6401
6759
  500: InternalError;
6402
6760
  };
6403
- export type TemplatesSpamCheckError = TemplatesSpamCheckErrors[keyof TemplatesSpamCheckErrors];
6404
- export type TemplatesSpamCheckResponses = {
6761
+ export type TemplateDocumentsUnpublishError = TemplateDocumentsUnpublishErrors[keyof TemplateDocumentsUnpublishErrors];
6762
+ export type TemplateDocumentsUnpublishResponses = {
6405
6763
  /**
6406
6764
  * Success
6407
6765
  */
6408
- 200: {
6409
- score: number;
6410
- severity: "low" | "medium" | "high";
6411
- issues: Array<{
6412
- rule: string;
6413
- description: string;
6414
- severity: "low" | "medium" | "high";
6415
- score: number;
6416
- }>;
6417
- recommendations: Array<string>;
6766
+ 200: Objects4;
6767
+ };
6768
+ export type TemplateDocumentsUnpublishResponse = TemplateDocumentsUnpublishResponses[keyof TemplateDocumentsUnpublishResponses];
6769
+ export type TemplateDocumentsRestoreData = {
6770
+ body: {
6771
+ expectedRevision: string;
6418
6772
  };
6773
+ path: {
6774
+ templateId: TemplateId;
6775
+ versionId: TemplateSourceVersionId;
6776
+ };
6777
+ query?: never;
6778
+ url: "/v1/template-documents/{templateId}/versions/{versionId}/restore";
6779
+ };
6780
+ export type TemplateDocumentsRestoreErrors = {
6781
+ /**
6782
+ * UnauthorizedError
6783
+ */
6784
+ 401: UnauthorizedError;
6785
+ /**
6786
+ * ForbiddenError
6787
+ */
6788
+ 403: ForbiddenError;
6789
+ /**
6790
+ * ResourceNotFoundError
6791
+ */
6792
+ 404: ResourceNotFoundError;
6793
+ /**
6794
+ * ConflictError
6795
+ */
6796
+ 409: ConflictError;
6797
+ /**
6798
+ * ValidationError
6799
+ */
6800
+ 422: ValidationError;
6801
+ /**
6802
+ * InternalError
6803
+ */
6804
+ 500: InternalError;
6805
+ };
6806
+ export type TemplateDocumentsRestoreError = TemplateDocumentsRestoreErrors[keyof TemplateDocumentsRestoreErrors];
6807
+ export type TemplateDocumentsRestoreResponses = {
6808
+ /**
6809
+ * Success
6810
+ */
6811
+ 200: Objects;
6419
6812
  };
6420
- export type TemplatesSpamCheckResponse = TemplatesSpamCheckResponses[keyof TemplatesSpamCheckResponses];
6813
+ export type TemplateDocumentsRestoreResponse = TemplateDocumentsRestoreResponses[keyof TemplateDocumentsRestoreResponses];
6421
6814
  export type DesignGetData = {
6422
6815
  body?: never;
6423
6816
  path?: never;
@@ -6519,7 +6912,7 @@ export type WebhooksCreateData = {
6519
6912
  body: {
6520
6913
  name: string;
6521
6914
  url: string;
6522
- 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">;
6915
+ 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">;
6523
6916
  channels?: Array<"sms" | "whatsapp" | "email"> | null | undefined;
6524
6917
  headers?: {
6525
6918
  [key: string]: string;
@@ -6643,7 +7036,7 @@ export type WebhooksUpdateData = {
6643
7036
  body: {
6644
7037
  name?: string | null | undefined;
6645
7038
  url?: string | null | undefined;
6646
- 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"> | null | undefined;
7039
+ eventTypes?: Array<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "contact.created" | "contact.updated" | "contact.deleted" | "conversation.started" | "conversation.ended" | "conversation.created" | "conversation.updated" | "conversation.archived" | "template.created" | "template.updated" | "template.deleted" | "template.approved" | "template.rejected" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated"> | null | undefined;
6647
7040
  channels?: Array<"sms" | "whatsapp" | "email"> | null | null | undefined;
6648
7041
  headers?: {
6649
7042
  [key: string]: string;