@gpt-platform/client 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1,3 +1,148 @@
1
+ /**
2
+ * A "Resource object" representing a crm_pipeline_stage
3
+ */
4
+ type CrmPipelineStage = {
5
+ /**
6
+ * An attributes object for a crm_pipeline_stage
7
+ */
8
+ attributes?: {
9
+ /**
10
+ * Field included by default.
11
+ */
12
+ automation_trigger?: string | null | unknown;
13
+ /**
14
+ * Field included by default.
15
+ */
16
+ forecast_category?: "pipeline" | "best_case" | "commit" | "closed_won" | "closed_lost" | unknown;
17
+ /**
18
+ * Field included by default.
19
+ */
20
+ is_closed: boolean;
21
+ /**
22
+ * Field included by default.
23
+ */
24
+ name: string;
25
+ /**
26
+ * Field included by default.
27
+ */
28
+ order: number;
29
+ /**
30
+ * Field included by default.
31
+ */
32
+ probability?: number | null | unknown;
33
+ };
34
+ id: string;
35
+ /**
36
+ * A relationships object for a crm_pipeline_stage
37
+ */
38
+ relationships?: {
39
+ [key: string]: never;
40
+ };
41
+ type: string;
42
+ };
43
+ /**
44
+ * A "Resource object" representing a email-marketing-campaign
45
+ */
46
+ type EmailMarketingCampaign = {
47
+ /**
48
+ * An attributes object for a email-marketing-campaign
49
+ */
50
+ attributes?: {
51
+ /**
52
+ * Field included by default.
53
+ */
54
+ column_mapping?: {
55
+ [key: string]: unknown;
56
+ } | null | unknown;
57
+ /**
58
+ * Field included by default.
59
+ */
60
+ csv_filename?: string | null | unknown;
61
+ /**
62
+ * Field included by default.
63
+ */
64
+ csv_storage_key?: string | null | unknown;
65
+ /**
66
+ * Field included by default.
67
+ */
68
+ description?: string | null | unknown;
69
+ /**
70
+ * Field included by default.
71
+ */
72
+ failed_count?: number | null | unknown;
73
+ /**
74
+ * Field included by default.
75
+ */
76
+ generated_count?: number | null | unknown;
77
+ /**
78
+ * Field included by default.
79
+ */
80
+ include_tracking_pixel?: boolean | null | unknown;
81
+ /**
82
+ * Field included by default.
83
+ */
84
+ include_unsubscribe_link?: boolean | null | unknown;
85
+ /**
86
+ * Field included by default.
87
+ */
88
+ name: string;
89
+ /**
90
+ * Field included by default.
91
+ */
92
+ sender_email?: string | null | unknown;
93
+ /**
94
+ * Field included by default.
95
+ */
96
+ sender_name?: string | null | unknown;
97
+ /**
98
+ * Field included by default.
99
+ */
100
+ sender_signature?: string | null | unknown;
101
+ /**
102
+ * Field included by default.
103
+ */
104
+ sent_count?: number | null | unknown;
105
+ /**
106
+ * Field included by default.
107
+ */
108
+ status?: "draft" | "importing" | "mapping" | "ready_to_generate" | "generating" | "review" | "approved" | "sending" | "scheduled" | "completed" | "failed" | "archived" | unknown;
109
+ /**
110
+ * Field included by default.
111
+ */
112
+ total_recipients?: number | null | unknown;
113
+ /**
114
+ * Field included by default.
115
+ */
116
+ unsubscribe_message?: string | null | unknown;
117
+ };
118
+ id: string;
119
+ /**
120
+ * A relationships object for a email-marketing-campaign
121
+ */
122
+ relationships?: {
123
+ [key: string]: never;
124
+ };
125
+ type: string;
126
+ };
127
+ /**
128
+ * A "Resource object" representing a crawler_result
129
+ */
130
+ type CrawlerResult = {
131
+ /**
132
+ * An attributes object for a crawler_result
133
+ */
134
+ attributes?: {
135
+ [key: string]: never;
136
+ };
137
+ id: string;
138
+ /**
139
+ * A relationships object for a crawler_result
140
+ */
141
+ relationships?: {
142
+ [key: string]: never;
143
+ };
144
+ type: string;
145
+ };
1
146
  /**
2
147
  * A "Resource object" representing a scheduling_participant
3
148
  */
@@ -139,6 +284,158 @@ type WebhookConfig = {
139
284
  };
140
285
  type: string;
141
286
  };
287
+ /**
288
+ * A "Resource object" representing a catalog_taxonomy_node
289
+ */
290
+ type CatalogTaxonomyNode = {
291
+ /**
292
+ * An attributes object for a catalog_taxonomy_node
293
+ */
294
+ attributes?: {
295
+ /**
296
+ * Field included by default.
297
+ */
298
+ description?: string | null | unknown;
299
+ /**
300
+ * Field included by default.
301
+ */
302
+ name: string;
303
+ /**
304
+ * Field included by default.
305
+ */
306
+ path?: string | null | unknown;
307
+ /**
308
+ * Field included by default.
309
+ */
310
+ position?: number | null | unknown;
311
+ /**
312
+ * Field included by default.
313
+ */
314
+ slug: string;
315
+ };
316
+ id: string;
317
+ /**
318
+ * A relationships object for a catalog_taxonomy_node
319
+ */
320
+ relationships?: {
321
+ [key: string]: never;
322
+ };
323
+ type: string;
324
+ };
325
+ /**
326
+ * A "Resource object" representing a crm_relationship_type
327
+ */
328
+ type CrmRelationshipType = {
329
+ /**
330
+ * An attributes object for a crm_relationship_type
331
+ */
332
+ attributes?: {
333
+ /**
334
+ * Field included by default.
335
+ */
336
+ is_directional: boolean;
337
+ /**
338
+ * Field included by default.
339
+ */
340
+ is_system: boolean;
341
+ /**
342
+ * Field included by default.
343
+ */
344
+ name: string;
345
+ /**
346
+ * Field included by default.
347
+ */
348
+ properties_schema?: {
349
+ [key: string]: unknown;
350
+ } | null | unknown;
351
+ /**
352
+ * Field included by default.
353
+ */
354
+ slug: string;
355
+ /**
356
+ * Field included by default.
357
+ */
358
+ source_entity_types: Array<string>;
359
+ /**
360
+ * Field included by default.
361
+ */
362
+ target_entity_types: Array<string>;
363
+ };
364
+ id: string;
365
+ /**
366
+ * A relationships object for a crm_relationship_type
367
+ */
368
+ relationships?: {
369
+ [key: string]: never;
370
+ };
371
+ type: string;
372
+ };
373
+ /**
374
+ * A "Resource object" representing a email-marketing-sender-profile
375
+ */
376
+ type EmailMarketingSenderProfile = {
377
+ /**
378
+ * An attributes object for a email-marketing-sender-profile
379
+ */
380
+ attributes?: {
381
+ /**
382
+ * Field included by default.
383
+ */
384
+ address?: string | null | unknown;
385
+ /**
386
+ * Field included by default.
387
+ */
388
+ company?: string | null | unknown;
389
+ /**
390
+ * Field included by default.
391
+ */
392
+ dkim_valid?: boolean | null | unknown;
393
+ /**
394
+ * Field included by default.
395
+ */
396
+ dmarc_valid?: boolean | null | unknown;
397
+ /**
398
+ * Field included by default.
399
+ */
400
+ dns_validated?: boolean | null | unknown;
401
+ /**
402
+ * Field included by default.
403
+ */
404
+ dns_validated_at?: unknown;
405
+ /**
406
+ * Field included by default.
407
+ */
408
+ email: string;
409
+ /**
410
+ * Field included by default.
411
+ */
412
+ is_default?: boolean | null | unknown;
413
+ /**
414
+ * Field included by default.
415
+ */
416
+ name: string;
417
+ /**
418
+ * Field included by default.
419
+ */
420
+ phone?: string | null | unknown;
421
+ /**
422
+ * Field included by default.
423
+ */
424
+ signature?: string | null | unknown;
425
+ /**
426
+ * Field included by default.
427
+ */
428
+ spf_valid?: boolean | null | unknown;
429
+ };
430
+ id: string;
431
+ /**
432
+ * A relationships object for a email-marketing-sender-profile
433
+ */
434
+ relationships?: {
435
+ [key: string]: never;
436
+ };
437
+ type: string;
438
+ };
142
439
  /**
143
440
  * A "Resource object" representing a scheduling_event_type
144
441
  */
