@gpt-platform/client 0.2.1 → 0.3.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.
- package/dist/index.d.mts +1970 -262
- package/dist/index.d.ts +1970 -262
- package/dist/index.js +2511 -193
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2511 -193
- package/dist/index.mjs.map +1 -1
- package/llms.txt +1 -1
- package/package.json +1 -1
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
|
*/
|
|
@@ -598,25 +895,165 @@ type Thread = {
|
|
|
598
895
|
type: string;
|
|
599
896
|
};
|
|
600
897
|
/**
|
|
601
|
-
* A "Resource object" representing a
|
|
898
|
+
* A "Resource object" representing a crm_activity
|
|
602
899
|
*/
|
|
603
|
-
type
|
|
900
|
+
type CrmActivity = {
|
|
604
901
|
/**
|
|
605
|
-
* An attributes object for a
|
|
902
|
+
* An attributes object for a crm_activity
|
|
606
903
|
*/
|
|
607
904
|
attributes?: {
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
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
|
+
};
|
|
1037
|
+
/**
|
|
1038
|
+
* A "Resource object" representing a notification_log
|
|
1039
|
+
*/
|
|
1040
|
+
type NotificationLog = {
|
|
1041
|
+
/**
|
|
1042
|
+
* An attributes object for a notification_log
|
|
1043
|
+
*/
|
|
1044
|
+
attributes?: {
|
|
1045
|
+
[key: string]: never;
|
|
1046
|
+
};
|
|
1047
|
+
id: string;
|
|
1048
|
+
/**
|
|
1049
|
+
* A relationships object for a notification_log
|
|
1050
|
+
*/
|
|
1051
|
+
relationships?: {
|
|
1052
|
+
[key: string]: never;
|
|
1053
|
+
};
|
|
1054
|
+
type: string;
|
|
1055
|
+
};
|
|
1056
|
+
/**
|
|
620
1057
|
* A "Resource object" representing a token
|
|
621
1058
|
*/
|
|
622
1059
|
type Token = {
|
|
@@ -713,6 +1150,80 @@ type NotificationMethod = {
|
|
|
713
1150
|
};
|
|
714
1151
|
type: string;
|
|
715
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.
|
|
1175
|
+
*/
|
|
1176
|
+
currency?: string | null | unknown;
|
|
1177
|
+
/**
|
|
1178
|
+
* Field included by default.
|
|
1179
|
+
*/
|
|
1180
|
+
description?: string | null | unknown;
|
|
1181
|
+
/**
|
|
1182
|
+
* Field included by default.
|
|
1183
|
+
*/
|
|
1184
|
+
media?: Array<{
|
|
1185
|
+
[key: string]: unknown;
|
|
1186
|
+
}> | null | unknown;
|
|
1187
|
+
/**
|
|
1188
|
+
* Field included by default.
|
|
1189
|
+
*/
|
|
1190
|
+
name: string;
|
|
1191
|
+
/**
|
|
1192
|
+
* Field included by default.
|
|
1193
|
+
*/
|
|
1194
|
+
properties?: {
|
|
1195
|
+
[key: string]: unknown;
|
|
1196
|
+
} | null | unknown;
|
|
1197
|
+
/**
|
|
1198
|
+
* Field included by default.
|
|
1199
|
+
*/
|
|
1200
|
+
short_description?: string | null | unknown;
|
|
1201
|
+
/**
|
|
1202
|
+
* Field included by default.
|
|
1203
|
+
*/
|
|
1204
|
+
sku?: string | null | unknown;
|
|
1205
|
+
/**
|
|
1206
|
+
* Field included by default.
|
|
1207
|
+
*/
|
|
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;
|
|
1217
|
+
};
|
|
1218
|
+
id: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* A relationships object for a catalog_product
|
|
1221
|
+
*/
|
|
1222
|
+
relationships?: {
|
|
1223
|
+
[key: string]: never;
|
|
1224
|
+
};
|
|
1225
|
+
type: string;
|
|
1226
|
+
};
|
|
716
1227
|
/**
|
|
717
1228
|
* A "Resource object" representing a scheduling_calendar_sync
|
|
718
1229
|
*/
|
|
@@ -956,80 +1467,77 @@ type WatcherEvent = {
|
|
|
956
1467
|
type: string;
|
|
957
1468
|
};
|
|
958
1469
|
/**
|
|
959
|
-
* A "Resource object" representing a
|
|
1470
|
+
* A "Resource object" representing a crm_pipeline
|
|
960
1471
|
*/
|
|
961
|
-
type
|
|
1472
|
+
type CrmPipeline = {
|
|
962
1473
|
/**
|
|
963
|
-
* An attributes object for a
|
|
1474
|
+
* An attributes object for a crm_pipeline
|
|
964
1475
|
*/
|
|
965
1476
|
attributes?: {
|
|
966
1477
|
/**
|
|
967
1478
|
* Field included by default.
|
|
968
1479
|
*/
|
|
969
|
-
|
|
1480
|
+
entity_type: string;
|
|
970
1481
|
/**
|
|
971
1482
|
* Field included by default.
|
|
972
1483
|
*/
|
|
973
|
-
|
|
1484
|
+
is_default: boolean;
|
|
974
1485
|
/**
|
|
975
1486
|
* Field included by default.
|
|
976
1487
|
*/
|
|
977
|
-
|
|
978
|
-
/**
|
|
979
|
-
* One-time credits granted upon first subscription (Welcome Bonus). Field included by default.
|
|
980
|
-
*/
|
|
981
|
-
initial_credits: number;
|
|
982
|
-
/**
|
|
983
|
-
* Distinguishes base plans from add-ons. Field included by default.
|
|
984
|
-
*/
|
|
985
|
-
is_addon: boolean;
|
|
986
|
-
/**
|
|
987
|
-
* Maximum number of renewals for free trial (nil = unlimited). Field included by default.
|
|
988
|
-
*/
|
|
989
|
-
max_renewals?: number | null | unknown;
|
|
1488
|
+
name: string;
|
|
990
1489
|
/**
|
|
991
1490
|
* Field included by default.
|
|
992
1491
|
*/
|
|
993
|
-
|
|
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?: {
|
|
994
1511
|
/**
|
|
995
1512
|
* Field included by default.
|
|
996
1513
|
*/
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
};
|
|
1514
|
+
properties?: {
|
|
1515
|
+
[key: string]: unknown;
|
|
1516
|
+
} | null | unknown;
|
|
1001
1517
|
/**
|
|
1002
1518
|
* Field included by default.
|
|
1003
1519
|
*/
|
|
1004
|
-
|
|
1520
|
+
source_entity_id: string;
|
|
1005
1521
|
/**
|
|
1006
1522
|
* Field included by default.
|
|
1007
1523
|
*/
|
|
1008
|
-
|
|
1009
|
-
/**
|
|
1010
|
-
* Storage included in plan (bytes). Free=1GB, Pro=10GB, Business=50GB, Enterprise=500GB. Field included by default.
|
|
1011
|
-
*/
|
|
1012
|
-
storage_included_bytes: number;
|
|
1013
|
-
/**
|
|
1014
|
-
* Hard ceiling in bytes. Prevents runaway bills. nil = unlimited. Field included by default.
|
|
1015
|
-
*/
|
|
1016
|
-
storage_max_bytes?: number | null | unknown;
|
|
1524
|
+
source_entity_type: string;
|
|
1017
1525
|
/**
|
|
1018
|
-
*
|
|
1526
|
+
* Field included by default.
|
|
1019
1527
|
*/
|
|
1020
|
-
|
|
1528
|
+
strength?: number | null | unknown;
|
|
1021
1529
|
/**
|
|
1022
1530
|
* Field included by default.
|
|
1023
1531
|
*/
|
|
1024
|
-
|
|
1532
|
+
target_entity_id: string;
|
|
1025
1533
|
/**
|
|
1026
1534
|
* Field included by default.
|
|
1027
1535
|
*/
|
|
1028
|
-
|
|
1536
|
+
target_entity_type: string;
|
|
1029
1537
|
};
|
|
1030
1538
|
id: string;
|
|
1031
1539
|
/**
|
|
1032
|
-
* A relationships object for a
|
|
1540
|
+
* A relationships object for a crm_relationship
|
|
1033
1541
|
*/
|
|
1034
1542
|
relationships?: {
|
|
1035
1543
|
[key: string]: never;
|
|
@@ -1037,20 +1545,127 @@ type Plan = {
|
|
|
1037
1545
|
type: string;
|
|
1038
1546
|
};
|
|
1039
1547
|
/**
|
|
1040
|
-
* A "Resource object" representing a
|
|
1548
|
+
* A "Resource object" representing a support_tag
|
|
1041
1549
|
*/
|
|
1042
|
-
type
|
|
1550
|
+
type SupportTag = {
|
|
1043
1551
|
/**
|
|
1044
|
-
* An attributes object for a
|
|
1552
|
+
* An attributes object for a support_tag
|
|
1045
1553
|
*/
|
|
1046
1554
|
attributes?: {
|
|
1047
|
-
acting_tenant_id?: string | null | unknown;
|
|
1048
1555
|
/**
|
|
1049
1556
|
* Field included by default.
|
|
1050
1557
|
*/
|
|
1051
|
-
|
|
1558
|
+
color?: string | null | unknown;
|
|
1052
1559
|
/**
|
|
1053
|
-
*
|
|
1560
|
+
* Field included by default.
|
|
1561
|
+
*/
|
|
1562
|
+
name: string;
|
|
1563
|
+
};
|
|
1564
|
+
id: string;
|
|
1565
|
+
/**
|
|
1566
|
+
* A relationships object for a support_tag
|
|
1567
|
+
*/
|
|
1568
|
+
relationships?: {
|
|
1569
|
+
[key: string]: never;
|
|
1570
|
+
};
|
|
1571
|
+
type: string;
|
|
1572
|
+
};
|
|
1573
|
+
/**
|
|
1574
|
+
* A "Resource object" representing a plan
|
|
1575
|
+
*/
|
|
1576
|
+
type Plan = {
|
|
1577
|
+
/**
|
|
1578
|
+
* An attributes object for a plan
|
|
1579
|
+
*/
|
|
1580
|
+
attributes?: {
|
|
1581
|
+
/**
|
|
1582
|
+
* Field included by default.
|
|
1583
|
+
*/
|
|
1584
|
+
application_id: string;
|
|
1585
|
+
/**
|
|
1586
|
+
* Field included by default.
|
|
1587
|
+
*/
|
|
1588
|
+
billing_interval: number;
|
|
1589
|
+
/**
|
|
1590
|
+
* Field included by default.
|
|
1591
|
+
*/
|
|
1592
|
+
created_at: unknown;
|
|
1593
|
+
/**
|
|
1594
|
+
* One-time credits granted upon first subscription (Welcome Bonus). Field included by default.
|
|
1595
|
+
*/
|
|
1596
|
+
initial_credits: number;
|
|
1597
|
+
/**
|
|
1598
|
+
* Distinguishes base plans from add-ons. Field included by default.
|
|
1599
|
+
*/
|
|
1600
|
+
is_addon: boolean;
|
|
1601
|
+
/**
|
|
1602
|
+
* Maximum number of renewals for free trial (nil = unlimited). Field included by default.
|
|
1603
|
+
*/
|
|
1604
|
+
max_renewals?: number | null | unknown;
|
|
1605
|
+
/**
|
|
1606
|
+
* Field included by default.
|
|
1607
|
+
*/
|
|
1608
|
+
monthly_credits: number;
|
|
1609
|
+
/**
|
|
1610
|
+
* Field included by default.
|
|
1611
|
+
*/
|
|
1612
|
+
monthly_price: {
|
|
1613
|
+
amount: string;
|
|
1614
|
+
currency: string;
|
|
1615
|
+
};
|
|
1616
|
+
/**
|
|
1617
|
+
* Field included by default.
|
|
1618
|
+
*/
|
|
1619
|
+
name: string;
|
|
1620
|
+
/**
|
|
1621
|
+
* Field included by default.
|
|
1622
|
+
*/
|
|
1623
|
+
slug: string;
|
|
1624
|
+
/**
|
|
1625
|
+
* Storage included in plan (bytes). Free=1GB, Pro=10GB, Business=50GB, Enterprise=500GB. Field included by default.
|
|
1626
|
+
*/
|
|
1627
|
+
storage_included_bytes: number;
|
|
1628
|
+
/**
|
|
1629
|
+
* Hard ceiling in bytes. Prevents runaway bills. nil = unlimited. Field included by default.
|
|
1630
|
+
*/
|
|
1631
|
+
storage_max_bytes?: number | null | unknown;
|
|
1632
|
+
/**
|
|
1633
|
+
* Cents per GB-month overage. Free=0 (hard cap), Pro=25, Business=20, Enterprise=15. Field included by default.
|
|
1634
|
+
*/
|
|
1635
|
+
storage_overage_rate_cents?: number | null | unknown;
|
|
1636
|
+
/**
|
|
1637
|
+
* Field included by default.
|
|
1638
|
+
*/
|
|
1639
|
+
type: "credits" | "storage" | "credits_storage" | "compute" | "seats" | "agents" | "support";
|
|
1640
|
+
/**
|
|
1641
|
+
* Field included by default.
|
|
1642
|
+
*/
|
|
1643
|
+
updated_at: unknown;
|
|
1644
|
+
};
|
|
1645
|
+
id: string;
|
|
1646
|
+
/**
|
|
1647
|
+
* A relationships object for a plan
|
|
1648
|
+
*/
|
|
1649
|
+
relationships?: {
|
|
1650
|
+
[key: string]: never;
|
|
1651
|
+
};
|
|
1652
|
+
type: string;
|
|
1653
|
+
};
|
|
1654
|
+
/**
|
|
1655
|
+
* A "Resource object" representing a application
|
|
1656
|
+
*/
|
|
1657
|
+
type Application = {
|
|
1658
|
+
/**
|
|
1659
|
+
* An attributes object for a application
|
|
1660
|
+
*/
|
|
1661
|
+
attributes?: {
|
|
1662
|
+
acting_tenant_id?: string | null | unknown;
|
|
1663
|
+
/**
|
|
1664
|
+
* Field included by default.
|
|
1665
|
+
*/
|
|
1666
|
+
badge_url?: string | null | unknown;
|
|
1667
|
+
/**
|
|
1668
|
+
* ISV's base URL for email links (verification, password reset, magic links). Field included by default.
|
|
1054
1669
|
*/
|
|
1055
1670
|
base_url: string;
|
|
1056
1671
|
/**
|
|
@@ -1393,6 +2008,38 @@ type ApiKey = {
|
|
|
1393
2008
|
};
|
|
1394
2009
|
type: string;
|
|
1395
2010
|
};
|
|
2011
|
+
/**
|
|
2012
|
+
* A "Resource object" representing a crm_custom_entity
|
|
2013
|
+
*/
|
|
2014
|
+
type CrmCustomEntity = {
|
|
2015
|
+
/**
|
|
2016
|
+
* An attributes object for a crm_custom_entity
|
|
2017
|
+
*/
|
|
2018
|
+
attributes?: {
|
|
2019
|
+
/**
|
|
2020
|
+
* Field included by default.
|
|
2021
|
+
*/
|
|
2022
|
+
name: string;
|
|
2023
|
+
/**
|
|
2024
|
+
* Field included by default.
|
|
2025
|
+
*/
|
|
2026
|
+
owner_id?: string | null | unknown;
|
|
2027
|
+
/**
|
|
2028
|
+
* Field included by default.
|
|
2029
|
+
*/
|
|
2030
|
+
properties?: {
|
|
2031
|
+
[key: string]: unknown;
|
|
2032
|
+
} | null | unknown;
|
|
2033
|
+
};
|
|
2034
|
+
id: string;
|
|
2035
|
+
/**
|
|
2036
|
+
* A relationships object for a crm_custom_entity
|
|
2037
|
+
*/
|
|
2038
|
+
relationships?: {
|
|
2039
|
+
[key: string]: never;
|
|
2040
|
+
};
|
|
2041
|
+
type: string;
|
|
2042
|
+
};
|
|
1396
2043
|
/**
|
|
1397
2044
|
* A "Resource object" representing a transaction
|
|
1398
2045
|
*/
|
|
@@ -1796,119 +2443,357 @@ type Tenant = {
|
|
|
1796
2443
|
type: string;
|
|
1797
2444
|
};
|
|
1798
2445
|
/**
|
|
1799
|
-
* A "Resource object" representing a
|
|
2446
|
+
* A "Resource object" representing a catalog_taxonomy
|
|
1800
2447
|
*/
|
|
1801
|
-
type
|
|
2448
|
+
type CatalogTaxonomy = {
|
|
1802
2449
|
/**
|
|
1803
|
-
* An attributes object for a
|
|
2450
|
+
* An attributes object for a catalog_taxonomy
|
|
1804
2451
|
*/
|
|
1805
2452
|
attributes?: {
|
|
1806
2453
|
/**
|
|
1807
2454
|
* Field included by default.
|
|
1808
2455
|
*/
|
|
1809
|
-
|
|
2456
|
+
ai_managed: boolean;
|
|
1810
2457
|
/**
|
|
1811
|
-
*
|
|
2458
|
+
* Field included by default.
|
|
1812
2459
|
*/
|
|
1813
|
-
|
|
1814
|
-
[key: string]: unknown;
|
|
1815
|
-
} | null | unknown;
|
|
2460
|
+
application_id: string;
|
|
1816
2461
|
/**
|
|
1817
|
-
*
|
|
2462
|
+
* Field included by default.
|
|
1818
2463
|
*/
|
|
1819
|
-
|
|
2464
|
+
is_hierarchical: boolean;
|
|
1820
2465
|
/**
|
|
1821
|
-
*
|
|
2466
|
+
* Field included by default.
|
|
1822
2467
|
*/
|
|
1823
|
-
|
|
1824
|
-
[key: string]: unknown;
|
|
1825
|
-
} | null | unknown;
|
|
2468
|
+
is_required: boolean;
|
|
1826
2469
|
/**
|
|
1827
2470
|
* Field included by default.
|
|
1828
2471
|
*/
|
|
1829
|
-
|
|
2472
|
+
max_depth?: number | null | unknown;
|
|
1830
2473
|
/**
|
|
1831
|
-
*
|
|
2474
|
+
* Field included by default.
|
|
1832
2475
|
*/
|
|
1833
|
-
|
|
1834
|
-
display_version?: string | null | unknown;
|
|
2476
|
+
name: string;
|
|
1835
2477
|
/**
|
|
1836
2478
|
* Field included by default.
|
|
1837
2479
|
*/
|
|
1838
|
-
|
|
1839
|
-
/**
|
|
1840
|
-
* Field included by default.
|
|
1841
|
-
*/
|
|
1842
|
-
ai_hints?: string | null | unknown;
|
|
1843
|
-
/**
|
|
1844
|
-
* Child fields for object/array-of-object types. Empty for leaf types. Each map has the same shape as SchemaField. Field included by default.
|
|
1845
|
-
*/
|
|
1846
|
-
children?: Array<{
|
|
1847
|
-
[key: string]: unknown;
|
|
1848
|
-
}> | null | unknown;
|
|
1849
|
-
/**
|
|
1850
|
-
* Field included by default.
|
|
1851
|
-
*/
|
|
1852
|
-
description?: string | null | unknown;
|
|
1853
|
-
/**
|
|
1854
|
-
* Whether this field is system-generated (e.g., _ai_suggestions) vs user-defined. Field included by default.
|
|
1855
|
-
*/
|
|
1856
|
-
is_system: boolean;
|
|
1857
|
-
/**
|
|
1858
|
-
* For array fields, specifies the type of items in the array. Field included by default.
|
|
1859
|
-
*/
|
|
1860
|
-
item_type?: "text" | "date" | "datetime" | "time" | "number" | "currency" | "boolean" | "email" | "phone" | "url" | "address" | "object" | "timestamp" | "alphanumeric_code" | unknown;
|
|
1861
|
-
/**
|
|
1862
|
-
* Field included by default.
|
|
1863
|
-
*/
|
|
1864
|
-
label?: string | null | unknown;
|
|
1865
|
-
/**
|
|
1866
|
-
* Field included by default.
|
|
1867
|
-
*/
|
|
1868
|
-
name: string;
|
|
1869
|
-
/**
|
|
1870
|
-
* Field included by default.
|
|
1871
|
-
*/
|
|
1872
|
-
order: number;
|
|
1873
|
-
/**
|
|
1874
|
-
* Field included by default.
|
|
1875
|
-
*/
|
|
1876
|
-
required: boolean;
|
|
1877
|
-
/**
|
|
1878
|
-
* Field included by default.
|
|
1879
|
-
*/
|
|
1880
|
-
type: "text" | "date" | "datetime" | "time" | "number" | "currency" | "boolean" | "email" | "phone" | "url" | "array" | "address" | "object" | "timestamp" | "alphanumeric_code";
|
|
1881
|
-
}> | null | unknown;
|
|
1882
|
-
has_been_used?: boolean | null | unknown;
|
|
2480
|
+
scope: "application" | "workspace";
|
|
1883
2481
|
/**
|
|
1884
2482
|
* Field included by default.
|
|
1885
2483
|
*/
|
|
1886
|
-
|
|
2484
|
+
slug: string;
|
|
1887
2485
|
/**
|
|
1888
|
-
*
|
|
2486
|
+
* Field included by default.
|
|
1889
2487
|
*/
|
|
1890
|
-
|
|
1891
|
-
|
|
2488
|
+
workspace_id?: string | null | unknown;
|
|
2489
|
+
};
|
|
2490
|
+
id: string;
|
|
2491
|
+
/**
|
|
2492
|
+
* A relationships object for a catalog_taxonomy
|
|
2493
|
+
*/
|
|
2494
|
+
relationships?: {
|
|
2495
|
+
[key: string]: never;
|
|
2496
|
+
};
|
|
2497
|
+
type: string;
|
|
2498
|
+
};
|
|
2499
|
+
/**
|
|
2500
|
+
* A "Resource object" representing a support_ticket
|
|
2501
|
+
*/
|
|
2502
|
+
type SupportTicket = {
|
|
2503
|
+
/**
|
|
2504
|
+
* An attributes object for a support_ticket
|
|
2505
|
+
*/
|
|
2506
|
+
attributes?: {
|
|
2507
|
+
/**
|
|
2508
|
+
* Field included by default.
|
|
2509
|
+
*/
|
|
2510
|
+
ai_classification?: string | null | unknown;
|
|
2511
|
+
/**
|
|
2512
|
+
* Field included by default.
|
|
2513
|
+
*/
|
|
2514
|
+
ai_confidence?: number | null | unknown;
|
|
2515
|
+
/**
|
|
2516
|
+
* Field included by default.
|
|
2517
|
+
*/
|
|
2518
|
+
ai_sentiment?: string | null | unknown;
|
|
2519
|
+
/**
|
|
2520
|
+
* Field included by default.
|
|
2521
|
+
*/
|
|
2522
|
+
assigned_agent_id?: string | null | unknown;
|
|
2523
|
+
/**
|
|
2524
|
+
* Field included by default.
|
|
2525
|
+
*/
|
|
2526
|
+
crm_contact_id?: string | null | unknown;
|
|
2527
|
+
/**
|
|
2528
|
+
* Field included by default.
|
|
2529
|
+
*/
|
|
2530
|
+
custom_fields?: {
|
|
1892
2531
|
[key: string]: unknown;
|
|
1893
2532
|
} | null | unknown;
|
|
1894
2533
|
/**
|
|
1895
|
-
*
|
|
2534
|
+
* Field included by default.
|
|
1896
2535
|
*/
|
|
1897
|
-
|
|
2536
|
+
customer_email?: string | null | unknown;
|
|
1898
2537
|
/**
|
|
1899
|
-
*
|
|
2538
|
+
* Field included by default.
|
|
1900
2539
|
*/
|
|
1901
|
-
|
|
2540
|
+
customer_name?: string | null | unknown;
|
|
1902
2541
|
/**
|
|
1903
|
-
*
|
|
2542
|
+
* Field included by default.
|
|
1904
2543
|
*/
|
|
1905
|
-
|
|
2544
|
+
description?: string | null | unknown;
|
|
1906
2545
|
/**
|
|
1907
|
-
*
|
|
2546
|
+
* Field included by default.
|
|
1908
2547
|
*/
|
|
1909
|
-
|
|
2548
|
+
external_id?: string | null | unknown;
|
|
1910
2549
|
/**
|
|
1911
|
-
*
|
|
2550
|
+
* Field included by default.
|
|
2551
|
+
*/
|
|
2552
|
+
first_response_at?: unknown;
|
|
2553
|
+
/**
|
|
2554
|
+
* Field included by default.
|
|
2555
|
+
*/
|
|
2556
|
+
invoice_id?: string | null | unknown;
|
|
2557
|
+
/**
|
|
2558
|
+
* Field included by default.
|
|
2559
|
+
*/
|
|
2560
|
+
priority: "low" | "normal" | "high" | "urgent";
|
|
2561
|
+
/**
|
|
2562
|
+
* Field included by default.
|
|
2563
|
+
*/
|
|
2564
|
+
product_id?: string | null | unknown;
|
|
2565
|
+
/**
|
|
2566
|
+
* Field included by default.
|
|
2567
|
+
*/
|
|
2568
|
+
resolved_at?: unknown;
|
|
2569
|
+
/**
|
|
2570
|
+
* Field included by default.
|
|
2571
|
+
*/
|
|
2572
|
+
sla_breached: boolean;
|
|
2573
|
+
/**
|
|
2574
|
+
* Field included by default.
|
|
2575
|
+
*/
|
|
2576
|
+
sla_due_at?: unknown;
|
|
2577
|
+
/**
|
|
2578
|
+
* Field included by default.
|
|
2579
|
+
*/
|
|
2580
|
+
sla_policy_id?: string | null | unknown;
|
|
2581
|
+
/**
|
|
2582
|
+
* Field included by default.
|
|
2583
|
+
*/
|
|
2584
|
+
source: "email" | "chat" | "phone" | "web_form" | "api" | "internal" | "connector_sync";
|
|
2585
|
+
/**
|
|
2586
|
+
* Field included by default.
|
|
2587
|
+
*/
|
|
2588
|
+
status: "new" | "open" | "pending" | "on_hold" | "resolved" | "closed";
|
|
2589
|
+
/**
|
|
2590
|
+
* Field included by default.
|
|
2591
|
+
*/
|
|
2592
|
+
subject: string;
|
|
2593
|
+
/**
|
|
2594
|
+
* Field included by default.
|
|
2595
|
+
*/
|
|
2596
|
+
synced_at?: unknown;
|
|
2597
|
+
/**
|
|
2598
|
+
* Field included by default.
|
|
2599
|
+
*/
|
|
2600
|
+
tags?: Array<string> | null | unknown;
|
|
2601
|
+
/**
|
|
2602
|
+
* Field included by default.
|
|
2603
|
+
*/
|
|
2604
|
+
ticket_number?: string | null | unknown;
|
|
2605
|
+
/**
|
|
2606
|
+
* Field included by default.
|
|
2607
|
+
*/
|
|
2608
|
+
type: "external" | "internal";
|
|
2609
|
+
};
|
|
2610
|
+
id: string;
|
|
2611
|
+
/**
|
|
2612
|
+
* A relationships object for a support_ticket
|
|
2613
|
+
*/
|
|
2614
|
+
relationships?: {
|
|
2615
|
+
[key: string]: never;
|
|
2616
|
+
};
|
|
2617
|
+
type: string;
|
|
2618
|
+
};
|
|
2619
|
+
/**
|
|
2620
|
+
* A "Resource object" representing a credential
|
|
2621
|
+
*/
|
|
2622
|
+
type Credential = {
|
|
2623
|
+
/**
|
|
2624
|
+
* An attributes object for a credential
|
|
2625
|
+
*/
|
|
2626
|
+
attributes?: {
|
|
2627
|
+
/**
|
|
2628
|
+
* Field included by default.
|
|
2629
|
+
*/
|
|
2630
|
+
application_id?: string | null | unknown;
|
|
2631
|
+
/**
|
|
2632
|
+
* Field included by default.
|
|
2633
|
+
*/
|
|
2634
|
+
auth_type: "oauth2" | "api_key" | "basic_auth" | "jwt_bearer" | "client_credentials";
|
|
2635
|
+
/**
|
|
2636
|
+
* Field included by default.
|
|
2637
|
+
*/
|
|
2638
|
+
connector_type: "salesforce" | "hubspot" | "slack" | "notion" | "sharepoint" | "gmail" | "outlook" | "microsoft_365" | "jira" | "confluence" | "fullscript" | "github" | "gitlab" | "google_calendar" | "google_chat" | "custom";
|
|
2639
|
+
/**
|
|
2640
|
+
* Number of consecutive token refresh failures. Reset to 0 on successful refresh. Field included by default.
|
|
2641
|
+
*/
|
|
2642
|
+
consecutive_failures: number;
|
|
2643
|
+
/**
|
|
2644
|
+
* Field included by default.
|
|
2645
|
+
*/
|
|
2646
|
+
expires_at?: string | null | unknown;
|
|
2647
|
+
/**
|
|
2648
|
+
* Field included by default.
|
|
2649
|
+
*/
|
|
2650
|
+
last_refreshed_at?: string | null | unknown;
|
|
2651
|
+
/**
|
|
2652
|
+
* Field included by default.
|
|
2653
|
+
*/
|
|
2654
|
+
metadata?: {
|
|
2655
|
+
[key: string]: unknown;
|
|
2656
|
+
} | null | unknown;
|
|
2657
|
+
/**
|
|
2658
|
+
* Field included by default.
|
|
2659
|
+
*/
|
|
2660
|
+
refresh_status?: "valid" | "expiring_soon" | "refresh_failed" | "revoked" | unknown;
|
|
2661
|
+
/**
|
|
2662
|
+
* Field included by default.
|
|
2663
|
+
*/
|
|
2664
|
+
scope_level: "workspace" | "tenant" | "application";
|
|
2665
|
+
/**
|
|
2666
|
+
* Field included by default.
|
|
2667
|
+
*/
|
|
2668
|
+
tenant_id?: string | null | unknown;
|
|
2669
|
+
/**
|
|
2670
|
+
* Field included by default.
|
|
2671
|
+
*/
|
|
2672
|
+
workspace_id: string;
|
|
2673
|
+
};
|
|
2674
|
+
id: string;
|
|
2675
|
+
/**
|
|
2676
|
+
* A relationships object for a credential
|
|
2677
|
+
*/
|
|
2678
|
+
relationships?: {
|
|
2679
|
+
[key: string]: never;
|
|
2680
|
+
};
|
|
2681
|
+
type: string;
|
|
2682
|
+
};
|
|
2683
|
+
/**
|
|
2684
|
+
* A "Resource object" representing a agent_version
|
|
2685
|
+
*/
|
|
2686
|
+
type AgentVersion = {
|
|
2687
|
+
/**
|
|
2688
|
+
* An attributes object for a agent_version
|
|
2689
|
+
*/
|
|
2690
|
+
attributes?: {
|
|
2691
|
+
/**
|
|
2692
|
+
* Field included by default.
|
|
2693
|
+
*/
|
|
2694
|
+
changes_summary?: string | null | unknown;
|
|
2695
|
+
/**
|
|
2696
|
+
* Strategy-specific chunking configuration. Field included by default.
|
|
2697
|
+
*/
|
|
2698
|
+
chunking_config?: {
|
|
2699
|
+
[key: string]: unknown;
|
|
2700
|
+
} | null | unknown;
|
|
2701
|
+
/**
|
|
2702
|
+
* Document chunking strategy for multi-chunk extraction. Field included by default.
|
|
2703
|
+
*/
|
|
2704
|
+
chunking_strategy?: "none" | "page_boundary" | "structural" | "sliding_window" | unknown;
|
|
2705
|
+
/**
|
|
2706
|
+
* Override default confidence signal weights. Field included by default.
|
|
2707
|
+
*/
|
|
2708
|
+
confidence_weights?: {
|
|
2709
|
+
[key: string]: unknown;
|
|
2710
|
+
} | null | unknown;
|
|
2711
|
+
/**
|
|
2712
|
+
* Field included by default.
|
|
2713
|
+
*/
|
|
2714
|
+
created_at: unknown;
|
|
2715
|
+
/**
|
|
2716
|
+
* When true, delegate_to_agent tool calls require HITL approval before child execution is created. Field included by default.
|
|
2717
|
+
*/
|
|
2718
|
+
delegation_requires_approval: boolean;
|
|
2719
|
+
display_version?: string | null | unknown;
|
|
2720
|
+
/**
|
|
2721
|
+
* Field included by default.
|
|
2722
|
+
*/
|
|
2723
|
+
fields?: Array<{
|
|
2724
|
+
/**
|
|
2725
|
+
* Field included by default.
|
|
2726
|
+
*/
|
|
2727
|
+
ai_hints?: string | null | unknown;
|
|
2728
|
+
/**
|
|
2729
|
+
* Child fields for object/array-of-object types. Empty for leaf types. Each map has the same shape as SchemaField. Field included by default.
|
|
2730
|
+
*/
|
|
2731
|
+
children?: Array<{
|
|
2732
|
+
[key: string]: unknown;
|
|
2733
|
+
}> | null | unknown;
|
|
2734
|
+
/**
|
|
2735
|
+
* Field included by default.
|
|
2736
|
+
*/
|
|
2737
|
+
description?: string | null | unknown;
|
|
2738
|
+
/**
|
|
2739
|
+
* Whether this field is system-generated (e.g., _ai_suggestions) vs user-defined. Field included by default.
|
|
2740
|
+
*/
|
|
2741
|
+
is_system: boolean;
|
|
2742
|
+
/**
|
|
2743
|
+
* For array fields, specifies the type of items in the array. Field included by default.
|
|
2744
|
+
*/
|
|
2745
|
+
item_type?: "text" | "date" | "datetime" | "time" | "number" | "currency" | "boolean" | "email" | "phone" | "url" | "address" | "object" | "timestamp" | "alphanumeric_code" | unknown;
|
|
2746
|
+
/**
|
|
2747
|
+
* Field included by default.
|
|
2748
|
+
*/
|
|
2749
|
+
label?: string | null | unknown;
|
|
2750
|
+
/**
|
|
2751
|
+
* Field included by default.
|
|
2752
|
+
*/
|
|
2753
|
+
name: string;
|
|
2754
|
+
/**
|
|
2755
|
+
* Field included by default.
|
|
2756
|
+
*/
|
|
2757
|
+
order: number;
|
|
2758
|
+
/**
|
|
2759
|
+
* Field included by default.
|
|
2760
|
+
*/
|
|
2761
|
+
required: boolean;
|
|
2762
|
+
/**
|
|
2763
|
+
* Field included by default.
|
|
2764
|
+
*/
|
|
2765
|
+
type: "text" | "date" | "datetime" | "time" | "number" | "currency" | "boolean" | "email" | "phone" | "url" | "array" | "address" | "object" | "timestamp" | "alphanumeric_code";
|
|
2766
|
+
}> | null | unknown;
|
|
2767
|
+
has_been_used?: boolean | null | unknown;
|
|
2768
|
+
/**
|
|
2769
|
+
* Field included by default.
|
|
2770
|
+
*/
|
|
2771
|
+
is_active: boolean;
|
|
2772
|
+
/**
|
|
2773
|
+
* Whether this is a draft version being edited (mutually exclusive with is_active). Field included by default.
|
|
2774
|
+
*/
|
|
2775
|
+
is_draft: boolean;
|
|
2776
|
+
json_schema?: {
|
|
2777
|
+
[key: string]: unknown;
|
|
2778
|
+
} | null | unknown;
|
|
2779
|
+
/**
|
|
2780
|
+
* ISV-configurable credit ceiling per execution. Nil means no limit. Field included by default.
|
|
2781
|
+
*/
|
|
2782
|
+
max_cost_credits?: string | null | unknown;
|
|
2783
|
+
/**
|
|
2784
|
+
* Maximum number of agent loop iterations per execution. Field included by default.
|
|
2785
|
+
*/
|
|
2786
|
+
max_iterations: number;
|
|
2787
|
+
/**
|
|
2788
|
+
* Maximum number of tool calls to execute concurrently. Field included by default.
|
|
2789
|
+
*/
|
|
2790
|
+
max_parallel_tools: number;
|
|
2791
|
+
/**
|
|
2792
|
+
* Maximum total tool calls allowed per execution. Field included by default.
|
|
2793
|
+
*/
|
|
2794
|
+
max_tool_calls: number;
|
|
2795
|
+
/**
|
|
2796
|
+
* Ordered extraction pipeline stages. Empty = single default stage. Field included by default.
|
|
1912
2797
|
*/
|
|
1913
2798
|
pipeline_stages?: Array<{
|
|
1914
2799
|
/**
|
|
@@ -2297,48 +3182,29 @@ type WebhookDelivery = {
|
|
|
2297
3182
|
type: string;
|
|
2298
3183
|
};
|
|
2299
3184
|
/**
|
|
2300
|
-
* A "Resource object" representing a
|
|
3185
|
+
* A "Resource object" representing a connector_instance
|
|
2301
3186
|
*/
|
|
2302
|
-
type
|
|
3187
|
+
type ConnectorInstance = {
|
|
2303
3188
|
/**
|
|
2304
|
-
* An attributes object for a
|
|
3189
|
+
* An attributes object for a connector_instance
|
|
2305
3190
|
*/
|
|
2306
3191
|
attributes?: {
|
|
2307
|
-
/**
|
|
2308
|
-
* Agent handling this session. Field included by default.
|
|
2309
|
-
*/
|
|
2310
|
-
agent_id?: string | null | unknown;
|
|
2311
3192
|
/**
|
|
2312
3193
|
* Field included by default.
|
|
2313
3194
|
*/
|
|
2314
|
-
|
|
3195
|
+
connector_type: "salesforce" | "hubspot" | "slack" | "notion" | "sharepoint" | "gmail" | "outlook" | "microsoft_365" | "jira" | "confluence" | "fullscript" | "github" | "gitlab" | "google_calendar" | "google_chat" | "custom";
|
|
2315
3196
|
/**
|
|
2316
3197
|
* Field included by default.
|
|
2317
3198
|
*/
|
|
2318
|
-
|
|
2319
|
-
/**
|
|
2320
|
-
* Timestamp when transcript finalization was dispatched. Field included by default.
|
|
2321
|
-
*/
|
|
2322
|
-
finalized_at?: unknown;
|
|
3199
|
+
enabled?: boolean | null | unknown;
|
|
2323
3200
|
/**
|
|
2324
3201
|
* Field included by default.
|
|
2325
3202
|
*/
|
|
2326
|
-
|
|
2327
|
-
/**
|
|
2328
|
-
* LiveKit room name for the session. Field included by default.
|
|
2329
|
-
*/
|
|
2330
|
-
livekit_room?: string | null | unknown;
|
|
3203
|
+
health_status?: "healthy" | "degraded" | "unhealthy" | "unknown" | unknown;
|
|
2331
3204
|
/**
|
|
2332
|
-
*
|
|
2333
|
-
*
|
|
2334
|
-
* **One-time delivery only.** This field is populated in the `POST /voice/sessions` create
|
|
2335
|
-
* response and is null in ALL subsequent read operations (GET, list). The token is
|
|
2336
|
-
* injected in-memory by the `:start` after_action and is NEVER written to the database
|
|
2337
|
-
* (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.
|
|
3205
|
+
* Field included by default.
|
|
2340
3206
|
*/
|
|
2341
|
-
|
|
3207
|
+
last_sync_at?: string | null | unknown;
|
|
2342
3208
|
/**
|
|
2343
3209
|
* Field included by default.
|
|
2344
3210
|
*/
|
|
@@ -2348,19 +3214,222 @@ type VoiceSession = {
|
|
|
2348
3214
|
/**
|
|
2349
3215
|
* Field included by default.
|
|
2350
3216
|
*/
|
|
2351
|
-
|
|
3217
|
+
name: string;
|
|
2352
3218
|
/**
|
|
2353
3219
|
* Field included by default.
|
|
2354
3220
|
*/
|
|
2355
|
-
|
|
2356
|
-
/**
|
|
2357
|
-
* Accumulated STT minutes for billing. Field included by default.
|
|
2358
|
-
*/
|
|
2359
|
-
stt_minutes?: number | null | unknown;
|
|
3221
|
+
sync_interval_minutes?: number | null | unknown;
|
|
2360
3222
|
/**
|
|
2361
|
-
*
|
|
3223
|
+
* Field included by default.
|
|
2362
3224
|
*/
|
|
2363
|
-
|
|
3225
|
+
workspace_id: string;
|
|
3226
|
+
};
|
|
3227
|
+
id: string;
|
|
3228
|
+
/**
|
|
3229
|
+
* A relationships object for a connector_instance
|
|
3230
|
+
*/
|
|
3231
|
+
relationships?: {
|
|
3232
|
+
workspace?: {
|
|
3233
|
+
/**
|
|
3234
|
+
* An identifier for workspace
|
|
3235
|
+
*/
|
|
3236
|
+
data?: {
|
|
3237
|
+
id: string;
|
|
3238
|
+
meta?: {
|
|
3239
|
+
[key: string]: unknown;
|
|
3240
|
+
};
|
|
3241
|
+
type: string;
|
|
3242
|
+
} | null;
|
|
3243
|
+
};
|
|
3244
|
+
};
|
|
3245
|
+
type: string;
|
|
3246
|
+
};
|
|
3247
|
+
/**
|
|
3248
|
+
* A "Resource object" representing a crm_deal
|
|
3249
|
+
*/
|
|
3250
|
+
type CrmDeal = {
|
|
3251
|
+
/**
|
|
3252
|
+
* An attributes object for a crm_deal
|
|
3253
|
+
*/
|
|
3254
|
+
attributes?: {
|
|
3255
|
+
/**
|
|
3256
|
+
* Field included by default.
|
|
3257
|
+
*/
|
|
3258
|
+
ai_forecast_category?: "pipeline" | "best_case" | "commit" | "closed" | unknown;
|
|
3259
|
+
/**
|
|
3260
|
+
* Field included by default.
|
|
3261
|
+
*/
|
|
3262
|
+
ai_next_action?: string | null | unknown;
|
|
3263
|
+
/**
|
|
3264
|
+
* Field included by default.
|
|
3265
|
+
*/
|
|
3266
|
+
ai_risk_score?: number | null | unknown;
|
|
3267
|
+
/**
|
|
3268
|
+
* Field included by default.
|
|
3269
|
+
*/
|
|
3270
|
+
amount?: string | null | unknown;
|
|
3271
|
+
/**
|
|
3272
|
+
* Field included by default.
|
|
3273
|
+
*/
|
|
3274
|
+
close_date?: string | null | unknown;
|
|
3275
|
+
/**
|
|
3276
|
+
* Field included by default.
|
|
3277
|
+
*/
|
|
3278
|
+
currency?: string | null | unknown;
|
|
3279
|
+
/**
|
|
3280
|
+
* Field included by default.
|
|
3281
|
+
*/
|
|
3282
|
+
lost_reason?: string | null | unknown;
|
|
3283
|
+
/**
|
|
3284
|
+
* Field included by default.
|
|
3285
|
+
*/
|
|
3286
|
+
name: string;
|
|
3287
|
+
/**
|
|
3288
|
+
* Field included by default.
|
|
3289
|
+
*/
|
|
3290
|
+
owner_id?: string | null | unknown;
|
|
3291
|
+
/**
|
|
3292
|
+
* Field included by default.
|
|
3293
|
+
*/
|
|
3294
|
+
probability?: number | null | unknown;
|
|
3295
|
+
/**
|
|
3296
|
+
* Field included by default.
|
|
3297
|
+
*/
|
|
3298
|
+
properties?: {
|
|
3299
|
+
[key: string]: unknown;
|
|
3300
|
+
} | null | unknown;
|
|
3301
|
+
/**
|
|
3302
|
+
* Field included by default.
|
|
3303
|
+
*/
|
|
3304
|
+
source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api" | unknown;
|
|
3305
|
+
/**
|
|
3306
|
+
* Field included by default.
|
|
3307
|
+
*/
|
|
3308
|
+
status?: "open" | "won" | "lost" | "abandoned" | unknown;
|
|
3309
|
+
};
|
|
3310
|
+
id: string;
|
|
3311
|
+
/**
|
|
3312
|
+
* A relationships object for a crm_deal
|
|
3313
|
+
*/
|
|
3314
|
+
relationships?: {
|
|
3315
|
+
[key: string]: never;
|
|
3316
|
+
};
|
|
3317
|
+
type: string;
|
|
3318
|
+
};
|
|
3319
|
+
/**
|
|
3320
|
+
* A "Resource object" representing a catalog_product_variant
|
|
3321
|
+
*/
|
|
3322
|
+
type CatalogProductVariant = {
|
|
3323
|
+
/**
|
|
3324
|
+
* An attributes object for a catalog_product_variant
|
|
3325
|
+
*/
|
|
3326
|
+
attributes?: {
|
|
3327
|
+
/**
|
|
3328
|
+
* Field included by default.
|
|
3329
|
+
*/
|
|
3330
|
+
media?: Array<{
|
|
3331
|
+
[key: string]: unknown;
|
|
3332
|
+
}> | null | unknown;
|
|
3333
|
+
/**
|
|
3334
|
+
* Field included by default.
|
|
3335
|
+
*/
|
|
3336
|
+
position?: number | null | unknown;
|
|
3337
|
+
/**
|
|
3338
|
+
* Field included by default.
|
|
3339
|
+
*/
|
|
3340
|
+
price_override?: string | null | unknown;
|
|
3341
|
+
/**
|
|
3342
|
+
* Field included by default.
|
|
3343
|
+
*/
|
|
3344
|
+
properties?: {
|
|
3345
|
+
[key: string]: unknown;
|
|
3346
|
+
} | null | unknown;
|
|
3347
|
+
/**
|
|
3348
|
+
* Field included by default.
|
|
3349
|
+
*/
|
|
3350
|
+
sku: string;
|
|
3351
|
+
/**
|
|
3352
|
+
* Field included by default.
|
|
3353
|
+
*/
|
|
3354
|
+
status: "active" | "archived";
|
|
3355
|
+
/**
|
|
3356
|
+
* Field included by default.
|
|
3357
|
+
*/
|
|
3358
|
+
workspace_id: string;
|
|
3359
|
+
};
|
|
3360
|
+
id: string;
|
|
3361
|
+
/**
|
|
3362
|
+
* A relationships object for a catalog_product_variant
|
|
3363
|
+
*/
|
|
3364
|
+
relationships?: {
|
|
3365
|
+
[key: string]: never;
|
|
3366
|
+
};
|
|
3367
|
+
type: string;
|
|
3368
|
+
};
|
|
3369
|
+
/**
|
|
3370
|
+
* A "Resource object" representing a voice_session
|
|
3371
|
+
*/
|
|
3372
|
+
type VoiceSession = {
|
|
3373
|
+
/**
|
|
3374
|
+
* An attributes object for a voice_session
|
|
3375
|
+
*/
|
|
3376
|
+
attributes?: {
|
|
3377
|
+
/**
|
|
3378
|
+
* Agent handling this session. Field included by default.
|
|
3379
|
+
*/
|
|
3380
|
+
agent_id?: string | null | unknown;
|
|
3381
|
+
/**
|
|
3382
|
+
* Field included by default.
|
|
3383
|
+
*/
|
|
3384
|
+
duration_seconds?: number | null | unknown;
|
|
3385
|
+
/**
|
|
3386
|
+
* Field included by default.
|
|
3387
|
+
*/
|
|
3388
|
+
ended_at?: unknown;
|
|
3389
|
+
/**
|
|
3390
|
+
* Timestamp when transcript finalization was dispatched. Field included by default.
|
|
3391
|
+
*/
|
|
3392
|
+
finalized_at?: unknown;
|
|
3393
|
+
/**
|
|
3394
|
+
* Field included by default.
|
|
3395
|
+
*/
|
|
3396
|
+
inserted_at: unknown;
|
|
3397
|
+
/**
|
|
3398
|
+
* LiveKit room name for the session. Field included by default.
|
|
3399
|
+
*/
|
|
3400
|
+
livekit_room?: string | null | unknown;
|
|
3401
|
+
/**
|
|
3402
|
+
* LiveKit JWT for immediate room connection.
|
|
3403
|
+
*
|
|
3404
|
+
* **One-time delivery only.** This field is populated in the `POST /voice/sessions` create
|
|
3405
|
+
* response and is null in ALL subsequent read operations (GET, list). The token is
|
|
3406
|
+
* injected in-memory by the `:start` after_action and is NEVER written to the database
|
|
3407
|
+
* (enforced by a database CHECK constraint). Clients must capture it from the create response
|
|
3408
|
+
* — it cannot be retrieved after that point. Field included by default.
|
|
3409
|
+
*/
|
|
3410
|
+
livekit_token?: string | null | unknown;
|
|
3411
|
+
/**
|
|
3412
|
+
* Field included by default.
|
|
3413
|
+
*/
|
|
3414
|
+
metadata?: {
|
|
3415
|
+
[key: string]: unknown;
|
|
3416
|
+
} | null | unknown;
|
|
3417
|
+
/**
|
|
3418
|
+
* Field included by default.
|
|
3419
|
+
*/
|
|
3420
|
+
session_type: "push_to_talk" | "bidirectional" | "telephony";
|
|
3421
|
+
/**
|
|
3422
|
+
* Field included by default.
|
|
3423
|
+
*/
|
|
3424
|
+
status: "active" | "ended" | "failed" | "timed_out";
|
|
3425
|
+
/**
|
|
3426
|
+
* Accumulated STT minutes for billing. Field included by default.
|
|
3427
|
+
*/
|
|
3428
|
+
stt_minutes?: number | null | unknown;
|
|
3429
|
+
/**
|
|
3430
|
+
* Chat thread linked to this session. Field included by default.
|
|
3431
|
+
*/
|
|
3432
|
+
thread_id?: string | null | unknown;
|
|
2364
3433
|
/**
|
|
2365
3434
|
* Accumulated TTS characters for billing. Field included by default.
|
|
2366
3435
|
*/
|
|
@@ -2450,60 +3519,320 @@ type SchedulingBooking = {
|
|
|
2450
3519
|
/**
|
|
2451
3520
|
* Field included by default.
|
|
2452
3521
|
*/
|
|
2453
|
-
intake_responses?: {
|
|
2454
|
-
[key: string]: unknown;
|
|
2455
|
-
} | null | unknown;
|
|
3522
|
+
intake_responses?: {
|
|
3523
|
+
[key: string]: unknown;
|
|
3524
|
+
} | null | unknown;
|
|
3525
|
+
/**
|
|
3526
|
+
* Field included by default.
|
|
3527
|
+
*/
|
|
3528
|
+
metadata?: {
|
|
3529
|
+
[key: string]: unknown;
|
|
3530
|
+
} | null | unknown;
|
|
3531
|
+
/**
|
|
3532
|
+
* Field included by default.
|
|
3533
|
+
*/
|
|
3534
|
+
party_size?: number | null | unknown;
|
|
3535
|
+
/**
|
|
3536
|
+
* Field included by default.
|
|
3537
|
+
*/
|
|
3538
|
+
status?: "pending_approval" | "pending_verification" | "confirmed" | "cancelled" | "no_show" | unknown;
|
|
3539
|
+
};
|
|
3540
|
+
id: string;
|
|
3541
|
+
/**
|
|
3542
|
+
* A relationships object for a scheduling_booking
|
|
3543
|
+
*/
|
|
3544
|
+
relationships?: {
|
|
3545
|
+
[key: string]: never;
|
|
3546
|
+
};
|
|
3547
|
+
type: string;
|
|
3548
|
+
};
|
|
3549
|
+
/**
|
|
3550
|
+
* A "Resource object" representing a email-marketing-template
|
|
3551
|
+
*/
|
|
3552
|
+
type EmailMarketingTemplate = {
|
|
3553
|
+
/**
|
|
3554
|
+
* An attributes object for a email-marketing-template
|
|
3555
|
+
*/
|
|
3556
|
+
attributes?: {
|
|
3557
|
+
/**
|
|
3558
|
+
* Field included by default.
|
|
3559
|
+
*/
|
|
3560
|
+
ai_instructions?: string | null | unknown;
|
|
3561
|
+
/**
|
|
3562
|
+
* Field included by default.
|
|
3563
|
+
*/
|
|
3564
|
+
archived?: boolean | null | unknown;
|
|
3565
|
+
/**
|
|
3566
|
+
* Field included by default.
|
|
3567
|
+
*/
|
|
3568
|
+
body_template?: string | null | unknown;
|
|
3569
|
+
/**
|
|
3570
|
+
* Field included by default.
|
|
3571
|
+
*/
|
|
3572
|
+
name: string;
|
|
3573
|
+
/**
|
|
3574
|
+
* Field included by default.
|
|
3575
|
+
*/
|
|
3576
|
+
subject_template?: string | null | unknown;
|
|
3577
|
+
/**
|
|
3578
|
+
* Field included by default.
|
|
3579
|
+
*/
|
|
3580
|
+
type?: "template" | "prompt" | unknown;
|
|
3581
|
+
/**
|
|
3582
|
+
* Field included by default.
|
|
3583
|
+
*/
|
|
3584
|
+
variables?: Array<string> | null | unknown;
|
|
3585
|
+
};
|
|
3586
|
+
id: string;
|
|
3587
|
+
/**
|
|
3588
|
+
* A relationships object for a email-marketing-template
|
|
3589
|
+
*/
|
|
3590
|
+
relationships?: {
|
|
3591
|
+
[key: string]: never;
|
|
3592
|
+
};
|
|
3593
|
+
type: string;
|
|
3594
|
+
};
|
|
3595
|
+
/**
|
|
3596
|
+
* A "Resource object" representing a email-marketing-generated-email
|
|
3597
|
+
*/
|
|
3598
|
+
type EmailMarketingGeneratedEmail = {
|
|
3599
|
+
/**
|
|
3600
|
+
* An attributes object for a email-marketing-generated-email
|
|
3601
|
+
*/
|
|
3602
|
+
attributes?: {
|
|
3603
|
+
/**
|
|
3604
|
+
* Field included by default.
|
|
3605
|
+
*/
|
|
3606
|
+
agent_execution_id?: string | null | unknown;
|
|
3607
|
+
/**
|
|
3608
|
+
* Field included by default.
|
|
3609
|
+
*/
|
|
3610
|
+
body?: string | null | unknown;
|
|
3611
|
+
/**
|
|
3612
|
+
* Field included by default.
|
|
3613
|
+
*/
|
|
3614
|
+
error_message?: string | null | unknown;
|
|
3615
|
+
/**
|
|
3616
|
+
* Field included by default.
|
|
3617
|
+
*/
|
|
3618
|
+
is_approved?: boolean | null | unknown;
|
|
3619
|
+
/**
|
|
3620
|
+
* Field included by default.
|
|
3621
|
+
*/
|
|
3622
|
+
is_edited?: boolean | null | unknown;
|
|
3623
|
+
/**
|
|
3624
|
+
* Field included by default.
|
|
3625
|
+
*/
|
|
3626
|
+
scheduled_for?: unknown;
|
|
3627
|
+
/**
|
|
3628
|
+
* Field included by default.
|
|
3629
|
+
*/
|
|
3630
|
+
sent_at?: unknown;
|
|
3631
|
+
/**
|
|
3632
|
+
* Field included by default.
|
|
3633
|
+
*/
|
|
3634
|
+
status?: "draft" | "approved" | "sending" | "sent" | "scheduled" | "failed" | unknown;
|
|
3635
|
+
/**
|
|
3636
|
+
* Field included by default.
|
|
3637
|
+
*/
|
|
3638
|
+
subject?: string | null | unknown;
|
|
3639
|
+
};
|
|
3640
|
+
id: string;
|
|
3641
|
+
/**
|
|
3642
|
+
* A relationships object for a email-marketing-generated-email
|
|
3643
|
+
*/
|
|
3644
|
+
relationships?: {
|
|
3645
|
+
[key: string]: never;
|
|
3646
|
+
};
|
|
3647
|
+
type: string;
|
|
3648
|
+
};
|
|
3649
|
+
/**
|
|
3650
|
+
* A "Resource object" representing a extraction_batch
|
|
3651
|
+
*/
|
|
3652
|
+
type ExtractionBatch = {
|
|
3653
|
+
/**
|
|
3654
|
+
* An attributes object for a extraction_batch
|
|
3655
|
+
*/
|
|
3656
|
+
attributes?: {
|
|
3657
|
+
/**
|
|
3658
|
+
* Field included by default.
|
|
3659
|
+
*/
|
|
3660
|
+
name?: string | null | unknown;
|
|
3661
|
+
status?: string | null | unknown;
|
|
3662
|
+
/**
|
|
3663
|
+
* Generate presigned upload URLs for batch
|
|
3664
|
+
*/
|
|
3665
|
+
upload_urls?: Array<{
|
|
3666
|
+
[key: string]: unknown;
|
|
3667
|
+
}> | null | unknown;
|
|
3668
|
+
/**
|
|
3669
|
+
* Field included by default.
|
|
3670
|
+
*/
|
|
3671
|
+
user_label?: string | null | unknown;
|
|
3672
|
+
};
|
|
3673
|
+
id: string;
|
|
3674
|
+
/**
|
|
3675
|
+
* A relationships object for a extraction_batch
|
|
3676
|
+
*/
|
|
3677
|
+
relationships?: {
|
|
3678
|
+
[key: string]: never;
|
|
3679
|
+
};
|
|
3680
|
+
type: string;
|
|
3681
|
+
};
|
|
3682
|
+
/**
|
|
3683
|
+
* A "Resource object" representing a workspace-membership
|
|
3684
|
+
*/
|
|
3685
|
+
type WorkspaceMembership = {
|
|
3686
|
+
/**
|
|
3687
|
+
* An attributes object for a workspace-membership
|
|
3688
|
+
*/
|
|
3689
|
+
attributes?: {
|
|
3690
|
+
/**
|
|
3691
|
+
* Field included by default.
|
|
3692
|
+
*/
|
|
3693
|
+
created_at: unknown;
|
|
3694
|
+
/**
|
|
3695
|
+
* For inherited members, describes the org role
|
|
3696
|
+
*/
|
|
3697
|
+
inherited_from?: string | null | unknown;
|
|
3698
|
+
/**
|
|
3699
|
+
* Last time user accessed this workspace. Field included by default.
|
|
3700
|
+
*/
|
|
3701
|
+
last_visited_at?: unknown;
|
|
3702
|
+
/**
|
|
3703
|
+
* Workspace permissions in format {app}:{resource}:{action}:{scope}. Field included by default.
|
|
3704
|
+
*/
|
|
3705
|
+
permissions: Array<string>;
|
|
3706
|
+
/**
|
|
3707
|
+
* ISV-defined member profile data (NPI, credentials, etc.). Field included by default.
|
|
3708
|
+
*/
|
|
3709
|
+
profile_attributes?: {
|
|
3710
|
+
[key: string]: unknown;
|
|
3711
|
+
} | null | unknown;
|
|
3712
|
+
/**
|
|
3713
|
+
* Effective role: admin, editor, or viewer
|
|
3714
|
+
*/
|
|
3715
|
+
role?: string | null | unknown;
|
|
3716
|
+
role_label?: string | null | unknown;
|
|
3717
|
+
/**
|
|
3718
|
+
* How user got access: :direct (explicit invite) or :inherited (org role)
|
|
3719
|
+
*/
|
|
3720
|
+
source?: string | null | unknown;
|
|
3721
|
+
/**
|
|
3722
|
+
* Field included by default.
|
|
3723
|
+
*/
|
|
3724
|
+
updated_at: unknown;
|
|
3725
|
+
/**
|
|
3726
|
+
* Field included by default.
|
|
3727
|
+
*/
|
|
3728
|
+
user_id: string;
|
|
3729
|
+
/**
|
|
3730
|
+
* Field included by default.
|
|
3731
|
+
*/
|
|
3732
|
+
workspace_id: string;
|
|
3733
|
+
};
|
|
3734
|
+
id: string;
|
|
3735
|
+
/**
|
|
3736
|
+
* A relationships object for a workspace-membership
|
|
3737
|
+
*/
|
|
3738
|
+
relationships?: {
|
|
3739
|
+
user?: {
|
|
3740
|
+
/**
|
|
3741
|
+
* An identifier for user
|
|
3742
|
+
*/
|
|
3743
|
+
data?: {
|
|
3744
|
+
id: string;
|
|
3745
|
+
meta?: {
|
|
3746
|
+
[key: string]: unknown;
|
|
3747
|
+
};
|
|
3748
|
+
type: string;
|
|
3749
|
+
} | null;
|
|
3750
|
+
};
|
|
3751
|
+
workspace?: {
|
|
3752
|
+
/**
|
|
3753
|
+
* An identifier for workspace
|
|
3754
|
+
*/
|
|
3755
|
+
data?: {
|
|
3756
|
+
id: string;
|
|
3757
|
+
meta?: {
|
|
3758
|
+
[key: string]: unknown;
|
|
3759
|
+
};
|
|
3760
|
+
type: string;
|
|
3761
|
+
} | null;
|
|
3762
|
+
};
|
|
3763
|
+
};
|
|
3764
|
+
type: string;
|
|
3765
|
+
};
|
|
3766
|
+
/**
|
|
3767
|
+
* A "Resource object" representing a crawler_schedule
|
|
3768
|
+
*/
|
|
3769
|
+
type CrawlerSchedule = {
|
|
3770
|
+
/**
|
|
3771
|
+
* An attributes object for a crawler_schedule
|
|
3772
|
+
*/
|
|
3773
|
+
attributes?: {
|
|
3774
|
+
[key: string]: never;
|
|
3775
|
+
};
|
|
3776
|
+
id: string;
|
|
3777
|
+
/**
|
|
3778
|
+
* A relationships object for a crawler_schedule
|
|
3779
|
+
*/
|
|
3780
|
+
relationships?: {
|
|
3781
|
+
jobs?: {
|
|
3782
|
+
/**
|
|
3783
|
+
* Relationship data for jobs
|
|
3784
|
+
*/
|
|
3785
|
+
data?: Array<{
|
|
3786
|
+
id: string;
|
|
3787
|
+
meta?: {
|
|
3788
|
+
[key: string]: unknown;
|
|
3789
|
+
};
|
|
3790
|
+
type: string;
|
|
3791
|
+
}>;
|
|
3792
|
+
};
|
|
3793
|
+
};
|
|
3794
|
+
type: string;
|
|
3795
|
+
};
|
|
3796
|
+
/**
|
|
3797
|
+
* A "Resource object" representing a support_ticket_message
|
|
3798
|
+
*/
|
|
3799
|
+
type SupportTicketMessage = {
|
|
3800
|
+
/**
|
|
3801
|
+
* An attributes object for a support_ticket_message
|
|
3802
|
+
*/
|
|
3803
|
+
attributes?: {
|
|
3804
|
+
/**
|
|
3805
|
+
* Field included by default.
|
|
3806
|
+
*/
|
|
3807
|
+
ai_draft: boolean;
|
|
2456
3808
|
/**
|
|
2457
3809
|
* Field included by default.
|
|
2458
3810
|
*/
|
|
2459
|
-
|
|
2460
|
-
[key: string]: unknown;
|
|
2461
|
-
} | null | unknown;
|
|
3811
|
+
body: string;
|
|
2462
3812
|
/**
|
|
2463
3813
|
* Field included by default.
|
|
2464
3814
|
*/
|
|
2465
|
-
|
|
3815
|
+
channel?: string | null | unknown;
|
|
2466
3816
|
/**
|
|
2467
3817
|
* Field included by default.
|
|
2468
3818
|
*/
|
|
2469
|
-
|
|
2470
|
-
};
|
|
2471
|
-
id: string;
|
|
2472
|
-
/**
|
|
2473
|
-
* A relationships object for a scheduling_booking
|
|
2474
|
-
*/
|
|
2475
|
-
relationships?: {
|
|
2476
|
-
[key: string]: never;
|
|
2477
|
-
};
|
|
2478
|
-
type: string;
|
|
2479
|
-
};
|
|
2480
|
-
/**
|
|
2481
|
-
* A "Resource object" representing a extraction_batch
|
|
2482
|
-
*/
|
|
2483
|
-
type ExtractionBatch = {
|
|
2484
|
-
/**
|
|
2485
|
-
* An attributes object for a extraction_batch
|
|
2486
|
-
*/
|
|
2487
|
-
attributes?: {
|
|
3819
|
+
channel_message_id?: string | null | unknown;
|
|
2488
3820
|
/**
|
|
2489
3821
|
* Field included by default.
|
|
2490
3822
|
*/
|
|
2491
|
-
|
|
2492
|
-
status?: string | null | unknown;
|
|
3823
|
+
is_internal_note: boolean;
|
|
2493
3824
|
/**
|
|
2494
|
-
*
|
|
3825
|
+
* Field included by default.
|
|
2495
3826
|
*/
|
|
2496
|
-
|
|
2497
|
-
[key: string]: unknown;
|
|
2498
|
-
}> | null | unknown;
|
|
3827
|
+
sender_id?: string | null | unknown;
|
|
2499
3828
|
/**
|
|
2500
3829
|
* Field included by default.
|
|
2501
3830
|
*/
|
|
2502
|
-
|
|
3831
|
+
sender_type: "customer" | "agent" | "ai" | "system";
|
|
2503
3832
|
};
|
|
2504
3833
|
id: string;
|
|
2505
3834
|
/**
|
|
2506
|
-
* A relationships object for a
|
|
3835
|
+
* A relationships object for a support_ticket_message
|
|
2507
3836
|
*/
|
|
2508
3837
|
relationships?: {
|
|
2509
3838
|
[key: string]: never;
|
|
@@ -2511,86 +3840,62 @@ type ExtractionBatch = {
|
|
|
2511
3840
|
type: string;
|
|
2512
3841
|
};
|
|
2513
3842
|
/**
|
|
2514
|
-
* A "Resource object" representing a
|
|
3843
|
+
* A "Resource object" representing a crm_company
|
|
2515
3844
|
*/
|
|
2516
|
-
type
|
|
3845
|
+
type CrmCompany = {
|
|
2517
3846
|
/**
|
|
2518
|
-
* An attributes object for a
|
|
3847
|
+
* An attributes object for a crm_company
|
|
2519
3848
|
*/
|
|
2520
3849
|
attributes?: {
|
|
2521
3850
|
/**
|
|
2522
3851
|
* Field included by default.
|
|
2523
3852
|
*/
|
|
2524
|
-
|
|
3853
|
+
annual_revenue?: string | null | unknown;
|
|
2525
3854
|
/**
|
|
2526
|
-
*
|
|
3855
|
+
* Field included by default.
|
|
2527
3856
|
*/
|
|
2528
|
-
|
|
3857
|
+
domain?: string | null | unknown;
|
|
2529
3858
|
/**
|
|
2530
|
-
*
|
|
3859
|
+
* Field included by default.
|
|
2531
3860
|
*/
|
|
2532
|
-
|
|
3861
|
+
employee_count?: number | null | unknown;
|
|
2533
3862
|
/**
|
|
2534
|
-
*
|
|
3863
|
+
* Field included by default.
|
|
2535
3864
|
*/
|
|
2536
|
-
|
|
3865
|
+
industry?: string | null | unknown;
|
|
2537
3866
|
/**
|
|
2538
|
-
*
|
|
3867
|
+
* Field included by default.
|
|
2539
3868
|
*/
|
|
2540
|
-
|
|
2541
|
-
[key: string]: unknown;
|
|
2542
|
-
} | null | unknown;
|
|
3869
|
+
lifecycle_stage?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | unknown;
|
|
2543
3870
|
/**
|
|
2544
|
-
*
|
|
3871
|
+
* Field included by default.
|
|
2545
3872
|
*/
|
|
2546
|
-
|
|
2547
|
-
role_label?: string | null | unknown;
|
|
3873
|
+
location?: string | null | unknown;
|
|
2548
3874
|
/**
|
|
2549
|
-
*
|
|
3875
|
+
* Field included by default.
|
|
2550
3876
|
*/
|
|
2551
|
-
|
|
3877
|
+
name: string;
|
|
2552
3878
|
/**
|
|
2553
3879
|
* Field included by default.
|
|
2554
3880
|
*/
|
|
2555
|
-
|
|
3881
|
+
owner_id?: string | null | unknown;
|
|
2556
3882
|
/**
|
|
2557
3883
|
* Field included by default.
|
|
2558
3884
|
*/
|
|
2559
|
-
|
|
3885
|
+
properties?: {
|
|
3886
|
+
[key: string]: unknown;
|
|
3887
|
+
} | null | unknown;
|
|
2560
3888
|
/**
|
|
2561
3889
|
* Field included by default.
|
|
2562
3890
|
*/
|
|
2563
|
-
|
|
3891
|
+
source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api" | unknown;
|
|
2564
3892
|
};
|
|
2565
3893
|
id: string;
|
|
2566
3894
|
/**
|
|
2567
|
-
* A relationships object for a
|
|
3895
|
+
* A relationships object for a crm_company
|
|
2568
3896
|
*/
|
|
2569
3897
|
relationships?: {
|
|
2570
|
-
|
|
2571
|
-
/**
|
|
2572
|
-
* An identifier for user
|
|
2573
|
-
*/
|
|
2574
|
-
data?: {
|
|
2575
|
-
id: string;
|
|
2576
|
-
meta?: {
|
|
2577
|
-
[key: string]: unknown;
|
|
2578
|
-
};
|
|
2579
|
-
type: string;
|
|
2580
|
-
} | null;
|
|
2581
|
-
};
|
|
2582
|
-
workspace?: {
|
|
2583
|
-
/**
|
|
2584
|
-
* An identifier for workspace
|
|
2585
|
-
*/
|
|
2586
|
-
data?: {
|
|
2587
|
-
id: string;
|
|
2588
|
-
meta?: {
|
|
2589
|
-
[key: string]: unknown;
|
|
2590
|
-
};
|
|
2591
|
-
type: string;
|
|
2592
|
-
} | null;
|
|
2593
|
-
};
|
|
3898
|
+
[key: string]: never;
|
|
2594
3899
|
};
|
|
2595
3900
|
type: string;
|
|
2596
3901
|
};
|
|
@@ -2700,6 +4005,36 @@ type CreditPackage = {
|
|
|
2700
4005
|
};
|
|
2701
4006
|
type: string;
|
|
2702
4007
|
};
|
|
4008
|
+
/**
|
|
4009
|
+
* A "Resource object" representing a crawler_job
|
|
4010
|
+
*/
|
|
4011
|
+
type CrawlerJob = {
|
|
4012
|
+
/**
|
|
4013
|
+
* An attributes object for a crawler_job
|
|
4014
|
+
*/
|
|
4015
|
+
attributes?: {
|
|
4016
|
+
[key: string]: never;
|
|
4017
|
+
};
|
|
4018
|
+
id: string;
|
|
4019
|
+
/**
|
|
4020
|
+
* A relationships object for a crawler_job
|
|
4021
|
+
*/
|
|
4022
|
+
relationships?: {
|
|
4023
|
+
results?: {
|
|
4024
|
+
/**
|
|
4025
|
+
* Relationship data for results
|
|
4026
|
+
*/
|
|
4027
|
+
data?: Array<{
|
|
4028
|
+
id: string;
|
|
4029
|
+
meta?: {
|
|
4030
|
+
[key: string]: unknown;
|
|
4031
|
+
};
|
|
4032
|
+
type: string;
|
|
4033
|
+
}>;
|
|
4034
|
+
};
|
|
4035
|
+
};
|
|
4036
|
+
type: string;
|
|
4037
|
+
};
|
|
2703
4038
|
/**
|
|
2704
4039
|
* A "Resource object" representing a workspace
|
|
2705
4040
|
*/
|
|
@@ -3882,7 +5217,7 @@ declare class BrowserApiKeyError extends Error {
|
|
|
3882
5217
|
}
|
|
3883
5218
|
|
|
3884
5219
|
/** SDK version — updated automatically by mix update.sdks */
|
|
3885
|
-
declare const SDK_VERSION = "0.
|
|
5220
|
+
declare const SDK_VERSION = "0.3.1";
|
|
3886
5221
|
/** Default API version sent in every request — updated automatically by mix update.sdks */
|
|
3887
5222
|
declare const DEFAULT_API_VERSION = "2026-02-25";
|
|
3888
5223
|
|
|
@@ -4225,6 +5560,32 @@ declare class RequestBuilder {
|
|
|
4225
5560
|
streamGetRequest(url: string, options?: RequestOptions, streamOptions?: StreamOptions): Promise<AsyncIterableIterator<StreamMessageChunk>>;
|
|
4226
5561
|
}
|
|
4227
5562
|
|
|
5563
|
+
/**
|
|
5564
|
+
* Return type for `voice.sessions.start()`.
|
|
5565
|
+
*
|
|
5566
|
+
* Narrows the generic `VoiceSession` type to guarantee that `livekit_token`
|
|
5567
|
+
* and `livekit_room` are present, non-null strings. These fields are populated
|
|
5568
|
+
* **only** on the POST /voice/sessions create response (one-time delivery) — the
|
|
5569
|
+
* server never persists the token and it is always null in GET/PATCH responses.
|
|
5570
|
+
*
|
|
5571
|
+
* Using this type instead of `VoiceSession` ensures TypeScript enforces that
|
|
5572
|
+
* callers capture the token before it becomes unavailable.
|
|
5573
|
+
*
|
|
5574
|
+
* @example
|
|
5575
|
+
* ```typescript
|
|
5576
|
+
* const session = await client.voice.sessions.start();
|
|
5577
|
+
* const token: string = session.attributes!.livekit_token; // guaranteed non-null
|
|
5578
|
+
* ```
|
|
5579
|
+
*/
|
|
5580
|
+
type VoiceSessionStart = VoiceSession & {
|
|
5581
|
+
attributes: NonNullable<VoiceSession["attributes"]> & {
|
|
5582
|
+
/** LiveKit JWT for immediate room connection. One-time delivery — capture this immediately. */
|
|
5583
|
+
livekit_token: string;
|
|
5584
|
+
/** LiveKit room name. One-time delivery — capture alongside `livekit_token`. */
|
|
5585
|
+
livekit_room: string;
|
|
5586
|
+
};
|
|
5587
|
+
};
|
|
5588
|
+
|
|
4228
5589
|
/**
|
|
4229
5590
|
* Response from the voice transcription endpoint.
|
|
4230
5591
|
* Not a JSON:API resource — this is a plain object response from the
|
|
@@ -4316,8 +5677,17 @@ declare function createVoiceNamespace(rb: RequestBuilder): {
|
|
|
4316
5677
|
phiMode?: "none" | "tokenize" | "tokenize_encrypt";
|
|
4317
5678
|
phiKey?: string;
|
|
4318
5679
|
patientId?: string;
|
|
4319
|
-
}, options?: RequestOptions) => Promise<
|
|
4320
|
-
/**
|
|
5680
|
+
}, options?: RequestOptions) => Promise<VoiceSessionStart>;
|
|
5681
|
+
/**
|
|
5682
|
+
* End a voice session and release the LiveKit room.
|
|
5683
|
+
*
|
|
5684
|
+
* @param id - Voice session ID to end
|
|
5685
|
+
* @param options - Request options
|
|
5686
|
+
*
|
|
5687
|
+
* @note Session stop is fully server-controlled. No attributes are accepted
|
|
5688
|
+
* in the request body — `status` is set to `"ended"` and `ended_at` is set
|
|
5689
|
+
* automatically. Passing extra attributes will result in a 422 error.
|
|
5690
|
+
*/
|
|
4321
5691
|
stop: (id: string, options?: RequestOptions) => Promise<VoiceSession>;
|
|
4322
5692
|
/**
|
|
4323
5693
|
* Dispatch the accumulated session transcript to the blueprint or chat
|
|
@@ -4473,7 +5843,7 @@ declare function createIdentityNamespace(rb: RequestBuilder, baseUrl?: string):
|
|
|
4473
5843
|
* A single attribute filter predicate for server-side JSONB row filtering.
|
|
4474
5844
|
* Operators: eq, not_eq, contains, in, lt, gt, not_null
|
|
4475
5845
|
*/
|
|
4476
|
-
interface AttributeFilter {
|
|
5846
|
+
interface AttributeFilter$1 {
|
|
4477
5847
|
/** The column name to filter on */
|
|
4478
5848
|
field: string;
|
|
4479
5849
|
/** Comparison operator */
|
|
@@ -4484,7 +5854,7 @@ interface AttributeFilter {
|
|
|
4484
5854
|
/** Parameters for `results.query()` */
|
|
4485
5855
|
interface ExtractionRowQueryParams {
|
|
4486
5856
|
/** Filter predicates applied server-side (AND semantics). Empty array returns all rows. */
|
|
4487
|
-
filters
|
|
5857
|
+
filters?: AttributeFilter$1[];
|
|
4488
5858
|
/** Maximum rows to return. Defaults to 1000. Server enforces max 5000. */
|
|
4489
5859
|
limit?: number;
|
|
4490
5860
|
/** Zero-based row offset for pagination. Defaults to 0. */
|
|
@@ -4567,7 +5937,7 @@ declare function createExtractionNamespace(rb: RequestBuilder): {
|
|
|
4567
5937
|
* });
|
|
4568
5938
|
* console.log(`${result.filtered} of ${result.total} rows match`);
|
|
4569
5939
|
*/
|
|
4570
|
-
query: (resultId: string, params
|
|
5940
|
+
query: (resultId: string, params?: ExtractionRowQueryParams, options?: RequestOptions) => Promise<ExtractionRowQueryResult>;
|
|
4571
5941
|
};
|
|
4572
5942
|
batches: {
|
|
4573
5943
|
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ExtractionBatch>;
|
|
@@ -4601,6 +5971,79 @@ declare function createExtractionNamespace(rb: RequestBuilder): {
|
|
|
4601
5971
|
};
|
|
4602
5972
|
};
|
|
4603
5973
|
|
|
5974
|
+
type CrmEntityType = "contact" | "custom_entity" | "activity";
|
|
5975
|
+
type CrmExportFormat = "json" | "csv";
|
|
5976
|
+
type CrmExportStatus = "pending" | "processing" | "complete" | "failed";
|
|
5977
|
+
interface CrmDataExportJob {
|
|
5978
|
+
id: string;
|
|
5979
|
+
workspace_id: string;
|
|
5980
|
+
entity_type: CrmEntityType;
|
|
5981
|
+
entity_subtype?: string;
|
|
5982
|
+
format: CrmExportFormat;
|
|
5983
|
+
include: string[];
|
|
5984
|
+
status: CrmExportStatus;
|
|
5985
|
+
file_url?: string;
|
|
5986
|
+
url_expires_at?: string;
|
|
5987
|
+
row_count?: number;
|
|
5988
|
+
error?: string;
|
|
5989
|
+
inserted_at: string;
|
|
5990
|
+
updated_at: string;
|
|
5991
|
+
}
|
|
5992
|
+
interface CrmExportCreateParams {
|
|
5993
|
+
entityType: CrmEntityType;
|
|
5994
|
+
entitySubtype?: string;
|
|
5995
|
+
format: CrmExportFormat;
|
|
5996
|
+
include?: string[];
|
|
5997
|
+
filters?: AttributeFilter[];
|
|
5998
|
+
}
|
|
5999
|
+
type FilterOperator = "eq" | "not_eq" | "contains" | "in" | "lt" | "gt" | "not_null";
|
|
6000
|
+
interface AttributeFilter {
|
|
6001
|
+
field: string;
|
|
6002
|
+
op: FilterOperator;
|
|
6003
|
+
value?: unknown;
|
|
6004
|
+
}
|
|
6005
|
+
interface AggregateMetric {
|
|
6006
|
+
fn: "count";
|
|
6007
|
+
}
|
|
6008
|
+
interface AggregateFieldMetric {
|
|
6009
|
+
fn: "avg" | "sum";
|
|
6010
|
+
field: string;
|
|
6011
|
+
}
|
|
6012
|
+
/**
|
|
6013
|
+
* A version snapshot of a CrmCustomEntity.
|
|
6014
|
+
* Field names match the CustomEntityVersion Ash resource attributes exactly.
|
|
6015
|
+
*/
|
|
6016
|
+
interface CrmCustomEntityVersion {
|
|
6017
|
+
id: string;
|
|
6018
|
+
version_number: number;
|
|
6019
|
+
/** Snapshot of the entity's properties field at the time of the update. */
|
|
6020
|
+
attributes: Record<string, unknown>;
|
|
6021
|
+
updated_by_user_id?: string;
|
|
6022
|
+
/** ISO 8601 timestamp — the resource uses inserted_at (no updated_at). */
|
|
6023
|
+
inserted_at: string;
|
|
6024
|
+
custom_entity_id: string;
|
|
6025
|
+
workspace_id: string;
|
|
6026
|
+
}
|
|
6027
|
+
|
|
6028
|
+
interface OAuthInitiateResult {
|
|
6029
|
+
auth_url: string;
|
|
6030
|
+
state: string;
|
|
6031
|
+
}
|
|
6032
|
+
interface FullscriptPatient {
|
|
6033
|
+
id: string;
|
|
6034
|
+
email: string;
|
|
6035
|
+
first_name: string;
|
|
6036
|
+
last_name: string;
|
|
6037
|
+
date_of_birth?: string;
|
|
6038
|
+
fullscript_id?: string;
|
|
6039
|
+
[key: string]: unknown;
|
|
6040
|
+
}
|
|
6041
|
+
interface FullscriptSessionGrant {
|
|
6042
|
+
token: string;
|
|
6043
|
+
expires_at: string;
|
|
6044
|
+
patient_id: string;
|
|
6045
|
+
}
|
|
6046
|
+
|
|
4604
6047
|
/**
|
|
4605
6048
|
* GPT Core Client SDK
|
|
4606
6049
|
*
|
|
@@ -4687,7 +6130,7 @@ declare class GptClient extends BaseClient {
|
|
|
4687
6130
|
messages: {
|
|
4688
6131
|
list: (options?: RequestOptions) => Promise<Record<string, unknown>[]>;
|
|
4689
6132
|
stream: (conversationId: string, body: Record<string, unknown>, options?: RequestOptions, streamOptions?: StreamOptions) => Promise<AsyncIterableIterator<StreamMessageChunk>>;
|
|
4690
|
-
send: (
|
|
6133
|
+
send: (conversationId: string, body: Record<string, unknown>, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
4691
6134
|
};
|
|
4692
6135
|
};
|
|
4693
6136
|
/** Wallet, plans, transactions, and payment methods */
|
|
@@ -4731,6 +6174,40 @@ declare class GptClient extends BaseClient {
|
|
|
4731
6174
|
get: (id: string, options?: RequestOptions) => Promise<PaymentMethod>;
|
|
4732
6175
|
};
|
|
4733
6176
|
};
|
|
6177
|
+
/** Product catalog, inventory, pricing, and taxonomy */
|
|
6178
|
+
readonly catalog: {
|
|
6179
|
+
products: {
|
|
6180
|
+
list: (workspaceId: string, options?: {
|
|
6181
|
+
page?: number;
|
|
6182
|
+
pageSize?: number;
|
|
6183
|
+
} & RequestOptions) => Promise<CatalogProduct[]>;
|
|
6184
|
+
get: (id: string, options?: RequestOptions) => Promise<CatalogProduct>;
|
|
6185
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CatalogProduct>;
|
|
6186
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CatalogProduct>;
|
|
6187
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6188
|
+
};
|
|
6189
|
+
variants: {
|
|
6190
|
+
get: (id: string, options?: RequestOptions) => Promise<CatalogProductVariant>;
|
|
6191
|
+
listByProduct: (productId: string, options?: RequestOptions) => Promise<CatalogProductVariant[]>;
|
|
6192
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CatalogProductVariant>;
|
|
6193
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CatalogProductVariant>;
|
|
6194
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6195
|
+
};
|
|
6196
|
+
taxonomies: {
|
|
6197
|
+
listByApplication: (applicationId: string, options?: RequestOptions) => Promise<CatalogTaxonomy[]>;
|
|
6198
|
+
get: (id: string, options?: RequestOptions) => Promise<CatalogTaxonomy>;
|
|
6199
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CatalogTaxonomy>;
|
|
6200
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CatalogTaxonomy>;
|
|
6201
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6202
|
+
};
|
|
6203
|
+
taxonomyNodes: {
|
|
6204
|
+
listByTaxonomy: (taxonomyId: string, options?: RequestOptions) => Promise<CatalogTaxonomyNode[]>;
|
|
6205
|
+
get: (id: string, options?: RequestOptions) => Promise<CatalogTaxonomyNode>;
|
|
6206
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CatalogTaxonomyNode>;
|
|
6207
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CatalogTaxonomyNode>;
|
|
6208
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6209
|
+
};
|
|
6210
|
+
};
|
|
4734
6211
|
/** Notification logs, methods, and preferences */
|
|
4735
6212
|
readonly communication: {
|
|
4736
6213
|
notifications: {
|
|
@@ -4768,6 +6245,235 @@ declare class GptClient extends BaseClient {
|
|
|
4768
6245
|
};
|
|
4769
6246
|
};
|
|
4770
6247
|
};
|
|
6248
|
+
/** OAuth and API adapters for external systems */
|
|
6249
|
+
readonly connectors: {
|
|
6250
|
+
instances: {
|
|
6251
|
+
list: (options?: RequestOptions) => Promise<ConnectorInstance[]>;
|
|
6252
|
+
get: (id: string, options?: RequestOptions) => Promise<ConnectorInstance>;
|
|
6253
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ConnectorInstance>;
|
|
6254
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ConnectorInstance>;
|
|
6255
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6256
|
+
};
|
|
6257
|
+
credentials: {
|
|
6258
|
+
list: (options?: RequestOptions) => Promise<Credential[]>;
|
|
6259
|
+
get: (id: string, options?: RequestOptions) => Promise<Credential>;
|
|
6260
|
+
refresh: (id: string, options?: RequestOptions) => Promise<Credential>;
|
|
6261
|
+
};
|
|
6262
|
+
oauth: {
|
|
6263
|
+
connect: (connectorType: string, workspaceId: string, options?: RequestOptions) => Promise<OAuthInitiateResult>;
|
|
6264
|
+
callback: (connectorType: string, code: string, state: string, workspaceId: string, options?: RequestOptions) => Promise<ConnectorInstance>;
|
|
6265
|
+
};
|
|
6266
|
+
available: {
|
|
6267
|
+
list: () => string[];
|
|
6268
|
+
};
|
|
6269
|
+
fullscript: {
|
|
6270
|
+
checkPatient: (connectorId: string, workspaceId: string, email: string, options?: RequestOptions) => Promise<FullscriptPatient | null>;
|
|
6271
|
+
createPatient: (connectorId: string, workspaceId: string, attrs: {
|
|
6272
|
+
first_name: string;
|
|
6273
|
+
last_name: string;
|
|
6274
|
+
email: string;
|
|
6275
|
+
date_of_birth?: string;
|
|
6276
|
+
}, options?: RequestOptions) => Promise<FullscriptPatient>;
|
|
6277
|
+
sessionGrant: (connectorId: string, workspaceId: string, patientId: string, options?: RequestOptions) => Promise<FullscriptSessionGrant>;
|
|
6278
|
+
oauth: {
|
|
6279
|
+
connect: (workspaceId: string, options?: RequestOptions) => Promise<OAuthInitiateResult>;
|
|
6280
|
+
callback: (code: string, state: string, workspaceId: string, options?: RequestOptions) => Promise<ConnectorInstance>;
|
|
6281
|
+
};
|
|
6282
|
+
};
|
|
6283
|
+
};
|
|
6284
|
+
/** Web crawling and content extraction */
|
|
6285
|
+
readonly crawler: {
|
|
6286
|
+
jobs: {
|
|
6287
|
+
list: (options?: {
|
|
6288
|
+
page?: number;
|
|
6289
|
+
pageSize?: number;
|
|
6290
|
+
} & RequestOptions) => Promise<CrawlerJob[]>;
|
|
6291
|
+
get: (id: string, options?: RequestOptions) => Promise<CrawlerJob>;
|
|
6292
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrawlerJob>;
|
|
6293
|
+
cancel: (id: string, options?: RequestOptions) => Promise<CrawlerJob>;
|
|
6294
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6295
|
+
};
|
|
6296
|
+
schedules: {
|
|
6297
|
+
list: (options?: RequestOptions) => Promise<CrawlerSchedule[]>;
|
|
6298
|
+
get: (id: string, options?: RequestOptions) => Promise<CrawlerSchedule>;
|
|
6299
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrawlerSchedule>;
|
|
6300
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrawlerSchedule>;
|
|
6301
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6302
|
+
};
|
|
6303
|
+
results: {
|
|
6304
|
+
list: (options?: {
|
|
6305
|
+
page?: number;
|
|
6306
|
+
pageSize?: number;
|
|
6307
|
+
} & RequestOptions) => Promise<CrawlerResult[]>;
|
|
6308
|
+
get: (id: string, options?: RequestOptions) => Promise<CrawlerResult>;
|
|
6309
|
+
};
|
|
6310
|
+
};
|
|
6311
|
+
/** Contacts, companies, deals, activities, pipelines, relationships, and custom entities */
|
|
6312
|
+
readonly crm: {
|
|
6313
|
+
contacts: {
|
|
6314
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmContact>;
|
|
6315
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmContact>;
|
|
6316
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmContact>;
|
|
6317
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6318
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6319
|
+
page?: number;
|
|
6320
|
+
pageSize?: number;
|
|
6321
|
+
} & RequestOptions) => Promise<CrmContact[]>;
|
|
6322
|
+
};
|
|
6323
|
+
companies: {
|
|
6324
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmCompany>;
|
|
6325
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCompany>;
|
|
6326
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCompany>;
|
|
6327
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6328
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6329
|
+
page?: number;
|
|
6330
|
+
pageSize?: number;
|
|
6331
|
+
} & RequestOptions) => Promise<CrmCompany[]>;
|
|
6332
|
+
};
|
|
6333
|
+
deals: {
|
|
6334
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmDeal>;
|
|
6335
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmDeal>;
|
|
6336
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmDeal>;
|
|
6337
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6338
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6339
|
+
page?: number;
|
|
6340
|
+
pageSize?: number;
|
|
6341
|
+
} & RequestOptions) => Promise<CrmDeal[]>;
|
|
6342
|
+
};
|
|
6343
|
+
activities: {
|
|
6344
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmActivity>;
|
|
6345
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmActivity>;
|
|
6346
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6347
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6348
|
+
page?: number;
|
|
6349
|
+
pageSize?: number;
|
|
6350
|
+
} & RequestOptions) => Promise<CrmActivity[]>;
|
|
6351
|
+
};
|
|
6352
|
+
pipelines: {
|
|
6353
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmPipeline>;
|
|
6354
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipeline>;
|
|
6355
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipeline>;
|
|
6356
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6357
|
+
listByWorkspace: (workspaceId: string, options?: RequestOptions) => Promise<CrmPipeline[]>;
|
|
6358
|
+
};
|
|
6359
|
+
pipelineStages: {
|
|
6360
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmPipelineStage>;
|
|
6361
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipelineStage>;
|
|
6362
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipelineStage>;
|
|
6363
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6364
|
+
};
|
|
6365
|
+
relationshipTypes: {
|
|
6366
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmRelationshipType>;
|
|
6367
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmRelationshipType>;
|
|
6368
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmRelationshipType>;
|
|
6369
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6370
|
+
list: (options?: RequestOptions) => Promise<CrmRelationshipType[]>;
|
|
6371
|
+
};
|
|
6372
|
+
relationships: {
|
|
6373
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmRelationship>;
|
|
6374
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmRelationship>;
|
|
6375
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6376
|
+
listByWorkspace: (workspaceId: string, options?: RequestOptions) => Promise<CrmRelationship[]>;
|
|
6377
|
+
};
|
|
6378
|
+
customEntities: {
|
|
6379
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmCustomEntity>;
|
|
6380
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCustomEntity>;
|
|
6381
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCustomEntity>;
|
|
6382
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6383
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6384
|
+
type?: string;
|
|
6385
|
+
filters?: AttributeFilter[];
|
|
6386
|
+
page?: number;
|
|
6387
|
+
pageSize?: number;
|
|
6388
|
+
} & RequestOptions) => Promise<CrmCustomEntity[]>;
|
|
6389
|
+
batchUpdate: (workspaceId: string, updates: Array<{
|
|
6390
|
+
id: string;
|
|
6391
|
+
attributes: Record<string, unknown>;
|
|
6392
|
+
}>, options?: RequestOptions) => Promise<CrmCustomEntity[]>;
|
|
6393
|
+
aggregate: (workspaceId: string, params: {
|
|
6394
|
+
type?: string;
|
|
6395
|
+
metrics: Array<AggregateMetric | AggregateFieldMetric>;
|
|
6396
|
+
group_by?: string;
|
|
6397
|
+
filters?: AttributeFilter[];
|
|
6398
|
+
}, options?: RequestOptions) => Promise<Array<Record<string, unknown>>>;
|
|
6399
|
+
versions: {
|
|
6400
|
+
list: (entityId: string, options?: {
|
|
6401
|
+
page?: number;
|
|
6402
|
+
pageSize?: number;
|
|
6403
|
+
} & RequestOptions) => Promise<CrmCustomEntityVersion[]>;
|
|
6404
|
+
get: (entityId: string, versionId: string, options?: RequestOptions) => Promise<CrmCustomEntityVersion>;
|
|
6405
|
+
restore: (entityId: string, versionId: string, options?: RequestOptions) => Promise<CrmCustomEntity>;
|
|
6406
|
+
};
|
|
6407
|
+
};
|
|
6408
|
+
export: {
|
|
6409
|
+
create: (workspaceId: string, params: CrmExportCreateParams, options?: RequestOptions) => Promise<CrmDataExportJob>;
|
|
6410
|
+
get: (jobId: string, options?: RequestOptions) => Promise<CrmDataExportJob>;
|
|
6411
|
+
list: (workspaceId: string, options?: RequestOptions) => Promise<CrmDataExportJob[]>;
|
|
6412
|
+
};
|
|
6413
|
+
};
|
|
6414
|
+
/** Email campaigns, recipients, and sequences */
|
|
6415
|
+
readonly emailMarketing: {
|
|
6416
|
+
campaigns: {
|
|
6417
|
+
get: (id: string, options?: RequestOptions) => Promise<EmailMarketingCampaign>;
|
|
6418
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingCampaign>;
|
|
6419
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingCampaign>;
|
|
6420
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6421
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6422
|
+
page?: number;
|
|
6423
|
+
pageSize?: number;
|
|
6424
|
+
} & RequestOptions) => Promise<EmailMarketingCampaign[]>;
|
|
6425
|
+
send: (id: string, options?: RequestOptions) => Promise<unknown>;
|
|
6426
|
+
analyze: (id: string, options?: RequestOptions) => Promise<unknown>;
|
|
6427
|
+
optimizeSendTimes: (id: string, options?: RequestOptions) => Promise<unknown>;
|
|
6428
|
+
createFollowup: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<unknown>;
|
|
6429
|
+
};
|
|
6430
|
+
templates: {
|
|
6431
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6432
|
+
page?: number;
|
|
6433
|
+
pageSize?: number;
|
|
6434
|
+
} & RequestOptions) => Promise<EmailMarketingTemplate[]>;
|
|
6435
|
+
};
|
|
6436
|
+
generatedEmails: {
|
|
6437
|
+
get: (id: string, options?: RequestOptions) => Promise<EmailMarketingGeneratedEmail>;
|
|
6438
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingGeneratedEmail>;
|
|
6439
|
+
approve: (id: string, options?: RequestOptions) => Promise<EmailMarketingGeneratedEmail>;
|
|
6440
|
+
};
|
|
6441
|
+
senderProfiles: {
|
|
6442
|
+
get: (id: string, options?: RequestOptions) => Promise<EmailMarketingSenderProfile>;
|
|
6443
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingSenderProfile>;
|
|
6444
|
+
validateDns: (id: string, options?: RequestOptions) => Promise<unknown>;
|
|
6445
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6446
|
+
};
|
|
6447
|
+
sequences: {
|
|
6448
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<unknown>;
|
|
6449
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6450
|
+
page?: number;
|
|
6451
|
+
pageSize?: number;
|
|
6452
|
+
} & RequestOptions) => Promise<unknown[]>;
|
|
6453
|
+
resume: (id: string, options?: RequestOptions) => Promise<unknown>;
|
|
6454
|
+
};
|
|
6455
|
+
};
|
|
6456
|
+
/** Support tickets, tags, and SLA tracking */
|
|
6457
|
+
readonly support: {
|
|
6458
|
+
tickets: {
|
|
6459
|
+
list: (workspaceId: string, options?: {
|
|
6460
|
+
page?: number;
|
|
6461
|
+
pageSize?: number;
|
|
6462
|
+
} & RequestOptions) => Promise<SupportTicket[]>;
|
|
6463
|
+
get: (id: string, options?: RequestOptions) => Promise<SupportTicket>;
|
|
6464
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<SupportTicket>;
|
|
6465
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<SupportTicket>;
|
|
6466
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6467
|
+
addMessage: (ticketId: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<SupportTicketMessage>;
|
|
6468
|
+
listMessages: (ticketId: string, options?: RequestOptions) => Promise<SupportTicketMessage[]>;
|
|
6469
|
+
rate: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<unknown>;
|
|
6470
|
+
};
|
|
6471
|
+
tags: {
|
|
6472
|
+
list: (workspaceId: string, options?: RequestOptions) => Promise<SupportTag[]>;
|
|
6473
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<SupportTag>;
|
|
6474
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6475
|
+
};
|
|
6476
|
+
};
|
|
4771
6477
|
/** Document upload, processing, results, and exports */
|
|
4772
6478
|
readonly extraction: {
|
|
4773
6479
|
documents: {
|
|
@@ -4814,7 +6520,7 @@ declare class GptClient extends BaseClient {
|
|
|
4814
6520
|
page?: number;
|
|
4815
6521
|
pageSize?: number;
|
|
4816
6522
|
} & RequestOptions) => Promise<ExtractionResult[]>;
|
|
4817
|
-
query: (resultId: string, params
|
|
6523
|
+
query: (resultId: string, params?: ExtractionRowQueryParams, options?: RequestOptions) => Promise<ExtractionRowQueryResult>;
|
|
4818
6524
|
};
|
|
4819
6525
|
batches: {
|
|
4820
6526
|
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ExtractionBatch>;
|
|
@@ -4913,7 +6619,9 @@ declare class GptClient extends BaseClient {
|
|
|
4913
6619
|
get: (id: string, options?: RequestOptions) => Promise<Workspace>;
|
|
4914
6620
|
create: (name: string, slug?: string, options?: RequestOptions) => Promise<Workspace>;
|
|
4915
6621
|
listExtractionExportsByWorkspace: (workspaceId: string, options?: {
|
|
4916
|
-
page
|
|
6622
|
+
page
|
|
6623
|
+
/** Support tickets, tags, and SLA tracking */
|
|
6624
|
+
? /** Support tickets, tags, and SLA tracking */: number;
|
|
4917
6625
|
pageSize?: number;
|
|
4918
6626
|
} & RequestOptions) => Promise<Workspace[]>;
|
|
4919
6627
|
listAllExtractionExportsByWorkspace: (workspaceId: string, options?: RequestOptions) => Promise<Workspace[]>;
|
|
@@ -5137,7 +6845,7 @@ declare class GptClient extends BaseClient {
|
|
|
5137
6845
|
phiMode?: "none" | "tokenize" | "tokenize_encrypt";
|
|
5138
6846
|
phiKey?: string;
|
|
5139
6847
|
patientId?: string;
|
|
5140
|
-
}, options?: RequestOptions) => Promise<
|
|
6848
|
+
}, options?: RequestOptions) => Promise<VoiceSessionStart>;
|
|
5141
6849
|
stop: (id: string, options?: RequestOptions) => Promise<VoiceSession>;
|
|
5142
6850
|
finalize: (id: string, params?: {
|
|
5143
6851
|
blueprintId?: string;
|
|
@@ -5537,7 +7245,7 @@ declare function createAiNamespace(rb: RequestBuilder): {
|
|
|
5537
7245
|
/** Stream a message to an AI conversation via SSE */
|
|
5538
7246
|
stream: (conversationId: string, body: Record<string, unknown>, options?: RequestOptions, streamOptions?: StreamOptions) => Promise<AsyncIterableIterator<StreamMessageChunk>>;
|
|
5539
7247
|
/** Send a message to an AI conversation (non-streaming) */
|
|
5540
|
-
send: (
|
|
7248
|
+
send: (conversationId: string, body: Record<string, unknown>, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5541
7249
|
};
|
|
5542
7250
|
};
|
|
5543
7251
|
|