@roarkanalytics/sdk 2.29.0 → 2.31.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.
Files changed (67) hide show
  1. package/CHANGELOG.md +54 -0
  2. package/internal/utils/env.js +2 -2
  3. package/internal/utils/env.js.map +1 -1
  4. package/internal/utils/env.mjs +2 -2
  5. package/internal/utils/env.mjs.map +1 -1
  6. package/package.json +1 -1
  7. package/resources/agent-endpoint.d.mts +12 -12
  8. package/resources/agent-endpoint.d.mts.map +1 -1
  9. package/resources/agent-endpoint.d.ts +12 -12
  10. package/resources/agent-endpoint.d.ts.map +1 -1
  11. package/resources/call.d.mts +15 -33
  12. package/resources/call.d.mts.map +1 -1
  13. package/resources/call.d.ts +15 -33
  14. package/resources/call.d.ts.map +1 -1
  15. package/resources/metric-collection-job.d.mts +15 -11
  16. package/resources/metric-collection-job.d.mts.map +1 -1
  17. package/resources/metric-collection-job.d.ts +15 -11
  18. package/resources/metric-collection-job.d.ts.map +1 -1
  19. package/resources/metric-collection-job.js +2 -2
  20. package/resources/metric-collection-job.mjs +2 -2
  21. package/resources/metric-policy.d.mts +6 -0
  22. package/resources/metric-policy.d.mts.map +1 -1
  23. package/resources/metric-policy.d.ts +6 -0
  24. package/resources/metric-policy.d.ts.map +1 -1
  25. package/resources/metric-policy.js +1 -0
  26. package/resources/metric-policy.js.map +1 -1
  27. package/resources/metric-policy.mjs +1 -0
  28. package/resources/metric-policy.mjs.map +1 -1
  29. package/resources/metric.d.mts +1 -2
  30. package/resources/metric.d.mts.map +1 -1
  31. package/resources/metric.d.ts +1 -2
  32. package/resources/metric.d.ts.map +1 -1
  33. package/resources/metric.js +1 -2
  34. package/resources/metric.js.map +1 -1
  35. package/resources/metric.mjs +1 -2
  36. package/resources/metric.mjs.map +1 -1
  37. package/resources/simulation-job.d.mts +2 -2
  38. package/resources/simulation-job.d.mts.map +1 -1
  39. package/resources/simulation-job.d.ts +2 -2
  40. package/resources/simulation-job.d.ts.map +1 -1
  41. package/resources/simulation-run-plan-job.d.mts +1 -1
  42. package/resources/simulation-run-plan-job.d.mts.map +1 -1
  43. package/resources/simulation-run-plan-job.d.ts +1 -1
  44. package/resources/simulation-run-plan-job.d.ts.map +1 -1
  45. package/resources/simulation-run-plan.d.mts +28 -0
  46. package/resources/simulation-run-plan.d.mts.map +1 -1
  47. package/resources/simulation-run-plan.d.ts +28 -0
  48. package/resources/simulation-run-plan.d.ts.map +1 -1
  49. package/resources/webhook.d.mts +4 -4
  50. package/resources/webhook.d.mts.map +1 -1
  51. package/resources/webhook.d.ts +4 -4
  52. package/resources/webhook.d.ts.map +1 -1
  53. package/src/internal/utils/env.ts +2 -2
  54. package/src/resources/agent-endpoint.ts +12 -12
  55. package/src/resources/call.ts +15 -33
  56. package/src/resources/metric-collection-job.ts +16 -11
  57. package/src/resources/metric-policy.ts +7 -0
  58. package/src/resources/metric.ts +1 -2
  59. package/src/resources/simulation-job.ts +2 -2
  60. package/src/resources/simulation-run-plan-job.ts +1 -1
  61. package/src/resources/simulation-run-plan.ts +24 -0
  62. package/src/resources/webhook.ts +8 -0
  63. package/src/version.ts +1 -1
  64. package/version.d.mts +1 -1
  65. package/version.d.ts +1 -1
  66. package/version.js +1 -1
  67. package/version.mjs +1 -1