@@ -597,6 +894,146 @@ type Thread = {
597
894
  };
598
895
  type: string;
599
896
  };
897
+ /**
898
+ * A "Resource object" representing a crm_activity
899
+ */
900
+ type CrmActivity = {
901
+ /**
902
+ * An attributes object for a crm_activity
903
+ */
904
+ attributes?: {
905
+ /**
906
+ * Field included by default.
907
+ */
908
+ ai_action_items?: {
909
+ [key: string]: unknown;
910
+ } | null | unknown;
911
+ /**
912
+ * Field included by default.
913
+ */
914
+ ai_summary?: string | null | unknown;
915
+ /**
916
+ * Field included by default.
917
+ */
918
+ body?: string | null | unknown;
919
+ /**
920
+ * Field included by default.
921
+ */
922
+ direction?: "inbound" | "outbound" | "internal" | unknown;
923
+ /**
924
+ * Field included by default.
925
+ */
926
+ duration_seconds?: number | null | unknown;
927
+ /**
928
+ * Field included by default.
929
+ */
930
+ occurred_at: unknown;
931
+ /**
932
+ * Field included by default.
933
+ */
934
+ properties?: {
935
+ [key: string]: unknown;
936
+ } | null | unknown;
937
+ /**
938
+ * Field included by default.
939
+ */
940
+ sentiment?: "positive" | "neutral" | "negative" | unknown;
941
+ /**
942
+ * Field included by default.
943
+ */
944
+ source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api" | unknown;
945
+ /**
946
+ * Field included by default.
947
+ */
948
+ source_ref?: string | null | unknown;
949
+ /**
950
+ * Field included by default.
951
+ */
952
+ subject?: string | null | unknown;
953
+ /**
954
+ * Field included by default.
955
+ */
956
+ type: "call" | "email" | "meeting" | "note" | "task" | "sms" | "chat" | "custom";
957
+ };
958
+ id: string;
959
+ /**
960
+ * A relationships object for a crm_activity
961
+ */
962
+ relationships?: {
963
+ [key: string]: never;
964
+ };
965
+ type: string;
966
+ };
967
+ /**
968
+ * A "Resource object" representing a crm_contact
969
+ */
970
+ type CrmContact = {
971
+ /**
972
+ * An attributes object for a crm_contact
973
+ */
974
+ attributes?: {
975
+ /**
976
+ * Field included by default.
977
+ */
978
+ ai_score?: number | null | unknown;
979
+ /**
980
+ * Field included by default.
981
+ */
982
+ ai_score_reasons?: {
983
+ [key: string]: unknown;
984
+ } | null | unknown;
985
+ /**
986
+ * Field included by default.
987
+ */
988
+ avatar_url?: string | null | unknown;
989
+ /**
990
+ * Field included by default.
991
+ */
992
+ email?: string | null | unknown;
993
+ /**
994
+ * Field included by default.
995
+ */
996
+ first_name: string;
997
+ /**
998
+ * Field included by default.
999
+ */
1000
+ last_name: string;
1001
+ /**
1002
+ * Field included by default.
1003
+ */
1004
+ lifecycle_stage?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | unknown;
1005
+ /**
1006
+ * Field included by default.
1007
+ */
1008
+ owner_id?: string | null | unknown;
1009
+ /**
1010
+ * Field included by default.
1011
+ */
1012
+ phone?: string | null | unknown;
1013
+ /**
1014
+ * Field included by default.
1015
+ */
1016
+ properties?: {
1017
+ [key: string]: unknown;
1018
+ } | null | unknown;
1019
+ /**
1020
+ * Field included by default.
1021
+ */
1022
+ source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api" | unknown;
1023
+ /**
1024
+ * Field included by default.
1025
+ */
1026
+ title?: string | null | unknown;
1027
+ };
1028
+ id: string;
1029
+ /**
1030
+ * A relationships object for a crm_contact
1031
+ */
1032
+ relationships?: {
1033
+ [key: string]: never;
1034
+ };
1035
+ type: string;
1036
+ };
600
1037
  /**
601
1038
  * A "Resource object" representing a notification_log
602
1039
  */
@@ -663,53 +1100,127 @@ type NotificationMethod = {
663
1100
  */
664
1101
  attributes?: {
665
1102
  /**
666
- * Configuration for the method, e.g. %{email: 'foo@bar.com'} or %{url: '...'}. Field included by default.
1103
+ * Configuration for the method, e.g. %{email: 'foo@bar.com'} or %{url: '...'}. Field included by default.
1104
+ */
1105
+ config: {
1106
+ [key: string]: unknown;
1107
+ };
1108
+ /**
1109
+ * Field included by default.
1110
+ */
1111
+ is_primary?: boolean | null | unknown;
1112
+ /**
1113
+ * User-friendly name, e.g. 'Personal Email'. Field included by default.
1114
+ */
1115
+ name: string;
1116
+ /**
1117
+ * Field included by default.
1118
+ */
1119
+ type: "email" | "sms" | "slack_webhook" | "generic_webhook";
1120
+ /**
1121
+ * Field included by default.
1122
+ */
1123
+ user_id: string;
1124
+ /**
1125
+ * When the last verification token was sent. Field included by default.
1126
+ */
1127
+ verification_sent_at?: unknown;
1128
+ /**
1129
+ * Field included by default.
1130
+ */
1131
+ verified_at?: unknown;
1132
+ };
1133
+ id: string;
1134
+ /**
1135
+ * A relationships object for a notification_method
1136
+ */
1137
+ relationships?: {
1138
+ user?: {
1139
+ /**
1140
+ * An identifier for user
1141
+ */
1142
+ data?: {
1143
+ id: string;
1144
+ meta?: {
1145
+ [key: string]: unknown;
1146
+ };
1147
+ type: string;
1148
+ } | null;
1149
+ };
1150
+ };
1151
+ type: string;
1152
+ };
1153
+ /**
1154
+ * A "Resource object" representing a catalog_product
1155
+ */
1156
+ type CatalogProduct = {
1157
+ /**
1158
+ * An attributes object for a catalog_product
1159
+ */
1160
+ attributes?: {
1161
+ /**
1162
+ * Field included by default.
1163
+ */
1164
+ ai_description?: string | null | unknown;
1165
+ /**
1166
+ * Field included by default.
1167
+ */
1168
+ application_id?: string | null | unknown;
1169
+ /**
1170
+ * Field included by default.
1171
+ */
1172
+ base_price?: string | null | unknown;
1173
+ /**
1174
+ * Field included by default.
667
1175
  */
668
- config: {
669
- [key: string]: unknown;
670
- };
1176
+ currency?: string | null | unknown;
671
1177
  /**
672
1178
  * Field included by default.
673
1179
  */
674
- is_primary?: boolean | null | unknown;
1180
+ description?: string | null | unknown;
675
1181
  /**
676
- * User-friendly name, e.g. 'Personal Email'. Field included by default.
1182
+ * Field included by default.
1183
+ */
1184
+ media?: Array<{
1185
+ [key: string]: unknown;
1186
+ }> | null | unknown;
1187
+ /**
1188
+ * Field included by default.
677
1189
  */
678
1190
  name: string;
679
1191
  /**
680
1192
  * Field included by default.
681
1193
  */
682
- type: "email" | "sms" | "slack_webhook" | "generic_webhook";
1194
+ properties?: {
1195
+ [key: string]: unknown;
1196
+ } | null | unknown;
683
1197
  /**
684
1198
  * Field included by default.
685
1199
  */
686
- user_id: string;
1200
+ short_description?: string | null | unknown;
687
1201
  /**
688
- * When the last verification token was sent. Field included by default.
1202
+ * Field included by default.
689
1203
  */
690
- verification_sent_at?: unknown;
1204
+ sku?: string | null | unknown;
691
1205
  /**
692
1206
  * Field included by default.
693
1207
  */
694
- verified_at?: unknown;
1208
+ slug: string;
1209
+ /**
1210
+ * Field included by default.
1211
+ */
1212
+ status: "draft" | "active" | "archived" | "discontinued";
1213
+ /**
1214
+ * Field included by default.
1215
+ */
1216
+ workspace_id: string;
695
1217
  };
696
1218
  id: string;
697
1219
  /**
698
- * A relationships object for a notification_method
1220
+ * A relationships object for a catalog_product
699
1221
  */
700
1222
  relationships?: {
701
- user?: {
702
- /**
703
- * An identifier for user
704
- */
705
- data?: {
706
- id: string;
707
- meta?: {
708
- [key: string]: unknown;
709
- };
710
- type: string;
711
- } | null;
712
- };
1223
+ [key: string]: never;
713
1224
  };
714
1225
  type: string;
715
1226
  };
