@vuevox/sdk 0.8.0 → 0.9.1

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.
@@ -148,6 +148,88 @@ export interface paths {
148
148
  patch?: never;
149
149
  trace?: never;
150
150
  };
151
+ "/v1/webhooks/endpoints": {
152
+ parameters: {
153
+ query?: never;
154
+ header?: never;
155
+ path?: never;
156
+ cookie?: never;
157
+ };
158
+ /**
159
+ * List webhook endpoints
160
+ * @description Returns webhook endpoints for the authenticated API client using cursor pagination.
161
+ */
162
+ get: operations["listWebhookEndpoints"];
163
+ put?: never;
164
+ /**
165
+ * Create a webhook endpoint
166
+ * @description Creates a webhook endpoint for the authenticated API client. The signing secret is returned only once.
167
+ */
168
+ post: operations["createWebhookEndpoint"];
169
+ delete?: never;
170
+ options?: never;
171
+ head?: never;
172
+ patch?: never;
173
+ trace?: never;
174
+ };
175
+ "/v1/webhooks/endpoints/{endpointId}": {
176
+ parameters: {
177
+ query?: never;
178
+ header?: never;
179
+ path?: never;
180
+ cookie?: never;
181
+ };
182
+ get?: never;
183
+ put?: never;
184
+ post?: never;
185
+ /** Delete a webhook endpoint */
186
+ delete: operations["deleteWebhookEndpoint"];
187
+ options?: never;
188
+ head?: never;
189
+ /** Update a webhook endpoint */
190
+ patch: operations["updateWebhookEndpoint"];
191
+ trace?: never;
192
+ };
193
+ "/v1/webhooks/endpoints/{endpointId}/rotate-secret": {
194
+ parameters: {
195
+ query?: never;
196
+ header?: never;
197
+ path?: never;
198
+ cookie?: never;
199
+ };
200
+ get?: never;
201
+ put?: never;
202
+ /**
203
+ * Rotate a webhook endpoint signing secret
204
+ * @description Replaces the endpoint signing secret. The new secret is returned only once.
205
+ */
206
+ post: operations["rotateWebhookEndpointSecret"];
207
+ delete?: never;
208
+ options?: never;
209
+ head?: never;
210
+ patch?: never;
211
+ trace?: never;
212
+ };
213
+ "/v1/webhooks/endpoints/{endpointId}/test": {
214
+ parameters: {
215
+ query?: never;
216
+ header?: never;
217
+ path?: never;
218
+ cookie?: never;
219
+ };
220
+ get?: never;
221
+ put?: never;
222
+ /**
223
+ * Send a test webhook event
224
+ * @description Queues a webhook.test delivery to validate endpoint reachability and signature verification.
225
+ */
226
+ post: operations["testWebhookEndpoint"];
227
+ delete?: never;
228
+ options?: never;
229
+ head?: never;
230
+ patch?: never;
231
+ trace?: never;
232
+ };
151
233
  "/v1/leads": {
152
234
  parameters: {
153
235
  query?: never;
@@ -267,7 +349,7 @@ export interface components {
267
349
  client_secret: string;
268
350
  /**
269
351
  * @description Space-separated scopes requested for the access token.
270
- * @example hello:read spaces:read agents:read calls:read calls:write leads:read leads:write lead_custom_fields:manage
352
+ * @example hello:read spaces:read agents:read calls:read calls:write leads:read leads:write lead_custom_fields:manage webhooks:read webhooks:write
271
353
  */
272
354
  scope?: string;
273
355
  };
@@ -277,7 +359,7 @@ export interface components {
277
359
  token_type: "Bearer";
278
360
  /** @example 3600 */
279
361
  expires_in: number;
280
- /** @example hello:read spaces:read agents:read calls:read calls:write leads:read leads:write lead_custom_fields:manage */
362
+ /** @example hello:read spaces:read agents:read calls:read calls:write leads:read leads:write lead_custom_fields:manage webhooks:read webhooks:write */
281
363
  scope: string;
282
364
  };
283
365
  HelloResponse: {
@@ -511,6 +593,79 @@ export interface components {
511
593
  isFilterable?: boolean;
512
594
  archived?: boolean;
513
595
  };
596
+ /**
597
+ * @description Subscribable webhook event type.
598
+ * @enum {string}
599
+ */
600
+ WebhookEventType: "analysis.completed" | "analysis.failed";
601
+ WebhookEndpoint: {
602
+ /** Format: uuid */
603
+ id: string;
604
+ /** Format: uri */
605
+ url: string;
606
+ events: components["schemas"]["WebhookEventType"][];
607
+ isActive: boolean;
608
+ /** Format: date-time */
609
+ lastDeliveredAt: string | null;
610
+ /** Format: date-time */
611
+ createdAt: string;
612
+ /** Format: date-time */
613
+ updatedAt: string;
614
+ };
615
+ WebhookEndpointWithSecret: components["schemas"]["WebhookEndpoint"] & {
616
+ /** @description Signing secret shown only when creating or rotating the endpoint. */
617
+ secret: string;
618
+ };
619
+ WebhookEndpointsListResponse: {
620
+ data: components["schemas"]["WebhookEndpoint"][];
621
+ pagination: components["schemas"]["CursorPagination"];
622
+ };
623
+ WebhookEndpointResponse: {
624
+ data: components["schemas"]["WebhookEndpoint"];
625
+ };
626
+ WebhookEndpointSecretResponse: {
627
+ data: components["schemas"]["WebhookEndpointWithSecret"];
628
+ };
629
+ WebhookEndpointCreateRequest: {
630
+ /**
631
+ * Format: uri
632
+ * @description Public HTTPS URL that will receive webhook POST requests.
633
+ */
634
+ url: string;
635
+ events: components["schemas"]["WebhookEventType"][];
636
+ /** @default true */
637
+ isActive: boolean;
638
+ };
639
+ WebhookEndpointUpdateRequest: {
640
+ /** Format: uri */
641
+ url?: string;
642
+ events?: components["schemas"]["WebhookEventType"][];
643
+ isActive?: boolean;
644
+ };
645
+ WebhookTestResponse: {
646
+ data: {
647
+ /**
648
+ * Format: uuid
649
+ * @description Delivery ID.
650
+ */
651
+ id: string;
652
+ /** @enum {string} */
653
+ status: "pending" | "retrying" | "delivered" | "failed" | "skipped";
654
+ /** @enum {string} */
655
+ eventType: "webhook.test";
656
+ };
657
+ };
658
+ WebhookEventPayload: {
659
+ /** Format: uuid */
660
+ id: string;
661
+ /** @enum {string} */
662
+ type: "analysis.completed" | "analysis.failed" | "webhook.test";
663
+ /** Format: date-time */
664
+ createdAt: string;
665
+ data: {
666
+ [key: string]: unknown;
667
+ };
668
+ };
514
669
  CursorPagination: {
515
670
  /** @example 50 */
516
671
  limit: number;
@@ -535,9 +690,15 @@ export interface components {
535
690
  };
536
691
  };
537
692
  responses: never;
538
- parameters: never;
693
+ parameters: {
694
+ /** @description Webhook endpoint ID. */
695
+ WebhookEndpointId: string;
696
+ };
539
697
  requestBodies: never;
540
- headers: never;
698
+ headers: {
699
+ /** @description Request correlation ID for logs and support. Matches error.requestId on error responses. */
700
+ XRequestId: string;
701
+ };
541
702
  pathItems: never;
542
703
  }
543
704
  export type $defs = Record<string, never>;
@@ -558,6 +719,7 @@ export interface operations {
558
719
  /** @description Access token issued. */
559
720
  200: {
560
721
  headers: {
722
+ "X-Request-Id": components["headers"]["XRequestId"];
561
723
  [name: string]: unknown;
562
724
  };
563
725
  content: {
@@ -567,6 +729,7 @@ export interface operations {
567
729
  /** @description Requested scope is not allowed. */
568
730
  400: {
569
731
  headers: {
732
+ "X-Request-Id": components["headers"]["XRequestId"];
570
733
  [name: string]: unknown;
571
734
  };
572
735
  content: {
@@ -576,6 +739,7 @@ export interface operations {
576
739
  /** @description Client authentication failed. */
577
740
  401: {
578
741
  headers: {
742
+ "X-Request-Id": components["headers"]["XRequestId"];
579
743
  [name: string]: unknown;
580
744
  };
581
745
  content: {
@@ -585,6 +749,7 @@ export interface operations {
585
749
  /** @description Request body failed validation. */
586
750
  422: {
587
751
  headers: {
752
+ "X-Request-Id": components["headers"]["XRequestId"];
588
753
  [name: string]: unknown;
589
754
  };
590
755
  content: {
@@ -605,6 +770,7 @@ export interface operations {
605
770
  /** @description Hello response. */
606
771
  200: {
607
772
  headers: {
773
+ "X-Request-Id": components["headers"]["XRequestId"];
608
774
  [name: string]: unknown;
609
775
  };
610
776
  content: {
@@ -614,6 +780,7 @@ export interface operations {
614
780
  /** @description Bearer token is missing, invalid, or expired. */
615
781
  401: {
616
782
  headers: {
783
+ "X-Request-Id": components["headers"]["XRequestId"];
617
784
  [name: string]: unknown;
618
785
  };
619
786
  content: {
@@ -623,6 +790,7 @@ export interface operations {
623
790
  /** @description Bearer token does not include the required scope. */
624
791
  403: {
625
792
  headers: {
793
+ "X-Request-Id": components["headers"]["XRequestId"];
626
794
  [name: string]: unknown;
627
795
  };
628
796
  content: {
@@ -632,6 +800,7 @@ export interface operations {
632
800
  /** @description Per-client rate limit exceeded. */
633
801
  429: {
634
802
  headers: {
803
+ "X-Request-Id": components["headers"]["XRequestId"];
635
804
  /** @description Seconds to wait before retrying. */
636
805
  "Retry-After"?: string;
637
806
  /** @description Request limit per minute for this API client. */
@@ -661,6 +830,7 @@ export interface operations {
661
830
  /** @description Paginated spaces response. */
662
831
  200: {
663
832
  headers: {
833
+ "X-Request-Id": components["headers"]["XRequestId"];
664
834
  [name: string]: unknown;
665
835
  };
666
836
  content: {
@@ -670,6 +840,7 @@ export interface operations {
670
840
  /** @description Bearer token is missing, invalid, or expired. */
671
841
  401: {
672
842
  headers: {
843
+ "X-Request-Id": components["headers"]["XRequestId"];
673
844
  [name: string]: unknown;
674
845
  };
675
846
  content: {
@@ -679,6 +850,7 @@ export interface operations {
679
850
  /** @description Bearer token does not include the required scope. */
680
851
  403: {
681
852
  headers: {
853
+ "X-Request-Id": components["headers"]["XRequestId"];
682
854
  [name: string]: unknown;
683
855
  };
684
856
  content: {
@@ -688,6 +860,7 @@ export interface operations {
688
860
  /** @description Query parameters failed validation. */
689
861
  422: {
690
862
  headers: {
863
+ "X-Request-Id": components["headers"]["XRequestId"];
691
864
  [name: string]: unknown;
692
865
  };
693
866
  content: {
@@ -697,6 +870,7 @@ export interface operations {
697
870
  /** @description Per-client rate limit exceeded. */
698
871
  429: {
699
872
  headers: {
873
+ "X-Request-Id": components["headers"]["XRequestId"];
700
874
  /** @description Seconds to wait before retrying. */
701
875
  "Retry-After"?: string;
702
876
  /** @description Request limit per minute for this API client. */
@@ -728,6 +902,7 @@ export interface operations {
728
902
  /** @description Paginated agents response. */
729
903
  200: {
730
904
  headers: {
905
+ "X-Request-Id": components["headers"]["XRequestId"];
731
906
  [name: string]: unknown;
732
907
  };
733
908
  content: {
@@ -737,6 +912,7 @@ export interface operations {
737
912
  /** @description Bearer token is missing, invalid, or expired. */
738
913
  401: {
739
914
  headers: {
915
+ "X-Request-Id": components["headers"]["XRequestId"];
740
916
  [name: string]: unknown;
741
917
  };
742
918
  content: {
@@ -746,6 +922,7 @@ export interface operations {
746
922
  /** @description Bearer token does not include the required scope. */
747
923
  403: {
748
924
  headers: {
925
+ "X-Request-Id": components["headers"]["XRequestId"];
749
926
  [name: string]: unknown;
750
927
  };
751
928
  content: {
@@ -755,6 +932,7 @@ export interface operations {
755
932
  /** @description Query parameters failed validation. */
756
933
  422: {
757
934
  headers: {
935
+ "X-Request-Id": components["headers"]["XRequestId"];
758
936
  [name: string]: unknown;
759
937
  };
760
938
  content: {
@@ -764,6 +942,7 @@ export interface operations {
764
942
  /** @description Per-client rate limit exceeded. */
765
943
  429: {
766
944
  headers: {
945
+ "X-Request-Id": components["headers"]["XRequestId"];
767
946
  /** @description Seconds to wait before retrying. */
768
947
  "Retry-After"?: string;
769
948
  /** @description Request limit per minute for this API client. */
@@ -805,6 +984,7 @@ export interface operations {
805
984
  /** @description Paginated calls response. */
806
985
  200: {
807
986
  headers: {
987
+ "X-Request-Id": components["headers"]["XRequestId"];
808
988
  [name: string]: unknown;
809
989
  };
810
990
  content: {
@@ -814,6 +994,7 @@ export interface operations {
814
994
  /** @description Bearer token is missing, invalid, or expired. */
815
995
  401: {
816
996
  headers: {
997
+ "X-Request-Id": components["headers"]["XRequestId"];
817
998
  [name: string]: unknown;
818
999
  };
819
1000
  content: {
@@ -823,6 +1004,7 @@ export interface operations {
823
1004
  /** @description Bearer token does not include the required scope. */
824
1005
  403: {
825
1006
  headers: {
1007
+ "X-Request-Id": components["headers"]["XRequestId"];
826
1008
  [name: string]: unknown;
827
1009
  };
828
1010
  content: {
@@ -832,6 +1014,7 @@ export interface operations {
832
1014
  /** @description Query parameters failed validation. */
833
1015
  422: {
834
1016
  headers: {
1017
+ "X-Request-Id": components["headers"]["XRequestId"];
835
1018
  [name: string]: unknown;
836
1019
  };
837
1020
  content: {
@@ -841,6 +1024,7 @@ export interface operations {
841
1024
  /** @description Per-client rate limit exceeded. */
842
1025
  429: {
843
1026
  headers: {
1027
+ "X-Request-Id": components["headers"]["XRequestId"];
844
1028
  /** @description Seconds to wait before retrying. */
845
1029
  "Retry-After"?: string;
846
1030
  /** @description Request limit per minute for this API client. */
@@ -880,6 +1064,7 @@ export interface operations {
880
1064
  /** @description Call uploaded. Analysis is queued when metadata.queueAnalysis is true. */
881
1065
  201: {
882
1066
  headers: {
1067
+ "X-Request-Id": components["headers"]["XRequestId"];
883
1068
  [name: string]: unknown;
884
1069
  };
885
1070
  content: {
@@ -889,6 +1074,7 @@ export interface operations {
889
1074
  /** @description Bearer token is missing, invalid, or expired. */
890
1075
  401: {
891
1076
  headers: {
1077
+ "X-Request-Id": components["headers"]["XRequestId"];
892
1078
  [name: string]: unknown;
893
1079
  };
894
1080
  content: {
@@ -898,6 +1084,7 @@ export interface operations {
898
1084
  /** @description Bearer token does not include the required scope. */
899
1085
  403: {
900
1086
  headers: {
1087
+ "X-Request-Id": components["headers"]["XRequestId"];
901
1088
  [name: string]: unknown;
902
1089
  };
903
1090
  content: {
@@ -907,6 +1094,7 @@ export interface operations {
907
1094
  /** @description Idempotency key conflict, external call ID conflict, or analysis already queued. */
908
1095
  409: {
909
1096
  headers: {
1097
+ "X-Request-Id": components["headers"]["XRequestId"];
910
1098
  [name: string]: unknown;
911
1099
  };
912
1100
  content: {
@@ -916,6 +1104,7 @@ export interface operations {
916
1104
  /** @description Multipart upload or metadata failed validation. */
917
1105
  422: {
918
1106
  headers: {
1107
+ "X-Request-Id": components["headers"]["XRequestId"];
919
1108
  [name: string]: unknown;
920
1109
  };
921
1110
  content: {
@@ -939,6 +1128,7 @@ export interface operations {
939
1128
  /** @description Call detail response. */
940
1129
  200: {
941
1130
  headers: {
1131
+ "X-Request-Id": components["headers"]["XRequestId"];
942
1132
  [name: string]: unknown;
943
1133
  };
944
1134
  content: {
@@ -948,6 +1138,7 @@ export interface operations {
948
1138
  /** @description Bearer token is missing, invalid, or expired. */
949
1139
  401: {
950
1140
  headers: {
1141
+ "X-Request-Id": components["headers"]["XRequestId"];
951
1142
  [name: string]: unknown;
952
1143
  };
953
1144
  content: {
@@ -957,6 +1148,7 @@ export interface operations {
957
1148
  /** @description Bearer token does not include the required scope. */
958
1149
  403: {
959
1150
  headers: {
1151
+ "X-Request-Id": components["headers"]["XRequestId"];
960
1152
  [name: string]: unknown;
961
1153
  };
962
1154
  content: {
@@ -966,6 +1158,7 @@ export interface operations {
966
1158
  /** @description Call was not found in the API client's organization. */
967
1159
  404: {
968
1160
  headers: {
1161
+ "X-Request-Id": components["headers"]["XRequestId"];
969
1162
  [name: string]: unknown;
970
1163
  };
971
1164
  content: {
@@ -975,6 +1168,7 @@ export interface operations {
975
1168
  /** @description Per-client rate limit exceeded. */
976
1169
  429: {
977
1170
  headers: {
1171
+ "X-Request-Id": components["headers"]["XRequestId"];
978
1172
  /** @description Seconds to wait before retrying. */
979
1173
  "Retry-After"?: string;
980
1174
  /** @description Request limit per minute for this API client. */
@@ -1002,6 +1196,7 @@ export interface operations {
1002
1196
  /** @description Analysis queued. */
1003
1197
  200: {
1004
1198
  headers: {
1199
+ "X-Request-Id": components["headers"]["XRequestId"];
1005
1200
  [name: string]: unknown;
1006
1201
  };
1007
1202
  content: {
@@ -1011,6 +1206,7 @@ export interface operations {
1011
1206
  /** @description Bearer token is missing, invalid, or expired. */
1012
1207
  401: {
1013
1208
  headers: {
1209
+ "X-Request-Id": components["headers"]["XRequestId"];
1014
1210
  [name: string]: unknown;
1015
1211
  };
1016
1212
  content: {
@@ -1020,6 +1216,7 @@ export interface operations {
1020
1216
  /** @description Bearer token does not include the required scope. */
1021
1217
  403: {
1022
1218
  headers: {
1219
+ "X-Request-Id": components["headers"]["XRequestId"];
1023
1220
  [name: string]: unknown;
1024
1221
  };
1025
1222
  content: {
@@ -1029,6 +1226,7 @@ export interface operations {
1029
1226
  /** @description Call was not found in the API client's organization. */
1030
1227
  404: {
1031
1228
  headers: {
1229
+ "X-Request-Id": components["headers"]["XRequestId"];
1032
1230
  [name: string]: unknown;
1033
1231
  };
1034
1232
  content: {
@@ -1038,6 +1236,7 @@ export interface operations {
1038
1236
  /** @description Analysis is already queued or processing. */
1039
1237
  409: {
1040
1238
  headers: {
1239
+ "X-Request-Id": components["headers"]["XRequestId"];
1041
1240
  [name: string]: unknown;
1042
1241
  };
1043
1242
  content: {
@@ -1047,6 +1246,346 @@ export interface operations {
1047
1246
  /** @description Organization AI settings, evaluation grid, or audio file is missing. */
1048
1247
  422: {
1049
1248
  headers: {
1249
+ "X-Request-Id": components["headers"]["XRequestId"];
1250
+ [name: string]: unknown;
1251
+ };
1252
+ content: {
1253
+ "application/json": components["schemas"]["ErrorResponse"];
1254
+ };
1255
+ };
1256
+ };
1257
+ };
1258
+ listWebhookEndpoints: {
1259
+ parameters: {
1260
+ query?: {
1261
+ /** @description Number of endpoints to return. Defaults to 50. Maximum is 100. */
1262
+ limit?: number;
1263
+ /** @description Opaque cursor from the previous response's pagination.nextCursor value. */
1264
+ cursor?: string;
1265
+ };
1266
+ header?: never;
1267
+ path?: never;
1268
+ cookie?: never;
1269
+ };
1270
+ requestBody?: never;
1271
+ responses: {
1272
+ /** @description Paginated webhook endpoints response. */
1273
+ 200: {
1274
+ headers: {
1275
+ "X-Request-Id": components["headers"]["XRequestId"];
1276
+ [name: string]: unknown;
1277
+ };
1278
+ content: {
1279
+ "application/json": components["schemas"]["WebhookEndpointsListResponse"];
1280
+ };
1281
+ };
1282
+ /** @description Bearer token is missing, invalid, or expired. */
1283
+ 401: {
1284
+ headers: {
1285
+ "X-Request-Id": components["headers"]["XRequestId"];
1286
+ [name: string]: unknown;
1287
+ };
1288
+ content: {
1289
+ "application/json": components["schemas"]["ErrorResponse"];
1290
+ };
1291
+ };
1292
+ /** @description Bearer token does not include the required scope. */
1293
+ 403: {
1294
+ headers: {
1295
+ "X-Request-Id": components["headers"]["XRequestId"];
1296
+ [name: string]: unknown;
1297
+ };
1298
+ content: {
1299
+ "application/json": components["schemas"]["ErrorResponse"];
1300
+ };
1301
+ };
1302
+ /** @description Query parameters failed validation. */
1303
+ 422: {
1304
+ headers: {
1305
+ "X-Request-Id": components["headers"]["XRequestId"];
1306
+ [name: string]: unknown;
1307
+ };
1308
+ content: {
1309
+ "application/json": components["schemas"]["ErrorResponse"];
1310
+ };
1311
+ };
1312
+ };
1313
+ };
1314
+ createWebhookEndpoint: {
1315
+ parameters: {
1316
+ query?: never;
1317
+ header?: never;
1318
+ path?: never;
1319
+ cookie?: never;
1320
+ };
1321
+ requestBody: {
1322
+ content: {
1323
+ "application/json": components["schemas"]["WebhookEndpointCreateRequest"];
1324
+ };
1325
+ };
1326
+ responses: {
1327
+ /** @description Webhook endpoint created. */
1328
+ 201: {
1329
+ headers: {
1330
+ "X-Request-Id": components["headers"]["XRequestId"];
1331
+ [name: string]: unknown;
1332
+ };
1333
+ content: {
1334
+ "application/json": components["schemas"]["WebhookEndpointSecretResponse"];
1335
+ };
1336
+ };
1337
+ /** @description Bearer token is missing, invalid, or expired. */
1338
+ 401: {
1339
+ headers: {
1340
+ "X-Request-Id": components["headers"]["XRequestId"];
1341
+ [name: string]: unknown;
1342
+ };
1343
+ content: {
1344
+ "application/json": components["schemas"]["ErrorResponse"];
1345
+ };
1346
+ };
1347
+ /** @description Bearer token does not include the required scope. */
1348
+ 403: {
1349
+ headers: {
1350
+ "X-Request-Id": components["headers"]["XRequestId"];
1351
+ [name: string]: unknown;
1352
+ };
1353
+ content: {
1354
+ "application/json": components["schemas"]["ErrorResponse"];
1355
+ };
1356
+ };
1357
+ /** @description Request body failed validation. */
1358
+ 422: {
1359
+ headers: {
1360
+ "X-Request-Id": components["headers"]["XRequestId"];
1361
+ [name: string]: unknown;
1362
+ };
1363
+ content: {
1364
+ "application/json": components["schemas"]["ErrorResponse"];
1365
+ };
1366
+ };
1367
+ };
1368
+ };
1369
+ deleteWebhookEndpoint: {
1370
+ parameters: {
1371
+ query?: never;
1372
+ header?: never;
1373
+ path: {
1374
+ /** @description Webhook endpoint ID. */
1375
+ endpointId: components["parameters"]["WebhookEndpointId"];
1376
+ };
1377
+ cookie?: never;
1378
+ };
1379
+ requestBody?: never;
1380
+ responses: {
1381
+ /** @description Webhook endpoint deleted. */
1382
+ 204: {
1383
+ headers: {
1384
+ "X-Request-Id": components["headers"]["XRequestId"];
1385
+ [name: string]: unknown;
1386
+ };
1387
+ content?: never;
1388
+ };
1389
+ /** @description Bearer token is missing, invalid, or expired. */
1390
+ 401: {
1391
+ headers: {
1392
+ "X-Request-Id": components["headers"]["XRequestId"];
1393
+ [name: string]: unknown;
1394
+ };
1395
+ content: {
1396
+ "application/json": components["schemas"]["ErrorResponse"];
1397
+ };
1398
+ };
1399
+ /** @description Bearer token does not include the required scope. */
1400
+ 403: {
1401
+ headers: {
1402
+ "X-Request-Id": components["headers"]["XRequestId"];
1403
+ [name: string]: unknown;
1404
+ };
1405
+ content: {
1406
+ "application/json": components["schemas"]["ErrorResponse"];
1407
+ };
1408
+ };
1409
+ /** @description Webhook endpoint was not found for this API client. */
1410
+ 404: {
1411
+ headers: {
1412
+ "X-Request-Id": components["headers"]["XRequestId"];
1413
+ [name: string]: unknown;
1414
+ };
1415
+ content: {
1416
+ "application/json": components["schemas"]["ErrorResponse"];
1417
+ };
1418
+ };
1419
+ };
1420
+ };
1421
+ updateWebhookEndpoint: {
1422
+ parameters: {
1423
+ query?: never;
1424
+ header?: never;
1425
+ path: {
1426
+ /** @description Webhook endpoint ID. */
1427
+ endpointId: components["parameters"]["WebhookEndpointId"];
1428
+ };
1429
+ cookie?: never;
1430
+ };
1431
+ requestBody: {
1432
+ content: {
1433
+ "application/json": components["schemas"]["WebhookEndpointUpdateRequest"];
1434
+ };
1435
+ };
1436
+ responses: {
1437
+ /** @description Webhook endpoint updated. */
1438
+ 200: {
1439
+ headers: {
1440
+ "X-Request-Id": components["headers"]["XRequestId"];
1441
+ [name: string]: unknown;
1442
+ };
1443
+ content: {
1444
+ "application/json": components["schemas"]["WebhookEndpointResponse"];
1445
+ };
1446
+ };
1447
+ /** @description Bearer token is missing, invalid, or expired. */
1448
+ 401: {
1449
+ headers: {
1450
+ "X-Request-Id": components["headers"]["XRequestId"];
1451
+ [name: string]: unknown;
1452
+ };
1453
+ content: {
1454
+ "application/json": components["schemas"]["ErrorResponse"];
1455
+ };
1456
+ };
1457
+ /** @description Bearer token does not include the required scope. */
1458
+ 403: {
1459
+ headers: {
1460
+ "X-Request-Id": components["headers"]["XRequestId"];
1461
+ [name: string]: unknown;
1462
+ };
1463
+ content: {
1464
+ "application/json": components["schemas"]["ErrorResponse"];
1465
+ };
1466
+ };
1467
+ /** @description Webhook endpoint was not found for this API client. */
1468
+ 404: {
1469
+ headers: {
1470
+ "X-Request-Id": components["headers"]["XRequestId"];
1471
+ [name: string]: unknown;
1472
+ };
1473
+ content: {
1474
+ "application/json": components["schemas"]["ErrorResponse"];
1475
+ };
1476
+ };
1477
+ /** @description Request body failed validation. */
1478
+ 422: {
1479
+ headers: {
1480
+ "X-Request-Id": components["headers"]["XRequestId"];
1481
+ [name: string]: unknown;
1482
+ };
1483
+ content: {
1484
+ "application/json": components["schemas"]["ErrorResponse"];
1485
+ };
1486
+ };
1487
+ };
1488
+ };
1489
+ rotateWebhookEndpointSecret: {
1490
+ parameters: {
1491
+ query?: never;
1492
+ header?: never;
1493
+ path: {
1494
+ /** @description Webhook endpoint ID. */
1495
+ endpointId: components["parameters"]["WebhookEndpointId"];
1496
+ };
1497
+ cookie?: never;
1498
+ };
1499
+ requestBody?: never;
1500
+ responses: {
1501
+ /** @description Webhook endpoint secret rotated. */
1502
+ 200: {
1503
+ headers: {
1504
+ "X-Request-Id": components["headers"]["XRequestId"];
1505
+ [name: string]: unknown;
1506
+ };
1507
+ content: {
1508
+ "application/json": components["schemas"]["WebhookEndpointSecretResponse"];
1509
+ };
1510
+ };
1511
+ /** @description Bearer token is missing, invalid, or expired. */
1512
+ 401: {
1513
+ headers: {
1514
+ "X-Request-Id": components["headers"]["XRequestId"];
1515
+ [name: string]: unknown;
1516
+ };
1517
+ content: {
1518
+ "application/json": components["schemas"]["ErrorResponse"];
1519
+ };
1520
+ };
1521
+ /** @description Bearer token does not include the required scope. */
1522
+ 403: {
1523
+ headers: {
1524
+ "X-Request-Id": components["headers"]["XRequestId"];
1525
+ [name: string]: unknown;
1526
+ };
1527
+ content: {
1528
+ "application/json": components["schemas"]["ErrorResponse"];
1529
+ };
1530
+ };
1531
+ /** @description Webhook endpoint was not found for this API client. */
1532
+ 404: {
1533
+ headers: {
1534
+ "X-Request-Id": components["headers"]["XRequestId"];
1535
+ [name: string]: unknown;
1536
+ };
1537
+ content: {
1538
+ "application/json": components["schemas"]["ErrorResponse"];
1539
+ };
1540
+ };
1541
+ };
1542
+ };
1543
+ testWebhookEndpoint: {
1544
+ parameters: {
1545
+ query?: never;
1546
+ header?: never;
1547
+ path: {
1548
+ /** @description Webhook endpoint ID. */
1549
+ endpointId: components["parameters"]["WebhookEndpointId"];
1550
+ };
1551
+ cookie?: never;
1552
+ };
1553
+ requestBody?: never;
1554
+ responses: {
1555
+ /** @description Test delivery queued. */
1556
+ 202: {
1557
+ headers: {
1558
+ "X-Request-Id": components["headers"]["XRequestId"];
1559
+ [name: string]: unknown;
1560
+ };
1561
+ content: {
1562
+ "application/json": components["schemas"]["WebhookTestResponse"];
1563
+ };
1564
+ };
1565
+ /** @description Bearer token is missing, invalid, or expired. */
1566
+ 401: {
1567
+ headers: {
1568
+ "X-Request-Id": components["headers"]["XRequestId"];
1569
+ [name: string]: unknown;
1570
+ };
1571
+ content: {
1572
+ "application/json": components["schemas"]["ErrorResponse"];
1573
+ };
1574
+ };
1575
+ /** @description Bearer token does not include the required scope. */
1576
+ 403: {
1577
+ headers: {
1578
+ "X-Request-Id": components["headers"]["XRequestId"];
1579
+ [name: string]: unknown;
1580
+ };
1581
+ content: {
1582
+ "application/json": components["schemas"]["ErrorResponse"];
1583
+ };
1584
+ };
1585
+ /** @description Webhook endpoint was not found for this API client. */
1586
+ 404: {
1587
+ headers: {
1588
+ "X-Request-Id": components["headers"]["XRequestId"];
1050
1589
  [name: string]: unknown;
1051
1590
  };
1052
1591
  content: {
@@ -1080,6 +1619,7 @@ export interface operations {
1080
1619
  /** @description Paginated leads response. */
1081
1620
  200: {
1082
1621
  headers: {
1622
+ "X-Request-Id": components["headers"]["XRequestId"];
1083
1623
  [name: string]: unknown;
1084
1624
  };
1085
1625
  content: {
@@ -1089,6 +1629,7 @@ export interface operations {
1089
1629
  /** @description Bearer token is missing, invalid, or expired. */
1090
1630
  401: {
1091
1631
  headers: {
1632
+ "X-Request-Id": components["headers"]["XRequestId"];
1092
1633
  [name: string]: unknown;
1093
1634
  };
1094
1635
  content: {
@@ -1098,6 +1639,7 @@ export interface operations {
1098
1639
  /** @description Bearer token does not include the required scope. */
1099
1640
  403: {
1100
1641
  headers: {
1642
+ "X-Request-Id": components["headers"]["XRequestId"];
1101
1643
  [name: string]: unknown;
1102
1644
  };
1103
1645
  content: {
@@ -1107,6 +1649,7 @@ export interface operations {
1107
1649
  /** @description Query parameters failed validation. */
1108
1650
  422: {
1109
1651
  headers: {
1652
+ "X-Request-Id": components["headers"]["XRequestId"];
1110
1653
  [name: string]: unknown;
1111
1654
  };
1112
1655
  content: {
@@ -1116,6 +1659,7 @@ export interface operations {
1116
1659
  /** @description Per-client rate limit exceeded. */
1117
1660
  429: {
1118
1661
  headers: {
1662
+ "X-Request-Id": components["headers"]["XRequestId"];
1119
1663
  /** @description Seconds to wait before retrying. */
1120
1664
  "Retry-After"?: string;
1121
1665
  /** @description Request limit per minute for this API client. */
@@ -1143,6 +1687,7 @@ export interface operations {
1143
1687
  /** @description Lead detail response. */
1144
1688
  200: {
1145
1689
  headers: {
1690
+ "X-Request-Id": components["headers"]["XRequestId"];
1146
1691
  [name: string]: unknown;
1147
1692
  };
1148
1693
  content: {
@@ -1152,6 +1697,7 @@ export interface operations {
1152
1697
  /** @description Bearer token is missing, invalid, or expired. */
1153
1698
  401: {
1154
1699
  headers: {
1700
+ "X-Request-Id": components["headers"]["XRequestId"];
1155
1701
  [name: string]: unknown;
1156
1702
  };
1157
1703
  content: {
@@ -1161,6 +1707,7 @@ export interface operations {
1161
1707
  /** @description Bearer token does not include the required scope. */
1162
1708
  403: {
1163
1709
  headers: {
1710
+ "X-Request-Id": components["headers"]["XRequestId"];
1164
1711
  [name: string]: unknown;
1165
1712
  };
1166
1713
  content: {
@@ -1170,6 +1717,7 @@ export interface operations {
1170
1717
  /** @description Lead was not found in the API client's organization. */
1171
1718
  404: {
1172
1719
  headers: {
1720
+ "X-Request-Id": components["headers"]["XRequestId"];
1173
1721
  [name: string]: unknown;
1174
1722
  };
1175
1723
  content: {
@@ -1179,6 +1727,7 @@ export interface operations {
1179
1727
  /** @description Per-client rate limit exceeded. */
1180
1728
  429: {
1181
1729
  headers: {
1730
+ "X-Request-Id": components["headers"]["XRequestId"];
1182
1731
  /** @description Seconds to wait before retrying. */
1183
1732
  "Retry-After"?: string;
1184
1733
  /** @description Request limit per minute for this API client. */
@@ -1210,6 +1759,7 @@ export interface operations {
1210
1759
  /** @description Lead updated. */
1211
1760
  200: {
1212
1761
  headers: {
1762
+ "X-Request-Id": components["headers"]["XRequestId"];
1213
1763
  [name: string]: unknown;
1214
1764
  };
1215
1765
  content: {
@@ -1219,6 +1769,7 @@ export interface operations {
1219
1769
  /** @description Bearer token is missing, invalid, or expired. */
1220
1770
  401: {
1221
1771
  headers: {
1772
+ "X-Request-Id": components["headers"]["XRequestId"];
1222
1773
  [name: string]: unknown;
1223
1774
  };
1224
1775
  content: {
@@ -1228,6 +1779,7 @@ export interface operations {
1228
1779
  /** @description Bearer token does not include the required scope. */
1229
1780
  403: {
1230
1781
  headers: {
1782
+ "X-Request-Id": components["headers"]["XRequestId"];
1231
1783
  [name: string]: unknown;
1232
1784
  };
1233
1785
  content: {
@@ -1237,6 +1789,7 @@ export interface operations {
1237
1789
  /** @description Lead was not found in the API client's organization. */
1238
1790
  404: {
1239
1791
  headers: {
1792
+ "X-Request-Id": components["headers"]["XRequestId"];
1240
1793
  [name: string]: unknown;
1241
1794
  };
1242
1795
  content: {
@@ -1246,6 +1799,7 @@ export interface operations {
1246
1799
  /** @description Request body failed validation. */
1247
1800
  422: {
1248
1801
  headers: {
1802
+ "X-Request-Id": components["headers"]["XRequestId"];
1249
1803
  [name: string]: unknown;
1250
1804
  };
1251
1805
  content: {
@@ -1273,6 +1827,7 @@ export interface operations {
1273
1827
  /** @description Existing lead updated. */
1274
1828
  200: {
1275
1829
  headers: {
1830
+ "X-Request-Id": components["headers"]["XRequestId"];
1276
1831
  [name: string]: unknown;
1277
1832
  };
1278
1833
  content: {
@@ -1282,6 +1837,7 @@ export interface operations {
1282
1837
  /** @description New lead created. */
1283
1838
  201: {
1284
1839
  headers: {
1840
+ "X-Request-Id": components["headers"]["XRequestId"];
1285
1841
  [name: string]: unknown;
1286
1842
  };
1287
1843
  content: {
@@ -1291,6 +1847,7 @@ export interface operations {
1291
1847
  /** @description Bearer token is missing, invalid, or expired. */
1292
1848
  401: {
1293
1849
  headers: {
1850
+ "X-Request-Id": components["headers"]["XRequestId"];
1294
1851
  [name: string]: unknown;
1295
1852
  };
1296
1853
  content: {
@@ -1300,6 +1857,7 @@ export interface operations {
1300
1857
  /** @description Bearer token does not include the required scope. */
1301
1858
  403: {
1302
1859
  headers: {
1860
+ "X-Request-Id": components["headers"]["XRequestId"];
1303
1861
  [name: string]: unknown;
1304
1862
  };
1305
1863
  content: {
@@ -1309,6 +1867,7 @@ export interface operations {
1309
1867
  /** @description Request body failed validation. */
1310
1868
  422: {
1311
1869
  headers: {
1870
+ "X-Request-Id": components["headers"]["XRequestId"];
1312
1871
  [name: string]: unknown;
1313
1872
  };
1314
1873
  content: {
@@ -1332,6 +1891,7 @@ export interface operations {
1332
1891
  /** @description Lead custom field definitions. */
1333
1892
  200: {
1334
1893
  headers: {
1894
+ "X-Request-Id": components["headers"]["XRequestId"];
1335
1895
  [name: string]: unknown;
1336
1896
  };
1337
1897
  content: {
@@ -1341,6 +1901,7 @@ export interface operations {
1341
1901
  /** @description Bearer token is missing, invalid, or expired. */
1342
1902
  401: {
1343
1903
  headers: {
1904
+ "X-Request-Id": components["headers"]["XRequestId"];
1344
1905
  [name: string]: unknown;
1345
1906
  };
1346
1907
  content: {
@@ -1350,6 +1911,7 @@ export interface operations {
1350
1911
  /** @description Bearer token does not include the required scope. */
1351
1912
  403: {
1352
1913
  headers: {
1914
+ "X-Request-Id": components["headers"]["XRequestId"];
1353
1915
  [name: string]: unknown;
1354
1916
  };
1355
1917
  content: {
@@ -1374,6 +1936,7 @@ export interface operations {
1374
1936
  /** @description Lead custom field created. */
1375
1937
  201: {
1376
1938
  headers: {
1939
+ "X-Request-Id": components["headers"]["XRequestId"];
1377
1940
  [name: string]: unknown;
1378
1941
  };
1379
1942
  content: {
@@ -1383,6 +1946,7 @@ export interface operations {
1383
1946
  /** @description Bearer token is missing, invalid, or expired. */
1384
1947
  401: {
1385
1948
  headers: {
1949
+ "X-Request-Id": components["headers"]["XRequestId"];
1386
1950
  [name: string]: unknown;
1387
1951
  };
1388
1952
  content: {
@@ -1392,6 +1956,7 @@ export interface operations {
1392
1956
  /** @description Bearer token does not include the required scope. */
1393
1957
  403: {
1394
1958
  headers: {
1959
+ "X-Request-Id": components["headers"]["XRequestId"];
1395
1960
  [name: string]: unknown;
1396
1961
  };
1397
1962
  content: {
@@ -1401,6 +1966,7 @@ export interface operations {
1401
1966
  /** @description A custom field with this key already exists. */
1402
1967
  409: {
1403
1968
  headers: {
1969
+ "X-Request-Id": components["headers"]["XRequestId"];
1404
1970
  [name: string]: unknown;
1405
1971
  };
1406
1972
  content: {
@@ -1410,6 +1976,7 @@ export interface operations {
1410
1976
  /** @description Request body failed validation. */
1411
1977
  422: {
1412
1978
  headers: {
1979
+ "X-Request-Id": components["headers"]["XRequestId"];
1413
1980
  [name: string]: unknown;
1414
1981
  };
1415
1982
  content: {
@@ -1437,6 +2004,7 @@ export interface operations {
1437
2004
  /** @description Lead custom field updated. */
1438
2005
  200: {
1439
2006
  headers: {
2007
+ "X-Request-Id": components["headers"]["XRequestId"];
1440
2008
  [name: string]: unknown;
1441
2009
  };
1442
2010
  content: {
@@ -1446,6 +2014,7 @@ export interface operations {
1446
2014
  /** @description Bearer token is missing, invalid, or expired. */
1447
2015
  401: {
1448
2016
  headers: {
2017
+ "X-Request-Id": components["headers"]["XRequestId"];
1449
2018
  [name: string]: unknown;
1450
2019
  };
1451
2020
  content: {
@@ -1455,6 +2024,7 @@ export interface operations {
1455
2024
  /** @description Bearer token does not include the required scope. */
1456
2025
  403: {
1457
2026
  headers: {
2027
+ "X-Request-Id": components["headers"]["XRequestId"];
1458
2028
  [name: string]: unknown;
1459
2029
  };
1460
2030
  content: {
@@ -1464,6 +2034,7 @@ export interface operations {
1464
2034
  /** @description Custom field was not found in the API client's organization. */
1465
2035
  404: {
1466
2036
  headers: {
2037
+ "X-Request-Id": components["headers"]["XRequestId"];
1467
2038
  [name: string]: unknown;
1468
2039
  };
1469
2040
  content: {
@@ -1473,6 +2044,7 @@ export interface operations {
1473
2044
  /** @description Request body failed validation. */
1474
2045
  422: {
1475
2046
  headers: {
2047
+ "X-Request-Id": components["headers"]["XRequestId"];
1476
2048
  [name: string]: unknown;
1477
2049
  };
1478
2050
  content: {