@@ -91,9 +91,9 @@ export namespace AgentEndpointCreateResponse {
91
91
  outboundDialType: 'NONE' | 'HTTP_REQUEST';
92
92
 
93
93
  /**
94
- * Agent endpoint type (PHONE or WEBSOCKET)
94
+ * Agent endpoint type (PHONE, WEBSOCKET, LIVEKIT, SMALL_WEBRTC, or ELEVENLABS_WS)
95
95
  */
96
- type: 'PHONE' | 'WEBSOCKET';
96
+ type: 'PHONE' | 'WEBSOCKET' | 'LIVEKIT' | 'SMALL_WEBRTC' | 'ELEVENLABS_WS' | 'KORE' | 'GOOGLE_CES';
97
97
 
98
98
  /**
99
99
  * Last update timestamp
@@ -101,7 +101,7 @@ export namespace AgentEndpointCreateResponse {
101
101
  updatedAt: string;
102
102
 
103
103
  /**
104
- * Agent endpoint value (phone number or websocket URL)
104
+ * Agent endpoint value (phone number, URL, etc.)
105
105
  */
106
106
  value: string;
107
107
  }
@@ -155,9 +155,9 @@ export namespace AgentEndpointUpdateResponse {
155
155
  outboundDialType: 'NONE' | 'HTTP_REQUEST';
156
156
 
157
157
  /**
158
- * Agent endpoint type (PHONE or WEBSOCKET)
158
+ * Agent endpoint type (PHONE, WEBSOCKET, LIVEKIT, SMALL_WEBRTC, or ELEVENLABS_WS)
159
159
  */
160
- type: 'PHONE' | 'WEBSOCKET';
160
+ type: 'PHONE' | 'WEBSOCKET' | 'LIVEKIT' | 'SMALL_WEBRTC' | 'ELEVENLABS_WS' | 'KORE' | 'GOOGLE_CES';
161
161
 
162
162
  /**
163
163
  * Last update timestamp
@@ -165,7 +165,7 @@ export namespace AgentEndpointUpdateResponse {
165
165
  updatedAt: string;
166
166
 
167
167
  /**
168
- * Agent endpoint value (phone number or websocket URL)
168
+ * Agent endpoint value (phone number, URL, etc.)
169
169
  */
170
170
  value: string;
171
171
  }
@@ -218,9 +218,9 @@ export namespace AgentEndpointListResponse {
218
218
  outboundDialType: 'NONE' | 'HTTP_REQUEST';
219
219
 
220
220
  /**
221
- * Agent endpoint type (PHONE or WEBSOCKET)
221
+ * Agent endpoint type (PHONE, WEBSOCKET, LIVEKIT, SMALL_WEBRTC, or ELEVENLABS_WS)
222
222
  */
223
- type: 'PHONE' | 'WEBSOCKET';
223
+ type: 'PHONE' | 'WEBSOCKET' | 'LIVEKIT' | 'SMALL_WEBRTC' | 'ELEVENLABS_WS' | 'KORE' | 'GOOGLE_CES';
224
224
 
225
225
  /**
226
226
  * Last update timestamp
@@ -228,7 +228,7 @@ export namespace AgentEndpointListResponse {
228
228
  updatedAt: string;
229
229
 
230
230
  /**
231
- * Agent endpoint value (phone number or websocket URL)
231
+ * Agent endpoint value (phone number, URL, etc.)
232
232
  */
233
233
  value: string;
234
234
  }
@@ -299,9 +299,9 @@ export namespace AgentEndpointGetByIDResponse {
299
299
  outboundDialType: 'NONE' | 'HTTP_REQUEST';
300
300
 
301
301
  /**
302
- * Agent endpoint type (PHONE or WEBSOCKET)
302
+ * Agent endpoint type (PHONE, WEBSOCKET, LIVEKIT, SMALL_WEBRTC, or ELEVENLABS_WS)
303
303
  */
304
- type: 'PHONE' | 'WEBSOCKET';
304
+ type: 'PHONE' | 'WEBSOCKET' | 'LIVEKIT' | 'SMALL_WEBRTC' | 'ELEVENLABS_WS' | 'KORE' | 'GOOGLE_CES';
305
305
 
306
306
  /**
307
307
  * Last update timestamp
@@ -309,7 +309,7 @@ export namespace AgentEndpointGetByIDResponse {
309
309
  updatedAt: string;
310
310
 
311
311
  /**
312
- * Agent endpoint value (phone number or websocket URL)
312
+ * Agent endpoint value (phone number, URL, etc.)
313
313
  */
314
314
  value: string;
315
315
  }