@@ -955,6 +1466,84 @@ type WatcherEvent = {
955
1466
  };
956
1467
  type: string;
957
1468
  };
1469
+ /**
1470
+ * A "Resource object" representing a crm_pipeline
1471
+ */
1472
+ type CrmPipeline = {
1473
+ /**
1474
+ * An attributes object for a crm_pipeline
1475
+ */
1476
+ attributes?: {
1477
+ /**
1478
+ * Field included by default.
1479
+ */
1480
+ entity_type: string;
1481
+ /**
1482
+ * Field included by default.
1483
+ */
1484
+ is_default: boolean;
1485
+ /**
1486
+ * Field included by default.
1487
+ */
1488
+ name: string;
1489
+ /**
1490
+ * Field included by default.
1491
+ */
1492
+ workspace_id?: string | null | unknown;
1493
+ };
1494
+ id: string;
1495
+ /**
1496
+ * A relationships object for a crm_pipeline
1497
+ */
1498
+ relationships?: {
1499
+ [key: string]: never;
1500
+ };
1501
+ type: string;
1502
+ };
1503
+ /**
1504
+ * A "Resource object" representing a crm_relationship
1505
+ */
1506
+ type CrmRelationship = {
1507
+ /**
1508
+ * An attributes object for a crm_relationship
1509
+ */
1510
+ attributes?: {
1511
+ /**
1512
+ * Field included by default.
1513
+ */
1514
+ properties?: {
1515
+ [key: string]: unknown;
1516
+ } | null | unknown;
1517
+ /**
1518
+ * Field included by default.
1519
+ */
1520
+ source_entity_id: string;
1521
+ /**
1522
+ * Field included by default.
1523
+ */
1524
+ source_entity_type: string;
1525
+ /**
1526
+ * Field included by default.
1527
+ */
1528
+ strength?: number | null | unknown;
1529
+ /**
1530
+ * Field included by default.
1531
+ */
1532
+ target_entity_id: string;
1533
+ /**
1534
+ * Field included by default.
1535
+ */
1536
+ target_entity_type: string;
1537
+ };
1538
+ id: string;
1539
+ /**
1540
+ * A relationships object for a crm_relationship
1541
+ */
1542
+ relationships?: {
1543
+ [key: string]: never;
1544
+ };
1545
+ type: string;
1546
+ };
958
1547
  /**
959
1548
  * A "Resource object" representing a plan
960
1549
  */
@@ -1393,6 +1982,38 @@ type ApiKey = {
1393
1982
  };
1394
1983
  type: string;
1395
1984
  };
1985
+ /**
1986
+ * A "Resource object" representing a crm_custom_entity
1987
+ */
1988
+ type CrmCustomEntity = {
1989
+ /**
1990
+ * An attributes object for a crm_custom_entity
1991
+ */
1992
+ attributes?: {
1993
+ /**
1994
+ * Field included by default.
1995
+ */
1996
+ name: string;
1997
+ /**
1998
+ * Field included by default.
1999
+ */
2000
+ owner_id?: string | null | unknown;
2001
+ /**
2002
+ * Field included by default.
2003
+ */
2004
+ properties?: {
2005
+ [key: string]: unknown;
2006
+ } | null | unknown;
2007
+ };
2008
+ id: string;
2009
+ /**
2010
+ * A relationships object for a crm_custom_entity
2011
+ */
2012
+ relationships?: {
2013
+ [key: string]: never;
2014
+ };
2015
+ type: string;
2016
+ };
1396
2017
  /**
1397
2018
  * A "Resource object" representing a transaction
1398
2019
  */
@@ -1768,30 +2389,148 @@ type Tenant = {
1768
2389
  * A relationships object for a tenant
1769
2390
  */
1770
2391
  relationships?: {
1771
- application?: {
1772
- /**
1773
- * An identifier for application
1774
- */
1775
- data?: {
1776
- id: string;
1777
- meta?: {
1778
- [key: string]: unknown;
1779
- };
1780
- type: string;
1781
- } | null;
1782
- };
1783
- workspaces?: {
1784
- /**
1785
- * Relationship data for workspaces
1786
- */
1787
- data?: Array<{
1788
- id: string;
1789
- meta?: {
1790
- [key: string]: unknown;
1791
- };
1792
- type: string;
1793
- }>;
1794
- };
2392
+ application?: {
2393
+ /**
2394
+ * An identifier for application
2395
+ */
2396
+ data?: {
2397
+ id: string;
2398
+ meta?: {
2399
+ [key: string]: unknown;
2400
+ };
2401
+ type: string;
2402
+ } | null;
2403
+ };
2404
+ workspaces?: {
2405
+ /**
2406
+ * Relationship data for workspaces
2407
+ */
2408
+ data?: Array<{
2409
+ id: string;
2410
+ meta?: {
2411
+ [key: string]: unknown;
2412
+ };
2413
+ type: string;
2414
+ }>;
2415
+ };
2416
+ };
2417
+ type: string;
2418
+ };
2419
+ /**
2420
+ * A "Resource object" representing a catalog_taxonomy
2421
+ */
2422
+ type CatalogTaxonomy = {
2423
+ /**
2424
+ * An attributes object for a catalog_taxonomy
2425
+ */
2426
+ attributes?: {
2427
+ /**
2428
+ * Field included by default.
2429
+ */
2430
+ ai_managed: boolean;
2431
+ /**
2432
+ * Field included by default.
2433
+ */
2434
+ application_id: string;
2435
+ /**
2436
+ * Field included by default.
2437
+ */
2438
+ is_hierarchical: boolean;
2439
+ /**
2440
+ * Field included by default.
2441
+ */
2442
+ is_required: boolean;
2443
+ /**
2444
+ * Field included by default.
2445
+ */
2446
+ max_depth?: number | null | unknown;
2447
+ /**
2448
+ * Field included by default.
2449
+ */
2450
+ name: string;
2451
+ /**
2452
+ * Field included by default.
2453
+ */
2454
+ scope: "application" | "workspace";
2455
+ /**
2456
+ * Field included by default.
2457
+ */
2458
+ slug: string;
2459
+ /**
2460
+ * Field included by default.
2461
+ */
2462
+ workspace_id?: string | null | unknown;
2463
+ };
2464
+ id: string;
2465
+ /**
2466
+ * A relationships object for a catalog_taxonomy
2467
+ */
2468
+ relationships?: {
2469
+ [key: string]: never;
2470
+ };
2471
+ type: string;
2472
+ };
2473
+ /**
2474
+ * A "Resource object" representing a credential
2475
+ */
2476
+ type Credential = {
2477
+ /**
2478
+ * An attributes object for a credential
2479
+ */
2480
+ attributes?: {
2481
+ /**
2482
+ * Field included by default.
2483
+ */
2484
+ application_id?: string | null | unknown;
2485
+ /**
2486
+ * Field included by default.
2487
+ */
2488
+ auth_type: "oauth2" | "api_key" | "basic_auth" | "jwt_bearer" | "client_credentials";
2489
+ /**
2490
+ * Field included by default.
2491
+ */
2492
+ connector_type: "salesforce" | "hubspot" | "slack" | "notion" | "sharepoint" | "gmail" | "outlook" | "microsoft_365" | "jira" | "confluence" | "fullscript" | "github" | "gitlab" | "google_calendar" | "google_chat" | "custom";
2493
+ /**
2494
+ * Number of consecutive token refresh failures. Reset to 0 on successful refresh. Field included by default.
2495
+ */
2496
+ consecutive_failures: number;
2497
+ /**
2498
+ * Field included by default.
2499
+ */
2500
+ expires_at?: string | null | unknown;
2501
+ /**
2502
+ * Field included by default.
2503
+ */
2504
+ last_refreshed_at?: string | null | unknown;
2505
+ /**
2506
+ * Field included by default.
2507
+ */
2508
+ metadata?: {
2509
+ [key: string]: unknown;
2510
+ } | null | unknown;
2511
+ /**
2512
+ * Field included by default.
2513
+ */
2514
+ refresh_status?: "valid" | "expiring_soon" | "refresh_failed" | "revoked" | unknown;
2515
+ /**
2516
+ * Field included by default.
2517
+ */
2518
+ scope_level: "workspace" | "tenant" | "application";
2519
+ /**
2520
+ * Field included by default.
2521
+ */
2522
+ tenant_id?: string | null | unknown;
2523
+ /**
2524
+ * Field included by default.
2525
+ */
2526
+ workspace_id: string;
2527
+ };
2528
+ id: string;
2529
+ /**
2530
+ * A relationships object for a credential
2531
+ */
2532
+ relationships?: {
2533
+ [key: string]: never;
1795
2534
  };
1796
2535
  type: string;
1797
2536
  };
