@amigo-ai/platform-sdk 0.5.1 → 0.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/README.md +81 -7
  2. package/api.md +5 -0
  3. package/dist/index.cjs +43 -10
  4. package/dist/index.cjs.map +2 -2
  5. package/dist/index.js +1 -0
  6. package/dist/index.js.map +1 -1
  7. package/dist/index.mjs +43 -10
  8. package/dist/index.mjs.map +2 -2
  9. package/dist/resources/base.js +7 -2
  10. package/dist/resources/base.js.map +1 -1
  11. package/dist/resources/operators.js.map +1 -1
  12. package/dist/resources/personas.js.map +1 -1
  13. package/dist/resources/webhook-destinations.js.map +1 -1
  14. package/dist/resources/workspaces.js +22 -0
  15. package/dist/resources/workspaces.js.map +1 -1
  16. package/dist/resources/world.js.map +1 -1
  17. package/dist/types/generated/api.d.ts +13373 -13213
  18. package/dist/types/generated/api.d.ts.map +1 -1
  19. package/dist/types/index.d.ts +3 -2
  20. package/dist/types/index.d.ts.map +1 -1
  21. package/dist/types/resources/actions.d.ts +166 -166
  22. package/dist/types/resources/agents.d.ts +88 -88
  23. package/dist/types/resources/analytics.d.ts +39 -39
  24. package/dist/types/resources/api-keys.d.ts +29 -29
  25. package/dist/types/resources/audit.d.ts +73 -73
  26. package/dist/types/resources/base.d.ts.map +1 -1
  27. package/dist/types/resources/billing.d.ts +36 -36
  28. package/dist/types/resources/calls.d.ts +106 -106
  29. package/dist/types/resources/compliance.d.ts +17 -17
  30. package/dist/types/resources/context-graphs.d.ts +643 -643
  31. package/dist/types/resources/data-sources.d.ts +81 -81
  32. package/dist/types/resources/functions.d.ts +22 -22
  33. package/dist/types/resources/functions.d.ts.map +1 -1
  34. package/dist/types/resources/integrations.d.ts +258 -258
  35. package/dist/types/resources/memory.d.ts +35 -35
  36. package/dist/types/resources/operators.d.ts +147 -147
  37. package/dist/types/resources/operators.d.ts.map +1 -1
  38. package/dist/types/resources/personas.d.ts +37 -37
  39. package/dist/types/resources/personas.d.ts.map +1 -1
  40. package/dist/types/resources/phone-numbers.d.ts +62 -62
  41. package/dist/types/resources/recordings.d.ts +9 -9
  42. package/dist/types/resources/review-queue.d.ts +331 -331
  43. package/dist/types/resources/safety.d.ts +33 -33
  44. package/dist/types/resources/services.d.ts +142 -142
  45. package/dist/types/resources/settings.d.ts +254 -254
  46. package/dist/types/resources/settings.d.ts.map +1 -1
  47. package/dist/types/resources/simulations.d.ts +73 -73
  48. package/dist/types/resources/skills.d.ts +163 -163
  49. package/dist/types/resources/triggers.d.ts +74 -74
  50. package/dist/types/resources/webhook-destinations.d.ts +57 -57
  51. package/dist/types/resources/webhook-destinations.d.ts.map +1 -1
  52. package/dist/types/resources/workspaces.d.ts +69 -35
  53. package/dist/types/resources/workspaces.d.ts.map +1 -1
  54. package/dist/types/resources/world.d.ts +216 -216
  55. package/dist/types/resources/world.d.ts.map +1 -1
  56. package/package.json +1 -1
