@gpt-platform/client 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +1767 -155
- package/dist/index.d.ts +1767 -155
- package/dist/index.js +2156 -175
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2156 -175
- 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
|
*/
|
|
@@ -955,6 +1466,84 @@ type WatcherEvent = {
|
|
|
955
1466
|
};
|
|
956
1467
|
type: string;
|
|
957
1468
|
};
|
|
1469
|
+
/**
|
|
1470
|
+
* A "Resource object" representing a crm_pipeline
|
|
1471
|
+
*/
|
|
1472
|
+
type CrmPipeline = {
|
|
1473
|
+
/**
|
|
1474
|
+
* An attributes object for a crm_pipeline
|
|
1475
|
+
*/
|
|
1476
|
+
attributes?: {
|
|
1477
|
+
/**
|
|
1478
|
+
* Field included by default.
|
|
1479
|
+
*/
|
|
1480
|
+
entity_type: string;
|
|
1481
|
+
/**
|
|
1482
|
+
* Field included by default.
|
|
1483
|
+
*/
|
|
1484
|
+
is_default: boolean;
|
|
1485
|
+
/**
|
|
1486
|
+
* Field included by default.
|
|
1487
|
+
*/
|
|
1488
|
+
name: string;
|
|
1489
|
+
/**
|
|
1490
|
+
* Field included by default.
|
|
1491
|
+
*/
|
|
1492
|
+
workspace_id?: string | null | unknown;
|
|
1493
|
+
};
|
|
1494
|
+
id: string;
|
|
1495
|
+
/**
|
|
1496
|
+
* A relationships object for a crm_pipeline
|
|
1497
|
+
*/
|
|
1498
|
+
relationships?: {
|
|
1499
|
+
[key: string]: never;
|
|
1500
|
+
};
|
|
1501
|
+
type: string;
|
|
1502
|
+
};
|
|
1503
|
+
/**
|
|
1504
|
+
* A "Resource object" representing a crm_relationship
|
|
1505
|
+
*/
|
|
1506
|
+
type CrmRelationship = {
|
|
1507
|
+
/**
|
|
1508
|
+
* An attributes object for a crm_relationship
|
|
1509
|
+
*/
|
|
1510
|
+
attributes?: {
|
|
1511
|
+
/**
|
|
1512
|
+
* Field included by default.
|
|
1513
|
+
*/
|
|
1514
|
+
properties?: {
|
|
1515
|
+
[key: string]: unknown;
|
|
1516
|
+
} | null | unknown;
|
|
1517
|
+
/**
|
|
1518
|
+
* Field included by default.
|
|
1519
|
+
*/
|
|
1520
|
+
source_entity_id: string;
|
|
1521
|
+
/**
|
|
1522
|
+
* Field included by default.
|
|
1523
|
+
*/
|
|
1524
|
+
source_entity_type: string;
|
|
1525
|
+
/**
|
|
1526
|
+
* Field included by default.
|
|
1527
|
+
*/
|
|
1528
|
+
strength?: number | null | unknown;
|
|
1529
|
+
/**
|
|
1530
|
+
* Field included by default.
|
|
1531
|
+
*/
|
|
1532
|
+
target_entity_id: string;
|
|
1533
|
+
/**
|
|
1534
|
+
* Field included by default.
|
|
1535
|
+
*/
|
|
1536
|
+
target_entity_type: string;
|
|
1537
|
+
};
|
|
1538
|
+
id: string;
|
|
1539
|
+
/**
|
|
1540
|
+
* A relationships object for a crm_relationship
|
|
1541
|
+
*/
|
|
1542
|
+
relationships?: {
|
|
1543
|
+
[key: string]: never;
|
|
1544
|
+
};
|
|
1545
|
+
type: string;
|
|
1546
|
+
};
|
|
958
1547
|
/**
|
|
959
1548
|
* A "Resource object" representing a plan
|
|
960
1549
|
*/
|
|
@@ -1394,11 +1983,43 @@ type ApiKey = {
|
|
|
1394
1983
|
type: string;
|
|
1395
1984
|
};
|
|
1396
1985
|
/**
|
|
1397
|
-
* A "Resource object" representing a
|
|
1986
|
+
* A "Resource object" representing a crm_custom_entity
|
|
1398
1987
|
*/
|
|
1399
|
-
type
|
|
1988
|
+
type CrmCustomEntity = {
|
|
1400
1989
|
/**
|
|
1401
|
-
* An attributes object for a
|
|
1990
|
+
* An attributes object for a crm_custom_entity
|
|
1991
|
+
*/
|
|
1992
|
+
attributes?: {
|
|
1993
|
+
/**
|
|
1994
|
+
* Field included by default.
|
|
1995
|
+
*/
|
|
1996
|
+
name: string;
|
|
1997
|
+
/**
|
|
1998
|
+
* Field included by default.
|
|
1999
|
+
*/
|
|
2000
|
+
owner_id?: string | null | unknown;
|
|
2001
|
+
/**
|
|
2002
|
+
* Field included by default.
|
|
2003
|
+
*/
|
|
2004
|
+
properties?: {
|
|
2005
|
+
[key: string]: unknown;
|
|
2006
|
+
} | null | unknown;
|
|
2007
|
+
};
|
|
2008
|
+
id: string;
|
|
2009
|
+
/**
|
|
2010
|
+
* A relationships object for a crm_custom_entity
|
|
2011
|
+
*/
|
|
2012
|
+
relationships?: {
|
|
2013
|
+
[key: string]: never;
|
|
2014
|
+
};
|
|
2015
|
+
type: string;
|
|
2016
|
+
};
|
|
2017
|
+
/**
|
|
2018
|
+
* A "Resource object" representing a transaction
|
|
2019
|
+
*/
|
|
2020
|
+
type Transaction = {
|
|
2021
|
+
/**
|
|
2022
|
+
* An attributes object for a transaction
|
|
1402
2023
|
*/
|
|
1403
2024
|
attributes?: {
|
|
1404
2025
|
/**
|
|
@@ -1795,6 +2416,124 @@ type Tenant = {
|
|
|
1795
2416
|
};
|
|
1796
2417
|
type: string;
|
|
1797
2418
|
};
|
|
2419
|
+
/**
|
|
2420
|
+
* A "Resource object" representing a catalog_taxonomy
|
|
2421
|
+
*/
|
|
2422
|
+
type CatalogTaxonomy = {
|
|
2423
|
+
/**
|
|
2424
|
+
* An attributes object for a catalog_taxonomy
|
|
2425
|
+
*/
|
|
2426
|
+
attributes?: {
|
|
2427
|
+
/**
|
|
2428
|
+
* Field included by default.
|
|
2429
|
+
*/
|
|
2430
|
+
ai_managed: boolean;
|
|
2431
|
+
/**
|
|
2432
|
+
* Field included by default.
|
|
2433
|
+
*/
|
|
2434
|
+
application_id: string;
|
|
2435
|
+
/**
|
|
2436
|
+
* Field included by default.
|
|
2437
|
+
*/
|
|
2438
|
+
is_hierarchical: boolean;
|
|
2439
|
+
/**
|
|
2440
|
+
* Field included by default.
|
|
2441
|
+
*/
|
|
2442
|
+
is_required: boolean;
|
|
2443
|
+
/**
|
|
2444
|
+
* Field included by default.
|
|
2445
|
+
*/
|
|
2446
|
+
max_depth?: number | null | unknown;
|
|
2447
|
+
/**
|
|
2448
|
+
* Field included by default.
|
|
2449
|
+
*/
|
|
2450
|
+
name: string;
|
|
2451
|
+
/**
|
|
2452
|
+
* Field included by default.
|
|
2453
|
+
*/
|
|
2454
|
+
scope: "application" | "workspace";
|
|
2455
|
+
/**
|
|
2456
|
+
* Field included by default.
|
|
2457
|
+
*/
|
|
2458
|
+
slug: string;
|
|
2459
|
+
/**
|
|
2460
|
+
* Field included by default.
|
|
2461
|
+
*/
|
|
2462
|
+
workspace_id?: string | null | unknown;
|
|
2463
|
+
};
|
|
2464
|
+
id: string;
|
|
2465
|
+
/**
|
|
2466
|
+
* A relationships object for a catalog_taxonomy
|
|
2467
|
+
*/
|
|
2468
|
+
relationships?: {
|
|
2469
|
+
[key: string]: never;
|
|
2470
|
+
};
|
|
2471
|
+
type: string;
|
|
2472
|
+
};
|
|
2473
|
+
/**
|
|
2474
|
+
* A "Resource object" representing a credential
|
|
2475
|
+
*/
|
|
2476
|
+
type Credential = {
|
|
2477
|
+
/**
|
|
2478
|
+
* An attributes object for a credential
|
|
2479
|
+
*/
|
|
2480
|
+
attributes?: {
|
|
2481
|
+
/**
|
|
2482
|
+
* Field included by default.
|
|
2483
|
+
*/
|
|
2484
|
+
application_id?: string | null | unknown;
|
|
2485
|
+
/**
|
|
2486
|
+
* Field included by default.
|
|
2487
|
+
*/
|
|
2488
|
+
auth_type: "oauth2" | "api_key" | "basic_auth" | "jwt_bearer" | "client_credentials";
|
|
2489
|
+
/**
|
|
2490
|
+
* Field included by default.
|
|
2491
|
+
*/
|
|
2492
|
+
connector_type: "salesforce" | "hubspot" | "slack" | "notion" | "sharepoint" | "gmail" | "outlook" | "microsoft_365" | "jira" | "confluence" | "fullscript" | "github" | "gitlab" | "google_calendar" | "google_chat" | "custom";
|
|
2493
|
+
/**
|
|
2494
|
+
* Number of consecutive token refresh failures. Reset to 0 on successful refresh. Field included by default.
|
|
2495
|
+
*/
|
|
2496
|
+
consecutive_failures: number;
|
|
2497
|
+
/**
|
|
2498
|
+
* Field included by default.
|
|
2499
|
+
*/
|
|
2500
|
+
expires_at?: string | null | unknown;
|
|
2501
|
+
/**
|
|
2502
|
+
* Field included by default.
|
|
2503
|
+
*/
|
|
2504
|
+
last_refreshed_at?: string | null | unknown;
|
|
2505
|
+
/**
|
|
2506
|
+
* Field included by default.
|
|
2507
|
+
*/
|
|
2508
|
+
metadata?: {
|
|
2509
|
+
[key: string]: unknown;
|
|
2510
|
+
} | null | unknown;
|
|
2511
|
+
/**
|
|
2512
|
+
* Field included by default.
|
|
2513
|
+
*/
|
|
2514
|
+
refresh_status?: "valid" | "expiring_soon" | "refresh_failed" | "revoked" | unknown;
|
|
2515
|
+
/**
|
|
2516
|
+
* Field included by default.
|
|
2517
|
+
*/
|
|
2518
|
+
scope_level: "workspace" | "tenant" | "application";
|
|
2519
|
+
/**
|
|
2520
|
+
* Field included by default.
|
|
2521
|
+
*/
|
|
2522
|
+
tenant_id?: string | null | unknown;
|
|
2523
|
+
/**
|
|
2524
|
+
* Field included by default.
|
|
2525
|
+
*/
|
|
2526
|
+
workspace_id: string;
|
|
2527
|
+
};
|
|
2528
|
+
id: string;
|
|
2529
|
+
/**
|
|
2530
|
+
* A relationships object for a credential
|
|
2531
|
+
*/
|
|
2532
|
+
relationships?: {
|
|
2533
|
+
[key: string]: never;
|
|
2534
|
+
};
|
|
2535
|
+
type: string;
|
|
2536
|
+
};
|
|
1798
2537
|
/**
|
|
1799
2538
|
* A "Resource object" representing a agent_version
|
|
1800
2539
|
*/
|
|
@@ -2296,6 +3035,191 @@ type WebhookDelivery = {
|
|
|
2296
3035
|
};
|
|
2297
3036
|
type: string;
|
|
2298
3037
|
};
|
|
3038
|
+
/**
|
|
3039
|
+
* A "Resource object" representing a connector_instance
|
|
3040
|
+
*/
|
|
3041
|
+
type ConnectorInstance = {
|
|
3042
|
+
/**
|
|
3043
|
+
* An attributes object for a connector_instance
|
|
3044
|
+
*/
|
|
3045
|
+
attributes?: {
|
|
3046
|
+
/**
|
|
3047
|
+
* Field included by default.
|
|
3048
|
+
*/
|
|
3049
|
+
connector_type: "salesforce" | "hubspot" | "slack" | "notion" | "sharepoint" | "gmail" | "outlook" | "microsoft_365" | "jira" | "confluence" | "fullscript" | "github" | "gitlab" | "google_calendar" | "google_chat" | "custom";
|
|
3050
|
+
/**
|
|
3051
|
+
* Field included by default.
|
|
3052
|
+
*/
|
|
3053
|
+
enabled?: boolean | null | unknown;
|
|
3054
|
+
/**
|
|
3055
|
+
* Field included by default.
|
|
3056
|
+
*/
|
|
3057
|
+
health_status?: "healthy" | "degraded" | "unhealthy" | "unknown" | unknown;
|
|
3058
|
+
/**
|
|
3059
|
+
* Field included by default.
|
|
3060
|
+
*/
|
|
3061
|
+
last_sync_at?: string | null | unknown;
|
|
3062
|
+
/**
|
|
3063
|
+
* Field included by default.
|
|
3064
|
+
*/
|
|
3065
|
+
metadata?: {
|
|
3066
|
+
[key: string]: unknown;
|
|
3067
|
+
} | null | unknown;
|
|
3068
|
+
/**
|
|
3069
|
+
* Field included by default.
|
|
3070
|
+
*/
|
|
3071
|
+
name: string;
|
|
3072
|
+
/**
|
|
3073
|
+
* Field included by default.
|
|
3074
|
+
*/
|
|
3075
|
+
sync_interval_minutes?: number | null | unknown;
|
|
3076
|
+
/**
|
|
3077
|
+
* Field included by default.
|
|
3078
|
+
*/
|
|
3079
|
+
workspace_id: string;
|
|
3080
|
+
};
|
|
3081
|
+
id: string;
|
|
3082
|
+
/**
|
|
3083
|
+
* A relationships object for a connector_instance
|
|
3084
|
+
*/
|
|
3085
|
+
relationships?: {
|
|
3086
|
+
workspace?: {
|
|
3087
|
+
/**
|
|
3088
|
+
* An identifier for workspace
|
|
3089
|
+
*/
|
|
3090
|
+
data?: {
|
|
3091
|
+
id: string;
|
|
3092
|
+
meta?: {
|
|
3093
|
+
[key: string]: unknown;
|
|
3094
|
+
};
|
|
3095
|
+
type: string;
|
|
3096
|
+
} | null;
|
|
3097
|
+
};
|
|
3098
|
+
};
|
|
3099
|
+
type: string;
|
|
3100
|
+
};
|
|
3101
|
+
/**
|
|
3102
|
+
* A "Resource object" representing a crm_deal
|
|
3103
|
+
*/
|
|
3104
|
+
type CrmDeal = {
|
|
3105
|
+
/**
|
|
3106
|
+
* An attributes object for a crm_deal
|
|
3107
|
+
*/
|
|
3108
|
+
attributes?: {
|
|
3109
|
+
/**
|
|
3110
|
+
* Field included by default.
|
|
3111
|
+
*/
|
|
3112
|
+
ai_forecast_category?: "pipeline" | "best_case" | "commit" | "closed" | unknown;
|
|
3113
|
+
/**
|
|
3114
|
+
* Field included by default.
|
|
3115
|
+
*/
|
|
3116
|
+
ai_next_action?: string | null | unknown;
|
|
3117
|
+
/**
|
|
3118
|
+
* Field included by default.
|
|
3119
|
+
*/
|
|
3120
|
+
ai_risk_score?: number | null | unknown;
|
|
3121
|
+
/**
|
|
3122
|
+
* Field included by default.
|
|
3123
|
+
*/
|
|
3124
|
+
amount?: string | null | unknown;
|
|
3125
|
+
/**
|
|
3126
|
+
* Field included by default.
|
|
3127
|
+
*/
|
|
3128
|
+
close_date?: string | null | unknown;
|
|
3129
|
+
/**
|
|
3130
|
+
* Field included by default.
|
|
3131
|
+
*/
|
|
3132
|
+
currency?: string | null | unknown;
|
|
3133
|
+
/**
|
|
3134
|
+
* Field included by default.
|
|
3135
|
+
*/
|
|
3136
|
+
lost_reason?: string | null | unknown;
|
|
3137
|
+
/**
|
|
3138
|
+
* Field included by default.
|
|
3139
|
+
*/
|
|
3140
|
+
name: string;
|
|
3141
|
+
/**
|
|
3142
|
+
* Field included by default.
|
|
3143
|
+
*/
|
|
3144
|
+
owner_id?: string | null | unknown;
|
|
3145
|
+
/**
|
|
3146
|
+
* Field included by default.
|
|
3147
|
+
*/
|
|
3148
|
+
probability?: number | null | unknown;
|
|
3149
|
+
/**
|
|
3150
|
+
* Field included by default.
|
|
3151
|
+
*/
|
|
3152
|
+
properties?: {
|
|
3153
|
+
[key: string]: unknown;
|
|
3154
|
+
} | null | unknown;
|
|
3155
|
+
/**
|
|
3156
|
+
* Field included by default.
|
|
3157
|
+
*/
|
|
3158
|
+
source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api" | unknown;
|
|
3159
|
+
/**
|
|
3160
|
+
* Field included by default.
|
|
3161
|
+
*/
|
|
3162
|
+
status?: "open" | "won" | "lost" | "abandoned" | unknown;
|
|
3163
|
+
};
|
|
3164
|
+
id: string;
|
|
3165
|
+
/**
|
|
3166
|
+
* A relationships object for a crm_deal
|
|
3167
|
+
*/
|
|
3168
|
+
relationships?: {
|
|
3169
|
+
[key: string]: never;
|
|
3170
|
+
};
|
|
3171
|
+
type: string;
|
|
3172
|
+
};
|
|
3173
|
+
/**
|
|
3174
|
+
* A "Resource object" representing a catalog_product_variant
|
|
3175
|
+
*/
|
|
3176
|
+
type CatalogProductVariant = {
|
|
3177
|
+
/**
|
|
3178
|
+
* An attributes object for a catalog_product_variant
|
|
3179
|
+
*/
|
|
3180
|
+
attributes?: {
|
|
3181
|
+
/**
|
|
3182
|
+
* Field included by default.
|
|
3183
|
+
*/
|
|
3184
|
+
media?: Array<{
|
|
3185
|
+
[key: string]: unknown;
|
|
3186
|
+
}> | null | unknown;
|
|
3187
|
+
/**
|
|
3188
|
+
* Field included by default.
|
|
3189
|
+
*/
|
|
3190
|
+
position?: number | null | unknown;
|
|
3191
|
+
/**
|
|
3192
|
+
* Field included by default.
|
|
3193
|
+
*/
|
|
3194
|
+
price_override?: string | null | unknown;
|
|
3195
|
+
/**
|
|
3196
|
+
* Field included by default.
|
|
3197
|
+
*/
|
|
3198
|
+
properties?: {
|
|
3199
|
+
[key: string]: unknown;
|
|
3200
|
+
} | null | unknown;
|
|
3201
|
+
/**
|
|
3202
|
+
* Field included by default.
|
|
3203
|
+
*/
|
|
3204
|
+
sku: string;
|
|
3205
|
+
/**
|
|
3206
|
+
* Field included by default.
|
|
3207
|
+
*/
|
|
3208
|
+
status: "active" | "archived";
|
|
3209
|
+
/**
|
|
3210
|
+
* Field included by default.
|
|
3211
|
+
*/
|
|
3212
|
+
workspace_id: string;
|
|
3213
|
+
};
|
|
3214
|
+
id: string;
|
|
3215
|
+
/**
|
|
3216
|
+
* A relationships object for a catalog_product_variant
|
|
3217
|
+
*/
|
|
3218
|
+
relationships?: {
|
|
3219
|
+
[key: string]: never;
|
|
3220
|
+
};
|
|
3221
|
+
type: string;
|
|
3222
|
+
};
|
|
2299
3223
|
/**
|
|
2300
3224
|
* A "Resource object" representing a voice_session
|
|
2301
3225
|
*/
|
|
@@ -2335,8 +3259,7 @@ type VoiceSession = {
|
|
|
2335
3259
|
* response and is null in ALL subsequent read operations (GET, list). The token is
|
|
2336
3260
|
* injected in-memory by the `:start` after_action and is NEVER written to the database
|
|
2337
3261
|
* (enforced by a database CHECK constraint). Clients must capture it from the create response
|
|
2338
|
-
* — it cannot be retrieved after that point.
|
|
2339
|
-
* . Field included by default.
|
|
3262
|
+
* — it cannot be retrieved after that point. Field included by default.
|
|
2340
3263
|
*/
|
|
2341
3264
|
livekit_token?: string | null | unknown;
|
|
2342
3265
|
/**
|
|
@@ -2368,19 +3291,109 @@ type VoiceSession = {
|
|
|
2368
3291
|
/**
|
|
2369
3292
|
* Field included by default.
|
|
2370
3293
|
*/
|
|
2371
|
-
updated_at: unknown;
|
|
3294
|
+
updated_at: unknown;
|
|
3295
|
+
/**
|
|
3296
|
+
* Field included by default.
|
|
3297
|
+
*/
|
|
3298
|
+
user_id: string;
|
|
3299
|
+
/**
|
|
3300
|
+
* Field included by default.
|
|
3301
|
+
*/
|
|
3302
|
+
workspace_id: string;
|
|
3303
|
+
};
|
|
3304
|
+
id: string;
|
|
3305
|
+
/**
|
|
3306
|
+
* A relationships object for a voice_session
|
|
3307
|
+
*/
|
|
3308
|
+
relationships?: {
|
|
3309
|
+
[key: string]: never;
|
|
3310
|
+
};
|
|
3311
|
+
type: string;
|
|
3312
|
+
};
|
|
3313
|
+
/**
|
|
3314
|
+
* A "Resource object" representing a scheduling_booking
|
|
3315
|
+
*/
|
|
3316
|
+
type SchedulingBooking = {
|
|
3317
|
+
/**
|
|
3318
|
+
* An attributes object for a scheduling_booking
|
|
3319
|
+
*/
|
|
3320
|
+
attributes?: {
|
|
3321
|
+
/**
|
|
3322
|
+
* Field included by default.
|
|
3323
|
+
*/
|
|
3324
|
+
_hp_field?: string | null | unknown;
|
|
3325
|
+
/**
|
|
3326
|
+
* Field included by default.
|
|
3327
|
+
*/
|
|
3328
|
+
booked_by_user_id?: string | null | unknown;
|
|
3329
|
+
/**
|
|
3330
|
+
* Field included by default.
|
|
3331
|
+
*/
|
|
3332
|
+
booker_contact_id?: string | null | unknown;
|
|
3333
|
+
/**
|
|
3334
|
+
* Field included by default.
|
|
3335
|
+
*/
|
|
3336
|
+
booker_email: string;
|
|
3337
|
+
/**
|
|
3338
|
+
* Field included by default.
|
|
3339
|
+
*/
|
|
3340
|
+
booker_name: string;
|
|
3341
|
+
/**
|
|
3342
|
+
* Field included by default.
|
|
3343
|
+
*/
|
|
3344
|
+
booker_phone?: string | null | unknown;
|
|
3345
|
+
/**
|
|
3346
|
+
* Field included by default.
|
|
3347
|
+
*/
|
|
3348
|
+
booker_timezone?: string | null | unknown;
|
|
3349
|
+
/**
|
|
3350
|
+
* Field included by default.
|
|
3351
|
+
*/
|
|
3352
|
+
cancellation_reason?: string | null | unknown;
|
|
3353
|
+
/**
|
|
3354
|
+
* Field included by default.
|
|
3355
|
+
*/
|
|
3356
|
+
cancelled_at?: unknown;
|
|
3357
|
+
/**
|
|
3358
|
+
* Field included by default.
|
|
3359
|
+
*/
|
|
3360
|
+
cancelled_by?: "booker" | "organizer" | "system" | unknown;
|
|
3361
|
+
/**
|
|
3362
|
+
* Field included by default.
|
|
3363
|
+
*/
|
|
3364
|
+
confirmed_at?: unknown;
|
|
3365
|
+
/**
|
|
3366
|
+
* Field included by default.
|
|
3367
|
+
*/
|
|
3368
|
+
event_id?: string | null | unknown;
|
|
3369
|
+
/**
|
|
3370
|
+
* Field included by default.
|
|
3371
|
+
*/
|
|
3372
|
+
event_type_id: string;
|
|
3373
|
+
/**
|
|
3374
|
+
* Field included by default.
|
|
3375
|
+
*/
|
|
3376
|
+
intake_responses?: {
|
|
3377
|
+
[key: string]: unknown;
|
|
3378
|
+
} | null | unknown;
|
|
3379
|
+
/**
|
|
3380
|
+
* Field included by default.
|
|
3381
|
+
*/
|
|
3382
|
+
metadata?: {
|
|
3383
|
+
[key: string]: unknown;
|
|
3384
|
+
} | null | unknown;
|
|
2372
3385
|
/**
|
|
2373
3386
|
* Field included by default.
|
|
2374
3387
|
*/
|
|
2375
|
-
|
|
3388
|
+
party_size?: number | null | unknown;
|
|
2376
3389
|
/**
|
|
2377
3390
|
* Field included by default.
|
|
2378
3391
|
*/
|
|
2379
|
-
|
|
3392
|
+
status?: "pending_approval" | "pending_verification" | "confirmed" | "cancelled" | "no_show" | unknown;
|
|
2380
3393
|
};
|
|
2381
3394
|
id: string;
|
|
2382
3395
|
/**
|
|
2383
|
-
* A relationships object for a
|
|
3396
|
+
* A relationships object for a scheduling_booking
|
|
2384
3397
|
*/
|
|
2385
3398
|
relationships?: {
|
|
2386
3399
|
[key: string]: never;
|
|
@@ -2388,89 +3401,99 @@ type VoiceSession = {
|
|
|
2388
3401
|
type: string;
|
|
2389
3402
|
};
|
|
2390
3403
|
/**
|
|
2391
|
-
* A "Resource object" representing a
|
|
3404
|
+
* A "Resource object" representing a email-marketing-template
|
|
2392
3405
|
*/
|
|
2393
|
-
type
|
|
3406
|
+
type EmailMarketingTemplate = {
|
|
2394
3407
|
/**
|
|
2395
|
-
* An attributes object for a
|
|
3408
|
+
* An attributes object for a email-marketing-template
|
|
2396
3409
|
*/
|
|
2397
3410
|
attributes?: {
|
|
2398
3411
|
/**
|
|
2399
3412
|
* Field included by default.
|
|
2400
3413
|
*/
|
|
2401
|
-
|
|
2402
|
-
/**
|
|
2403
|
-
* Field included by default.
|
|
2404
|
-
*/
|
|
2405
|
-
booked_by_user_id?: string | null | unknown;
|
|
3414
|
+
ai_instructions?: string | null | unknown;
|
|
2406
3415
|
/**
|
|
2407
3416
|
* Field included by default.
|
|
2408
3417
|
*/
|
|
2409
|
-
|
|
3418
|
+
archived?: boolean | null | unknown;
|
|
2410
3419
|
/**
|
|
2411
3420
|
* Field included by default.
|
|
2412
3421
|
*/
|
|
2413
|
-
|
|
3422
|
+
body_template?: string | null | unknown;
|
|
2414
3423
|
/**
|
|
2415
3424
|
* Field included by default.
|
|
2416
3425
|
*/
|
|
2417
|
-
|
|
3426
|
+
name: string;
|
|
2418
3427
|
/**
|
|
2419
3428
|
* Field included by default.
|
|
2420
3429
|
*/
|
|
2421
|
-
|
|
3430
|
+
subject_template?: string | null | unknown;
|
|
2422
3431
|
/**
|
|
2423
3432
|
* Field included by default.
|
|
2424
3433
|
*/
|
|
2425
|
-
|
|
3434
|
+
type?: "template" | "prompt" | unknown;
|
|
2426
3435
|
/**
|
|
2427
3436
|
* Field included by default.
|
|
2428
3437
|
*/
|
|
2429
|
-
|
|
3438
|
+
variables?: Array<string> | null | unknown;
|
|
3439
|
+
};
|
|
3440
|
+
id: string;
|
|
3441
|
+
/**
|
|
3442
|
+
* A relationships object for a email-marketing-template
|
|
3443
|
+
*/
|
|
3444
|
+
relationships?: {
|
|
3445
|
+
[key: string]: never;
|
|
3446
|
+
};
|
|
3447
|
+
type: string;
|
|
3448
|
+
};
|
|
3449
|
+
/**
|
|
3450
|
+
* A "Resource object" representing a email-marketing-generated-email
|
|
3451
|
+
*/
|
|
3452
|
+
type EmailMarketingGeneratedEmail = {
|
|
3453
|
+
/**
|
|
3454
|
+
* An attributes object for a email-marketing-generated-email
|
|
3455
|
+
*/
|
|
3456
|
+
attributes?: {
|
|
2430
3457
|
/**
|
|
2431
3458
|
* Field included by default.
|
|
2432
3459
|
*/
|
|
2433
|
-
|
|
3460
|
+
agent_execution_id?: string | null | unknown;
|
|
2434
3461
|
/**
|
|
2435
3462
|
* Field included by default.
|
|
2436
3463
|
*/
|
|
2437
|
-
|
|
3464
|
+
body?: string | null | unknown;
|
|
2438
3465
|
/**
|
|
2439
3466
|
* Field included by default.
|
|
2440
3467
|
*/
|
|
2441
|
-
|
|
3468
|
+
error_message?: string | null | unknown;
|
|
2442
3469
|
/**
|
|
2443
3470
|
* Field included by default.
|
|
2444
3471
|
*/
|
|
2445
|
-
|
|
3472
|
+
is_approved?: boolean | null | unknown;
|
|
2446
3473
|
/**
|
|
2447
3474
|
* Field included by default.
|
|
2448
3475
|
*/
|
|
2449
|
-
|
|
3476
|
+
is_edited?: boolean | null | unknown;
|
|
2450
3477
|
/**
|
|
2451
3478
|
* Field included by default.
|
|
2452
3479
|
*/
|
|
2453
|
-
|
|
2454
|
-
[key: string]: unknown;
|
|
2455
|
-
} | null | unknown;
|
|
3480
|
+
scheduled_for?: unknown;
|
|
2456
3481
|
/**
|
|
2457
3482
|
* Field included by default.
|
|
2458
3483
|
*/
|
|
2459
|
-
|
|
2460
|
-
[key: string]: unknown;
|
|
2461
|
-
} | null | unknown;
|
|
3484
|
+
sent_at?: unknown;
|
|
2462
3485
|
/**
|
|
2463
3486
|
* Field included by default.
|
|
2464
3487
|
*/
|
|
2465
|
-
|
|
3488
|
+
status?: "draft" | "approved" | "sending" | "sent" | "scheduled" | "failed" | unknown;
|
|
2466
3489
|
/**
|
|
2467
3490
|
* Field included by default.
|
|
2468
3491
|
*/
|
|
2469
|
-
|
|
3492
|
+
subject?: string | null | unknown;
|
|
2470
3493
|
};
|
|
2471
3494
|
id: string;
|
|
2472
3495
|
/**
|
|
2473
|
-
* A relationships object for a
|
|
3496
|
+
* A relationships object for a email-marketing-generated-email
|
|
2474
3497
|
*/
|
|
2475
3498
|
relationships?: {
|
|
2476
3499
|
[key: string]: never;
|
|
@@ -2594,6 +3617,96 @@ type WorkspaceMembership = {
|
|
|
2594
3617
|
};
|
|
2595
3618
|
type: string;
|
|
2596
3619
|
};
|
|
3620
|
+
/**
|
|
3621
|
+
* A "Resource object" representing a crawler_schedule
|
|
3622
|
+
*/
|
|
3623
|
+
type CrawlerSchedule = {
|
|
3624
|
+
/**
|
|
3625
|
+
* An attributes object for a crawler_schedule
|
|
3626
|
+
*/
|
|
3627
|
+
attributes?: {
|
|
3628
|
+
[key: string]: never;
|
|
3629
|
+
};
|
|
3630
|
+
id: string;
|
|
3631
|
+
/**
|
|
3632
|
+
* A relationships object for a crawler_schedule
|
|
3633
|
+
*/
|
|
3634
|
+
relationships?: {
|
|
3635
|
+
jobs?: {
|
|
3636
|
+
/**
|
|
3637
|
+
* Relationship data for jobs
|
|
3638
|
+
*/
|
|
3639
|
+
data?: Array<{
|
|
3640
|
+
id: string;
|
|
3641
|
+
meta?: {
|
|
3642
|
+
[key: string]: unknown;
|
|
3643
|
+
};
|
|
3644
|
+
type: string;
|
|
3645
|
+
}>;
|
|
3646
|
+
};
|
|
3647
|
+
};
|
|
3648
|
+
type: string;
|
|
3649
|
+
};
|
|
3650
|
+
/**
|
|
3651
|
+
* A "Resource object" representing a crm_company
|
|
3652
|
+
*/
|
|
3653
|
+
type CrmCompany = {
|
|
3654
|
+
/**
|
|
3655
|
+
* An attributes object for a crm_company
|
|
3656
|
+
*/
|
|
3657
|
+
attributes?: {
|
|
3658
|
+
/**
|
|
3659
|
+
* Field included by default.
|
|
3660
|
+
*/
|
|
3661
|
+
annual_revenue?: string | null | unknown;
|
|
3662
|
+
/**
|
|
3663
|
+
* Field included by default.
|
|
3664
|
+
*/
|
|
3665
|
+
domain?: string | null | unknown;
|
|
3666
|
+
/**
|
|
3667
|
+
* Field included by default.
|
|
3668
|
+
*/
|
|
3669
|
+
employee_count?: number | null | unknown;
|
|
3670
|
+
/**
|
|
3671
|
+
* Field included by default.
|
|
3672
|
+
*/
|
|
3673
|
+
industry?: string | null | unknown;
|
|
3674
|
+
/**
|
|
3675
|
+
* Field included by default.
|
|
3676
|
+
*/
|
|
3677
|
+
lifecycle_stage?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | unknown;
|
|
3678
|
+
/**
|
|
3679
|
+
* Field included by default.
|
|
3680
|
+
*/
|
|
3681
|
+
location?: string | null | unknown;
|
|
3682
|
+
/**
|
|
3683
|
+
* Field included by default.
|
|
3684
|
+
*/
|
|
3685
|
+
name: string;
|
|
3686
|
+
/**
|
|
3687
|
+
* Field included by default.
|
|
3688
|
+
*/
|
|
3689
|
+
owner_id?: string | null | unknown;
|
|
3690
|
+
/**
|
|
3691
|
+
* Field included by default.
|
|
3692
|
+
*/
|
|
3693
|
+
properties?: {
|
|
3694
|
+
[key: string]: unknown;
|
|
3695
|
+
} | null | unknown;
|
|
3696
|
+
/**
|
|
3697
|
+
* Field included by default.
|
|
3698
|
+
*/
|
|
3699
|
+
source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api" | unknown;
|
|
3700
|
+
};
|
|
3701
|
+
id: string;
|
|
3702
|
+
/**
|
|
3703
|
+
* A relationships object for a crm_company
|
|
3704
|
+
*/
|
|
3705
|
+
relationships?: {
|
|
3706
|
+
[key: string]: never;
|
|
3707
|
+
};
|
|
3708
|
+
type: string;
|
|
3709
|
+
};
|
|
2597
3710
|
/**
|
|
2598
3711
|
* A "Resource object" representing a bucket
|
|
2599
3712
|
*/
|
|
@@ -2700,6 +3813,36 @@ type CreditPackage = {
|
|
|
2700
3813
|
};
|
|
2701
3814
|
type: string;
|
|
2702
3815
|
};
|
|
3816
|
+
/**
|
|
3817
|
+
* A "Resource object" representing a crawler_job
|
|
3818
|
+
*/
|
|
3819
|
+
type CrawlerJob = {
|
|
3820
|
+
/**
|
|
3821
|
+
* An attributes object for a crawler_job
|
|
3822
|
+
*/
|
|
3823
|
+
attributes?: {
|
|
3824
|
+
[key: string]: never;
|
|
3825
|
+
};
|
|
3826
|
+
id: string;
|
|
3827
|
+
/**
|
|
3828
|
+
* A relationships object for a crawler_job
|
|
3829
|
+
*/
|
|
3830
|
+
relationships?: {
|
|
3831
|
+
results?: {
|
|
3832
|
+
/**
|
|
3833
|
+
* Relationship data for results
|
|
3834
|
+
*/
|
|
3835
|
+
data?: Array<{
|
|
3836
|
+
id: string;
|
|
3837
|
+
meta?: {
|
|
3838
|
+
[key: string]: unknown;
|
|
3839
|
+
};
|
|
3840
|
+
type: string;
|
|
3841
|
+
}>;
|
|
3842
|
+
};
|
|
3843
|
+
};
|
|
3844
|
+
type: string;
|
|
3845
|
+
};
|
|
2703
3846
|
/**
|
|
2704
3847
|
* A "Resource object" representing a workspace
|
|
2705
3848
|
*/
|
|
@@ -3882,7 +5025,7 @@ declare class BrowserApiKeyError extends Error {
|
|
|
3882
5025
|
}
|
|
3883
5026
|
|
|
3884
5027
|
/** SDK version — updated automatically by mix update.sdks */
|
|
3885
|
-
declare const SDK_VERSION = "0.
|
|
5028
|
+
declare const SDK_VERSION = "0.3.0";
|
|
3886
5029
|
/** Default API version sent in every request — updated automatically by mix update.sdks */
|
|
3887
5030
|
declare const DEFAULT_API_VERSION = "2026-02-25";
|
|
3888
5031
|
|
|
@@ -4225,6 +5368,32 @@ declare class RequestBuilder {
|
|
|
4225
5368
|
streamGetRequest(url: string, options?: RequestOptions, streamOptions?: StreamOptions): Promise<AsyncIterableIterator<StreamMessageChunk>>;
|
|
4226
5369
|
}
|
|
4227
5370
|
|
|
5371
|
+
/**
|
|
5372
|
+
* Return type for `voice.sessions.start()`.
|
|
5373
|
+
*
|
|
5374
|
+
* Narrows the generic `VoiceSession` type to guarantee that `livekit_token`
|
|
5375
|
+
* and `livekit_room` are present, non-null strings. These fields are populated
|
|
5376
|
+
* **only** on the POST /voice/sessions create response (one-time delivery) — the
|
|
5377
|
+
* server never persists the token and it is always null in GET/PATCH responses.
|
|
5378
|
+
*
|
|
5379
|
+
* Using this type instead of `VoiceSession` ensures TypeScript enforces that
|
|
5380
|
+
* callers capture the token before it becomes unavailable.
|
|
5381
|
+
*
|
|
5382
|
+
* @example
|
|
5383
|
+
* ```typescript
|
|
5384
|
+
* const session = await client.voice.sessions.start();
|
|
5385
|
+
* const token: string = session.attributes!.livekit_token; // guaranteed non-null
|
|
5386
|
+
* ```
|
|
5387
|
+
*/
|
|
5388
|
+
type VoiceSessionStart = VoiceSession & {
|
|
5389
|
+
attributes: NonNullable<VoiceSession["attributes"]> & {
|
|
5390
|
+
/** LiveKit JWT for immediate room connection. One-time delivery — capture this immediately. */
|
|
5391
|
+
livekit_token: string;
|
|
5392
|
+
/** LiveKit room name. One-time delivery — capture alongside `livekit_token`. */
|
|
5393
|
+
livekit_room: string;
|
|
5394
|
+
};
|
|
5395
|
+
};
|
|
5396
|
+
|
|
4228
5397
|
/**
|
|
4229
5398
|
* Response from the voice transcription endpoint.
|
|
4230
5399
|
* Not a JSON:API resource — this is a plain object response from the
|
|
@@ -4316,39 +5485,165 @@ declare function createVoiceNamespace(rb: RequestBuilder): {
|
|
|
4316
5485
|
phiMode?: "none" | "tokenize" | "tokenize_encrypt";
|
|
4317
5486
|
phiKey?: string;
|
|
4318
5487
|
patientId?: string;
|
|
4319
|
-
}, options?: RequestOptions) => Promise<
|
|
4320
|
-
/**
|
|
5488
|
+
}, options?: RequestOptions) => Promise<VoiceSessionStart>;
|
|
5489
|
+
/**
|
|
5490
|
+
* End a voice session and release the LiveKit room.
|
|
5491
|
+
*
|
|
5492
|
+
* @param id - Voice session ID to end
|
|
5493
|
+
* @param options - Request options
|
|
5494
|
+
*
|
|
5495
|
+
* @note Session stop is fully server-controlled. No attributes are accepted
|
|
5496
|
+
* in the request body — `status` is set to `"ended"` and `ended_at` is set
|
|
5497
|
+
* automatically. Passing extra attributes will result in a 422 error.
|
|
5498
|
+
*/
|
|
4321
5499
|
stop: (id: string, options?: RequestOptions) => Promise<VoiceSession>;
|
|
4322
5500
|
/**
|
|
4323
|
-
* Dispatch the accumulated session transcript to the blueprint or chat
|
|
4324
|
-
* pipeline. The transcript may contain PHI (Protected Health Information)
|
|
4325
|
-
* depending on the session's `phiMode`.
|
|
4326
|
-
*
|
|
4327
|
-
* @param id - Voice session ID
|
|
4328
|
-
* @param params - Finalization parameters
|
|
4329
|
-
* @param params.phiKey - AES-256 encryption key for PHI, encoded as
|
|
4330
|
-
* Base64 (32 raw bytes). Overrides the key supplied at session start.
|
|
4331
|
-
* Required when `phiMode` is `"tokenize_encrypt"`.
|
|
4332
|
-
* @param options - Request options
|
|
4333
|
-
*
|
|
4334
|
-
* @remarks
|
|
4335
|
-
* **Security — transcript PHI:** The finalized transcript submitted to
|
|
4336
|
-
* this endpoint may contain Protected Health Information. Ensure the
|
|
4337
|
-
* request is made over HTTPS only.
|
|
5501
|
+
* Dispatch the accumulated session transcript to the blueprint or chat
|
|
5502
|
+
* pipeline. The transcript may contain PHI (Protected Health Information)
|
|
5503
|
+
* depending on the session's `phiMode`.
|
|
5504
|
+
*
|
|
5505
|
+
* @param id - Voice session ID
|
|
5506
|
+
* @param params - Finalization parameters
|
|
5507
|
+
* @param params.phiKey - AES-256 encryption key for PHI, encoded as
|
|
5508
|
+
* Base64 (32 raw bytes). Overrides the key supplied at session start.
|
|
5509
|
+
* Required when `phiMode` is `"tokenize_encrypt"`.
|
|
5510
|
+
* @param options - Request options
|
|
5511
|
+
*
|
|
5512
|
+
* @remarks
|
|
5513
|
+
* **Security — transcript PHI:** The finalized transcript submitted to
|
|
5514
|
+
* this endpoint may contain Protected Health Information. Ensure the
|
|
5515
|
+
* request is made over HTTPS only.
|
|
5516
|
+
*
|
|
5517
|
+
* **Security — `phiKey`:** This value is a sensitive encryption key.
|
|
5518
|
+
* - Transmitted over HTTPS only — never send over plain HTTP.
|
|
5519
|
+
* - Do not log, store in `localStorage`, or include in error reports.
|
|
5520
|
+
* - Treat it with the same care as a password or private key.
|
|
5521
|
+
* - The server never persists this key; it is used only within the
|
|
5522
|
+
* lifetime of the request.
|
|
5523
|
+
*/
|
|
5524
|
+
finalize: (id: string, params?: {
|
|
5525
|
+
blueprintId?: string;
|
|
5526
|
+
phiMode?: "none" | "tokenize" | "tokenize_encrypt";
|
|
5527
|
+
phiKey?: string;
|
|
5528
|
+
patientId?: string;
|
|
5529
|
+
}, options?: RequestOptions) => Promise<VoiceSession>;
|
|
5530
|
+
};
|
|
5531
|
+
};
|
|
5532
|
+
|
|
5533
|
+
type OAuthProvider = "google" | "github" | "microsoft";
|
|
5534
|
+
interface OAuthSignInOptions {
|
|
5535
|
+
/** Application ID (app_id) — required to scope the OAuth flow to your ISV application */
|
|
5536
|
+
appId: string;
|
|
5537
|
+
/**
|
|
5538
|
+
* URL to redirect to after OAuth completes. Must be in your application's
|
|
5539
|
+
* allowed callback URLs. If omitted, uses the application's default callback URL.
|
|
5540
|
+
*/
|
|
5541
|
+
redirectUrl?: string;
|
|
5542
|
+
}
|
|
5543
|
+
declare function createIdentityNamespace(rb: RequestBuilder, baseUrl?: string): {
|
|
5544
|
+
/** Login with email and password — returns a token object */
|
|
5545
|
+
login: (email: string, password: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5546
|
+
/** Register a new user account */
|
|
5547
|
+
register: (email: string, password: string, passwordConfirmation: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5548
|
+
/** Get the currently authenticated user */
|
|
5549
|
+
me: (options?: RequestOptions) => Promise<User>;
|
|
5550
|
+
/** Get the current user profile (alias for me()) */
|
|
5551
|
+
profile: (options?: RequestOptions) => Promise<User>;
|
|
5552
|
+
list: (options?: {
|
|
5553
|
+
page?: number;
|
|
5554
|
+
pageSize?: number;
|
|
5555
|
+
} & RequestOptions) => Promise<User[]>;
|
|
5556
|
+
listAll: (options?: RequestOptions) => Promise<User[]>;
|
|
5557
|
+
get: (id: string, options?: RequestOptions) => Promise<User>;
|
|
5558
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<User>;
|
|
5559
|
+
/** Resend confirmation email to an unconfirmed user */
|
|
5560
|
+
resendConfirmation: (options?: RequestOptions) => Promise<User>;
|
|
5561
|
+
/** Confirm an email address using the token from the confirmation email */
|
|
5562
|
+
confirmEmail: (email: string, confirmationToken: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5563
|
+
/** Request a magic link sign-in email */
|
|
5564
|
+
requestMagicLink: (email: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5565
|
+
/**
|
|
5566
|
+
* Request a password reset email — always returns success to prevent email enumeration.
|
|
5567
|
+
* The user will receive an email with a reset token if the account exists.
|
|
5568
|
+
*/
|
|
5569
|
+
requestPasswordReset: (email: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5570
|
+
/** Sign in using a token from a magic link email */
|
|
5571
|
+
signInWithMagicLink: (token: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5572
|
+
/** Reset a password using the token from a password reset email */
|
|
5573
|
+
resetPasswordWithToken: (token: string, password: string, passwordConfirmation: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5574
|
+
/** Change password for the currently authenticated user */
|
|
5575
|
+
changePassword: (currentPassword: string, password: string, passwordConfirmation: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5576
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
5577
|
+
tokens: {
|
|
5578
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<Token>;
|
|
5579
|
+
};
|
|
5580
|
+
profiles: {
|
|
5581
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
5582
|
+
list: (options?: {
|
|
5583
|
+
page?: number;
|
|
5584
|
+
pageSize?: number;
|
|
5585
|
+
} & RequestOptions) => Promise<UserProfile[]>;
|
|
5586
|
+
listAll: (options?: RequestOptions) => Promise<UserProfile[]>;
|
|
5587
|
+
get: (id: string, options?: RequestOptions) => Promise<UserProfile>;
|
|
5588
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<UserProfile>;
|
|
5589
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<UserProfile>;
|
|
5590
|
+
};
|
|
5591
|
+
/**
|
|
5592
|
+
* Social OAuth sign-in (Google, GitHub, Microsoft).
|
|
5593
|
+
*
|
|
5594
|
+
* This is a browser-redirect flow — the backend redirects the user's browser
|
|
5595
|
+
* to the provider, then back to your `redirectUrl` with `?token=JWT` appended.
|
|
5596
|
+
*
|
|
5597
|
+
* @example
|
|
5598
|
+
* ```typescript
|
|
5599
|
+
* // Get the URL and redirect manually
|
|
5600
|
+
* const url = client.identity.oauth.getAuthorizationUrl('google', {
|
|
5601
|
+
* appId: 'your-app-id',
|
|
5602
|
+
* redirectUrl: 'https://yourapp.com/auth/callback',
|
|
5603
|
+
* });
|
|
5604
|
+
* window.location.href = url;
|
|
5605
|
+
*
|
|
5606
|
+
* // Or use the convenience helper (browser only)
|
|
5607
|
+
* client.identity.oauth.signIn('google', {
|
|
5608
|
+
* appId: 'your-app-id',
|
|
5609
|
+
* redirectUrl: 'https://yourapp.com/auth/callback',
|
|
5610
|
+
* });
|
|
5611
|
+
*
|
|
5612
|
+
* // On your callback page, extract the token:
|
|
5613
|
+
* const token = new URLSearchParams(window.location.search).get('token');
|
|
5614
|
+
* ```
|
|
5615
|
+
*/
|
|
5616
|
+
oauth: {
|
|
5617
|
+
/**
|
|
5618
|
+
* Build the authorization URL for the given OAuth provider.
|
|
5619
|
+
* Navigate the user's browser to this URL to begin the sign-in flow.
|
|
5620
|
+
*/
|
|
5621
|
+
getAuthorizationUrl(provider: OAuthProvider, options: OAuthSignInOptions): string;
|
|
5622
|
+
/**
|
|
5623
|
+
* Redirect the browser to the OAuth sign-in page for the given provider.
|
|
5624
|
+
* Only works in browser environments (sets `window.location.href`).
|
|
4338
5625
|
*
|
|
4339
|
-
*
|
|
4340
|
-
*
|
|
4341
|
-
* - Do not log, store in `localStorage`, or include in error reports.
|
|
4342
|
-
* - Treat it with the same care as a password or private key.
|
|
4343
|
-
* - The server never persists this key; it is used only within the
|
|
4344
|
-
* lifetime of the request.
|
|
5626
|
+
* After the user authenticates, they are redirected back to `redirectUrl`
|
|
5627
|
+
* with a `?token=JWT` query parameter containing their session token.
|
|
4345
5628
|
*/
|
|
4346
|
-
|
|
4347
|
-
|
|
4348
|
-
|
|
4349
|
-
|
|
4350
|
-
|
|
4351
|
-
|
|
5629
|
+
signIn(provider: OAuthProvider, options: OAuthSignInOptions): void;
|
|
5630
|
+
};
|
|
5631
|
+
apiKeys: {
|
|
5632
|
+
list: (options?: {
|
|
5633
|
+
page?: number;
|
|
5634
|
+
pageSize?: number;
|
|
5635
|
+
} & RequestOptions) => Promise<ApiKey[]>;
|
|
5636
|
+
listAll: (options?: RequestOptions) => Promise<ApiKey[]>;
|
|
5637
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
5638
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ApiKey>;
|
|
5639
|
+
create: (name: string, options?: RequestOptions) => Promise<ApiKey>;
|
|
5640
|
+
get: (id: string, options?: RequestOptions) => Promise<ApiKey>;
|
|
5641
|
+
/** Revoke an API key (permanently disables it) */
|
|
5642
|
+
revoke: (id: string, options?: RequestOptions) => Promise<ApiKey>;
|
|
5643
|
+
/** Rotate an API key (generates a new secret) */
|
|
5644
|
+
rotate: (id: string, options?: RequestOptions) => Promise<ApiKey>;
|
|
5645
|
+
/** Allocate credits to an API key */
|
|
5646
|
+
allocate: (id: string, amount: number, description: string, options?: RequestOptions) => Promise<ApiKey>;
|
|
4352
5647
|
};
|
|
4353
5648
|
};
|
|
4354
5649
|
|
|
@@ -4356,7 +5651,7 @@ declare function createVoiceNamespace(rb: RequestBuilder): {
|
|
|
4356
5651
|
* A single attribute filter predicate for server-side JSONB row filtering.
|
|
4357
5652
|
* Operators: eq, not_eq, contains, in, lt, gt, not_null
|
|
4358
5653
|
*/
|
|
4359
|
-
interface AttributeFilter {
|
|
5654
|
+
interface AttributeFilter$1 {
|
|
4360
5655
|
/** The column name to filter on */
|
|
4361
5656
|
field: string;
|
|
4362
5657
|
/** Comparison operator */
|
|
@@ -4367,7 +5662,7 @@ interface AttributeFilter {
|
|
|
4367
5662
|
/** Parameters for `results.query()` */
|
|
4368
5663
|
interface ExtractionRowQueryParams {
|
|
4369
5664
|
/** Filter predicates applied server-side (AND semantics). Empty array returns all rows. */
|
|
4370
|
-
filters
|
|
5665
|
+
filters?: AttributeFilter$1[];
|
|
4371
5666
|
/** Maximum rows to return. Defaults to 1000. Server enforces max 5000. */
|
|
4372
5667
|
limit?: number;
|
|
4373
5668
|
/** Zero-based row offset for pagination. Defaults to 0. */
|
|
@@ -4450,7 +5745,7 @@ declare function createExtractionNamespace(rb: RequestBuilder): {
|
|
|
4450
5745
|
* });
|
|
4451
5746
|
* console.log(`${result.filtered} of ${result.total} rows match`);
|
|
4452
5747
|
*/
|
|
4453
|
-
query: (resultId: string, params
|
|
5748
|
+
query: (resultId: string, params?: ExtractionRowQueryParams, options?: RequestOptions) => Promise<ExtractionRowQueryResult>;
|
|
4454
5749
|
};
|
|
4455
5750
|
batches: {
|
|
4456
5751
|
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ExtractionBatch>;
|
|
@@ -4484,6 +5779,111 @@ declare function createExtractionNamespace(rb: RequestBuilder): {
|
|
|
4484
5779
|
};
|
|
4485
5780
|
};
|
|
4486
5781
|
|
|
5782
|
+
interface Ticket {
|
|
5783
|
+
id: string;
|
|
5784
|
+
[key: string]: unknown;
|
|
5785
|
+
}
|
|
5786
|
+
interface TicketMessage {
|
|
5787
|
+
id: string;
|
|
5788
|
+
[key: string]: unknown;
|
|
5789
|
+
}
|
|
5790
|
+
|
|
5791
|
+
interface DataStoreRecord {
|
|
5792
|
+
id: string;
|
|
5793
|
+
namespace: string;
|
|
5794
|
+
key: string;
|
|
5795
|
+
value: unknown;
|
|
5796
|
+
version: number;
|
|
5797
|
+
[key: string]: unknown;
|
|
5798
|
+
}
|
|
5799
|
+
|
|
5800
|
+
type CrmEntityType = "contact" | "custom_entity" | "activity";
|
|
5801
|
+
type CrmExportFormat = "json" | "csv";
|
|
5802
|
+
type CrmExportStatus = "pending" | "processing" | "complete" | "failed";
|
|
5803
|
+
interface CrmDataExportJob {
|
|
5804
|
+
id: string;
|
|
5805
|
+
workspace_id: string;
|
|
5806
|
+
entity_type: CrmEntityType;
|
|
5807
|
+
entity_subtype?: string;
|
|
5808
|
+
format: CrmExportFormat;
|
|
5809
|
+
include: string[];
|
|
5810
|
+
status: CrmExportStatus;
|
|
5811
|
+
file_url?: string;
|
|
5812
|
+
url_expires_at?: string;
|
|
5813
|
+
row_count?: number;
|
|
5814
|
+
error?: string;
|
|
5815
|
+
inserted_at: string;
|
|
5816
|
+
updated_at: string;
|
|
5817
|
+
}
|
|
5818
|
+
interface CrmExportCreateParams {
|
|
5819
|
+
entityType: CrmEntityType;
|
|
5820
|
+
entitySubtype?: string;
|
|
5821
|
+
format: CrmExportFormat;
|
|
5822
|
+
include?: string[];
|
|
5823
|
+
filters?: AttributeFilter[];
|
|
5824
|
+
}
|
|
5825
|
+
type FilterOperator = "eq" | "not_eq" | "contains" | "in" | "lt" | "gt" | "not_null";
|
|
5826
|
+
interface AttributeFilter {
|
|
5827
|
+
field: string;
|
|
5828
|
+
op: FilterOperator;
|
|
5829
|
+
value?: unknown;
|
|
5830
|
+
}
|
|
5831
|
+
interface AggregateMetric {
|
|
5832
|
+
fn: "count";
|
|
5833
|
+
}
|
|
5834
|
+
interface AggregateFieldMetric {
|
|
5835
|
+
fn: "avg" | "sum";
|
|
5836
|
+
field: string;
|
|
5837
|
+
}
|
|
5838
|
+
/**
|
|
5839
|
+
* A version snapshot of a CrmCustomEntity.
|
|
5840
|
+
* Field names match the CustomEntityVersion Ash resource attributes exactly.
|
|
5841
|
+
*/
|
|
5842
|
+
interface CrmCustomEntityVersion {
|
|
5843
|
+
id: string;
|
|
5844
|
+
version_number: number;
|
|
5845
|
+
/** Snapshot of the entity's properties field at the time of the update. */
|
|
5846
|
+
attributes: Record<string, unknown>;
|
|
5847
|
+
updated_by_user_id?: string;
|
|
5848
|
+
/** ISO 8601 timestamp — the resource uses inserted_at (no updated_at). */
|
|
5849
|
+
inserted_at: string;
|
|
5850
|
+
custom_entity_id: string;
|
|
5851
|
+
workspace_id: string;
|
|
5852
|
+
}
|
|
5853
|
+
|
|
5854
|
+
interface OAuthInitiateResult {
|
|
5855
|
+
auth_url: string;
|
|
5856
|
+
state: string;
|
|
5857
|
+
}
|
|
5858
|
+
interface FullscriptPatient {
|
|
5859
|
+
id: string;
|
|
5860
|
+
email: string;
|
|
5861
|
+
first_name: string;
|
|
5862
|
+
last_name: string;
|
|
5863
|
+
date_of_birth?: string;
|
|
5864
|
+
fullscript_id?: string;
|
|
5865
|
+
[key: string]: unknown;
|
|
5866
|
+
}
|
|
5867
|
+
interface FullscriptSessionGrant {
|
|
5868
|
+
token: string;
|
|
5869
|
+
expires_at: string;
|
|
5870
|
+
patient_id: string;
|
|
5871
|
+
}
|
|
5872
|
+
|
|
5873
|
+
interface ChannelConfig {
|
|
5874
|
+
id: string;
|
|
5875
|
+
channel_type: string;
|
|
5876
|
+
[key: string]: unknown;
|
|
5877
|
+
}
|
|
5878
|
+
interface InboundMessage {
|
|
5879
|
+
id: string;
|
|
5880
|
+
[key: string]: unknown;
|
|
5881
|
+
}
|
|
5882
|
+
interface OutboundMessage {
|
|
5883
|
+
id: string;
|
|
5884
|
+
[key: string]: unknown;
|
|
5885
|
+
}
|
|
5886
|
+
|
|
4487
5887
|
/**
|
|
4488
5888
|
* GPT Core Client SDK
|
|
4489
5889
|
*
|
|
@@ -4614,6 +6014,39 @@ declare class GptClient extends BaseClient {
|
|
|
4614
6014
|
get: (id: string, options?: RequestOptions) => Promise<PaymentMethod>;
|
|
4615
6015
|
};
|
|
4616
6016
|
};
|
|
6017
|
+
/** Product catalog, inventory, pricing, and taxonomy */
|
|
6018
|
+
readonly catalog: {
|
|
6019
|
+
products: {
|
|
6020
|
+
list: (_options?: {
|
|
6021
|
+
page?: number;
|
|
6022
|
+
pageSize?: number;
|
|
6023
|
+
} & RequestOptions) => Promise<CatalogProduct[]>;
|
|
6024
|
+
get: (_id: string, _options?: RequestOptions) => Promise<CatalogProduct>;
|
|
6025
|
+
create: (_attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<CatalogProduct>;
|
|
6026
|
+
update: (_id: string, _attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<CatalogProduct>;
|
|
6027
|
+
};
|
|
6028
|
+
variants: {
|
|
6029
|
+
listByProduct: (_productId: string, _options?: RequestOptions) => Promise<CatalogProductVariant[]>;
|
|
6030
|
+
};
|
|
6031
|
+
taxonomies: {
|
|
6032
|
+
list: (_options?: RequestOptions) => Promise<CatalogTaxonomy[]>;
|
|
6033
|
+
getNodes: (_taxonomyId: string, _options?: RequestOptions) => Promise<CatalogTaxonomyNode[]>;
|
|
6034
|
+
};
|
|
6035
|
+
};
|
|
6036
|
+
/** Multi-channel messaging (WhatsApp, Slack, Email) */
|
|
6037
|
+
readonly channels: {
|
|
6038
|
+
configs: {
|
|
6039
|
+
list: (_options?: RequestOptions) => Promise<ChannelConfig[]>;
|
|
6040
|
+
get: (_id: string, _options?: RequestOptions) => Promise<ChannelConfig>;
|
|
6041
|
+
};
|
|
6042
|
+
messages: {
|
|
6043
|
+
send: (_attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<OutboundMessage>;
|
|
6044
|
+
listInbound: (_options?: {
|
|
6045
|
+
page?: number;
|
|
6046
|
+
pageSize?: number;
|
|
6047
|
+
} & RequestOptions) => Promise<InboundMessage[]>;
|
|
6048
|
+
};
|
|
6049
|
+
};
|
|
4617
6050
|
/** Notification logs, methods, and preferences */
|
|
4618
6051
|
readonly communication: {
|
|
4619
6052
|
notifications: {
|
|
@@ -4651,6 +6084,246 @@ declare class GptClient extends BaseClient {
|
|
|
4651
6084
|
};
|
|
4652
6085
|
};
|
|
4653
6086
|
};
|
|
6087
|
+
/** OAuth and API adapters for external systems */
|
|
6088
|
+
readonly connectors: {
|
|
6089
|
+
instances: {
|
|
6090
|
+
list: (options?: RequestOptions) => Promise<ConnectorInstance[]>;
|
|
6091
|
+
get: (id: string, options?: RequestOptions) => Promise<ConnectorInstance>;
|
|
6092
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ConnectorInstance>;
|
|
6093
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ConnectorInstance>;
|
|
6094
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6095
|
+
};
|
|
6096
|
+
credentials: {
|
|
6097
|
+
list: (options?: RequestOptions) => Promise<Credential[]>;
|
|
6098
|
+
get: (id: string, options?: RequestOptions) => Promise<Credential>;
|
|
6099
|
+
refresh: (id: string, options?: RequestOptions) => Promise<Credential>;
|
|
6100
|
+
};
|
|
6101
|
+
oauth: {
|
|
6102
|
+
connect: (connectorType: string, workspaceId: string, options?: RequestOptions) => Promise<OAuthInitiateResult>;
|
|
6103
|
+
callback: (connectorType: string, code: string, state: string, workspaceId: string, options?: RequestOptions) => Promise<ConnectorInstance>;
|
|
6104
|
+
};
|
|
6105
|
+
available: {
|
|
6106
|
+
list: () => string[];
|
|
6107
|
+
};
|
|
6108
|
+
fullscript: {
|
|
6109
|
+
checkPatient: (connectorId: string, workspaceId: string, email: string, options?: RequestOptions) => Promise<FullscriptPatient | null>;
|
|
6110
|
+
createPatient: (connectorId: string, workspaceId: string, attrs: {
|
|
6111
|
+
first_name: string;
|
|
6112
|
+
last_name: string;
|
|
6113
|
+
email: string;
|
|
6114
|
+
date_of_birth?: string;
|
|
6115
|
+
}, options?: RequestOptions) => Promise<FullscriptPatient>;
|
|
6116
|
+
sessionGrant: (connectorId: string, workspaceId: string, patientId: string, options?: RequestOptions) => Promise<FullscriptSessionGrant>;
|
|
6117
|
+
oauth: {
|
|
6118
|
+
connect: (workspaceId: string, options?: RequestOptions) => Promise<OAuthInitiateResult>;
|
|
6119
|
+
callback: (code: string, state: string, workspaceId: string, options?: RequestOptions) => Promise<ConnectorInstance>;
|
|
6120
|
+
};
|
|
6121
|
+
};
|
|
6122
|
+
};
|
|
6123
|
+
/** Web crawling and content extraction */
|
|
6124
|
+
readonly crawler: {
|
|
6125
|
+
jobs: {
|
|
6126
|
+
list: (options?: {
|
|
6127
|
+
page?: number;
|
|
6128
|
+
pageSize?: number;
|
|
6129
|
+
} & RequestOptions) => Promise<CrawlerJob[]>;
|
|
6130
|
+
get: (id: string, options?: RequestOptions) => Promise<CrawlerJob>;
|
|
6131
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrawlerJob>;
|
|
6132
|
+
cancel: (id: string, options?: RequestOptions) => Promise<CrawlerJob>;
|
|
6133
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6134
|
+
};
|
|
6135
|
+
schedules: {
|
|
6136
|
+
list: (options?: RequestOptions) => Promise<CrawlerSchedule[]>;
|
|
6137
|
+
get: (id: string, options?: RequestOptions) => Promise<CrawlerSchedule>;
|
|
6138
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrawlerSchedule>;
|
|
6139
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrawlerSchedule>;
|
|
6140
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6141
|
+
};
|
|
6142
|
+
results: {
|
|
6143
|
+
list: (options?: {
|
|
6144
|
+
page?: number;
|
|
6145
|
+
pageSize?: number;
|
|
6146
|
+
} & RequestOptions) => Promise<CrawlerResult[]>;
|
|
6147
|
+
get: (id: string, options?: RequestOptions) => Promise<CrawlerResult>;
|
|
6148
|
+
};
|
|
6149
|
+
};
|
|
6150
|
+
/** Contacts, companies, deals, activities, pipelines, relationships, and custom entities */
|
|
6151
|
+
readonly crm: {
|
|
6152
|
+
contacts: {
|
|
6153
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmContact>;
|
|
6154
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmContact>;
|
|
6155
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmContact>;
|
|
6156
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6157
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6158
|
+
page?: number;
|
|
6159
|
+
pageSize?: number;
|
|
6160
|
+
} & RequestOptions) => Promise<CrmContact[]>;
|
|
6161
|
+
};
|
|
6162
|
+
companies: {
|
|
6163
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmCompany>;
|
|
6164
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCompany>;
|
|
6165
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCompany>;
|
|
6166
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6167
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6168
|
+
page?: number;
|
|
6169
|
+
pageSize?: number;
|
|
6170
|
+
} & RequestOptions) => Promise<CrmCompany[]>;
|
|
6171
|
+
};
|
|
6172
|
+
deals: {
|
|
6173
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmDeal>;
|
|
6174
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmDeal>;
|
|
6175
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmDeal>;
|
|
6176
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6177
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6178
|
+
page?: number;
|
|
6179
|
+
pageSize?: number;
|
|
6180
|
+
} & RequestOptions) => Promise<CrmDeal[]>;
|
|
6181
|
+
};
|
|
6182
|
+
activities: {
|
|
6183
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmActivity>;
|
|
6184
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmActivity>;
|
|
6185
|
+
update: (_id: string, _attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<CrmActivity>;
|
|
6186
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6187
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6188
|
+
page?: number;
|
|
6189
|
+
pageSize?: number;
|
|
6190
|
+
} & RequestOptions) => Promise<CrmActivity[]>;
|
|
6191
|
+
};
|
|
6192
|
+
pipelines: {
|
|
6193
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmPipeline>;
|
|
6194
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipeline>;
|
|
6195
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipeline>;
|
|
6196
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6197
|
+
listByWorkspace: (workspaceId: string, options?: RequestOptions) => Promise<CrmPipeline[]>;
|
|
6198
|
+
};
|
|
6199
|
+
pipelineStages: {
|
|
6200
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmPipelineStage>;
|
|
6201
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipelineStage>;
|
|
6202
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmPipelineStage>;
|
|
6203
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6204
|
+
};
|
|
6205
|
+
relationshipTypes: {
|
|
6206
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmRelationshipType>;
|
|
6207
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmRelationshipType>;
|
|
6208
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmRelationshipType>;
|
|
6209
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6210
|
+
list: (options?: RequestOptions) => Promise<CrmRelationshipType[]>;
|
|
6211
|
+
};
|
|
6212
|
+
relationships: {
|
|
6213
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmRelationship>;
|
|
6214
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmRelationship>;
|
|
6215
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6216
|
+
listByWorkspace: (workspaceId: string, options?: RequestOptions) => Promise<CrmRelationship[]>;
|
|
6217
|
+
};
|
|
6218
|
+
customEntities: {
|
|
6219
|
+
get: (id: string, options?: RequestOptions) => Promise<CrmCustomEntity>;
|
|
6220
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCustomEntity>;
|
|
6221
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<CrmCustomEntity>;
|
|
6222
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6223
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6224
|
+
type?: string;
|
|
6225
|
+
filters?: AttributeFilter[];
|
|
6226
|
+
page?: number;
|
|
6227
|
+
pageSize?: number;
|
|
6228
|
+
} & RequestOptions) => Promise<CrmCustomEntity[]>;
|
|
6229
|
+
batchUpdate: (workspaceId: string, updates: Array<{
|
|
6230
|
+
id: string;
|
|
6231
|
+
attributes: Record<string, unknown>;
|
|
6232
|
+
}>, options?: RequestOptions) => Promise<CrmCustomEntity[]>;
|
|
6233
|
+
aggregate: (workspaceId: string, params: {
|
|
6234
|
+
type?: string;
|
|
6235
|
+
metrics: Array<AggregateMetric | AggregateFieldMetric>;
|
|
6236
|
+
group_by?: string;
|
|
6237
|
+
filters?: AttributeFilter[];
|
|
6238
|
+
}, options?: RequestOptions) => Promise<Array<Record<string, unknown>>>;
|
|
6239
|
+
versions: {
|
|
6240
|
+
list: (entityId: string, options?: {
|
|
6241
|
+
page?: number;
|
|
6242
|
+
pageSize?: number;
|
|
6243
|
+
} & RequestOptions) => Promise<CrmCustomEntityVersion[]>;
|
|
6244
|
+
get: (entityId: string, versionId: string, options?: RequestOptions) => Promise<CrmCustomEntityVersion>;
|
|
6245
|
+
restore: (entityId: string, versionId: string, options?: RequestOptions) => Promise<CrmCustomEntity>;
|
|
6246
|
+
};
|
|
6247
|
+
};
|
|
6248
|
+
export: {
|
|
6249
|
+
create: (workspaceId: string, params: CrmExportCreateParams, options?: RequestOptions) => Promise<CrmDataExportJob>;
|
|
6250
|
+
get: (jobId: string, options?: RequestOptions) => Promise<CrmDataExportJob>;
|
|
6251
|
+
list: (workspaceId: string, options?: RequestOptions) => Promise<CrmDataExportJob[]>;
|
|
6252
|
+
};
|
|
6253
|
+
};
|
|
6254
|
+
/** Key-value data store with namespaces and TTL */
|
|
6255
|
+
readonly dataStore: {
|
|
6256
|
+
records: {
|
|
6257
|
+
get: (_namespace: string, _key: string, _options?: RequestOptions) => Promise<DataStoreRecord | null>;
|
|
6258
|
+
set: (_namespace: string, _key: string, _value: unknown, _options?: RequestOptions) => Promise<DataStoreRecord>;
|
|
6259
|
+
delete: (_namespace: string, _key: string, _options?: RequestOptions) => Promise<true>;
|
|
6260
|
+
listKeys: (_namespace: string, _options?: RequestOptions) => Promise<string[]>;
|
|
6261
|
+
list: (_namespace: string, _options?: RequestOptions) => Promise<DataStoreRecord[]>;
|
|
6262
|
+
};
|
|
6263
|
+
namespaces: {
|
|
6264
|
+
getPolicy: (_namespace: string, _options?: RequestOptions) => Promise<unknown>;
|
|
6265
|
+
createPolicy: (_attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<unknown>;
|
|
6266
|
+
getStats: (_namespace: string, _options?: RequestOptions) => Promise<unknown>;
|
|
6267
|
+
};
|
|
6268
|
+
};
|
|
6269
|
+
/** Email campaigns, recipients, and sequences */
|
|
6270
|
+
readonly emailMarketing: {
|
|
6271
|
+
campaigns: {
|
|
6272
|
+
get: (id: string, options?: RequestOptions) => Promise<EmailMarketingCampaign>;
|
|
6273
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingCampaign>;
|
|
6274
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingCampaign>;
|
|
6275
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6276
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6277
|
+
page?: number;
|
|
6278
|
+
pageSize?: number;
|
|
6279
|
+
} & RequestOptions) => Promise<EmailMarketingCampaign[]>;
|
|
6280
|
+
send: (id: string, options?: RequestOptions) => Promise<unknown>;
|
|
6281
|
+
analyze: (id: string, options?: RequestOptions) => Promise<unknown>;
|
|
6282
|
+
optimizeSendTimes: (id: string, options?: RequestOptions) => Promise<unknown>;
|
|
6283
|
+
createFollowup: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<unknown>;
|
|
6284
|
+
};
|
|
6285
|
+
templates: {
|
|
6286
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6287
|
+
page?: number;
|
|
6288
|
+
pageSize?: number;
|
|
6289
|
+
} & RequestOptions) => Promise<EmailMarketingTemplate[]>;
|
|
6290
|
+
};
|
|
6291
|
+
generatedEmails: {
|
|
6292
|
+
get: (id: string, options?: RequestOptions) => Promise<EmailMarketingGeneratedEmail>;
|
|
6293
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingGeneratedEmail>;
|
|
6294
|
+
approve: (id: string, options?: RequestOptions) => Promise<EmailMarketingGeneratedEmail>;
|
|
6295
|
+
};
|
|
6296
|
+
senderProfiles: {
|
|
6297
|
+
get: (id: string, options?: RequestOptions) => Promise<EmailMarketingSenderProfile>;
|
|
6298
|
+
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<EmailMarketingSenderProfile>;
|
|
6299
|
+
validateDns: (id: string, options?: RequestOptions) => Promise<unknown>;
|
|
6300
|
+
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
6301
|
+
};
|
|
6302
|
+
sequences: {
|
|
6303
|
+
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<unknown>;
|
|
6304
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
6305
|
+
page?: number;
|
|
6306
|
+
pageSize?: number;
|
|
6307
|
+
} & RequestOptions) => Promise<unknown[]>;
|
|
6308
|
+
resume: (id: string, options?: RequestOptions) => Promise<unknown>;
|
|
6309
|
+
};
|
|
6310
|
+
};
|
|
6311
|
+
/** Support tickets, queues, SLA, and agent presence */
|
|
6312
|
+
readonly support: {
|
|
6313
|
+
tickets: {
|
|
6314
|
+
list: (_options?: {
|
|
6315
|
+
page?: number;
|
|
6316
|
+
pageSize?: number;
|
|
6317
|
+
} & RequestOptions) => Promise<Ticket[]>;
|
|
6318
|
+
get: (_id: string, _options?: RequestOptions) => Promise<Ticket>;
|
|
6319
|
+
create: (_attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<Ticket>;
|
|
6320
|
+
update: (_id: string, _attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<Ticket>;
|
|
6321
|
+
addMessage: (_ticketId: string, _attributes: Record<string, unknown>, _options?: RequestOptions) => Promise<TicketMessage>;
|
|
6322
|
+
};
|
|
6323
|
+
queues: {
|
|
6324
|
+
list: (_options?: RequestOptions) => Promise<unknown[]>;
|
|
6325
|
+
};
|
|
6326
|
+
};
|
|
4654
6327
|
/** Document upload, processing, results, and exports */
|
|
4655
6328
|
readonly extraction: {
|
|
4656
6329
|
documents: {
|
|
@@ -4697,7 +6370,7 @@ declare class GptClient extends BaseClient {
|
|
|
4697
6370
|
page?: number;
|
|
4698
6371
|
pageSize?: number;
|
|
4699
6372
|
} & RequestOptions) => Promise<ExtractionResult[]>;
|
|
4700
|
-
query: (resultId: string, params
|
|
6373
|
+
query: (resultId: string, params?: ExtractionRowQueryParams, options?: RequestOptions) => Promise<ExtractionRowQueryResult>;
|
|
4701
6374
|
};
|
|
4702
6375
|
batches: {
|
|
4703
6376
|
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ExtractionBatch>;
|
|
@@ -4765,6 +6438,10 @@ declare class GptClient extends BaseClient {
|
|
|
4765
6438
|
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<UserProfile>;
|
|
4766
6439
|
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<UserProfile>;
|
|
4767
6440
|
};
|
|
6441
|
+
oauth: {
|
|
6442
|
+
getAuthorizationUrl(provider: OAuthProvider, options: OAuthSignInOptions): string;
|
|
6443
|
+
signIn(provider: OAuthProvider, options: OAuthSignInOptions): void;
|
|
6444
|
+
};
|
|
4768
6445
|
apiKeys: {
|
|
4769
6446
|
list: (options?: {
|
|
4770
6447
|
page?: number;
|
|
@@ -4992,7 +6669,9 @@ declare class GptClient extends BaseClient {
|
|
|
4992
6669
|
transcribe: (audio: File | Blob, params?: {
|
|
4993
6670
|
language?: string;
|
|
4994
6671
|
modelSize?: "tiny" | "base" | "small" | "medium" | "large";
|
|
4995
|
-
phiMode
|
|
6672
|
+
phiMode
|
|
6673
|
+
/** Contacts, companies, deals, activities, pipelines, relationships, and custom entities */
|
|
6674
|
+
?: "none" | "tokenize" | "tokenize_encrypt";
|
|
4996
6675
|
phiKey?: string;
|
|
4997
6676
|
}, options?: RequestOptions) => Promise<VoiceTranscribeResult>;
|
|
4998
6677
|
sessions: {
|
|
@@ -5016,7 +6695,7 @@ declare class GptClient extends BaseClient {
|
|
|
5016
6695
|
phiMode?: "none" | "tokenize" | "tokenize_encrypt";
|
|
5017
6696
|
phiKey?: string;
|
|
5018
6697
|
patientId?: string;
|
|
5019
|
-
}, options?: RequestOptions) => Promise<
|
|
6698
|
+
}, options?: RequestOptions) => Promise<VoiceSessionStart>;
|
|
5020
6699
|
stop: (id: string, options?: RequestOptions) => Promise<VoiceSession>;
|
|
5021
6700
|
finalize: (id: string, params?: {
|
|
5022
6701
|
blueprintId?: string;
|
|
@@ -5245,73 +6924,6 @@ declare function createSearchNamespace(rb: RequestBuilder): {
|
|
|
5245
6924
|
};
|
|
5246
6925
|
};
|
|
5247
6926
|
|
|
5248
|
-
declare function createIdentityNamespace(rb: RequestBuilder): {
|
|
5249
|
-
/** Login with email and password — returns a token object */
|
|
5250
|
-
login: (email: string, password: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5251
|
-
/** Register a new user account */
|
|
5252
|
-
register: (email: string, password: string, passwordConfirmation: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5253
|
-
/** Get the currently authenticated user */
|
|
5254
|
-
me: (options?: RequestOptions) => Promise<User>;
|
|
5255
|
-
/** Get the current user profile (alias for me()) */
|
|
5256
|
-
profile: (options?: RequestOptions) => Promise<User>;
|
|
5257
|
-
list: (options?: {
|
|
5258
|
-
page?: number;
|
|
5259
|
-
pageSize?: number;
|
|
5260
|
-
} & RequestOptions) => Promise<User[]>;
|
|
5261
|
-
listAll: (options?: RequestOptions) => Promise<User[]>;
|
|
5262
|
-
get: (id: string, options?: RequestOptions) => Promise<User>;
|
|
5263
|
-
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<User>;
|
|
5264
|
-
/** Resend confirmation email to an unconfirmed user */
|
|
5265
|
-
resendConfirmation: (options?: RequestOptions) => Promise<User>;
|
|
5266
|
-
/** Confirm an email address using the token from the confirmation email */
|
|
5267
|
-
confirmEmail: (email: string, confirmationToken: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5268
|
-
/** Request a magic link sign-in email */
|
|
5269
|
-
requestMagicLink: (email: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5270
|
-
/**
|
|
5271
|
-
* Request a password reset email — always returns success to prevent email enumeration.
|
|
5272
|
-
* The user will receive an email with a reset token if the account exists.
|
|
5273
|
-
*/
|
|
5274
|
-
requestPasswordReset: (email: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5275
|
-
/** Sign in using a token from a magic link email */
|
|
5276
|
-
signInWithMagicLink: (token: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5277
|
-
/** Reset a password using the token from a password reset email */
|
|
5278
|
-
resetPasswordWithToken: (token: string, password: string, passwordConfirmation: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5279
|
-
/** Change password for the currently authenticated user */
|
|
5280
|
-
changePassword: (currentPassword: string, password: string, passwordConfirmation: string, options?: RequestOptions) => Promise<Record<string, unknown>>;
|
|
5281
|
-
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
5282
|
-
tokens: {
|
|
5283
|
-
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<Token>;
|
|
5284
|
-
};
|
|
5285
|
-
profiles: {
|
|
5286
|
-
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
5287
|
-
list: (options?: {
|
|
5288
|
-
page?: number;
|
|
5289
|
-
pageSize?: number;
|
|
5290
|
-
} & RequestOptions) => Promise<UserProfile[]>;
|
|
5291
|
-
listAll: (options?: RequestOptions) => Promise<UserProfile[]>;
|
|
5292
|
-
get: (id: string, options?: RequestOptions) => Promise<UserProfile>;
|
|
5293
|
-
create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<UserProfile>;
|
|
5294
|
-
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<UserProfile>;
|
|
5295
|
-
};
|
|
5296
|
-
apiKeys: {
|
|
5297
|
-
list: (options?: {
|
|
5298
|
-
page?: number;
|
|
5299
|
-
pageSize?: number;
|
|
5300
|
-
} & RequestOptions) => Promise<ApiKey[]>;
|
|
5301
|
-
listAll: (options?: RequestOptions) => Promise<ApiKey[]>;
|
|
5302
|
-
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
5303
|
-
update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<ApiKey>;
|
|
5304
|
-
create: (name: string, options?: RequestOptions) => Promise<ApiKey>;
|
|
5305
|
-
get: (id: string, options?: RequestOptions) => Promise<ApiKey>;
|
|
5306
|
-
/** Revoke an API key (permanently disables it) */
|
|
5307
|
-
revoke: (id: string, options?: RequestOptions) => Promise<ApiKey>;
|
|
5308
|
-
/** Rotate an API key (generates a new secret) */
|
|
5309
|
-
rotate: (id: string, options?: RequestOptions) => Promise<ApiKey>;
|
|
5310
|
-
/** Allocate credits to an API key */
|
|
5311
|
-
allocate: (id: string, amount: number, description: string, options?: RequestOptions) => Promise<ApiKey>;
|
|
5312
|
-
};
|
|
5313
|
-
};
|
|
5314
|
-
|
|
5315
6927
|
declare function createBillingNamespace(rb: RequestBuilder): {
|
|
5316
6928
|
wallet: {
|
|
5317
6929
|
/** Get the current workspace wallet balance and details */
|