@@ -2296,6 +3035,191 @@ type WebhookDelivery = {
2296
3035
  };
2297
3036
  type: string;
2298
3037
  };
3038
+ /**
3039
+ * A "Resource object" representing a connector_instance
3040
+ */
3041
+ type ConnectorInstance = {
3042
+ /**
3043
+ * An attributes object for a connector_instance
3044
+ */
3045
+ attributes?: {
3046
+ /**
3047
+ * Field included by default.
3048
+ */
3049
+ connector_type: "salesforce" | "hubspot" | "slack" | "notion" | "sharepoint" | "gmail" | "outlook" | "microsoft_365" | "jira" | "confluence" | "fullscript" | "github" | "gitlab" | "google_calendar" | "google_chat" | "custom";
3050
+ /**
3051
+ * Field included by default.
3052
+ */
3053
+ enabled?: boolean | null | unknown;
3054
+ /**
3055
+ * Field included by default.
3056
+ */
3057
+ health_status?: "healthy" | "degraded" | "unhealthy" | "unknown" | unknown;
3058
+ /**
3059
+ * Field included by default.
3060
+ */
3061
+ last_sync_at?: string | null | unknown;
3062
+ /**
3063
+ * Field included by default.
3064
+ */
3065
+ metadata?: {
3066
+ [key: string]: unknown;
3067
+ } | null | unknown;
3068
+ /**
3069
+ * Field included by default.
3070
+ */
3071
+ name: string;
3072
+ /**
3073
+ * Field included by default.
3074
+ */
3075
+ sync_interval_minutes?: number | null | unknown;
3076
+ /**
3077
+ * Field included by default.
3078
+ */
3079
+ workspace_id: string;
3080
+ };
3081
+ id: string;
3082
+ /**
3083
+ * A relationships object for a connector_instance
3084
+ */
3085
+ relationships?: {
3086
+ workspace?: {
3087
+ /**
3088
+ * An identifier for workspace
3089
+ */
3090
+ data?: {
3091
+ id: string;
3092
+ meta?: {
3093
+ [key: string]: unknown;
3094
+ };
3095
+ type: string;
3096
+ } | null;
3097
+ };
3098
+ };
3099
+ type: string;
3100
+ };
3101
+ /**
3102
+ * A "Resource object" representing a crm_deal
3103
+ */
3104
+ type CrmDeal = {
3105
+ /**
3106
+ * An attributes object for a crm_deal
3107
+ */
3108
+ attributes?: {
3109
+ /**
3110
+ * Field included by default.
3111
+ */
3112
+ ai_forecast_category?: "pipeline" | "best_case" | "commit" | "closed" | unknown;
3113
+ /**
3114
+ * Field included by default.
3115
+ */
3116
+ ai_next_action?: string | null | unknown;
3117
+ /**
3118
+ * Field included by default.
3119
+ */
3120
+ ai_risk_score?: number | null | unknown;
3121
+ /**
3122
+ * Field included by default.
3123
+ */
3124
+ amount?: string | null | unknown;
3125
+ /**
3126
+ * Field included by default.
3127
+ */
3128
+ close_date?: string | null | unknown;
3129
+ /**
3130
+ * Field included by default.
3131
+ */
3132
+ currency?: string | null | unknown;
3133
+ /**
3134
+ * Field included by default.
3135
+ */
3136
+ lost_reason?: string | null | unknown;
3137
+ /**
3138
+ * Field included by default.
3139
+ */
3140
+ name: string;
3141
+ /**
3142
+ * Field included by default.
3143
+ */
3144
+ owner_id?: string | null | unknown;
3145
+ /**
3146
+ * Field included by default.
3147
+ */
3148
+ probability?: number | null | unknown;
3149
+ /**
3150
+ * Field included by default.
3151
+ */
3152
+ properties?: {
3153
+ [key: string]: unknown;
3154
+ } | null | unknown;
3155
+ /**
3156
+ * Field included by default.
3157
+ */
3158
+ source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api" | unknown;
3159
+ /**
3160
+ * Field included by default.
3161
+ */
3162
+ status?: "open" | "won" | "lost" | "abandoned" | unknown;
3163
+ };
3164
+ id: string;
3165
+ /**
3166
+ * A relationships object for a crm_deal
3167
+ */
3168
+ relationships?: {
3169
+ [key: string]: never;
3170
+ };
3171
+ type: string;
3172
+ };
3173
+ /**
3174
+ * A "Resource object" representing a catalog_product_variant
3175
+ */
3176
+ type CatalogProductVariant = {
3177
+ /**
3178
+ * An attributes object for a catalog_product_variant
3179
+ */
3180
+ attributes?: {
3181
+ /**
3182
+ * Field included by default.
3183
+ */
3184
+ media?: Array<{
3185
+ [key: string]: unknown;
3186
+ }> | null | unknown;
3187
+ /**
3188
+ * Field included by default.
3189
+ */
3190
+ position?: number | null | unknown;
3191
+ /**
3192
+ * Field included by default.
3193
+ */
3194
+ price_override?: string | null | unknown;
3195
+ /**
3196
+ * Field included by default.
3197
+ */
3198
+ properties?: {
3199
+ [key: string]: unknown;
3200
+ } | null | unknown;
3201
+ /**
3202
+ * Field included by default.
3203
+ */
3204
+ sku: string;
3205
+ /**
3206
+ * Field included by default.
3207
+ */
3208
+ status: "active" | "archived";
3209
+ /**
3210
+ * Field included by default.
3211
+ */
3212
+ workspace_id: string;
3213
+ };
3214
+ id: string;
3215
+ /**
3216
+ * A relationships object for a catalog_product_variant
3217
+ */
3218
+ relationships?: {
3219
+ [key: string]: never;
3220
+ };
3221
+ type: string;
3222
+ };
2299
3223
  /**
2300
3224
  * A "Resource object" representing a voice_session
2301
3225
  */