package/dist/types/resources/settings.d.ts CHANGED
@@ -9,152 +9,152 @@ import { WorkspaceScopedResource } from './base.js';
9
9
  export declare class SettingsResource extends WorkspaceScopedResource {
10
10
  readonly voice: {
11
11
  get: () => Promise<{
12
- correction_categories: string[];
13
- keyterms: string[];
12
+ voice_id: string | null;
13
+ tone: string | null;
14
+ speed: number | null;
15
+ volume: number | null;
14
16
  language: string;
15
- post_call_analysis_enabled: boolean;
17
+ keyterms: string[];
18
+ correction_categories: string[];
16
19
  pronunciation_dict_id: string | null;
17
20
  sensitive_topics: string[];
18
- speed: number | null;
19
- tone: string | null;
21
+ post_call_analysis_enabled: boolean;
20
22
  transcript_correction_enabled: boolean;
21
- voice_id: string | null;
22
- volume: number | null;
23
23
  } & import("../index.js").ResponseMetadata>;
24
24
  update: (body: components["schemas"]["VoiceSettingsRequest"]) => Promise<{
25
- correction_categories: string[];
26
- keyterms: string[];
25
+ voice_id: string | null;
26
+ tone: string | null;
27
+ speed: number | null;
28
+ volume: number | null;
27
29
  language: string;
28
- post_call_analysis_enabled: boolean;
30
+ keyterms: string[];
31
+ correction_categories: string[];
29
32
  pronunciation_dict_id: string | null;
30
33
  sensitive_topics: string[];
31
- speed: number | null;
32
- tone: string | null;
34
+ post_call_analysis_enabled: boolean;
33
35
  transcript_correction_enabled: boolean;
34
- voice_id: string | null;
35
- volume: number | null;
36
36
  } & import("../index.js").ResponseMetadata>;
37
37
  };
38
38
  readonly branding: {
39
39
  get: () => Promise<{
40
40
  branding: {
41
- background_color?: string | null | undefined;
42
- font_family?: string | null | undefined;
43
41
  logo_url?: string | null | undefined;
44
42
  primary_color?: string | null | undefined;
43
+ background_color?: string | null | undefined;
44
+ font_family?: string | null | undefined;
45
45
  };
46
46
  } & import("../index.js").ResponseMetadata>;
47
47
  update: (body: components["schemas"]["BrandingSettingsRequest"]) => Promise<{
48
48
  branding: {
49
- background_color?: string | null | undefined;
50
- font_family?: string | null | undefined;
51
49
  logo_url?: string | null | undefined;
52
50
  primary_color?: string | null | undefined;
51
+ background_color?: string | null | undefined;
52
+ font_family?: string | null | undefined;
53
53
  };
54
54
  } & import("../index.js").ResponseMetadata>;
55
55
  };
56
56
  readonly outreach: {
57
57
  get: () => Promise<{
58
- data_templates: {
59
- fields: {
60
- field_type?: components["schemas"]["FieldType"] | undefined;
61
- key: string;
62
- label: components["schemas"]["NameString"];
63
- path: string;
64
- required?: boolean | undefined;
65
- sensitive?: boolean | undefined;
66
- }[];
58
+ rules: {
67
59
  id?: string | undefined;
68
60
  name: components["schemas"]["NameString"];
69
- }[];
70
- rules: {
71
- active?: boolean | undefined;
61
+ trigger?: "appointment_window" | "post_visit" | "gap_detected" | "form_intake" | "manual" | undefined;
62
+ trigger_config?: {
63
+ [x: string]: unknown;
64
+ } | undefined;
72
65
  channel?: components["schemas"]["ChannelType"] | undefined;
73
66
  consent_required?: boolean | undefined;
74
- data_template_id?: string | null | undefined;
75
- form_template_id?: string | null | undefined;
76
- id?: string | undefined;
77
- message_template?: string | undefined;
78
- name: components["schemas"]["NameString"];
79
67
  quiet_hours?: {
80
68
  enabled?: boolean | undefined;
81
- end_hour?: number | undefined;
82
69
  start_hour?: number | undefined;
70
+ end_hour?: number | undefined;
83
71
  timezone?: string | undefined;
84
72
  } | undefined;
85
73
  review_required?: boolean | undefined;
86
- trigger?: "appointment_window" | "post_visit" | "gap_detected" | "form_intake" | "manual" | undefined;
87
- trigger_config?: {
88
- [x: string]: unknown;
89
- } | undefined;
74
+ message_template?: string | undefined;
75
+ data_template_id?: string | null | undefined;
76
+ form_template_id?: string | null | undefined;
77
+ active?: boolean | undefined;
90
78
  }[];
91
- } & import("../index.js").ResponseMetadata>;
92
- update: (body: components["schemas"]["OutreachSettingsRequest"]) => Promise<{
93
79
  data_templates: {
80
+ id?: string | undefined;
81
+ name: components["schemas"]["NameString"];
94
82
  fields: {
95
- field_type?: components["schemas"]["FieldType"] | undefined;
96
83
  key: string;
97
84
  label: components["schemas"]["NameString"];
98
- path: string;
85
+ field_type?: components["schemas"]["FieldType"] | undefined;
99
86
  required?: boolean | undefined;
100
87
  sensitive?: boolean | undefined;
88
+ path: string;
101
89
  }[];
102
- id?: string | undefined;
103
- name: components["schemas"]["NameString"];
104
90
  }[];
91
+ } & import("../index.js").ResponseMetadata>;
92
+ update: (body: components["schemas"]["OutreachSettingsRequest"]) => Promise<{
105
93
  rules: {
106
- active?: boolean | undefined;
107
- channel?: components["schemas"]["ChannelType"] | undefined;
108
- consent_required?: boolean | undefined;
109
- data_template_id?: string | null | undefined;
110
- form_template_id?: string | null | undefined;
111
94
  id?: string | undefined;
112
- message_template?: string | undefined;
113
95
  name: components["schemas"]["NameString"];
96
+ trigger?: "appointment_window" | "post_visit" | "gap_detected" | "form_intake" | "manual" | undefined;
97
+ trigger_config?: {
98
+ [x: string]: unknown;
99
+ } | undefined;
100
+ channel?: components["schemas"]["ChannelType"] | undefined;
101
+ consent_required?: boolean | undefined;
114
102
  quiet_hours?: {
115
103
  enabled?: boolean | undefined;
116
- end_hour?: number | undefined;
117
104
  start_hour?: number | undefined;
105
+ end_hour?: number | undefined;
118
106
  timezone?: string | undefined;
119
107
  } | undefined;
120
108
  review_required?: boolean | undefined;
121
- trigger?: "appointment_window" | "post_visit" | "gap_detected" | "form_intake" | "manual" | undefined;
122
- trigger_config?: {
123
- [x: string]: unknown;
124
- } | undefined;
109
+ message_template?: string | undefined;
110
+ data_template_id?: string | null | undefined;
111
+ form_template_id?: string | null | undefined;
112
+ active?: boolean | undefined;
113
+ }[];
114
+ data_templates: {
115
+ id?: string | undefined;
116
+ name: components["schemas"]["NameString"];
117
+ fields: {
118
+ key: string;
119
+ label: components["schemas"]["NameString"];
120
+ field_type?: components["schemas"]["FieldType"] | undefined;
121
+ required?: boolean | undefined;
122
+ sensitive?: boolean | undefined;
123
+ path: string;
124
+ }[];
125
125
  }[];
126
126
  } & import("../index.js").ResponseMetadata>;
127
127
  };
128
128
  readonly memory: {
129
129
  get: () => Promise<{
130
- backfill_requested: boolean;
131
130
  dimensions: {
132
- active?: boolean | undefined;
133
- builtin?: boolean | undefined;
131
+ id?: string | undefined;
132
+ key: string;
133
+ name: components["schemas"]["NameString"];
134
134
  description?: (components["schemas"]["DescriptionString"] | null) | undefined;
135
135
  event_types: string[];
136
136
  extract_paths?: string[] | undefined;
137
137
  extraction_mode?: "static" | "llm" | undefined;
138
- id?: string | undefined;
139
- key: string;
140
- name: components["schemas"]["NameString"];
141
138
  weight?: number | undefined;
139
+ active?: boolean | undefined;
140
+ builtin?: boolean | undefined;
142
141
  }[];
142
+ backfill_requested: boolean;
143
143
  } & import("../index.js").ResponseMetadata>;
144
144
  update: (body: components["schemas"]["MemorySettingsRequest"]) => Promise<{
145
- backfill_requested: boolean;
146
145
  dimensions: {
147
- active?: boolean | undefined;
148
- builtin?: boolean | undefined;
146
+ id?: string | undefined;
147
+ key: string;
148
+ name: components["schemas"]["NameString"];
149
149
  description?: (components["schemas"]["DescriptionString"] | null) | undefined;
150
150
  event_types: string[];
151
151
  extract_paths?: string[] | undefined;
152
152
  extraction_mode?: "static" | "llm" | undefined;
153
- id?: string | undefined;
154
- key: string;
155
- name: components["schemas"]["NameString"];
156
153
  weight?: number | undefined;
154
+ active?: boolean | undefined;
155
+ builtin?: boolean | undefined;
157
156
  }[];
157
+ backfill_requested: boolean;
158
158
  } & import("../index.js").ResponseMetadata>;
159
159
  };
160
160
  readonly security: {
@@ -167,261 +167,261 @@ export declare class SettingsResource extends WorkspaceScopedResource {
167
167
  };
168
168
  readonly retention: {
169
169
  get: () => Promise<{
170
- audit_log_days: number;
171
170
  call_recordings_days: number;
172
171
  call_transcripts_days: number;
172
+ audit_log_days: number;
173
+ world_events_days: number;
174
+ phi_data_days: number;
173
175
  legal_hold: boolean;
174
176
  legal_hold_reason?: string | null | undefined;
175
- phi_data_days: number;
176
- world_events_days: number;
177
177
  } & import("../index.js").ResponseMetadata>;
178
178
  update: (body: components["schemas"]["RetentionPolicyRequest"]) => Promise<{
179
- audit_log_days: number;
180
179
  call_recordings_days: number;
181
180
  call_transcripts_days: number;
181
+ audit_log_days: number;
182
+ world_events_days: number;
183
+ phi_data_days: number;
182
184
  legal_hold: boolean;
183
185
  legal_hold_reason?: string | null | undefined;
184
- phi_data_days: number;
185
- world_events_days: number;
186
186
  } & import("../index.js").ResponseMetadata>;
187
187
  };
188
188
  readonly behaviors: {
189
189
  get: () => Promise<{
190
+ enabled: boolean;
190
191
  behaviors: {
192
+ name: components["schemas"]["NameString"];
193
+ description?: components["schemas"]["DescriptionString"] | undefined;
194
+ trigger?: {
195
+ keywords?: string[] | undefined;
196
+ intent_categories?: string[] | undefined;
197
+ emotion_tiers?: number[] | undefined;
198
+ states?: string[] | undefined;
199
+ } | undefined;
191
200
  action?: {
192
- add_tools?: string[] | undefined;
193
- filler_override?: ("empathy" | "receipt" | "working" | "silent") | null | undefined;
194
- instruction?: string | undefined;
195
- remove_tools?: string[] | undefined;
196
201
  turn_policy_overrides?: {
197
202
  [x: string]: unknown;
198
203
  } | undefined;
204
+ instruction?: string | undefined;
205
+ add_tools?: string[] | undefined;
206
+ remove_tools?: string[] | undefined;
207
+ filler_override?: ("empathy" | "receipt" | "working" | "silent") | null | undefined;
199
208
  } | undefined;
200
209
  cooldown_turns?: number | undefined;
201
- description?: components["schemas"]["DescriptionString"] | undefined;
210
+ priority?: number | undefined;
202
211
  enabled?: boolean | undefined;
212
+ }[];
213
+ } & import("../index.js").ResponseMetadata>;
214
+ update: (body: components["schemas"]["BehaviorSettingsRequest"]) => Promise<{
215
+ enabled: boolean;
216
+ behaviors: {
203
217
  name: components["schemas"]["NameString"];
204
- priority?: number | undefined;
218
+ description?: components["schemas"]["DescriptionString"] | undefined;
205
219
  trigger?: {
206
- emotion_tiers?: number[] | undefined;
207
- intent_categories?: string[] | undefined;
208
220
  keywords?: string[] | undefined;
221
+ intent_categories?: string[] | undefined;
222
+ emotion_tiers?: number[] | undefined;
209
223
  states?: string[] | undefined;
210
224
  } | undefined;
211
- }[];
212
- enabled: boolean;
213
- } & import("../index.js").ResponseMetadata>;
214
- update: (body: components["schemas"]["BehaviorSettingsRequest"]) => Promise<{
215
- behaviors: {
216
225
  action?: {
217
- add_tools?: string[] | undefined;
218
- filler_override?: ("empathy" | "receipt" | "working" | "silent") | null | undefined;
219
- instruction?: string | undefined;
220
- remove_tools?: string[] | undefined;
221
226
  turn_policy_overrides?: {
222
227
  [x: string]: unknown;
223
228
  } | undefined;
229
+ instruction?: string | undefined;
230
+ add_tools?: string[] | undefined;
231
+ remove_tools?: string[] | undefined;
232
+ filler_override?: ("empathy" | "receipt" | "working" | "silent") | null | undefined;
224
233
  } | undefined;
225
234
  cooldown_turns?: number | undefined;
226
- description?: components["schemas"]["DescriptionString"] | undefined;
227
- enabled?: boolean | undefined;
228
- name: components["schemas"]["NameString"];
229
235
  priority?: number | undefined;
230
- trigger?: {
231
- emotion_tiers?: number[] | undefined;
232
- intent_categories?: string[] | undefined;
233
- keywords?: string[] | undefined;
234
- states?: string[] | undefined;
235
- } | undefined;
236
+ enabled?: boolean | undefined;
236
237
  }[];
237
- enabled: boolean;
238
238
  } & import("../index.js").ResponseMetadata>;
239
239
  };
240
240
  readonly gapScanner: {
241
241
  get: () => Promise<{
242
+ enabled: boolean;
243
+ scan_interval_seconds: number;
242
244
  appointment_lookahead_hours: number;
243
- channel_optimization: boolean;
244
245
  cooldown_hours: number;
245
- enabled: boolean;
246
- max_pending_surfaces: number;
247
246
  max_surfaces_per_tick: number;
247
+ max_pending_surfaces: number;
248
248
  min_completion_rate: number;
249
+ channel_optimization: boolean;
249
250
  requirements: {
250
- channel?: components["schemas"]["ChannelType"] | undefined;
251
- entity_type?: "person" | undefined;
252
251
  name: components["schemas"]["NameString"];
253
- priority?: "low" | "normal" | "high" | undefined;
252
+ entity_type?: "person" | undefined;
253
+ trigger?: "upcoming_appointment" | "recent_interaction" | undefined;
254
254
  required_fields: {
255
- field_type?: components["schemas"]["FieldType"] | undefined;
255
+ path: string;
256
256
  label: components["schemas"]["NameString"];
257
+ field_type?: components["schemas"]["FieldType"] | undefined;
257
258
  min_items?: number | null | undefined;
258
- path: string;
259
259
  }[];
260
- surface_description?: (components["schemas"]["DescriptionString"] | null) | undefined;
260
+ channel?: components["schemas"]["ChannelType"] | undefined;
261
+ priority?: "low" | "normal" | "high" | undefined;
261
262
  surface_title?: (components["schemas"]["NameString"] | null) | undefined;
262
- trigger?: "upcoming_appointment" | "recent_interaction" | undefined;
263
+ surface_description?: (components["schemas"]["DescriptionString"] | null) | undefined;
263
264
  }[];
264
- scan_interval_seconds: number;
265
265
  } & import("../index.js").ResponseMetadata>;
266
266
  update: (body: components["schemas"]["GapScannerSettingsRequest"]) => Promise<{
267
+ enabled: boolean;
268
+ scan_interval_seconds: number;
267
269
  appointment_lookahead_hours: number;
268
- channel_optimization: boolean;
269
270
  cooldown_hours: number;
270
- enabled: boolean;
271
- max_pending_surfaces: number;
272
271
  max_surfaces_per_tick: number;
272
+ max_pending_surfaces: number;
273
273
  min_completion_rate: number;
274
+ channel_optimization: boolean;
274
275
  requirements: {
275
- channel?: components["schemas"]["ChannelType"] | undefined;
276
- entity_type?: "person" | undefined;
277
276
  name: components["schemas"]["NameString"];
278
- priority?: "low" | "normal" | "high" | undefined;
277
+ entity_type?: "person" | undefined;
278
+ trigger?: "upcoming_appointment" | "recent_interaction" | undefined;
279
279
  required_fields: {
280
- field_type?: components["schemas"]["FieldType"] | undefined;
280
+ path: string;
281
281
  label: components["schemas"]["NameString"];
282
+ field_type?: components["schemas"]["FieldType"] | undefined;
282
283
  min_items?: number | null | undefined;
283
- path: string;
284
284
  }[];
285
- surface_description?: (components["schemas"]["DescriptionString"] | null) | undefined;
285
+ channel?: components["schemas"]["ChannelType"] | undefined;
286
+ priority?: "low" | "normal" | "high" | undefined;
286
287
  surface_title?: (components["schemas"]["NameString"] | null) | undefined;
287
- trigger?: "upcoming_appointment" | "recent_interaction" | undefined;
288
+ surface_description?: (components["schemas"]["DescriptionString"] | null) | undefined;
288
289
  }[];
289
- scan_interval_seconds: number;
290
290
  } & import("../index.js").ResponseMetadata>;
291
291
  };
292
292
  readonly scribe: {
293
293
  get: () => Promise<{
294
+ enabled: boolean;
294
295
  authorized_clinicians: {
295
296
  email: string;
296
297
  name?: string | null | undefined;
297
298
  role?: string | undefined;
298
299
  }[];
300
+ soap_style?: "concise" | "detailed" | "structured" | undefined;
301
+ safety?: {
302
+ drug_interaction_checking?: boolean | undefined;
303
+ allergy_cross_reference?: boolean | undefined;
304
+ crisis_detection?: boolean | undefined;
305
+ vital_range_alerting?: boolean | undefined;
306
+ } | undefined;
299
307
  cds?: {
300
308
  care_gap_surfacing?: boolean | undefined;
301
- documentation_completeness?: boolean | undefined;
302
- guideline_matching?: boolean | undefined;
303
309
  icd10_auto_suggest?: boolean | undefined;
310
+ guideline_matching?: boolean | undefined;
311
+ documentation_completeness?: boolean | undefined;
304
312
  } | undefined;
305
- enabled: boolean;
306
313
  post_encounter?: {
307
314
  auto_polish_note?: boolean | undefined;
315
+ order_preparation?: boolean | undefined;
308
316
  education_materials?: boolean | undefined;
309
317
  follow_up_surface?: boolean | undefined;
310
- order_preparation?: boolean | undefined;
311
- } | undefined;
312
- safety?: {
313
- allergy_cross_reference?: boolean | undefined;
314
- crisis_detection?: boolean | undefined;
315
- drug_interaction_checking?: boolean | undefined;
316
- vital_range_alerting?: boolean | undefined;
317
318
  } | undefined;
318
- soap_style?: "concise" | "detailed" | "structured" | undefined;
319
319
  voice_auth_enabled?: boolean | undefined;
320
320
  } & import("../index.js").ResponseMetadata>;
321
321
  update: (body: components["schemas"]["ScribeSettingsRequest"]) => Promise<{
322
+ enabled: boolean;
322
323
  authorized_clinicians: {
323
324
  email: string;
324
325
  name?: string | null | undefined;
325
326
  role?: string | undefined;
326
327
  }[];
328
+ soap_style?: "concise" | "detailed" | "structured" | undefined;
329
+ safety?: {
330
+ drug_interaction_checking?: boolean | undefined;
331
+ allergy_cross_reference?: boolean | undefined;
332
+ crisis_detection?: boolean | undefined;
333
+ vital_range_alerting?: boolean | undefined;
334
+ } | undefined;
327
335
  cds?: {
328
336
  care_gap_surfacing?: boolean | undefined;
329
- documentation_completeness?: boolean | undefined;
330
- guideline_matching?: boolean | undefined;
331
337
  icd10_auto_suggest?: boolean | undefined;
338
+ guideline_matching?: boolean | undefined;
339
+ documentation_completeness?: boolean | undefined;
332
340
  } | undefined;
333
- enabled: boolean;
334
341
  post_encounter?: {
335
342
  auto_polish_note?: boolean | undefined;
343
+ order_preparation?: boolean | undefined;
336
344
  education_materials?: boolean | undefined;
337
345
  follow_up_surface?: boolean | undefined;
338
- order_preparation?: boolean | undefined;
339
- } | undefined;
340
- safety?: {
341
- allergy_cross_reference?: boolean | undefined;
342
- crisis_detection?: boolean | undefined;
343
- drug_interaction_checking?: boolean | undefined;
344
- vital_range_alerting?: boolean | undefined;
345
346
  } | undefined;
346
- soap_style?: "concise" | "detailed" | "structured" | undefined;
347
347
  voice_auth_enabled?: boolean | undefined;
348
348
  } & import("../index.js").ResponseMetadata>;
349
349
  };
350
350
  readonly metrics: {
351
351
  get: () => Promise<{
352
352
  definitions: {
353
- active?: boolean | undefined;
354
- aggregation?: "count" | "sum" | "avg" | "min" | "max" | "count_distinct" | "ratio" | "rate" | undefined;
355
- ai_labels?: string[] | null | undefined;
356
- ai_query_endpoint?: string | null | undefined;
357
- ai_query_prompt?: string | null | undefined;
358
- ai_schema?: {
359
- [x: string]: unknown;
360
- } | null | undefined;
361
- applies_to_product_types?: string[] | null | undefined;
362
- builtin?: boolean | undefined;
363
- categories?: string[] | null | undefined;
364
- channel_scope?: "all" | "voice" | "text" | "surface" | "inbound" | "outbound" | undefined;
365
- description?: (components["schemas"]["DescriptionString"] | null) | undefined;
366
- event_types: string[];
367
- extract_path?: string | null | undefined;
368
- extraction_mode?: "static" | "ai_classify" | "ai_extract" | "ai_sentiment" | "ai_query" | "sql_expr" | undefined;
369
- freshness_sla_minutes?: number | undefined;
370
- granularity?: "aggregate" | "per_entity" | undefined;
371
353
  id?: string | undefined;
372
354
  key: string;
373
- latency_tier?: "streaming" | "near_realtime" | "batch" | undefined;
374
- metric_type: "numerical" | "categorical" | "boolean";
375
- model_tier?: "free" | "fast" | "balanced" | "max" | "custom" | undefined;
376
355
  name: components["schemas"]["NameString"];
356
+ description?: (components["schemas"]["DescriptionString"] | null) | undefined;
357
+ metric_type: "numerical" | "categorical" | "boolean";
358
+ latency_tier?: "streaming" | "near_realtime" | "batch" | undefined;
377
359
  period_granularity?: "hourly" | "daily" | undefined;
378
- prompt?: string | null | undefined;
379
- ratio_denominator_event?: string | null | undefined;
380
- ratio_numerator_event?: string | null | undefined;
381
360
  source: "call_intelligence" | "world_events" | "surface_events" | "emotion_events" | "connector_events" | "zerobus_events" | "voice_judge_results";
361
+ event_types: string[];
382
362
  source_filter?: string | null | undefined;
383
- sql_expression?: string | null | undefined;
384
- unit?: string | null | undefined;
385
- valid_range_max?: number | null | undefined;
386
- valid_range_min?: number | null | undefined;
387
- }[];
388
- } & import("../index.js").ResponseMetadata>;
389
- update: (body: components["schemas"]["MetricSettingsRequest"]) => Promise<{
390
- definitions: {
391
- active?: boolean | undefined;
392
- aggregation?: "count" | "sum" | "avg" | "min" | "max" | "count_distinct" | "ratio" | "rate" | undefined;
363
+ extraction_mode?: "static" | "ai_classify" | "ai_extract" | "ai_sentiment" | "ai_query" | "sql_expr" | undefined;
364
+ extract_path?: string | null | undefined;
393
365
  ai_labels?: string[] | null | undefined;
394
- ai_query_endpoint?: string | null | undefined;
395
- ai_query_prompt?: string | null | undefined;
396
366
  ai_schema?: {
397
367
  [x: string]: unknown;
398
368
  } | null | undefined;
399
- applies_to_product_types?: string[] | null | undefined;
400
- builtin?: boolean | undefined;
369
+ ai_query_endpoint?: string | null | undefined;
370
+ ai_query_prompt?: string | null | undefined;
371
+ sql_expression?: string | null | undefined;
372
+ aggregation?: "count" | "sum" | "avg" | "min" | "max" | "count_distinct" | "ratio" | "rate" | undefined;
373
+ ratio_numerator_event?: string | null | undefined;
374
+ ratio_denominator_event?: string | null | undefined;
375
+ valid_range_min?: number | null | undefined;
376
+ valid_range_max?: number | null | undefined;
377
+ freshness_sla_minutes?: number | undefined;
378
+ unit?: string | null | undefined;
401
379
  categories?: string[] | null | undefined;
380
+ model_tier?: "free" | "fast" | "balanced" | "max" | "custom" | undefined;
402
381
  channel_scope?: "all" | "voice" | "text" | "surface" | "inbound" | "outbound" | undefined;
403
- description?: (components["schemas"]["DescriptionString"] | null) | undefined;
404
- event_types: string[];
405
- extract_path?: string | null | undefined;
406
- extraction_mode?: "static" | "ai_classify" | "ai_extract" | "ai_sentiment" | "ai_query" | "sql_expr" | undefined;
407
- freshness_sla_minutes?: number | undefined;
382
+ applies_to_product_types?: string[] | null | undefined;
383
+ prompt?: string | null | undefined;
408
384
  granularity?: "aggregate" | "per_entity" | undefined;
385
+ active?: boolean | undefined;
386
+ builtin?: boolean | undefined;
387
+ }[];
388
+ } & import("../index.js").ResponseMetadata>;
389
+ update: (body: components["schemas"]["MetricSettingsRequest"]) => Promise<{
390
+ definitions: {
409
391
  id?: string | undefined;
410
392
  key: string;
411
- latency_tier?: "streaming" | "near_realtime" | "batch" | undefined;
412
- metric_type: "numerical" | "categorical" | "boolean";
413
- model_tier?: "free" | "fast" | "balanced" | "max" | "custom" | undefined;
414
393
  name: components["schemas"]["NameString"];
394
+ description?: (components["schemas"]["DescriptionString"] | null) | undefined;
395
+ metric_type: "numerical" | "categorical" | "boolean";
396
+ latency_tier?: "streaming" | "near_realtime" | "batch" | undefined;
415
397
  period_granularity?: "hourly" | "daily" | undefined;
416
- prompt?: string | null | undefined;
417
- ratio_denominator_event?: string | null | undefined;
418
- ratio_numerator_event?: string | null | undefined;
419
398
  source: "call_intelligence" | "world_events" | "surface_events" | "emotion_events" | "connector_events" | "zerobus_events" | "voice_judge_results";
399
+ event_types: string[];
420
400
  source_filter?: string | null | undefined;
401
+ extraction_mode?: "static" | "ai_classify" | "ai_extract" | "ai_sentiment" | "ai_query" | "sql_expr" | undefined;
402
+ extract_path?: string | null | undefined;
403
+ ai_labels?: string[] | null | undefined;
404
+ ai_schema?: {
405
+ [x: string]: unknown;
406
+ } | null | undefined;
407
+ ai_query_endpoint?: string | null | undefined;
408
+ ai_query_prompt?: string | null | undefined;
421
409
  sql_expression?: string | null | undefined;
422
- unit?: string | null | undefined;
423
- valid_range_max?: number | null | undefined;
410
+ aggregation?: "count" | "sum" | "avg" | "min" | "max" | "count_distinct" | "ratio" | "rate" | undefined;
411
+ ratio_numerator_event?: string | null | undefined;
412
+ ratio_denominator_event?: string | null | undefined;
424
413
  valid_range_min?: number | null | undefined;
414
+ valid_range_max?: number | null | undefined;
415
+ freshness_sla_minutes?: number | undefined;
416
+ unit?: string | null | undefined;
417
+ categories?: string[] | null | undefined;
418
+ model_tier?: "free" | "fast" | "balanced" | "max" | "custom" | undefined;
419
+ channel_scope?: "all" | "voice" | "text" | "surface" | "inbound" | "outbound" | undefined;
420
+ applies_to_product_types?: string[] | null | undefined;
421
+ prompt?: string | null | undefined;
422
+ granularity?: "aggregate" | "per_entity" | undefined;
423
+ active?: boolean | undefined;
424
+ builtin?: boolean | undefined;
425
425
  }[];
426
426
  } & import("../index.js").ResponseMetadata>;
427
427
  };
@@ -430,10 +430,10 @@ export declare class SettingsResource extends WorkspaceScopedResource {
430
430
  environments?: {
431
431
  [x: string]: {
432
432
  data_source_id?: string | null | undefined;
433
- data_source_overrides?: {
433
+ tool_overrides?: {
434
434
  [x: string]: unknown;
435
435
  } | undefined;
436
- tool_overrides?: {
436
+ data_source_overrides?: {
437
437
  [x: string]: unknown;
438
438
  } | undefined;
439
439
  };
@@ -443,10 +443,10 @@ export declare class SettingsResource extends WorkspaceScopedResource {
443
443
  environments?: {
444
444
  [x: string]: {
445
445
  data_source_id?: string | null | undefined;
446
- data_source_overrides?: {
446
+ tool_overrides?: {
447
447
  [x: string]: unknown;
448
448
  } | undefined;
449
- tool_overrides?: {
449
+ data_source_overrides?: {
450
450
  [x: string]: unknown;
451
451
  } | undefined;
452
452
  };
@@ -456,88 +456,88 @@ export declare class SettingsResource extends WorkspaceScopedResource {
456
456
  readonly workflows: {
457
457
  get: () => Promise<{
458
458
  workflows?: {
459
- description?: string | undefined;
460
- enabled?: boolean | undefined;
461
459
  id?: string | undefined;
462
- input_query?: string | null | undefined;
463
- max_concurrent?: number | undefined;
464
460
  name: string;
465
- steps: {
466
- body_steps?: /*elided*/ any[] | null | undefined;
467
- condition?: string | null | undefined;
468
- endpoint?: string | null | undefined;
469
- integration?: string | null | undefined;
470
- items_from?: string | null | undefined;
471
- name: string;
472
- on_false?: string | null | undefined;
473
- on_true?: string | null | undefined;
474
- request_body?: {
475
- [x: string]: unknown;
476
- } | undefined;
477
- retry_backoff_seconds?: number | undefined;
478
- retry_count?: number | undefined;
479
- surface_spec?: {
461
+ description?: string | undefined;
462
+ trigger: {
463
+ type: "cron" | "event" | "manual";
464
+ cron_expression?: string | null | undefined;
465
+ event_filter?: {
480
466
  [x: string]: unknown;
481
467
  } | null | undefined;
468
+ };
469
+ input_query?: string | null | undefined;
470
+ steps: {
471
+ name: string;
472
+ type: "tool_call" | "integration_call" | "wait" | "branch" | "for_each" | "surface";
482
473
  tool_name?: string | null | undefined;
483
474
  tool_params?: {
484
475
  [x: string]: unknown;
485
476
  } | undefined;
486
- type: "tool_call" | "integration_call" | "wait" | "branch" | "for_each" | "surface";
477
+ integration?: string | null | undefined;
478
+ endpoint?: string | null | undefined;
479
+ request_body?: {
480
+ [x: string]: unknown;
481
+ } | undefined;
487
482
  wait_duration?: string | null | undefined;
488
483
  wait_for_event?: string | null | undefined;
484
+ condition?: string | null | undefined;
485
+ on_true?: string | null | undefined;
486
+ on_false?: string | null | undefined;
487
+ items_from?: string | null | undefined;
488
+ body_steps?: /*elided*/ any[] | null | undefined;
489
+ surface_spec?: {
490
+ [x: string]: unknown;
491
+ } | null | undefined;
492
+ retry_count?: number | undefined;
493
+ retry_backoff_seconds?: number | undefined;
489
494
  }[];
490
495
  timeout?: string | undefined;
496
+ max_concurrent?: number | undefined;
497
+ enabled?: boolean | undefined;
498
+ }[] | undefined;
499
+ } & import("../index.js").ResponseMetadata>;
500
+ update: (body: components["schemas"]["WorkflowSettingsRequest"]) => Promise<{
501
+ workflows?: {
502
+ id?: string | undefined;
503
+ name: string;
504
+ description?: string | undefined;
491
505
  trigger: {
506
+ type: "cron" | "event" | "manual";
492
507
  cron_expression?: string | null | undefined;
493
508
  event_filter?: {
494
509
  [x: string]: unknown;
495
510
  } | null | undefined;
496
- type: "cron" | "event" | "manual";
497
511
  };
498
- }[] | undefined;
499
- } & import("../index.js").ResponseMetadata>;
500
- update: (body: components["schemas"]["WorkflowSettingsRequest"]) => Promise<{
501
- workflows?: {
502
- description?: string | undefined;
503
- enabled?: boolean | undefined;
504
- id?: string | undefined;
505
512
  input_query?: string | null | undefined;
506
- max_concurrent?: number | undefined;
507
- name: string;
508
513
  steps: {
509
- body_steps?: /*elided*/ any[] | null | undefined;
510
- condition?: string | null | undefined;
511
- endpoint?: string | null | undefined;
512
- integration?: string | null | undefined;
513
- items_from?: string | null | undefined;
514
514
  name: string;
515
- on_false?: string | null | undefined;
516
- on_true?: string | null | undefined;
517
- request_body?: {
518
- [x: string]: unknown;
519
- } | undefined;
520
- retry_backoff_seconds?: number | undefined;
521
- retry_count?: number | undefined;
522
- surface_spec?: {
523
- [x: string]: unknown;
524
- } | null | undefined;
515
+ type: "tool_call" | "integration_call" | "wait" | "branch" | "for_each" | "surface";
525
516
  tool_name?: string | null | undefined;
526
517
  tool_params?: {
527
518
  [x: string]: unknown;
528
519
  } | undefined;
529
- type: "tool_call" | "integration_call" | "wait" | "branch" | "for_each" | "surface";
520
+ integration?: string | null | undefined;
521
+ endpoint?: string | null | undefined;
522
+ request_body?: {
523
+ [x: string]: unknown;
524
+ } | undefined;
530
525
  wait_duration?: string | null | undefined;
531
526
  wait_for_event?: string | null | undefined;
532
- }[];
533
- timeout?: string | undefined;
534
- trigger: {
535
- cron_expression?: string | null | undefined;
536
- event_filter?: {
527
+ condition?: string | null | undefined;
528
+ on_true?: string | null | undefined;
529
+ on_false?: string | null | undefined;
530
+ items_from?: string | null | undefined;
531
+ body_steps?: /*elided*/ any[] | null | undefined;
532
+ surface_spec?: {
537
533
  [x: string]: unknown;
538
534
  } | null | undefined;
539
- type: "cron" | "event" | "manual";
540
- };
535
+ retry_count?: number | undefined;
536
+ retry_backoff_seconds?: number | undefined;
537
+ }[];
538
+ timeout?: string | undefined;
539
+ max_concurrent?: number | undefined;
540
+ enabled?: boolean | undefined;
541
541
  }[] | undefined;
542
542
  } & import("../index.js").ResponseMetadata>;
543
543
  };