@@ -493,12 +493,12 @@ export namespace CallGetTranscriptResponse {
493
493
  */
494
494
  export interface Entry {
495
495
  /**
496
- * End time offset in milliseconds from the start of the call
496
+ * End time offset in milliseconds from the start of the conversation
497
497
  */
498
498
  endOffsetMs: number;
499
499
 
500
500
  /**
501
- * ID of the conversation participant who spoke this entry. References
501
+ * ID of the conversation participant who produced this entry. References
502
502
  * participants[].id.
503
503
  */
504
504
  participantId: string | null;
@@ -509,7 +509,7 @@ export namespace CallGetTranscriptResponse {
509
509
  role: 'AGENT' | 'CUSTOMER' | null;
510
510
 
511
511
  /**
512
- * Start time offset in milliseconds from the start of the call
512
+ * Start time offset in milliseconds from the start of the conversation
513
513
  */
514
514
  startOffsetMs: number;
515
515
 
@@ -774,14 +774,14 @@ export namespace CallListEvaluationRunsResponse {
774
774
 
775
775
  export interface CallListMetricsResponse {
776
776
  /**
777
- * Call metrics response payload grouped by metric definition
777
+ * Conversation metrics response payload grouped by metric definition
778
778
  */
779
779
  data: Array<CallListMetricsResponse.Data>;
780
780
  }
781
781
 
782
782
  export namespace CallListMetricsResponse {
783
783
  /**
784
- * Call metric data grouped by metric definition
784
+ * Metric data grouped by metric definition
785
785
  */
786
786
  export interface Data {
787
787
  /**
@@ -840,8 +840,8 @@ export namespace CallListMetricsResponse {
840
840
  confidence: number;
841
841
 
842
842
  /**
843
- * Context level: CALL (entire call), SEGMENT (single segment), SEGMENT_RANGE
844
- * (between/across segments)
843
+ * Context level: CALL (entire conversation), SEGMENT (single segment),
844
+ * SEGMENT_RANGE (between/across segments)
845
845
  */
846
846
  context: 'CALL' | 'SEGMENT' | 'SEGMENT_RANGE';
847
847
 
@@ -887,7 +887,7 @@ export namespace CallListMetricsResponse {
887
887
  */
888
888
  export interface FromSegment {
889
889
  /**
890
- * Starting segment ID
890
+ * Segment ID
891
891
  */
892
892
  id: string;
893
893
 
@@ -902,7 +902,7 @@ export namespace CallListMetricsResponse {
902
902
  startOffsetMs: number;
903
903
 
904
904
  /**
905
- * Starting segment text content
905
+ * Segment text content
906
906
  */
907
907
  text: string;
908
908
  }
@@ -937,7 +937,7 @@ export namespace CallListMetricsResponse {
937
937
  */
938
938
  export interface ToSegment {
939
939
  /**
940
- * Ending segment ID
940
+ * Segment ID
941
941
  */
942
942
  id: string;
943
943
 
@@ -952,7 +952,7 @@ export namespace CallListMetricsResponse {
952
952
  startOffsetMs: number;
953
953
 
954
954
  /**
955
- * Ending segment text content
955
+ * Segment text content
956
956
  */
957
957
  text: string;
958
958
  }
@@ -1168,7 +1168,8 @@ export namespace CallCreateParams {
1168
1168
  }
1169
1169
 
1170
1170
  /**
1171
- * Create a new agent or find existing by customId if provided
1171
+ * Find existing by customId if provided, otherwise reuse exact project name match
1172
+ * before creating
1172
1173
  */
1173
1174
  export interface AgentIdentificationByName {
1174
1175
  /**
@@ -1353,7 +1354,8 @@ export namespace CallCreateParams {
1353
1354
  }
1354
1355
 
1355
1356
  /**
1356
- * Create a new agent or find existing by customId if provided
1357
+ * Find existing by customId if provided, otherwise reuse exact project name match
1358
+ * before creating
1357
1359
  */
1358
1360
  export interface AgentIdentificationByName {
1359
1361
  /**
@@ -1565,14 +1567,8 @@ export namespace CallCreateParams {
1565
1567
  * the agents array this tool invocation belongs to
1566
1568
  */
1567
1569
  export interface Agent {
1568
- /**
1569
- * The custom ID set on the agent
1570
- */
1571
1570
  customId?: string;
1572
1571
 
1573
- /**
1574
- * The Roark ID of the agent
1575
- */
1576
1572
  roarkId?: string;
1577
1573
  }
1578
1574
  }
@@ -1586,29 +1582,15 @@ export namespace CallCreateParams {
1586
1582
 
1587
1583
  text: string;
1588
1584
 
1589
- /**
1590
- * Metadata about the agent that spoke this turn - used to match which agent from
1591
- * the `agents` array this transcript entry belongs to
1592
- */
1593
1585
  agent?: TranscriptEntryAgent.Agent;
1594
1586
 
1595
1587
  languageCode?: string;
1596
1588
  }
1597
1589
 
1598
1590
  export namespace TranscriptEntryAgent {
1599
- /**
1600
- * Metadata about the agent that spoke this turn - used to match which agent from
1601
- * the `agents` array this transcript entry belongs to
1602
- */
1603
1591
  export interface Agent {
1604
- /**
1605
- * The custom ID set on the agent
1606
- */
1607
1592
  customId?: string;
1608
1593
 
1609
- /**
1610
- * The Roark ID of the agent
1611
- */
1612
1594
  roarkId?: string;
1613
1595
  }
1614
1596
  }
@@ -7,8 +7,8 @@ import { path } from '../internal/utils/path';
7
7
 
8
8
  export class MetricCollectionJob extends APIResource {
9
9
  /**
10
- * Creates a metric collection job for the specified calls and metrics, then
11
- * triggers processing.
10
+ * Creates a metric collection job for the specified calls or chats and metrics,
11
+ * then triggers processing. Provide exactly one of callIds or chatIds.
12
12
  */
13
13
  create(
14
14
  body: MetricCollectionJobCreateParams,
@@ -37,14 +37,14 @@ export class MetricCollectionJob extends APIResource {
37
37
 
38
38
  export interface MetricCollectionJobCreateResponse {
39
39
  /**
40
- * A metric collection job that processes metrics for calls
40
+ * A metric collection job that processes metrics for calls or chats
41
41
  */
42
42
  data: MetricCollectionJobCreateResponse.Data;
43
43
  }
44
44
 
45
45
  export namespace MetricCollectionJobCreateResponse {
46
46
  /**
47
- * A metric collection job that processes metrics for calls
47
+ * A metric collection job that processes metrics for calls or chats
48
48
  */
49
49
  export interface Data {
50
50
  /**
@@ -120,7 +120,7 @@ export interface MetricCollectionJobListResponse {
120
120
 
121
121
  export namespace MetricCollectionJobListResponse {
122
122
  /**
123
- * A metric collection job that processes metrics for calls
123
+ * A metric collection job that processes metrics for calls or chats
124
124
  */
125
125
  export interface Data {
126
126
  /**
@@ -204,14 +204,14 @@ export namespace MetricCollectionJobListResponse {
204
204
 
205
205
  export interface MetricCollectionJobGetByIDResponse {
206
206
  /**
207
- * A metric collection job that processes metrics for calls
207
+ * A metric collection job that processes metrics for calls or chats
208
208
  */
209
209
  data: MetricCollectionJobGetByIDResponse.Data;
210
210
  }
211
211
 
212
212
  export namespace MetricCollectionJobGetByIDResponse {
213
213
  /**
214
- * A metric collection job that processes metrics for calls
214
+ * A metric collection job that processes metrics for calls or chats
215
215
  */
216
216
  export interface Data {
217
217
  /**
@@ -278,14 +278,19 @@ export namespace MetricCollectionJobGetByIDResponse {
278
278
 
279
279
  export interface MetricCollectionJobCreateParams {
280
280
  /**
281
- * Call IDs to collect metrics for
281
+ * Metric definitions to collect
282
282
  */
283
- callIds: Array<string>;
283
+ metrics: Array<MetricCollectionJobCreateParams.Metric>;
284
284
 
285
285
  /**
286
- * Metric definitions to collect
286
+ * Call IDs to collect metrics for. Mutually exclusive with chatIds.
287
287
  */
288
- metrics: Array<MetricCollectionJobCreateParams.Metric>;
288
+ callIds?: Array<string>;
289
+
290
+ /**
291
+ * Chat IDs to collect metrics for. Mutually exclusive with callIds.
292
+ */
293
+ chatIds?: Array<string>;
289
294
  }
290
295
 
291
296
  export namespace MetricCollectionJobCreateParams {
@@ -14,6 +14,7 @@ export class MetricPolicy extends APIResource {
14
14
  * ```ts
15
15
  * const metricPolicy = await client.metricPolicy.create({
16
16
  * metrics: [{ id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }],
17
+ * modality: 'call',
17
18
  * name: 'Evaluate all inbound calls',
18
19
  * });
19
20
  * ```
@@ -519,6 +520,12 @@ export interface MetricPolicyCreateParams {
519
520
  */
520
521
  metrics: Array<MetricPolicyCreateParams.Metric>;
521
522
 
523
+ /**
524
+ * Modality this policy targets. A policy fires for exactly one modality and can
525
+ * only reference metrics that support that modality.
526
+ */
527
+ modality: 'call' | 'chat';
528
+
522
529
  /**
523
530
  * Name of the metric policy
524
531
  */
@@ -27,8 +27,7 @@ export class Metric extends APIResource {
27
27
 
28
28
  /**
29
29
  * Fetch all metric definitions available in the project, including both
30
- * system-generated and custom metrics. Only returns metrics from enabled analysis
31
- * packages.
30
+ * system-generated and custom metrics.
32
31
  *
33
32
  * @example
34
33
  * ```ts
@@ -130,7 +130,7 @@ export namespace SimulationJobGetByIDResponse {
130
130
  /**
131
131
  * Agent endpoint type
132
132
  */
133
- type: 'PHONE' | 'WEBSOCKET';
133
+ type: 'PHONE' | 'WEBSOCKET' | 'LIVEKIT' | 'SMALL_WEBRTC' | 'ELEVENLABS_WS' | 'KORE' | 'GOOGLE_CES';
134
134
  }
135
135
 
136
136
  export interface Persona {
@@ -411,7 +411,7 @@ export namespace SimulationJobLookupResponse {
411
411
  /**
412
412
  * Agent endpoint type
413
413
  */
414
- type: 'PHONE' | 'WEBSOCKET';
414
+ type: 'PHONE' | 'WEBSOCKET' | 'LIVEKIT' | 'SMALL_WEBRTC' | 'ELEVENLABS_WS' | 'KORE' | 'GOOGLE_CES';
415
415
  }
416
416
 
417
417
  export interface Persona {
@@ -290,7 +290,7 @@ export namespace SimulationRunPlanJobGetByIDResponse {
290
290
  /**
291
291
  * Agent endpoint type
292
292
  */
293
- type: 'PHONE' | 'WEBSOCKET';
293
+ type: 'PHONE' | 'WEBSOCKET' | 'LIVEKIT' | 'SMALL_WEBRTC' | 'ELEVENLABS_WS' | 'KORE' | 'GOOGLE_CES';
294
294
  }
295
295
 
296
296
  export interface Persona {
@@ -249,6 +249,12 @@ export namespace SimulationRunPlanCreateResponse {
249
249
 
250
250
  export interface Scenario {
251
251
  id: string;
252
+
253
+ /**
254
+ * Template variables for this scenario instance. Absent when no variables are set.
255
+ * The same scenario can appear multiple times with different variables.
256
+ */
257
+ variables?: { [key: string]: string };
252
258
  }
253
259
  }
254
260
 
@@ -418,6 +424,12 @@ export namespace SimulationRunPlanUpdateResponse {
418
424
 
419
425
  export interface Scenario {
420
426
  id: string;
427
+
428
+ /**
429
+ * Template variables for this scenario instance. Absent when no variables are set.
430
+ * The same scenario can appear multiple times with different variables.
431
+ */
432
+ variables?: { [key: string]: string };
421
433
  }
422
434
  }
423
435
  }
@@ -552,6 +564,12 @@ export namespace SimulationRunPlanListResponse {
552
564
 
553
565
  export interface Scenario {
554
566
  id: string;
567
+
568
+ /**
569
+ * Template variables for this scenario instance. Absent when no variables are set.
570
+ * The same scenario can appear multiple times with different variables.
571
+ */
572
+ variables?: { [key: string]: string };
555
573
  }
556
574
  }
557
575
 
@@ -714,6 +732,12 @@ export namespace SimulationRunPlanGetByIDResponse {
714
732
 
715
733
  export interface Scenario {
716
734
  id: string;
735
+
736
+ /**
737
+ * Template variables for this scenario instance. Absent when no variables are set.
738
+ * The same scenario can appear multiple times with different variables.
739
+ */
740
+ variables?: { [key: string]: string };
717
741
  }
718
742
  }
719
743
  }
@@ -85,6 +85,8 @@ export namespace WebhookCreateResponse {
85
85
  | 'SIMULATION_JOB_CANCELLED'
86
86
  | 'METRIC_COLLECTION_JOB_COMPLETED'
87
87
  | 'METRIC_COLLECTION_JOB_FAILED'
88
+ | 'CHAT_ANALYSIS_COMPLETED'
89
+ | 'CHAT_ANALYSIS_FAILED'
88
90
  >;
89
91
 
90
92
  /**
@@ -154,6 +156,8 @@ export namespace WebhookListResponse {
154
156
  | 'SIMULATION_JOB_CANCELLED'
155
157
  | 'METRIC_COLLECTION_JOB_COMPLETED'
156
158
  | 'METRIC_COLLECTION_JOB_FAILED'
159
+ | 'CHAT_ANALYSIS_COMPLETED'
160
+ | 'CHAT_ANALYSIS_FAILED'
157
161
  >;
158
162
 
159
163
  /**
@@ -249,6 +253,8 @@ export namespace WebhookGetByIDResponse {
249
253
  | 'SIMULATION_JOB_CANCELLED'
250
254
  | 'METRIC_COLLECTION_JOB_COMPLETED'
251
255
  | 'METRIC_COLLECTION_JOB_FAILED'
256
+ | 'CHAT_ANALYSIS_COMPLETED'
257
+ | 'CHAT_ANALYSIS_FAILED'
252
258
  >;
253
259
 
254
260
  /**
@@ -288,6 +294,8 @@ export interface WebhookCreateParams {
288
294
  | 'SIMULATION_JOB_CANCELLED'
289
295
  | 'METRIC_COLLECTION_JOB_COMPLETED'
290
296
  | 'METRIC_COLLECTION_JOB_FAILED'
297
+ | 'CHAT_ANALYSIS_COMPLETED'
298
+ | 'CHAT_ANALYSIS_FAILED'
291
299
  >;
292
300
 
293
301
  /**
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '2.29.0'; // x-release-please-version
1
+ export const VERSION = '2.31.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "2.29.0";
1
+ export declare const VERSION = "2.31.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "2.29.0";
1
+ export declare const VERSION = "2.31.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '2.29.0'; // x-release-please-version
4
+ exports.VERSION = '2.31.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '2.29.0'; // x-release-please-version
1
+ export const VERSION = '2.31.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map