@@ -2335,8 +3259,7 @@ type VoiceSession = {
2335
3259
  * response and is null in ALL subsequent read operations (GET, list). The token is
2336
3260
  * injected in-memory by the `:start` after_action and is NEVER written to the database
2337
3261
  * (enforced by a database CHECK constraint). Clients must capture it from the create response
2338
- * — it cannot be retrieved after that point.
2339
- * . Field included by default.
3262
+ * — it cannot be retrieved after that point. Field included by default.
2340
3263
  */
2341
3264
  livekit_token?: string | null | unknown;
2342
3265
  /**
@@ -2462,15 +3385,115 @@ type SchedulingBooking = {
2462
3385
  /**
2463
3386
  * Field included by default.
2464
3387
  */
2465
- party_size?: number | null | unknown;
3388
+ party_size?: number | null | unknown;
3389
+ /**
3390
+ * Field included by default.
3391
+ */
3392
+ status?: "pending_approval" | "pending_verification" | "confirmed" | "cancelled" | "no_show" | unknown;
3393
+ };
3394
+ id: string;
3395
+ /**
3396
+ * A relationships object for a scheduling_booking
3397
+ */
3398
+ relationships?: {
3399
+ [key: string]: never;
3400
+ };
3401
+ type: string;
3402
+ };
3403
+ /**
3404
+ * A "Resource object" representing a email-marketing-template
3405
+ */
3406
+ type EmailMarketingTemplate = {
3407
+ /**
3408
+ * An attributes object for a email-marketing-template
3409
+ */
3410
+ attributes?: {
3411
+ /**
3412
+ * Field included by default.
3413
+ */
3414
+ ai_instructions?: string | null | unknown;
3415
+ /**
3416
+ * Field included by default.
3417
+ */
3418
+ archived?: boolean | null | unknown;
3419
+ /**
3420
+ * Field included by default.
3421
+ */
3422
+ body_template?: string | null | unknown;
3423
+ /**
3424
+ * Field included by default.
3425
+ */
3426
+ name: string;
3427
+ /**
3428
+ * Field included by default.
3429
+ */
3430
+ subject_template?: string | null | unknown;
3431
+ /**
3432
+ * Field included by default.
3433
+ */
3434
+ type?: "template" | "prompt" | unknown;
3435
+ /**
3436
+ * Field included by default.
3437
+ */
3438
+ variables?: Array<string> | null | unknown;
3439
+ };
3440
+ id: string;
3441
+ /**
3442
+ * A relationships object for a email-marketing-template
3443
+ */
3444
+ relationships?: {
3445
+ [key: string]: never;
3446
+ };
3447
+ type: string;
3448
+ };
3449
+ /**
3450
+ * A "Resource object" representing a email-marketing-generated-email
3451
+ */
3452
+ type EmailMarketingGeneratedEmail = {
3453
+ /**
3454
+ * An attributes object for a email-marketing-generated-email
3455
+ */
3456
+ attributes?: {
3457
+ /**
3458
+ * Field included by default.
3459
+ */
3460
+ agent_execution_id?: string | null | unknown;
3461
+ /**
3462
+ * Field included by default.
3463
+ */
3464
+ body?: string | null | unknown;
3465
+ /**
3466
+ * Field included by default.
3467
+ */
3468
+ error_message?: string | null | unknown;
3469
+ /**
3470
+ * Field included by default.
3471
+ */
3472
+ is_approved?: boolean | null | unknown;
3473
+ /**
3474
+ * Field included by default.
3475
+ */
3476
+ is_edited?: boolean | null | unknown;
3477
+ /**
3478
+ * Field included by default.
3479
+ */
3480
+ scheduled_for?: unknown;
3481
+ /**
3482
+ * Field included by default.
3483
+ */
3484
+ sent_at?: unknown;
3485
+ /**
3486
+ * Field included by default.
3487
+ */
3488
+ status?: "draft" | "approved" | "sending" | "sent" | "scheduled" | "failed" | unknown;
2466
3489
  /**
2467
3490
  * Field included by default.
2468
3491
  */
2469
- status?: "pending_approval" | "pending_verification" | "confirmed" | "cancelled" | "no_show" | unknown;
3492
+ subject?: string | null | unknown;
2470
3493
  };
2471
3494
  id: string;
2472
3495
  /**
2473
- * A relationships object for a scheduling_booking
3496
+ * A relationships object for a email-marketing-generated-email
2474
3497
  */
2475
3498
  relationships?: {
2476
3499
  [key: string]: never;
@@ -2594,6 +3617,96 @@ type WorkspaceMembership = {
2594
3617
  };
2595
3618
  type: string;
2596
3619
  };
3620
+ /**
3621
+ * A "Resource object" representing a crawler_schedule
3622
+ */
3623
+ type CrawlerSchedule = {
3624
+ /**
3625
+ * An attributes object for a crawler_schedule
3626
+ */
3627
+ attributes?: {
3628
+ [key: string]: never;
3629
+ };
3630
+ id: string;
3631
+ /**
3632
+ * A relationships object for a crawler_schedule
3633
+ */
3634
+ relationships?: {
3635
+ jobs?: {
3636
+ /**
3637
+ * Relationship data for jobs
3638
+ */
3639
+ data?: Array<{
3640
+ id: string;
3641
+ meta?: {
3642
+ [key: string]: unknown;
3643
+ };
3644
+ type: string;
3645
+ }>;
3646
+ };
3647
+ };
3648
+ type: string;
3649
+ };
3650
+ /**
3651
+ * A "Resource object" representing a crm_company
3652
+ */
3653
+ type CrmCompany = {
3654
+ /**
3655
+ * An attributes object for a crm_company
3656
+ */
3657
+ attributes?: {
3658
+ /**
3659
+ * Field included by default.
3660
+ */
3661
+ annual_revenue?: string | null | unknown;
3662
+ /**
3663
+ * Field included by default.
3664
+ */
3665
+ domain?: string | null | unknown;
3666
+ /**
3667
+ * Field included by default.
3668
+ */
3669
+ employee_count?: number | null | unknown;
3670
+ /**
3671
+ * Field included by default.
3672
+ */
3673
+ industry?: string | null | unknown;
3674
+ /**
3675
+ * Field included by default.
3676
+ */
3677
+ lifecycle_stage?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | unknown;
3678
+ /**
3679
+ * Field included by default.
3680
+ */
3681
+ location?: string | null | unknown;
3682
+ /**
3683
+ * Field included by default.
3684
+ */
3685
+ name: string;
3686
+ /**
3687
+ * Field included by default.
3688
+ */
3689
+ owner_id?: string | null | unknown;
3690
+ /**
3691
+ * Field included by default.
3692
+ */
3693
+ properties?: {
3694
+ [key: string]: unknown;
3695
+ } | null | unknown;
3696
+ /**
3697
+ * Field included by default.
3698
+ */
3699
+ source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api" | unknown;
3700
+ };
3701
+ id: string;
3702
+ /**
3703
+ * A relationships object for a crm_company
3704
+ */
3705
+ relationships?: {
3706
+ [key: string]: never;
3707
+ };
3708
+ type: string;
3709
+ };
2597
3710
  /**
2598
3711
  * A "Resource object" representing a bucket
2599
3712
  */
@@ -2700,6 +3813,36 @@ type CreditPackage = {
2700
3813
  };
2701
3814
  type: string;
2702
3815
  };
3816
+ /**
3817
+ * A "Resource object" representing a crawler_job
3818
+ */
3819
+ type CrawlerJob = {
3820
+ /**
3821
+ * An attributes object for a crawler_job
3822
+ */
3823
+ attributes?: {
3824
+ [key: string]: never;
3825
+ };
3826
+ id: string;
3827
+ /**
3828
+ * A relationships object for a crawler_job
3829
+ */
3830
+ relationships?: {
3831
+ results?: {
3832
+ /**
3833
+ * Relationship data for results
3834
+ */
3835
+ data?: Array<{
3836
+ id: string;
3837
+ meta?: {
3838
+ [key: string]: unknown;
3839
+ };
3840
+ type: string;
3841
+ }>;
3842
+ };
3843
+ };
3844
+ type: string;
3845
+ };
2703
3846
  /**
2704
3847
  * A "Resource object" representing a workspace
2705
3848
  */
@@ -3882,7 +5025,7 @@ declare class BrowserApiKeyError extends Error {
3882
5025
  }
3883
5026
 
3884
5027
  /** SDK version — updated automatically by mix update.sdks */
3885
- declare const SDK_VERSION = "0.2.1";
5028
+ declare const SDK_VERSION = "0.3.0";
3886
5029
  /** Default API version sent in every request — updated automatically by mix update.sdks */
3887
5030
  declare const DEFAULT_API_VERSION = "2026-02-25";
3888
5031
 
@@ -4225,6 +5368,32 @@ declare class RequestBuilder {
4225
5368
  streamGetRequest(url: string, options?: RequestOptions, streamOptions?: StreamOptions): Promise<AsyncIterableIterator<StreamMessageChunk>>;
4226
5369
  }
