@roarkanalytics/sdk 3.5.0 → 3.7.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 +24 -0
  2. package/client.d.mts +7 -4
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +7 -4
  5. package/client.d.ts.map +1 -1
  6. package/client.js +3 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +3 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/call.d.mts +199 -1
  12. package/resources/call.d.mts.map +1 -1
  13. package/resources/call.d.ts +199 -1
  14. package/resources/call.d.ts.map +1 -1
  15. package/resources/call.js +30 -0
  16. package/resources/call.js.map +1 -1
  17. package/resources/call.mjs +30 -0
  18. package/resources/call.mjs.map +1 -1
  19. package/resources/config.d.mts +1 -1
  20. package/resources/config.d.mts.map +1 -1
  21. package/resources/config.d.ts +1 -1
  22. package/resources/config.d.ts.map +1 -1
  23. package/resources/customer-flow.d.mts +17 -2
  24. package/resources/customer-flow.d.mts.map +1 -1
  25. package/resources/customer-flow.d.ts +17 -2
  26. package/resources/customer-flow.d.ts.map +1 -1
  27. package/resources/index.d.mts +3 -2
  28. package/resources/index.d.mts.map +1 -1
  29. package/resources/index.d.ts +3 -2
  30. package/resources/index.d.ts.map +1 -1
  31. package/resources/index.js +3 -1
  32. package/resources/index.js.map +1 -1
  33. package/resources/index.mjs +1 -0
  34. package/resources/index.mjs.map +1 -1
  35. package/resources/metric-variant.d.mts +357 -0
  36. package/resources/metric-variant.d.mts.map +1 -0
  37. package/resources/metric-variant.d.ts +357 -0
  38. package/resources/metric-variant.d.ts.map +1 -0
  39. package/resources/metric-variant.js +112 -0
  40. package/resources/metric-variant.js.map +1 -0
  41. package/resources/metric-variant.mjs +108 -0
  42. package/resources/metric-variant.mjs.map +1 -0
  43. package/resources/metric.d.mts +696 -1
  44. package/resources/metric.d.mts.map +1 -1
  45. package/resources/metric.d.ts +696 -1
  46. package/resources/metric.d.ts.map +1 -1
  47. package/resources/metric.js +22 -0
  48. package/resources/metric.js.map +1 -1
  49. package/resources/metric.mjs +22 -0
  50. package/resources/metric.mjs.map +1 -1
  51. package/resources/simulation-job.d.mts +90 -0
  52. package/resources/simulation-job.d.mts.map +1 -1
  53. package/resources/simulation-job.d.ts +90 -0
  54. package/resources/simulation-job.d.ts.map +1 -1
  55. package/src/client.ts +35 -0
  56. package/src/resources/call.ts +236 -0
  57. package/src/resources/config.ts +1 -0
  58. package/src/resources/customer-flow.ts +24 -2
  59. package/src/resources/index.ts +16 -0
  60. package/src/resources/metric-variant.ts +458 -0
  61. package/src/resources/metric.ts +1008 -124
  62. package/src/resources/simulation-job.ts +104 -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