4227
5370
 
5371
+ /**
5372
+ * Return type for `voice.sessions.start()`.
5373
+ *
5374
+ * Narrows the generic `VoiceSession` type to guarantee that `livekit_token`
5375
+ * and `livekit_room` are present, non-null strings. These fields are populated
5376
+ * **only** on the POST /voice/sessions create response (one-time delivery) — the
5377
+ * server never persists the token and it is always null in GET/PATCH responses.
5378
+ *
5379
+ * Using this type instead of `VoiceSession` ensures TypeScript enforces that
5380
+ * callers capture the token before it becomes unavailable.
5381
+ *
5382
+ * @example
5383
+ * ```typescript
5384
+ * const session = await client.voice.sessions.start();
5385
+ * const token: string = session.attributes!.livekit_token; // guaranteed non-null
5386
+ * ```
5387
+ */
5388
+ type VoiceSessionStart = VoiceSession & {
5389
+ attributes: NonNullable<VoiceSession["attributes"]> & {
5390
+ /** LiveKit JWT for immediate room connection. One-time delivery — capture this immediately. */
5391
+ livekit_token: string;
5392
+ /** LiveKit room name. One-time delivery — capture alongside `livekit_token`. */
5393
+ livekit_room: string;
5394
+ };
5395
+ };
5396
+
4228
5397
  /**
4229
5398
  * Response from the voice transcription endpoint.
4230
5399
  * Not a JSON:API resource — this is a plain object response from the
@@ -4316,8 +5485,17 @@ declare function createVoiceNamespace(rb: RequestBuilder): {
4316
5485
  phiMode?: "none" | "tokenize" | "tokenize_encrypt";
4317
5486
  phiKey?: string;
4318
5487
  patientId?: string;
4319
- }, options?: RequestOptions) => Promise<VoiceSession>;
4320
- /** End a voice session and release the LiveKit room */
5488
+ }, options?: RequestOptions) => Promise<VoiceSessionStart>;
5489
+ /**
5490
+ * End a voice session and release the LiveKit room.
5491
+ *
5492
+ * @param id - Voice session ID to end
5493
+ * @param options - Request options
5494
+ *
5495
+ * @note Session stop is fully server-controlled. No attributes are accepted
5496
+ * in the request body — `status` is set to `"ended"` and `ended_at` is set
5497
+ * automatically. Passing extra attributes will result in a 422 error.
5498
+ */
4321
5499
  stop: (id: string, options?: RequestOptions) => Promise<VoiceSession>;
4322
5500
  /**
4323
5501
  * Dispatch the accumulated session transcript to the blueprint or chat
@@ -4473,7 +5651,7 @@ declare function createIdentityNamespace(rb: RequestBuilder, baseUrl?: string):
4473
5651
  * A single attribute filter predicate for server-side JSONB row filtering.
4474
5652
  * Operators: eq, not_eq, contains, in, lt, gt, not_null
4475
5653
  */