@@ -62,6 +62,12 @@ export namespace SimulationJobGetByIDResponse {
62
62
  */
63
63
  createdAt: string;
64
64
 
65
+ /**
66
+ * What happened to this run's live-conversation enrichment, and what scoring fell
67
+ * back to when none arrived.
68
+ */
69
+ enrichment: Data.Enrichment;
70
+
65
71
  persona: Data.Persona;
66
72
 
67
73
  /**
@@ -143,6 +149,52 @@ export namespace SimulationJobGetByIDResponse {
143
149
  | 'DAILY';
144
150
  }
145
151
 
152
+ /**
153
+ * What happened to this run's live-conversation enrichment, and what scoring fell
154
+ * back to when none arrived.
155
+ */
156
+ export interface Enrichment {
157
+ /**
158
+ * How the wait for the live conversation resolved. `WAITING` means the run is
159
+ * holding open for it right now. `MERGED` means it arrived and live-sourced
160
+ * metrics were scored against it. `TIMED_OUT` and `SKIPPED` both mean it never
161
+ * arrived, so scoring fell back to the simulated side: read
162
+ * `metricsScoredOnSimulationInstead` and `metricsNotCollected` for what that cost.
163
+ * `UNKNOWN` is a run that finished before Roark started recording this.
164
+ */
165
+ outcome: 'NOT_REQUESTED' | 'WAITING' | 'MERGED' | 'TIMED_OUT' | 'SKIPPED' | 'UNKNOWN';
166
+
167
+ /**
168
+ * Whether the run plan asked for the customer's live conversation to be merged
169
+ * into this run.
170
+ */
171
+ requested: boolean;
172
+
173
+ /**
174
+ * Metrics that only support the live side and so were not scored at all. Null on
175
+ * runs that predate this recording.
176
+ */
177
+ metricsNotCollected?: number | null;
178
+
179
+ /**
180
+ * Metrics that asked for the live side and were scored against the simulated side
181
+ * because no live conversation arrived. Null on runs that predate this recording.
182
+ */
183
+ metricsScoredOnSimulationInstead?: number | null;
184
+
185
+ /**
186
+ * When the wait ended, however it ended. Null if it never waited or is still
187
+ * waiting.
188
+ */
189
+ waitEndedAt?: string | null;
190
+
191
+ /**
192
+ * When the run began holding open for the live conversation. Null if it never
193
+ * waited.
194
+ */
195
+ waitStartedAt?: string | null;
196
+ }
197
+
146
198
  export interface Persona {
147
199
  /**
148
200
  * Unique identifier of the persona
@@ -405,6 +457,12 @@ export namespace SimulationJobLookupResponse {
405
457
  */
406
458
  createdAt: string;
407
459
 
460
+ /**
461
+ * What happened to this run's live-conversation enrichment, and what scoring fell
462
+ * back to when none arrived.
463
+ */
464
+ enrichment: Data.Enrichment;
465
+
408
466
  persona: Data.Persona;
409
467
 
410
468
  /**
@@ -486,6 +544,52 @@ export namespace SimulationJobLookupResponse {
486
544
  | 'DAILY';
487
545
  }
488
546
 
547
+ /**
548
+ * What happened to this run's live-conversation enrichment, and what scoring fell
549
+ * back to when none arrived.
550
+ */
551
+ export interface Enrichment {
552
+ /**
553
+ * How the wait for the live conversation resolved. `WAITING` means the run is
554
+ * holding open for it right now. `MERGED` means it arrived and live-sourced
555
+ * metrics were scored against it. `TIMED_OUT` and `SKIPPED` both mean it never
556
+ * arrived, so scoring fell back to the simulated side: read
557
+ * `metricsScoredOnSimulationInstead` and `metricsNotCollected` for what that cost.
558
+ * `UNKNOWN` is a run that finished before Roark started recording this.
559
+ */
560
+ outcome: 'NOT_REQUESTED' | 'WAITING' | 'MERGED' | 'TIMED_OUT' | 'SKIPPED' | 'UNKNOWN';
561
+
562
+ /**
563
+ * Whether the run plan asked for the customer's live conversation to be merged
564
+ * into this run.
565
+ */
566
+ requested: boolean;
567
+
568
+ /**
569
+ * Metrics that only support the live side and so were not scored at all. Null on
570
+ * runs that predate this recording.
571
+ */
572
+ metricsNotCollected?: number | null;
573
+
574
+ /**
575
+ * Metrics that asked for the live side and were scored against the simulated side
576
+ * because no live conversation arrived. Null on runs that predate this recording.
577
+ */
578
+ metricsScoredOnSimulationInstead?: number | null;
579
+
580
+ /**
581
+ * When the wait ended, however it ended. Null if it never waited or is still
582
+ * waiting.
583
+ */
584
+ waitEndedAt?: string | null;
585
+
586
+ /**
587
+ * When the run began holding open for the live conversation. Null if it never
588
+ * waited.
589
+ */
590
+ waitStartedAt?: string | null;
591
+ }
592
+
489
593
  export interface Persona {
490
594
  /**
491
595
  * Unique identifier of the persona
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '3.5.0'; // x-release-please-version
1
+ export const VERSION = '3.7.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "3.5.0";
1
+ export declare const VERSION = "3.7.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "3.5.0";
1
+ export declare const VERSION = "3.7.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 = '3.5.0'; // x-release-please-version
4
+ exports.VERSION = '3.7.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '3.5.0'; // x-release-please-version
1
+ export const VERSION = '3.7.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map