4476
- interface AttributeFilter {
5654
+ interface AttributeFilter$1 {
4477
5655
  /** The column name to filter on */
4478
5656
  field: string;
4479
5657
  /** Comparison operator */
@@ -4484,7 +5662,7 @@ interface AttributeFilter {
4484
5662
  /** Parameters for `results.query()` */
4485
5663
  interface ExtractionRowQueryParams {
4486
5664
  /** Filter predicates applied server-side (AND semantics). Empty array returns all rows. */
4487
- filters: AttributeFilter[];
5665
+ filters?: AttributeFilter$1[];
4488
5666
  /** Maximum rows to return. Defaults to 1000. Server enforces max 5000. */
4489
5667
  limit?: number;
4490
5668
  /** Zero-based row offset for pagination. Defaults to 0. */
@@ -4567,7 +5745,7 @@ declare function createExtractionNamespace(rb: RequestBuilder): {
4567
5745
  * });
4568
5746
  * console.log(`${result.filtered} of ${result.total} rows match`);
4569
5747
  */
4570
- query: (resultId: string, params: ExtractionRowQueryParams, options?: RequestOptions) => Promise<ExtractionRowQueryResult>;
5748
+ query: (resultId: string, params?: ExtractionRowQueryParams, options?: RequestOptions) => Promise<ExtractionRowQueryResult>;
4571
5749
  };
4572
5750
  batches: {
4573
5751
  create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ExtractionBatch>;
@@ -4601,6 +5779,111 @@ declare function createExtractionNamespace(rb: RequestBuilder): {
4601
5779
  };
4602
5780
  };
4603
5781
 
5782
+ interface Ticket {
5783
+ id: string;
5784
+ [key: string]: unknown;
5785
+ }
5786
+ interface TicketMessage {
5787
+ id: string;
5788
+ [key: string]: unknown;
5789
+ }
5790
+
5791
+ interface DataStoreRecord {
5792
+ id: string;
5793
+ namespace: string;
5794
+ key: string;
5795
+ value: unknown;
5796
+ version: number;
5797
+ [key: string]: unknown;
5798
+ }
5799
+
5800
+ type CrmEntityType = "contact" | "custom_entity" | "activity";
5801
+ type CrmExportFormat = "json" | "csv";
5802
+ type CrmExportStatus = "pending" | "processing" | "complete" | "failed";
5803
+ interface CrmDataExportJob {
5804
+ id: string;
5805
+ workspace_id: string;
5806
+ entity_type: CrmEntityType;
5807
+ entity_subtype?: string;
5808
+ format: CrmExportFormat;
5809
+ include: string[];
5810
+ status: CrmExportStatus;
5811
+ file_url?: string;
5812
+ url_expires_at?: string;
5813
+ row_count?: number;
5814
+ error?: string;
5815
+ inserted_at: string;
5816
+ updated_at: string;
5817
+ }
5818
+ interface CrmExportCreateParams {
5819
+ entityType: CrmEntityType;
5820
+ entitySubtype?: string;
5821
+ format: CrmExportFormat;
5822
+ include?: string[];
5823
+ filters?: AttributeFilter[];
5824
+ }
5825
+ type FilterOperator = "eq" | "not_eq" | "contains" | "in" | "lt" | "gt" | "not_null";
5826
+ interface AttributeFilter {
5827
+ field: string;
5828
+ op: FilterOperator;
5829
+ value?: unknown;
5830
+ }
5831
+ interface AggregateMetric {
5832
+ fn: "count";
5833
+ }
5834
+ interface AggregateFieldMetric {
5835
+ fn: "avg" | "sum";
5836
+ field: string;
5837
+ }
5838
+ /**
5839
+ * A version snapshot of a CrmCustomEntity.
5840
+ * Field names match the CustomEntityVersion Ash resource attributes exactly.
5841
+ */
5842
+ interface CrmCustomEntityVersion {
5843
+ id: string;
5844
+ version_number: number;
5845
+ /** Snapshot of the entity's properties field at the time of the update. */
5846
+ attributes: Record<string, unknown>;
5847
+ updated_by_user_id?: string;
5848
+ /** ISO 8601 timestamp — the resource uses inserted_at (no updated_at). */
5849
+ inserted_at: string;
5850
+ custom_entity_id: string;
5851
+ workspace_id: string;
5852
+ }
5853
+
5854
+ interface OAuthInitiateResult {
5855
+ auth_url: string;
5856
+ state: string;
5857
+ }
5858
+ interface FullscriptPatient {
5859
+ id: string;
5860
+ email: string;
5861
+ first_name: string;
5862
+ last_name: string;
5863
+ date_of_birth?: string;
5864
+ fullscript_id?: string;
5865
+ [key: string]: unknown;
5866
+ }
5867
+ interface FullscriptSessionGrant {
5868
+ token: string;
5869
+ expires_at: string;
5870
+ patient_id: string;
5871
+ }
5872
+
5873
+ interface ChannelConfig {
5874
+ id: string;
5875
+ channel_type: string;
5876
+ [key: string]: unknown;
5877
+ }
5878
+ interface InboundMessage {
5879
+ id: string;
5880
+ [key: string]: unknown;
5881
+ }
5882
+ interface OutboundMessage {
5883
+ id: string;
5884
+ [key: string]: unknown;
5885
+ }
5886
+
4604
5887
  /**
4605
5888
  * GPT Core Client SDK
4606
5889
  *
@@ -4731,6 +6014,39 @@ declare class GptClient extends BaseClient {
4731
6014
  get: (id: string, options?: RequestOptions) => Promise<PaymentMethod>;
4732
6015
  };
4733
6016
  };
6017
+ /** Product catalog, inventory, pricing, and taxonomy */
6018
+ readonly catalog: {
6019
+ products: {
6020
+ list: (_options?: {
6021
+ page?: number;
6022
+ pageSize?: number;
6023
+ } & RequestOptions) => Promise<CatalogProduct[]>;
6024
+ get: (_id: string, _options?: RequestOptions) => Promise<CatalogProduct>;
6025
+ create: (_attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<CatalogProduct>;
6026
+ update: (_id: string, _attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<CatalogProduct>;
6027
+ };
6028
+ variants: {
6029
+ listByProduct: (_productId: string, _options?: RequestOptions) => Promise<CatalogProductVariant[]>;
6030
+ };
6031
+ taxonomies: {
6032
+ list: (_options?: RequestOptions) => Promise<CatalogTaxonomy[]>;
6033
+ getNodes: (_taxonomyId: string, _options?: RequestOptions) => Promise<CatalogTaxonomyNode[]>;
6034
+ };
6035
+ };
6036
+ /** Multi-channel messaging (WhatsApp, Slack, Email) */
6037
+ readonly channels: {
6038
+ configs: {
6039
+ list: (_options?: RequestOptions) => Promise<ChannelConfig[]>;
6040
+ get: (_id: string, _options?: RequestOptions) => Promise<ChannelConfig>;
6041
+ };
6042
+ messages: {
6043
+ send: (_attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<OutboundMessage>;
6044
+ listInbound: (_options?: {
6045
+ page?: number;
6046
+ pageSize?: number;
6047
+ } & RequestOptions) => Promise<InboundMessage[]>;
6048
+ };
6049
+ };
4734
6050
  /** Notification logs, methods, and preferences */
4735
6051
  readonly communication: {
4736
6052
  notifications: {
@@ -4768,6 +6084,246 @@ declare class GptClient extends BaseClient {
4768
6084
  };
4769
6085
  };
4770
6086
  };
6087
+ /** OAuth and API adapters for external systems */
6088
+ readonly connectors: {
6089
+ instances: {
6090
+ list: (options?: RequestOptions) => Promise<ConnectorInstance[]>;
6091
+ get: (id: string, options?: RequestOptions) => Promise<ConnectorInstance>;
6092
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ConnectorInstance>;
6093
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ConnectorInstance>;
6094
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6095
+ };
6096
+ credentials: {
6097
+ list: (options?: RequestOptions) => Promise<Credential[]>;
6098
+ get: (id: string, options?: RequestOptions) => Promise<Credential>;
6099
+ refresh: (id: string, options?: RequestOptions) => Promise<Credential>;
6100
+ };
6101
+ oauth: {
6102
+ connect: (connectorType: string, workspaceId: string, options?: RequestOptions) => Promise<OAuthInitiateResult>;
6103
+ callback: (connectorType: string, code: string, state: string, workspaceId: string, options?: RequestOptions) => Promise<ConnectorInstance>;
6104
+ };
6105
+ available: {
6106
+ list: () => string[];
6107
+ };
6108
+ fullscript: {
6109
+ checkPatient: (connectorId: string, workspaceId: string, email: string, options?: RequestOptions) => Promise<FullscriptPatient | null>;
6110
+ createPatient: (connectorId: string, workspaceId: string, attrs: {
6111
+ first_name: string;
6112
+ last_name: string;
6113
+ email: string;
6114
+ date_of_birth?: string;
6115
+ }, options?: RequestOptions) => Promise<FullscriptPatient>;
6116
+ sessionGrant: (connectorId: string, workspaceId: string, patientId: string, options?: RequestOptions) => Promise<FullscriptSessionGrant>;
6117
+ oauth: {
6118
+ connect: (workspaceId: string, options?: RequestOptions) => Promise<OAuthInitiateResult>;
6119
+ callback: (code: string, state: string, workspaceId: string, options?: RequestOptions) => Promise<ConnectorInstance>;
6120
+ };
6121
+ };
6122
+ };
6123
+ /** Web crawling and content extraction */
6124
+ readonly crawler: {
6125
+ jobs: {
6126
+ list: (options?: {
6127
+ page?: number;
6128
+ pageSize?: number;
6129
+ } & RequestOptions) => Promise<CrawlerJob[]>;
6130
+ get: (id: string, options?: RequestOptions) => Promise<CrawlerJob>;
6131
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrawlerJob>;
6132
+ cancel: (id: string, options?: RequestOptions) => Promise<CrawlerJob>;
6133
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6134
+ };
6135
+ schedules: {
6136
+ list: (options?: RequestOptions) => Promise<CrawlerSchedule[]>;
6137
+ get: (id: string, options?: RequestOptions) => Promise<CrawlerSchedule>;
6138
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrawlerSchedule>;
6139
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrawlerSchedule>;
6140
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6141
+ };
6142
+ results: {
6143
+ list: (options?: {
6144
+ page?: number;
6145
+ pageSize?: number;
6146
+ } & RequestOptions) => Promise<CrawlerResult[]>;
6147
+ get: (id: string, options?: RequestOptions) => Promise<CrawlerResult>;
6148
+ };
6149
+ };
6150
+ /** Contacts, companies, deals, activities, pipelines, relationships, and custom entities */
6151
+ readonly crm: {
6152
+ contacts: {
6153
+ get: (id: string, options?: RequestOptions) => Promise<CrmContact>;
6154
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmContact>;
6155
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmContact>;
6156
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6157
+ listByWorkspace: (workspaceId: string, options?: {
6158
+ page?: number;
6159
+ pageSize?: number;
6160
+ } & RequestOptions) => Promise<CrmContact[]>;
6161
+ };
6162
+ companies: {
6163
+ get: (id: string, options?: RequestOptions) => Promise<CrmCompany>;
6164
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCompany>;
6165
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCompany>;
6166
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6167
+ listByWorkspace: (workspaceId: string, options?: {
6168
+ page?: number;
6169
+ pageSize?: number;
6170
+ } & RequestOptions) => Promise<CrmCompany[]>;
6171
+ };
6172
+ deals: {
6173
+ get: (id: string, options?: RequestOptions) => Promise<CrmDeal>;
6174
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmDeal>;
6175
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmDeal>;
6176
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6177
+ listByWorkspace: (workspaceId: string, options?: {
6178
+ page?: number;
6179
+ pageSize?: number;
6180
+ } & RequestOptions) => Promise<CrmDeal[]>;
6181
+ };
6182
+ activities: {
6183
+ get: (id: string, options?: RequestOptions) => Promise<CrmActivity>;
6184
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmActivity>;
6185
+ update: (_id: string, _attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<CrmActivity>;
6186
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6187
+ listByWorkspace: (workspaceId: string, options?: {
6188
+ page?: number;
6189
+ pageSize?: number;
6190
+ } & RequestOptions) => Promise<CrmActivity[]>;
6191
+ };
6192
+ pipelines: {
6193
+ get: (id: string, options?: RequestOptions) => Promise<CrmPipeline>;
6194
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipeline>;
6195
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipeline>;
6196
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6197
+ listByWorkspace: (workspaceId: string, options?: RequestOptions) => Promise<CrmPipeline[]>;
6198
+ };
6199
+ pipelineStages: {
6200
+ get: (id: string, options?: RequestOptions) => Promise<CrmPipelineStage>;
6201
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipelineStage>;
6202
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipelineStage>;
6203
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6204
+ };
6205
+ relationshipTypes: {
6206
+ get: (id: string, options?: RequestOptions) => Promise<CrmRelationshipType>;
6207
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmRelationshipType>;
6208
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmRelationshipType>;
6209
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6210
+ list: (options?: RequestOptions) => Promise<CrmRelationshipType[]>;
6211
+ };
6212
+ relationships: {
6213
+ get: (id: string, options?: RequestOptions) => Promise<CrmRelationship>;
6214
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmRelationship>;
6215
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6216
+ listByWorkspace: (workspaceId: string, options?: RequestOptions) => Promise<CrmRelationship[]>;
6217
+ };
6218
+ customEntities: {
6219
+ get: (id: string, options?: RequestOptions) => Promise<CrmCustomEntity>;
6220
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCustomEntity>;
6221
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCustomEntity>;
6222
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6223
+ listByWorkspace: (workspaceId: string, options?: {
6224
+ type?: string;
6225
+ filters?: AttributeFilter[];
6226
+ page?: number;
6227
+ pageSize?: number;
6228
+ } & RequestOptions) => Promise<CrmCustomEntity[]>;
6229
+ batchUpdate: (workspaceId: string, updates: Array<{
6230
+ id: string;
6231
+ attributes: Record<string, unknown>;
6232
+ }>, options?: RequestOptions) => Promise<CrmCustomEntity[]>;
6233
+ aggregate: (workspaceId: string, params: {
6234
+ type?: string;
6235
+ metrics: Array<AggregateMetric | AggregateFieldMetric>;
6236
+ group_by?: string;
6237
+ filters?: AttributeFilter[];
6238
+ }, options?: RequestOptions) => Promise<Array<Record<string, unknown>>>;
6239
+ versions: {
6240
+ list: (entityId: string, options?: {
6241
+ page?: number;
6242
+ pageSize?: number;
6243
+ } & RequestOptions) => Promise<CrmCustomEntityVersion[]>;
6244
+ get: (entityId: string, versionId: string, options?: RequestOptions) => Promise<CrmCustomEntityVersion>;
6245
+ restore: (entityId: string, versionId: string, options?: RequestOptions) => Promise<CrmCustomEntity>;
6246
+ };
6247
+ };
6248
+ export: {
6249
+ create: (workspaceId: string, params: CrmExportCreateParams, options?: RequestOptions) => Promise<CrmDataExportJob>;
6250
+ get: (jobId: string, options?: RequestOptions) => Promise<CrmDataExportJob>;
6251
+ list: (workspaceId: string, options?: RequestOptions) => Promise<CrmDataExportJob[]>;
6252
+ };
6253
+ };
6254
+ /** Key-value data store with namespaces and TTL */
6255
+ readonly dataStore: {
6256
+ records: {
6257
+ get: (_namespace: string, _key: string, _options?: RequestOptions) => Promise<DataStoreRecord | null>;
6258
+ set: (_namespace: string, _key: string, _value: unknown, _options?: RequestOptions) => Promise<DataStoreRecord>;
6259
+ delete: (_namespace: string, _key: string, _options?: RequestOptions) => Promise<true>;
6260
+ listKeys: (_namespace: string, _options?: RequestOptions) => Promise<string[]>;
6261
+ list: (_namespace: string, _options?: RequestOptions) => Promise<DataStoreRecord[]>;
6262
+ };
6263
+ namespaces: {
6264
+ getPolicy: (_namespace: string, _options?: RequestOptions) => Promise<unknown>;
6265
+ createPolicy: (_attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<unknown>;
6266
+ getStats: (_namespace: string, _options?: RequestOptions) => Promise<unknown>;
6267
+ };
6268
+ };
6269
+ /** Email campaigns, recipients, and sequences */
6270
+ readonly emailMarketing: {
6271
+ campaigns: {
6272
+ get: (id: string, options?: RequestOptions) => Promise<EmailMarketingCampaign>;
6273
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingCampaign>;
6274
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingCampaign>;
6275
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6276
+ listByWorkspace: (workspaceId: string, options?: {
6277
+ page?: number;
6278
+ pageSize?: number;
6279
+ } & RequestOptions) => Promise<EmailMarketingCampaign[]>;
6280
+ send: (id: string, options?: RequestOptions) => Promise<unknown>;
6281
+ analyze: (id: string, options?: RequestOptions) => Promise<unknown>;
6282
+ optimizeSendTimes: (id: string, options?: RequestOptions) => Promise<unknown>;
6283
+ createFollowup: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<unknown>;
6284
+ };
6285
+ templates: {
6286
+ listByWorkspace: (workspaceId: string, options?: {
6287
+ page?: number;
6288
+ pageSize?: number;
6289
+ } & RequestOptions) => Promise<EmailMarketingTemplate[]>;
6290
+ };
6291
+ generatedEmails: {
6292
+ get: (id: string, options?: RequestOptions) => Promise<EmailMarketingGeneratedEmail>;
6293
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingGeneratedEmail>;
6294
+ approve: (id: string, options?: RequestOptions) => Promise<EmailMarketingGeneratedEmail>;
6295
+ };
6296
+ senderProfiles: {
6297
+ get: (id: string, options?: RequestOptions) => Promise<EmailMarketingSenderProfile>;
6298
+ update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingSenderProfile>;
6299
+ validateDns: (id: string, options?: RequestOptions) => Promise<unknown>;
6300
+ delete: (id: string, options?: RequestOptions) => Promise<true>;
6301
+ };
6302
+ sequences: {
6303
+ create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<unknown>;
6304
+ listByWorkspace: (workspaceId: string, options?: {
6305
+ page?: number;
6306
+ pageSize?: number;
6307
+ } & RequestOptions) => Promise<unknown[]>;
6308
+ resume: (id: string, options?: RequestOptions) => Promise<unknown>;
6309
+ };
6310
+ };
6311
+ /** Support tickets, queues, SLA, and agent presence */
6312
+ readonly support: {
6313
+ tickets: {
6314
+ list: (_options?: {
6315
+ page?: number;
6316
+ pageSize?: number;
6317
+ } & RequestOptions) => Promise<Ticket[]>;
6318
+ get: (_id: string, _options?: RequestOptions) => Promise<Ticket>;
6319
+ create: (_attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<Ticket>;
6320
+ update: (_id: string, _attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<Ticket>;
6321
+ addMessage: (_ticketId: string, _attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<TicketMessage>;
6322
+ };
6323
+ queues: {
6324
+ list: (_options?: RequestOptions) => Promise<unknown[]>;
6325
+ };
6326
+ };
4771
6327
  /** Document upload, processing, results, and exports */
4772
6328
  readonly extraction: {
4773
6329
  documents: {
@@ -4814,7 +6370,7 @@ declare class GptClient extends BaseClient {
4814
6370
  page?: number;
4815
6371
  pageSize?: number;
4816
6372
  } & RequestOptions) => Promise<ExtractionResult[]>;
4817
- query: (resultId: string, params: ExtractionRowQueryParams, options?: RequestOptions) => Promise<ExtractionRowQueryResult>;
6373
+ query: (resultId: string, params?: ExtractionRowQueryParams, options?: RequestOptions) => Promise<ExtractionRowQueryResult>;
4818
6374
  };
4819
6375
  batches: {
4820
6376
  create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ExtractionBatch>;
@@ -5113,7 +6669,9 @@ declare class GptClient extends BaseClient {
5113
6669
  transcribe: (audio: File | Blob, params?: {
5114
6670
  language?: string;
5115
6671
  modelSize?: "tiny" | "base" | "small" | "medium" | "large";
5116
- phiMode?: "none" | "tokenize" | "tokenize_encrypt";
6672
+ phiMode
6673
+ /** Contacts, companies, deals, activities, pipelines, relationships, and custom entities */
6674
+ ?: "none" | "tokenize" | "tokenize_encrypt";
5117
6675
  phiKey?: string;
5118
6676
  }, options?: RequestOptions) => Promise<VoiceTranscribeResult>;
5119
6677
  sessions: {
@@ -5137,7 +6695,7 @@ declare class GptClient extends BaseClient {
5137
6695
  phiMode?: "none" | "tokenize" | "tokenize_encrypt";
5138
6696
  phiKey?: string;
5139
6697
  patientId?: string;
5140
- }, options?: RequestOptions) => Promise<VoiceSession>;
6698
+ }, options?: RequestOptions) => Promise<VoiceSessionStart>;
5141
6699
  stop: (id: string, options?: RequestOptions) => Promise<VoiceSession>;
5142
6700
  finalize: (id: string, params?: {
5143
6701
  blueprintId?: string;