@roarkanalytics/sdk 2.33.2 → 3.0.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 (165) hide show
  1. package/CHANGELOG.md +44 -0
  2. package/client.d.mts +2 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +2 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/agent-endpoint.d.mts +26 -0
  10. package/resources/agent-endpoint.d.mts.map +1 -1
  11. package/resources/agent-endpoint.d.ts +26 -0
  12. package/resources/agent-endpoint.d.ts.map +1 -1
  13. package/resources/agent-endpoint.js +26 -0
  14. package/resources/agent-endpoint.js.map +1 -1
  15. package/resources/agent-endpoint.mjs +26 -0
  16. package/resources/agent-endpoint.mjs.map +1 -1
  17. package/resources/agent.d.mts +20 -0
  18. package/resources/agent.d.mts.map +1 -1
  19. package/resources/agent.d.ts +20 -0
  20. package/resources/agent.d.ts.map +1 -1
  21. package/resources/agent.js +20 -0
  22. package/resources/agent.js.map +1 -1
  23. package/resources/agent.mjs +20 -0
  24. package/resources/agent.mjs.map +1 -1
  25. package/resources/call.d.mts +39 -170
  26. package/resources/call.d.mts.map +1 -1
  27. package/resources/call.d.ts +39 -170
  28. package/resources/call.d.ts.map +1 -1
  29. package/resources/call.js +39 -0
  30. package/resources/call.js.map +1 -1
  31. package/resources/call.mjs +39 -0
  32. package/resources/call.mjs.map +1 -1
  33. package/resources/config.d.mts +90 -99
  34. package/resources/config.d.mts.map +1 -1
  35. package/resources/config.d.ts +90 -99
  36. package/resources/config.d.ts.map +1 -1
  37. package/resources/config.js +18 -5
  38. package/resources/config.js.map +1 -1
  39. package/resources/config.mjs +18 -5
  40. package/resources/config.mjs.map +1 -1
  41. package/resources/customer-flow-edge-case.d.mts +79 -0
  42. package/resources/customer-flow-edge-case.d.mts.map +1 -1
  43. package/resources/customer-flow-edge-case.d.ts +79 -0
  44. package/resources/customer-flow-edge-case.d.ts.map +1 -1
  45. package/resources/customer-flow-edge-case.js +34 -0
  46. package/resources/customer-flow-edge-case.js.map +1 -1
  47. package/resources/customer-flow-edge-case.mjs +34 -0
  48. package/resources/customer-flow-edge-case.mjs.map +1 -1
  49. package/resources/customer-flow.d.mts +271 -615
  50. package/resources/customer-flow.d.mts.map +1 -1
  51. package/resources/customer-flow.d.ts +271 -615
  52. package/resources/customer-flow.d.ts.map +1 -1
  53. package/resources/customer-flow.js +42 -1
  54. package/resources/customer-flow.js.map +1 -1
  55. package/resources/customer-flow.mjs +42 -1
  56. package/resources/customer-flow.mjs.map +1 -1
  57. package/resources/health.d.mts +5 -0
  58. package/resources/health.d.mts.map +1 -1
  59. package/resources/health.d.ts +5 -0
  60. package/resources/health.d.ts.map +1 -1
  61. package/resources/health.js +5 -0
  62. package/resources/health.js.map +1 -1
  63. package/resources/health.mjs +5 -0
  64. package/resources/health.mjs.map +1 -1
  65. package/resources/http-request-definition.d.mts +29 -0
  66. package/resources/http-request-definition.d.mts.map +1 -1
  67. package/resources/http-request-definition.d.ts +29 -0
  68. package/resources/http-request-definition.d.ts.map +1 -1
  69. package/resources/http-request-definition.js +29 -0
  70. package/resources/http-request-definition.js.map +1 -1
  71. package/resources/http-request-definition.mjs +29 -0
  72. package/resources/http-request-definition.mjs.map +1 -1
  73. package/resources/index.d.mts +1 -1
  74. package/resources/index.d.mts.map +1 -1
  75. package/resources/index.d.ts +1 -1
  76. package/resources/index.d.ts.map +1 -1
  77. package/resources/index.js.map +1 -1
  78. package/resources/index.mjs.map +1 -1
  79. package/resources/metric-collection-job.d.mts +23 -0
  80. package/resources/metric-collection-job.d.mts.map +1 -1
  81. package/resources/metric-collection-job.d.ts +23 -0
  82. package/resources/metric-collection-job.d.ts.map +1 -1
  83. package/resources/metric-collection-job.js +23 -0
  84. package/resources/metric-collection-job.js.map +1 -1
  85. package/resources/metric-collection-job.mjs +23 -0
  86. package/resources/metric-collection-job.mjs.map +1 -1
  87. package/resources/metric.d.mts +5 -7
  88. package/resources/metric.d.mts.map +1 -1
  89. package/resources/metric.d.ts +5 -7
  90. package/resources/metric.d.ts.map +1 -1
  91. package/resources/metric.js +5 -0
  92. package/resources/metric.js.map +1 -1
  93. package/resources/metric.mjs +5 -0
  94. package/resources/metric.mjs.map +1 -1
  95. package/resources/simulation-environment.d.mts +13 -0
  96. package/resources/simulation-environment.d.mts.map +1 -1
  97. package/resources/simulation-environment.d.ts +13 -0
  98. package/resources/simulation-environment.d.ts.map +1 -1
  99. package/resources/simulation-environment.js +13 -0
  100. package/resources/simulation-environment.js.map +1 -1
  101. package/resources/simulation-environment.mjs +13 -0
  102. package/resources/simulation-environment.mjs.map +1 -1
  103. package/resources/simulation-job.d.mts +14 -4
  104. package/resources/simulation-job.d.mts.map +1 -1
  105. package/resources/simulation-job.d.ts +14 -4
  106. package/resources/simulation-job.d.ts.map +1 -1
  107. package/resources/simulation-job.js +1 -1
  108. package/resources/simulation-job.js.map +1 -1
  109. package/resources/simulation-job.mjs +1 -1
  110. package/resources/simulation-job.mjs.map +1 -1
  111. package/resources/simulation-persona.d.mts +32 -3
  112. package/resources/simulation-persona.d.mts.map +1 -1
  113. package/resources/simulation-persona.d.ts +32 -3
  114. package/resources/simulation-persona.d.ts.map +1 -1
  115. package/resources/simulation-persona.js +2 -3
  116. package/resources/simulation-persona.js.map +1 -1
  117. package/resources/simulation-persona.mjs +2 -3
  118. package/resources/simulation-persona.mjs.map +1 -1
  119. package/resources/simulation-run-plan-job.d.mts +14 -2
  120. package/resources/simulation-run-plan-job.d.mts.map +1 -1
  121. package/resources/simulation-run-plan-job.d.ts +14 -2
  122. package/resources/simulation-run-plan-job.d.ts.map +1 -1
  123. package/resources/simulation-run-plan-job.js +7 -0
  124. package/resources/simulation-run-plan-job.js.map +1 -1
  125. package/resources/simulation-run-plan-job.mjs +7 -0
  126. package/resources/simulation-run-plan-job.mjs.map +1 -1
  127. package/resources/simulation.d.mts +2 -2
  128. package/resources/simulation.d.ts +2 -2
  129. package/resources/simulation.js +2 -2
  130. package/resources/simulation.mjs +2 -2
  131. package/resources/webhook.d.mts +23 -0
  132. package/resources/webhook.d.mts.map +1 -1
  133. package/resources/webhook.d.ts +23 -0
  134. package/resources/webhook.d.ts.map +1 -1
  135. package/resources/webhook.js +23 -0
  136. package/resources/webhook.js.map +1 -1
  137. package/resources/webhook.mjs +23 -0
  138. package/resources/webhook.mjs.map +1 -1
  139. package/src/client.ts +2 -0
  140. package/src/resources/agent-endpoint.ts +26 -0
  141. package/src/resources/agent.ts +20 -0
  142. package/src/resources/call.ts +39 -202
  143. package/src/resources/config.ts +123 -158
  144. package/src/resources/customer-flow-edge-case.ts +88 -0
  145. package/src/resources/customer-flow.ts +318 -1009
  146. package/src/resources/health.ts +5 -0
  147. package/src/resources/http-request-definition.ts +29 -0
  148. package/src/resources/index.ts +1 -0
  149. package/src/resources/metric-collection-job.ts +23 -0
  150. package/src/resources/metric.ts +5 -18
  151. package/src/resources/simulation-environment.ts +13 -0
  152. package/src/resources/simulation-job.ts +16 -4
  153. package/src/resources/simulation-persona.ts +38 -3
  154. package/src/resources/simulation-run-plan-job.ts +15 -2
  155. package/src/resources/simulation.ts +2 -2
  156. package/src/resources/webhook.ts +23 -0
  157. package/src/version.ts +1 -1
  158. package/version.d.mts +1 -1
  159. package/version.d.mts.map +1 -1
  160. package/version.d.ts +1 -1
  161. package/version.d.ts.map +1 -1
  162. package/version.js +1 -1
  163. package/version.js.map +1 -1
  164. package/version.mjs +1 -1
  165. package/version.mjs.map +1 -1
@@ -16,7 +16,7 @@ export class CustomerFlow extends APIResource {
16
16
  * @example
17
17
  * ```ts
18
18
  * const customerFlow = await client.customerFlow.create({
19
- * graph: [{ type: 'CUSTOMER_FIRST_MESSAGE' }],
19
+ * graph: [{ type: 'AGENT_TURN' }],
20
20
  * title: 'Reschedule an appointment',
21
21
  * type: 'SCRIPTED',
22
22
  * });
@@ -29,6 +29,13 @@ export class CustomerFlow extends APIResource {
29
29
  /**
30
30
  * Updates a flow's title, description, branching mode, linked agents or flow-level
31
31
  * expectations. The step graph is replaced through PUT /graph.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const customerFlow = await client.customerFlow.update(
36
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
37
+ * );
38
+ * ```
32
39
  */
33
40
  update(
34
41
  flowID: string,
@@ -44,6 +51,11 @@ export class CustomerFlow extends APIResource {
44
51
  * walks the project's whole step graph, so it comes back from the single-flow
45
52
  * endpoint instead. Customer flows are how a project describes what to test; they
46
53
  * replace the older simulation scenarios.
54
+ *
55
+ * @example
56
+ * ```ts
57
+ * const customerFlows = await client.customerFlow.list();
58
+ * ```
47
59
  */
48
60
  list(
49
61
  query: CustomerFlowListParams | null | undefined = {},
@@ -56,6 +68,13 @@ export class CustomerFlow extends APIResource {
56
68
  * Soft-deletes a customer flow along with its edge cases, expectations and (for
57
69
  * scripted flows) its step graph. Run plans that linked it drop it from their test
58
70
  * cases.
71
+ *
72
+ * @example
73
+ * ```ts
74
+ * const customerFlow = await client.customerFlow.delete(
75
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
76
+ * );
77
+ * ```
59
78
  */
60
79
  delete(flowID: string, options?: RequestOptions): APIPromise<CustomerFlowDeleteResponse> {
61
80
  return this._client.delete(path`/v1/customer-flow/${flowID}`, options);
@@ -64,6 +83,13 @@ export class CustomerFlow extends APIResource {
64
83
  /**
65
84
  * Returns a customer flow with its happy path, edge cases, expectations and linked
66
85
  * agents. Scripted flows also carry their step graph.
86
+ *
87
+ * @example
88
+ * ```ts
89
+ * const response = await client.customerFlow.getByID(
90
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
91
+ * );
92
+ * ```
67
93
  */
68
94
  getByID(flowID: string, options?: RequestOptions): APIPromise<CustomerFlowGetByIDResponse> {
69
95
  return this._client.get(path`/v1/customer-flow/${flowID}`, options);
@@ -81,6 +107,14 @@ export class CustomerFlow extends APIResource {
81
107
  * A change to the set of paths re-seeds how the flow runs, which the response
82
108
  * reports as `variantsReshaped` along with the resulting happy path and edge
83
109
  * cases.
110
+ *
111
+ * @example
112
+ * ```ts
113
+ * const response = await client.customerFlow.replaceGraph(
114
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
115
+ * { graph: [{ type: 'AGENT_TURN' }] },
116
+ * );
117
+ * ```
84
118
  */
85
119
  replaceGraph(
86
120
  flowID: string,
@@ -97,6 +131,13 @@ export class CustomerFlow extends APIResource {
97
131
  *
98
132
  * Its persona and environment are what the edge cases inherit, so changing them
99
133
  * here changes every edge case that does not name its own.
134
+ *
135
+ * @example
136
+ * ```ts
137
+ * const response = await client.customerFlow.updateHappyPath(
138
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
139
+ * );
140
+ * ```
100
141
  */
101
142
  updateHappyPath(
102
143
  flowID: string,
@@ -480,6 +521,12 @@ export namespace CustomerFlowCreateResponse {
480
521
  | 'PT'
481
522
  | 'IL';
482
523
 
524
+ /**
525
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
526
+ * voice for are accepted; defaults to ADULT, which every accent supports.
527
+ */
528
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
529
+
483
530
  /**
484
531
  * Background noise setting
485
532
  */
@@ -787,6 +834,12 @@ export namespace CustomerFlowCreateResponse {
787
834
  | 'PT'
788
835
  | 'IL';
789
836
 
837
+ /**
838
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
839
+ * voice for are accepted; defaults to ADULT, which every accent supports.
840
+ */
841
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
842
+
790
843
  /**
791
844
  * Background noise setting
792
845
  */
@@ -1181,6 +1234,12 @@ export namespace CustomerFlowCreateResponse {
1181
1234
  | 'PT'
1182
1235
  | 'IL';
1183
1236
 
1237
+ /**
1238
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
1239
+ * voice for are accepted; defaults to ADULT, which every accent supports.
1240
+ */
1241
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
1242
+
1184
1243
  /**
1185
1244
  * Background noise setting
1186
1245
  */
@@ -1486,6 +1545,12 @@ export namespace CustomerFlowCreateResponse {
1486
1545
  | 'PT'
1487
1546
  | 'IL';
1488
1547
 
1548
+ /**
1549
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
1550
+ * voice for are accepted; defaults to ADULT, which every accent supports.
1551
+ */
1552
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
1553
+
1489
1554
  /**
1490
1555
  * Background noise setting
1491
1556
  */
@@ -1874,6 +1939,12 @@ export namespace CustomerFlowCreateResponse {
1874
1939
  | 'PT'
1875
1940
  | 'IL';
1876
1941
 
1942
+ /**
1943
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
1944
+ * voice for are accepted; defaults to ADULT, which every accent supports.
1945
+ */
1946
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
1947
+
1877
1948
  /**
1878
1949
  * Background noise setting
1879
1950
  */
@@ -2174,6 +2245,12 @@ export namespace CustomerFlowCreateResponse {
2174
2245
  | 'PT'
2175
2246
  | 'IL';
2176
2247
 
2248
+ /**
2249
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
2250
+ * voice for are accepted; defaults to ADULT, which every accent supports.
2251
+ */
2252
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
2253
+
2177
2254
  /**
2178
2255
  * Background noise setting
2179
2256
  */
@@ -2595,6 +2672,12 @@ export namespace CustomerFlowUpdateResponse {
2595
2672
  | 'PT'
2596
2673
  | 'IL';
2597
2674
 
2675
+ /**
2676
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
2677
+ * voice for are accepted; defaults to ADULT, which every accent supports.
2678
+ */
2679
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
2680
+
2598
2681
  /**
2599
2682
  * Background noise setting
2600
2683
  */
@@ -2902,6 +2985,12 @@ export namespace CustomerFlowUpdateResponse {
2902
2985
  | 'PT'
2903
2986
  | 'IL';
2904
2987
 
2988
+ /**
2989
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
2990
+ * voice for are accepted; defaults to ADULT, which every accent supports.
2991
+ */
2992
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
2993
+
2905
2994
  /**
2906
2995
  * Background noise setting
2907
2996
  */
@@ -3296,6 +3385,12 @@ export namespace CustomerFlowUpdateResponse {
3296
3385
  | 'PT'
3297
3386
  | 'IL';
3298
3387
 
3388
+ /**
3389
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
3390
+ * voice for are accepted; defaults to ADULT, which every accent supports.
3391
+ */
3392
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
3393
+
3299
3394
  /**
3300
3395
  * Background noise setting
3301
3396
  */
@@ -3601,6 +3696,12 @@ export namespace CustomerFlowUpdateResponse {
3601
3696
  | 'PT'
3602
3697
  | 'IL';
3603
3698
 
3699
+ /**
3700
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
3701
+ * voice for are accepted; defaults to ADULT, which every accent supports.
3702
+ */
3703
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
3704
+
3604
3705
  /**
3605
3706
  * Background noise setting
3606
3707
  */
@@ -3989,6 +4090,12 @@ export namespace CustomerFlowUpdateResponse {
3989
4090
  | 'PT'
3990
4091
  | 'IL';
3991
4092
 
4093
+ /**
4094
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
4095
+ * voice for are accepted; defaults to ADULT, which every accent supports.
4096
+ */
4097
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
4098
+
3992
4099
  /**
3993
4100
  * Background noise setting
3994
4101
  */
@@ -4289,6 +4396,12 @@ export namespace CustomerFlowUpdateResponse {
4289
4396
  | 'PT'
4290
4397
  | 'IL';
4291
4398
 
4399
+ /**
4400
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
4401
+ * voice for are accepted; defaults to ADULT, which every accent supports.
4402
+ */
4403
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
4404
+
4292
4405
  /**
4293
4406
  * Background noise setting
4294
4407
  */
@@ -4713,6 +4826,12 @@ export namespace CustomerFlowListResponse {
4713
4826
  | 'PT'
4714
4827
  | 'IL';
4715
4828
 
4829
+ /**
4830
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
4831
+ * voice for are accepted; defaults to ADULT, which every accent supports.
4832
+ */
4833
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
4834
+
4716
4835
  /**
4717
4836
  * Background noise setting
4718
4837
  */
@@ -5020,6 +5139,12 @@ export namespace CustomerFlowListResponse {
5020
5139
  | 'PT'
5021
5140
  | 'IL';
5022
5141
 
5142
+ /**
5143
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
5144
+ * voice for are accepted; defaults to ADULT, which every accent supports.
5145
+ */
5146
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
5147
+
5023
5148
  /**
5024
5149
  * Background noise setting
5025
5150
  */
@@ -5414,6 +5539,12 @@ export namespace CustomerFlowListResponse {
5414
5539
  | 'PT'
5415
5540
  | 'IL';
5416
5541
 
5542
+ /**
5543
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
5544
+ * voice for are accepted; defaults to ADULT, which every accent supports.
5545
+ */
5546
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
5547
+
5417
5548
  /**
5418
5549
  * Background noise setting
5419
5550
  */
@@ -5719,6 +5850,12 @@ export namespace CustomerFlowListResponse {
5719
5850
  | 'PT'
5720
5851
  | 'IL';
5721
5852
 
5853
+ /**
5854
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
5855
+ * voice for are accepted; defaults to ADULT, which every accent supports.
5856
+ */
5857
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
5858
+
5722
5859
  /**
5723
5860
  * Background noise setting
5724
5861
  */
@@ -6107,6 +6244,12 @@ export namespace CustomerFlowListResponse {
6107
6244
  | 'PT'
6108
6245
  | 'IL';
6109
6246
 
6247
+ /**
6248
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
6249
+ * voice for are accepted; defaults to ADULT, which every accent supports.
6250
+ */
6251
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
6252
+
6110
6253
  /**
6111
6254
  * Background noise setting
6112
6255
  */
@@ -6407,6 +6550,12 @@ export namespace CustomerFlowListResponse {
6407
6550
  | 'PT'
6408
6551
  | 'IL';
6409
6552
 
6553
+ /**
6554
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
6555
+ * voice for are accepted; defaults to ADULT, which every accent supports.
6556
+ */
6557
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
6558
+
6410
6559
  /**
6411
6560
  * Background noise setting
6412
6561
  */
@@ -6858,6 +7007,12 @@ export namespace CustomerFlowGetByIDResponse {
6858
7007
  | 'PT'
6859
7008
  | 'IL';
6860
7009
 
7010
+ /**
7011
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
7012
+ * voice for are accepted; defaults to ADULT, which every accent supports.
7013
+ */
7014
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
7015
+
6861
7016
  /**
6862
7017
  * Background noise setting
6863
7018
  */
@@ -7165,6 +7320,12 @@ export namespace CustomerFlowGetByIDResponse {
7165
7320
  | 'PT'
7166
7321
  | 'IL';
7167
7322
 
7323
+ /**
7324
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
7325
+ * voice for are accepted; defaults to ADULT, which every accent supports.
7326
+ */
7327
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
7328
+
7168
7329
  /**
7169
7330
  * Background noise setting
7170
7331
  */
@@ -7559,6 +7720,12 @@ export namespace CustomerFlowGetByIDResponse {
7559
7720
  | 'PT'
7560
7721
  | 'IL';
7561
7722
 
7723
+ /**
7724
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
7725
+ * voice for are accepted; defaults to ADULT, which every accent supports.
7726
+ */
7727
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
7728
+
7562
7729
  /**
7563
7730
  * Background noise setting
7564
7731
  */
@@ -7864,6 +8031,12 @@ export namespace CustomerFlowGetByIDResponse {
7864
8031
  | 'PT'
7865
8032
  | 'IL';
7866
8033
 
8034
+ /**
8035
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
8036
+ * voice for are accepted; defaults to ADULT, which every accent supports.
8037
+ */
8038
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
8039
+
7867
8040
  /**
7868
8041
  * Background noise setting
7869
8042
  */
@@ -8252,6 +8425,12 @@ export namespace CustomerFlowGetByIDResponse {
8252
8425
  | 'PT'
8253
8426
  | 'IL';
8254
8427
 
8428
+ /**
8429
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
8430
+ * voice for are accepted; defaults to ADULT, which every accent supports.
8431
+ */
8432
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
8433
+
8255
8434
  /**
8256
8435
  * Background noise setting
8257
8436
  */
@@ -8552,6 +8731,12 @@ export namespace CustomerFlowGetByIDResponse {
8552
8731
  | 'PT'
8553
8732
  | 'IL';
8554
8733
 
8734
+ /**
8735
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
8736
+ * voice for are accepted; defaults to ADULT, which every accent supports.
8737
+ */
8738
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
8739
+
8555
8740
  /**
8556
8741
  * Background noise setting
8557
8742
  */
@@ -8889,6 +9074,12 @@ export namespace CustomerFlowReplaceGraphResponse {
8889
9074
  | 'PT'
8890
9075
  | 'IL';
8891
9076
 
9077
+ /**
9078
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
9079
+ * voice for are accepted; defaults to ADULT, which every accent supports.
9080
+ */
9081
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
9082
+
8892
9083
  /**
8893
9084
  * Background noise setting
8894
9085
  */
@@ -9194,6 +9385,12 @@ export namespace CustomerFlowReplaceGraphResponse {
9194
9385
  | 'PT'
9195
9386
  | 'IL';
9196
9387
 
9388
+ /**
9389
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
9390
+ * voice for are accepted; defaults to ADULT, which every accent supports.
9391
+ */
9392
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
9393
+
9197
9394
  /**
9198
9395
  * Background noise setting
9199
9396
  */
@@ -9494,6 +9691,12 @@ export namespace CustomerFlowReplaceGraphResponse {
9494
9691
  | 'PT'
9495
9692
  | 'IL';
9496
9693
 
9694
+ /**
9695
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
9696
+ * voice for are accepted; defaults to ADULT, which every accent supports.
9697
+ */
9698
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
9699
+
9497
9700
  /**
9498
9701
  * Background noise setting
9499
9702
  */
@@ -9665,1041 +9868,129 @@ export namespace CustomerFlowReplaceGraphResponse {
9665
9868
  secondaryLanguage?: 'EN' | null;
9666
9869
  }
9667
9870
  }
9871
+ }
9872
+ }
9873
+
9874
+ export interface CustomerFlowUpdateHappyPathResponse {
9875
+ /**
9876
+ * One way of running a customer flow.
9877
+ */
9878
+ data:
9879
+ | CustomerFlowUpdateHappyPathResponse.ScriptedFlowVariant
9880
+ | CustomerFlowUpdateHappyPathResponse.ImprovFlowVariant
9881
+ | CustomerFlowUpdateHappyPathResponse.VoicemailFlowVariant;
9882
+ }
9883
+
9884
+ export namespace CustomerFlowUpdateHappyPathResponse {
9885
+ /**
9886
+ * One path through a scripted flow. The path engine owns which paths exist, so
9887
+ * editing the graph is what creates and removes these.
9888
+ */
9889
+ export interface ScriptedFlowVariant {
9890
+ id: string;
9668
9891
 
9669
9892
  /**
9670
- * One path through a scripted flow. The path engine owns which paths exist, so
9671
- * editing the graph is what creates and removes these.
9893
+ * Graded on top of the flow's own expectations, for this variant only.
9672
9894
  */
9673
- export interface ScriptedFlowVariant {
9674
- id: string;
9895
+ additionalExpectations: Array<ScriptedFlowVariant.AdditionalExpectation>;
9675
9896
 
9676
- /**
9677
- * Graded on top of the flow's own expectations, for this variant only.
9678
- */
9679
- additionalExpectations: Array<ScriptedFlowVariant.AdditionalExpectation>;
9897
+ /**
9898
+ * Creation timestamp in ISO 8601 format
9899
+ */
9900
+ createdAt: string;
9680
9901
 
9681
- /**
9682
- * Creation timestamp in ISO 8601 format
9683
- */
9684
- createdAt: string;
9902
+ /**
9903
+ * A simulation environment: the ambient conditions a customer flow variant runs
9904
+ * under. The list includes both your own and the ones Roark curates for every
9905
+ * project.
9906
+ */
9907
+ environment: ScriptedFlowVariant.Environment | null;
9685
9908
 
9686
- /**
9687
- * A simulation environment: the ambient conditions a customer flow variant runs
9688
- * under. The list includes both your own and the ones Roark curates for every
9689
- * project.
9690
- */
9691
- environment: ScriptedFlowVariant.Environment | null;
9909
+ isGenerated: boolean;
9692
9910
 
9693
- isGenerated: boolean;
9911
+ /**
9912
+ * The persona this runs as instead of the happy path's. Null means it inherits.
9913
+ */
9914
+ personaOverride: ScriptedFlowVariant.PersonaOverride | null;
9915
+
9916
+ precededByCustomerFlowId: string | null;
9917
+
9918
+ precededByCustomerFlowVariantId: string | null;
9919
+
9920
+ /**
9921
+ * The one path through the graph this variant runs, in order. Linear by
9922
+ * construction, so these steps never nest.
9923
+ */
9924
+ steps: Array<CustomerFlowAPI.FlowStep>;
9925
+
9926
+ title: string;
9927
+
9928
+ type: 'SCRIPTED';
9929
+
9930
+ /**
9931
+ * Last update timestamp in ISO 8601 format
9932
+ */
9933
+ updatedAt: string;
9934
+ }
9935
+
9936
+ export namespace ScriptedFlowVariant {
9937
+ /**
9938
+ * One thing the agent under test is graded against.
9939
+ */
9940
+ export interface AdditionalExpectation {
9941
+ id: string;
9694
9942
 
9695
9943
  /**
9696
- * The persona this runs as instead of the happy path's. Null means it inherits.
9944
+ * What the agent under test is graded against.
9697
9945
  */
9698
- personaOverride: ScriptedFlowVariant.PersonaOverride | null;
9946
+ prompt: string;
9947
+ }
9699
9948
 
9700
- precededByCustomerFlowId: string | null;
9949
+ /**
9950
+ * A simulation environment: the ambient conditions a customer flow variant runs
9951
+ * under. The list includes both your own and the ones Roark curates for every
9952
+ * project.
9953
+ */
9954
+ export interface Environment {
9955
+ id: string;
9701
9956
 
9702
- precededByCustomerFlowVariantId: string | null;
9957
+ backgroundNoise:
9958
+ | 'NONE'
9959
+ | 'AIRPORT'
9960
+ | 'CHILDREN_PLAYING'
9961
+ | 'CITY'
9962
+ | 'COFFEE_SHOP'
9963
+ | 'DRIVING'
9964
+ | 'OFFICE'
9965
+ | 'THUNDERSTORM';
9703
9966
 
9704
9967
  /**
9705
- * The one path through the graph this variant runs, in order. Linear by
9706
- * construction, so these steps never nest.
9968
+ * Creation timestamp in ISO 8601 format
9707
9969
  */
9708
- steps: Array<CustomerFlowAPI.FlowStep>;
9709
-
9710
- title: string;
9970
+ createdAt: string;
9711
9971
 
9712
- type: 'SCRIPTED';
9972
+ name: string;
9713
9973
 
9714
9974
  /**
9715
9975
  * Last update timestamp in ISO 8601 format
9716
9976
  */
9717
9977
  updatedAt: string;
9978
+
9979
+ description?: string | null;
9718
9980
  }
9719
9981
 
9720
- export namespace ScriptedFlowVariant {
9982
+ /**
9983
+ * The persona this runs as instead of the happy path's. Null means it inherits.
9984
+ */
9985
+ export interface PersonaOverride {
9721
9986
  /**
9722
- * One thing the agent under test is graded against.
9987
+ * Unique identifier of the persona
9723
9988
  */
9724
- export interface AdditionalExpectation {
9725
- id: string;
9726
-
9727
- /**
9728
- * What the agent under test is graded against.
9729
- */
9730
- prompt: string;
9731
- }
9989
+ id: string;
9732
9990
 
9733
9991
  /**
9734
- * A simulation environment: the ambient conditions a customer flow variant runs
9735
- * under. The list includes both your own and the ones Roark curates for every
9736
- * project.
9737
- */
9738
- export interface Environment {
9739
- id: string;
9740
-
9741
- backgroundNoise:
9742
- | 'NONE'
9743
- | 'AIRPORT'
9744
- | 'CHILDREN_PLAYING'
9745
- | 'CITY'
9746
- | 'COFFEE_SHOP'
9747
- | 'DRIVING'
9748
- | 'OFFICE'
9749
- | 'THUNDERSTORM';
9750
-
9751
- /**
9752
- * Creation timestamp in ISO 8601 format
9753
- */
9754
- createdAt: string;
9755
-
9756
- name: string;
9757
-
9758
- /**
9759
- * Last update timestamp in ISO 8601 format
9760
- */
9761
- updatedAt: string;
9762
-
9763
- description?: string | null;
9764
- }
9765
-
9766
- /**
9767
- * The persona this runs as instead of the happy path's. Null means it inherits.
9768
- */
9769
- export interface PersonaOverride {
9770
- /**
9771
- * Unique identifier of the persona
9772
- */
9773
- id: string;
9774
-
9775
- /**
9776
- * Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
9777
- * optional variants
9778
- */
9779
- accent:
9780
- | 'US'
9781
- | 'US_X_SOUTH'
9782
- | 'GB'
9783
- | 'ES'
9784
- | 'DE'
9785
- | 'IN'
9786
- | 'FR'
9787
- | 'NL'
9788
- | 'SA'
9789
- | 'GR'
9790
- | 'AU'
9791
- | 'IT'
9792
- | 'ID'
9793
- | 'TH'
9794
- | 'JP'
9795
- | 'NZ'
9796
- | 'PH'
9797
- | 'SG'
9798
- | 'MY'
9799
- | 'HK'
9800
- | 'TR'
9801
- | 'PT'
9802
- | 'IL';
9803
-
9804
- /**
9805
- * Background noise setting
9806
- */
9807
- backgroundNoise:
9808
- | 'NONE'
9809
- | 'AIRPORT'
9810
- | 'CHILDREN_PLAYING'
9811
- | 'CITY'
9812
- | 'COFFEE_SHOP'
9813
- | 'DRIVING'
9814
- | 'OFFICE'
9815
- | 'THUNDERSTORM';
9816
-
9817
- /**
9818
- * Base emotional state of the persona
9819
- */
9820
- baseEmotion:
9821
- | 'NEUTRAL'
9822
- | 'CHEERFUL'
9823
- | 'CONFUSED'
9824
- | 'FRUSTRATED'
9825
- | 'SKEPTICAL'
9826
- | 'RUSHED'
9827
- | 'DISTRACTED';
9828
-
9829
- /**
9830
- * How the persona confirms information
9831
- */
9832
- confirmationStyle: 'EXPLICIT' | 'VAGUE';
9833
-
9834
- /**
9835
- * Creation timestamp
9836
- */
9837
- createdAt: string;
9838
-
9839
- /**
9840
- * Gender of the persona
9841
- */
9842
- gender: 'MALE' | 'FEMALE';
9843
-
9844
- /**
9845
- * Whether the persona uses filler words like "um" and "uh"
9846
- */
9847
- hasDisfluencies: boolean;
9848
-
9849
- /**
9850
- * Maximum number of idle messages the persona will send before giving up
9851
- */
9852
- idleMessageMaxSpokenCount: number;
9853
-
9854
- /**
9855
- * Whether the idle message counter resets when the agent speaks
9856
- */
9857
- idleMessageResetCountOnUserSpeechEnabled: boolean;
9858
-
9859
- /**
9860
- * Messages the persona will say when the agent goes silent during a call. null =
9861
- * "Automatic": language-appropriate defaults are used at call time.
9862
- */
9863
- idleMessages: Array<string> | null;
9864
-
9865
- /**
9866
- * Seconds of silence before the persona sends an idle message
9867
- */
9868
- idleTimeoutSeconds: number;
9869
-
9870
- /**
9871
- * How clearly the persona expresses their intentions
9872
- */
9873
- intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
9874
-
9875
- /**
9876
- * Primary language ISO 639-1 code for the persona
9877
- */
9878
- language:
9879
- | 'EN'
9880
- | 'ES'
9881
- | 'DE'
9882
- | 'HI'
9883
- | 'FR'
9884
- | 'NL'
9885
- | 'AR'
9886
- | 'EL'
9887
- | 'IT'
9888
- | 'ID'
9889
- | 'TH'
9890
- | 'JA'
9891
- | 'TL'
9892
- | 'MS'
9893
- | 'ZH'
9894
- | 'TR'
9895
- | 'PT'
9896
- | 'HE';
9897
-
9898
- /**
9899
- * How reliable the persona's memory is
9900
- */
9901
- memoryReliability: 'HIGH' | 'LOW';
9902
-
9903
- /**
9904
- * The name the agent will identify as during conversations
9905
- */
9906
- name: string;
9907
-
9908
- /**
9909
- * Additional custom properties about the persona
9910
- */
9911
- properties: { [key: string]: unknown };
9912
-
9913
- /**
9914
- * Controls how quickly the persona responds to pauses in conversation (QUICK,
9915
- * NORMAL, RELAXED)
9916
- */
9917
- responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
9918
-
9919
- /**
9920
- * Speech clarity of the persona
9921
- */
9922
- speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
9923
-
9924
- /**
9925
- * Speech pace of the persona
9926
- */
9927
- speechPace: 'SUPER_SLOW' | 'SLOW' | 'NORMAL' | 'FAST' | 'SUPER_FAST';
9928
-
9929
- /**
9930
- * Languages the persona can understand. Multilingual combinations are limited by
9931
- * multilingual speech recognition support.
9932
- */
9933
- understoodLanguages: Array<
9934
- | 'EN'
9935
- | 'ES'
9936
- | 'DE'
9937
- | 'HI'
9938
- | 'FR'
9939
- | 'NL'
9940
- | 'AR'
9941
- | 'EL'
9942
- | 'IT'
9943
- | 'ID'
9944
- | 'TH'
9945
- | 'JA'
9946
- | 'TL'
9947
- | 'MS'
9948
- | 'ZH'
9949
- | 'TR'
9950
- | 'PT'
9951
- | 'HE'
9952
- >;
9953
-
9954
- /**
9955
- * Last update timestamp
9956
- */
9957
- updatedAt: string;
9958
-
9959
- /**
9960
- * Background story and behavioral patterns for the persona
9961
- */
9962
- backstoryPrompt?: string | null;
9963
-
9964
- /**
9965
- * Human-readable description of the persona
9966
- */
9967
- description?: string | null;
9968
-
9969
- /**
9970
- * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
9971
- */
9972
- secondaryLanguage?: 'EN' | null;
9973
- }
9974
- }
9975
-
9976
- /**
9977
- * One brief to run an improv flow with.
9978
- */
9979
- export interface ImprovFlowVariant {
9980
- id: string;
9981
-
9982
- /**
9983
- * Graded on top of the flow's own expectations, for this variant only.
9984
- */
9985
- additionalExpectations: Array<ImprovFlowVariant.AdditionalExpectation>;
9986
-
9987
- /**
9988
- * Creation timestamp in ISO 8601 format
9989
- */
9990
- createdAt: string;
9991
-
9992
- /**
9993
- * A simulation environment: the ambient conditions a customer flow variant runs
9994
- * under. The list includes both your own and the ones Roark curates for every
9995
- * project.
9996
- */
9997
- environment: ImprovFlowVariant.Environment | null;
9998
-
9999
- isGenerated: boolean;
10000
-
10001
- /**
10002
- * The persona this runs as instead of the happy path's. Null means it inherits.
10003
- */
10004
- personaOverride: ImprovFlowVariant.PersonaOverride | null;
10005
-
10006
- precededByCustomerFlowId: string | null;
10007
-
10008
- precededByCustomerFlowVariantId: string | null;
10009
-
10010
- title: string;
10011
-
10012
- type: 'IMPROV';
10013
-
10014
- /**
10015
- * Last update timestamp in ISO 8601 format
10016
- */
10017
- updatedAt: string;
10018
-
10019
- /**
10020
- * The brief the simulated customer improvises from.
10021
- */
10022
- prompt?: string | null;
10023
- }
10024
-
10025
- export namespace ImprovFlowVariant {
10026
- /**
10027
- * One thing the agent under test is graded against.
10028
- */
10029
- export interface AdditionalExpectation {
10030
- id: string;
10031
-
10032
- /**
10033
- * What the agent under test is graded against.
10034
- */
10035
- prompt: string;
10036
- }
10037
-
10038
- /**
10039
- * A simulation environment: the ambient conditions a customer flow variant runs
10040
- * under. The list includes both your own and the ones Roark curates for every
10041
- * project.
10042
- */
10043
- export interface Environment {
10044
- id: string;
10045
-
10046
- backgroundNoise:
10047
- | 'NONE'
10048
- | 'AIRPORT'
10049
- | 'CHILDREN_PLAYING'
10050
- | 'CITY'
10051
- | 'COFFEE_SHOP'
10052
- | 'DRIVING'
10053
- | 'OFFICE'
10054
- | 'THUNDERSTORM';
10055
-
10056
- /**
10057
- * Creation timestamp in ISO 8601 format
10058
- */
10059
- createdAt: string;
10060
-
10061
- name: string;
10062
-
10063
- /**
10064
- * Last update timestamp in ISO 8601 format
10065
- */
10066
- updatedAt: string;
10067
-
10068
- description?: string | null;
10069
- }
10070
-
10071
- /**
10072
- * The persona this runs as instead of the happy path's. Null means it inherits.
10073
- */
10074
- export interface PersonaOverride {
10075
- /**
10076
- * Unique identifier of the persona
10077
- */
10078
- id: string;
10079
-
10080
- /**
10081
- * Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
10082
- * optional variants
10083
- */
10084
- accent:
10085
- | 'US'
10086
- | 'US_X_SOUTH'
10087
- | 'GB'
10088
- | 'ES'
10089
- | 'DE'
10090
- | 'IN'
10091
- | 'FR'
10092
- | 'NL'
10093
- | 'SA'
10094
- | 'GR'
10095
- | 'AU'
10096
- | 'IT'
10097
- | 'ID'
10098
- | 'TH'
10099
- | 'JP'
10100
- | 'NZ'
10101
- | 'PH'
10102
- | 'SG'
10103
- | 'MY'
10104
- | 'HK'
10105
- | 'TR'
10106
- | 'PT'
10107
- | 'IL';
10108
-
10109
- /**
10110
- * Background noise setting
10111
- */
10112
- backgroundNoise:
10113
- | 'NONE'
10114
- | 'AIRPORT'
10115
- | 'CHILDREN_PLAYING'
10116
- | 'CITY'
10117
- | 'COFFEE_SHOP'
10118
- | 'DRIVING'
10119
- | 'OFFICE'
10120
- | 'THUNDERSTORM';
10121
-
10122
- /**
10123
- * Base emotional state of the persona
10124
- */
10125
- baseEmotion:
10126
- | 'NEUTRAL'
10127
- | 'CHEERFUL'
10128
- | 'CONFUSED'
10129
- | 'FRUSTRATED'
10130
- | 'SKEPTICAL'
10131
- | 'RUSHED'
10132
- | 'DISTRACTED';
10133
-
10134
- /**
10135
- * How the persona confirms information
10136
- */
10137
- confirmationStyle: 'EXPLICIT' | 'VAGUE';
10138
-
10139
- /**
10140
- * Creation timestamp
10141
- */
10142
- createdAt: string;
10143
-
10144
- /**
10145
- * Gender of the persona
10146
- */
10147
- gender: 'MALE' | 'FEMALE';
10148
-
10149
- /**
10150
- * Whether the persona uses filler words like "um" and "uh"
10151
- */
10152
- hasDisfluencies: boolean;
10153
-
10154
- /**
10155
- * Maximum number of idle messages the persona will send before giving up
10156
- */
10157
- idleMessageMaxSpokenCount: number;
10158
-
10159
- /**
10160
- * Whether the idle message counter resets when the agent speaks
10161
- */
10162
- idleMessageResetCountOnUserSpeechEnabled: boolean;
10163
-
10164
- /**
10165
- * Messages the persona will say when the agent goes silent during a call. null =
10166
- * "Automatic": language-appropriate defaults are used at call time.
10167
- */
10168
- idleMessages: Array<string> | null;
10169
-
10170
- /**
10171
- * Seconds of silence before the persona sends an idle message
10172
- */
10173
- idleTimeoutSeconds: number;
10174
-
10175
- /**
10176
- * How clearly the persona expresses their intentions
10177
- */
10178
- intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
10179
-
10180
- /**
10181
- * Primary language ISO 639-1 code for the persona
10182
- */
10183
- language:
10184
- | 'EN'
10185
- | 'ES'
10186
- | 'DE'
10187
- | 'HI'
10188
- | 'FR'
10189
- | 'NL'
10190
- | 'AR'
10191
- | 'EL'
10192
- | 'IT'
10193
- | 'ID'
10194
- | 'TH'
10195
- | 'JA'
10196
- | 'TL'
10197
- | 'MS'
10198
- | 'ZH'
10199
- | 'TR'
10200
- | 'PT'
10201
- | 'HE';
10202
-
10203
- /**
10204
- * How reliable the persona's memory is
10205
- */
10206
- memoryReliability: 'HIGH' | 'LOW';
10207
-
10208
- /**
10209
- * The name the agent will identify as during conversations
10210
- */
10211
- name: string;
10212
-
10213
- /**
10214
- * Additional custom properties about the persona
10215
- */
10216
- properties: { [key: string]: unknown };
10217
-
10218
- /**
10219
- * Controls how quickly the persona responds to pauses in conversation (QUICK,
10220
- * NORMAL, RELAXED)
10221
- */
10222
- responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
10223
-
10224
- /**
10225
- * Speech clarity of the persona
10226
- */
10227
- speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
10228
-
10229
- /**
10230
- * Speech pace of the persona
10231
- */
10232
- speechPace: 'SUPER_SLOW' | 'SLOW' | 'NORMAL' | 'FAST' | 'SUPER_FAST';
10233
-
10234
- /**
10235
- * Languages the persona can understand. Multilingual combinations are limited by
10236
- * multilingual speech recognition support.
10237
- */
10238
- understoodLanguages: Array<
10239
- | 'EN'
10240
- | 'ES'
10241
- | 'DE'
10242
- | 'HI'
10243
- | 'FR'
10244
- | 'NL'
10245
- | 'AR'
10246
- | 'EL'
10247
- | 'IT'
10248
- | 'ID'
10249
- | 'TH'
10250
- | 'JA'
10251
- | 'TL'
10252
- | 'MS'
10253
- | 'ZH'
10254
- | 'TR'
10255
- | 'PT'
10256
- | 'HE'
10257
- >;
10258
-
10259
- /**
10260
- * Last update timestamp
10261
- */
10262
- updatedAt: string;
10263
-
10264
- /**
10265
- * Background story and behavioral patterns for the persona
10266
- */
10267
- backstoryPrompt?: string | null;
10268
-
10269
- /**
10270
- * Human-readable description of the persona
10271
- */
10272
- description?: string | null;
10273
-
10274
- /**
10275
- * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
10276
- */
10277
- secondaryLanguage?: 'EN' | null;
10278
- }
10279
- }
10280
-
10281
- /**
10282
- * One voicemail greeting.
10283
- */
10284
- export interface VoicemailFlowVariant {
10285
- id: string;
10286
-
10287
- /**
10288
- * Graded on top of the flow's own expectations, for this variant only.
10289
- */
10290
- additionalExpectations: Array<VoicemailFlowVariant.AdditionalExpectation>;
10291
-
10292
- /**
10293
- * Creation timestamp in ISO 8601 format
10294
- */
10295
- createdAt: string;
10296
-
10297
- /**
10298
- * A simulation environment: the ambient conditions a customer flow variant runs
10299
- * under. The list includes both your own and the ones Roark curates for every
10300
- * project.
10301
- */
10302
- environment: VoicemailFlowVariant.Environment | null;
10303
-
10304
- isGenerated: boolean;
10305
-
10306
- /**
10307
- * The persona this runs as instead of the happy path's. Null means it inherits.
10308
- */
10309
- personaOverride: VoicemailFlowVariant.PersonaOverride | null;
10310
-
10311
- precededByCustomerFlowId: string | null;
10312
-
10313
- precededByCustomerFlowVariantId: string | null;
10314
-
10315
- title: string;
10316
-
10317
- type: 'VOICEMAIL';
10318
-
10319
- /**
10320
- * Last update timestamp in ISO 8601 format
10321
- */
10322
- updatedAt: string;
10323
- }
10324
-
10325
- export namespace VoicemailFlowVariant {
10326
- /**
10327
- * One thing the agent under test is graded against.
10328
- */
10329
- export interface AdditionalExpectation {
10330
- id: string;
10331
-
10332
- /**
10333
- * What the agent under test is graded against.
10334
- */
10335
- prompt: string;
10336
- }
10337
-
10338
- /**
10339
- * A simulation environment: the ambient conditions a customer flow variant runs
10340
- * under. The list includes both your own and the ones Roark curates for every
10341
- * project.
10342
- */
10343
- export interface Environment {
10344
- id: string;
10345
-
10346
- backgroundNoise:
10347
- | 'NONE'
10348
- | 'AIRPORT'
10349
- | 'CHILDREN_PLAYING'
10350
- | 'CITY'
10351
- | 'COFFEE_SHOP'
10352
- | 'DRIVING'
10353
- | 'OFFICE'
10354
- | 'THUNDERSTORM';
10355
-
10356
- /**
10357
- * Creation timestamp in ISO 8601 format
10358
- */
10359
- createdAt: string;
10360
-
10361
- name: string;
10362
-
10363
- /**
10364
- * Last update timestamp in ISO 8601 format
10365
- */
10366
- updatedAt: string;
10367
-
10368
- description?: string | null;
10369
- }
10370
-
10371
- /**
10372
- * The persona this runs as instead of the happy path's. Null means it inherits.
10373
- */
10374
- export interface PersonaOverride {
10375
- /**
10376
- * Unique identifier of the persona
10377
- */
10378
- id: string;
10379
-
10380
- /**
10381
- * Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
10382
- * optional variants
10383
- */
10384
- accent:
10385
- | 'US'
10386
- | 'US_X_SOUTH'
10387
- | 'GB'
10388
- | 'ES'
10389
- | 'DE'
10390
- | 'IN'
10391
- | 'FR'
10392
- | 'NL'
10393
- | 'SA'
10394
- | 'GR'
10395
- | 'AU'
10396
- | 'IT'
10397
- | 'ID'
10398
- | 'TH'
10399
- | 'JP'
10400
- | 'NZ'
10401
- | 'PH'
10402
- | 'SG'
10403
- | 'MY'
10404
- | 'HK'
10405
- | 'TR'
10406
- | 'PT'
10407
- | 'IL';
10408
-
10409
- /**
10410
- * Background noise setting
10411
- */
10412
- backgroundNoise:
10413
- | 'NONE'
10414
- | 'AIRPORT'
10415
- | 'CHILDREN_PLAYING'
10416
- | 'CITY'
10417
- | 'COFFEE_SHOP'
10418
- | 'DRIVING'
10419
- | 'OFFICE'
10420
- | 'THUNDERSTORM';
10421
-
10422
- /**
10423
- * Base emotional state of the persona
10424
- */
10425
- baseEmotion:
10426
- | 'NEUTRAL'
10427
- | 'CHEERFUL'
10428
- | 'CONFUSED'
10429
- | 'FRUSTRATED'
10430
- | 'SKEPTICAL'
10431
- | 'RUSHED'
10432
- | 'DISTRACTED';
10433
-
10434
- /**
10435
- * How the persona confirms information
10436
- */
10437
- confirmationStyle: 'EXPLICIT' | 'VAGUE';
10438
-
10439
- /**
10440
- * Creation timestamp
10441
- */
10442
- createdAt: string;
10443
-
10444
- /**
10445
- * Gender of the persona
10446
- */
10447
- gender: 'MALE' | 'FEMALE';
10448
-
10449
- /**
10450
- * Whether the persona uses filler words like "um" and "uh"
10451
- */
10452
- hasDisfluencies: boolean;
10453
-
10454
- /**
10455
- * Maximum number of idle messages the persona will send before giving up
10456
- */
10457
- idleMessageMaxSpokenCount: number;
10458
-
10459
- /**
10460
- * Whether the idle message counter resets when the agent speaks
10461
- */
10462
- idleMessageResetCountOnUserSpeechEnabled: boolean;
10463
-
10464
- /**
10465
- * Messages the persona will say when the agent goes silent during a call. null =
10466
- * "Automatic": language-appropriate defaults are used at call time.
10467
- */
10468
- idleMessages: Array<string> | null;
10469
-
10470
- /**
10471
- * Seconds of silence before the persona sends an idle message
10472
- */
10473
- idleTimeoutSeconds: number;
10474
-
10475
- /**
10476
- * How clearly the persona expresses their intentions
10477
- */
10478
- intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
10479
-
10480
- /**
10481
- * Primary language ISO 639-1 code for the persona
10482
- */
10483
- language:
10484
- | 'EN'
10485
- | 'ES'
10486
- | 'DE'
10487
- | 'HI'
10488
- | 'FR'
10489
- | 'NL'
10490
- | 'AR'
10491
- | 'EL'
10492
- | 'IT'
10493
- | 'ID'
10494
- | 'TH'
10495
- | 'JA'
10496
- | 'TL'
10497
- | 'MS'
10498
- | 'ZH'
10499
- | 'TR'
10500
- | 'PT'
10501
- | 'HE';
10502
-
10503
- /**
10504
- * How reliable the persona's memory is
10505
- */
10506
- memoryReliability: 'HIGH' | 'LOW';
10507
-
10508
- /**
10509
- * The name the agent will identify as during conversations
10510
- */
10511
- name: string;
10512
-
10513
- /**
10514
- * Additional custom properties about the persona
10515
- */
10516
- properties: { [key: string]: unknown };
10517
-
10518
- /**
10519
- * Controls how quickly the persona responds to pauses in conversation (QUICK,
10520
- * NORMAL, RELAXED)
10521
- */
10522
- responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
10523
-
10524
- /**
10525
- * Speech clarity of the persona
10526
- */
10527
- speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
10528
-
10529
- /**
10530
- * Speech pace of the persona
10531
- */
10532
- speechPace: 'SUPER_SLOW' | 'SLOW' | 'NORMAL' | 'FAST' | 'SUPER_FAST';
10533
-
10534
- /**
10535
- * Languages the persona can understand. Multilingual combinations are limited by
10536
- * multilingual speech recognition support.
10537
- */
10538
- understoodLanguages: Array<
10539
- | 'EN'
10540
- | 'ES'
10541
- | 'DE'
10542
- | 'HI'
10543
- | 'FR'
10544
- | 'NL'
10545
- | 'AR'
10546
- | 'EL'
10547
- | 'IT'
10548
- | 'ID'
10549
- | 'TH'
10550
- | 'JA'
10551
- | 'TL'
10552
- | 'MS'
10553
- | 'ZH'
10554
- | 'TR'
10555
- | 'PT'
10556
- | 'HE'
10557
- >;
10558
-
10559
- /**
10560
- * Last update timestamp
10561
- */
10562
- updatedAt: string;
10563
-
10564
- /**
10565
- * Background story and behavioral patterns for the persona
10566
- */
10567
- backstoryPrompt?: string | null;
10568
-
10569
- /**
10570
- * Human-readable description of the persona
10571
- */
10572
- description?: string | null;
10573
-
10574
- /**
10575
- * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
10576
- */
10577
- secondaryLanguage?: 'EN' | null;
10578
- }
10579
- }
10580
- }
10581
- }
10582
-
10583
- export interface CustomerFlowUpdateHappyPathResponse {
10584
- /**
10585
- * One way of running a customer flow.
10586
- */
10587
- data:
10588
- | CustomerFlowUpdateHappyPathResponse.ScriptedFlowVariant
10589
- | CustomerFlowUpdateHappyPathResponse.ImprovFlowVariant
10590
- | CustomerFlowUpdateHappyPathResponse.VoicemailFlowVariant;
10591
- }
10592
-
10593
- export namespace CustomerFlowUpdateHappyPathResponse {
10594
- /**
10595
- * One path through a scripted flow. The path engine owns which paths exist, so
10596
- * editing the graph is what creates and removes these.
10597
- */
10598
- export interface ScriptedFlowVariant {
10599
- id: string;
10600
-
10601
- /**
10602
- * Graded on top of the flow's own expectations, for this variant only.
10603
- */
10604
- additionalExpectations: Array<ScriptedFlowVariant.AdditionalExpectation>;
10605
-
10606
- /**
10607
- * Creation timestamp in ISO 8601 format
10608
- */
10609
- createdAt: string;
10610
-
10611
- /**
10612
- * A simulation environment: the ambient conditions a customer flow variant runs
10613
- * under. The list includes both your own and the ones Roark curates for every
10614
- * project.
10615
- */
10616
- environment: ScriptedFlowVariant.Environment | null;
10617
-
10618
- isGenerated: boolean;
10619
-
10620
- /**
10621
- * The persona this runs as instead of the happy path's. Null means it inherits.
10622
- */
10623
- personaOverride: ScriptedFlowVariant.PersonaOverride | null;
10624
-
10625
- precededByCustomerFlowId: string | null;
10626
-
10627
- precededByCustomerFlowVariantId: string | null;
10628
-
10629
- /**
10630
- * The one path through the graph this variant runs, in order. Linear by
10631
- * construction, so these steps never nest.
10632
- */
10633
- steps: Array<CustomerFlowAPI.FlowStep>;
10634
-
10635
- title: string;
10636
-
10637
- type: 'SCRIPTED';
10638
-
10639
- /**
10640
- * Last update timestamp in ISO 8601 format
10641
- */
10642
- updatedAt: string;
10643
- }
10644
-
10645
- export namespace ScriptedFlowVariant {
10646
- /**
10647
- * One thing the agent under test is graded against.
10648
- */
10649
- export interface AdditionalExpectation {
10650
- id: string;
10651
-
10652
- /**
10653
- * What the agent under test is graded against.
10654
- */
10655
- prompt: string;
10656
- }
10657
-
10658
- /**
10659
- * A simulation environment: the ambient conditions a customer flow variant runs
10660
- * under. The list includes both your own and the ones Roark curates for every
10661
- * project.
10662
- */
10663
- export interface Environment {
10664
- id: string;
10665
-
10666
- backgroundNoise:
10667
- | 'NONE'
10668
- | 'AIRPORT'
10669
- | 'CHILDREN_PLAYING'
10670
- | 'CITY'
10671
- | 'COFFEE_SHOP'
10672
- | 'DRIVING'
10673
- | 'OFFICE'
10674
- | 'THUNDERSTORM';
10675
-
10676
- /**
10677
- * Creation timestamp in ISO 8601 format
10678
- */
10679
- createdAt: string;
10680
-
10681
- name: string;
10682
-
10683
- /**
10684
- * Last update timestamp in ISO 8601 format
10685
- */
10686
- updatedAt: string;
10687
-
10688
- description?: string | null;
10689
- }
10690
-
10691
- /**
10692
- * The persona this runs as instead of the happy path's. Null means it inherits.
10693
- */
10694
- export interface PersonaOverride {
10695
- /**
10696
- * Unique identifier of the persona
10697
- */
10698
- id: string;
10699
-
10700
- /**
10701
- * Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
10702
- * optional variants
9992
+ * Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
9993
+ * optional variants
10703
9994
  */
10704
9995
  accent:
10705
9996
  | 'US'
@@ -10726,6 +10017,12 @@ export namespace CustomerFlowUpdateHappyPathResponse {
10726
10017
  | 'PT'
10727
10018
  | 'IL';
10728
10019
 
10020
+ /**
10021
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
10022
+ * voice for are accepted; defaults to ADULT, which every accent supports.
10023
+ */
10024
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
10025
+
10729
10026
  /**
10730
10027
  * Background noise setting
10731
10028
  */
@@ -11024,6 +10321,12 @@ export namespace CustomerFlowUpdateHappyPathResponse {
11024
10321
  | 'PT'
11025
10322
  | 'IL';
11026
10323
 
10324
+ /**
10325
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
10326
+ * voice for are accepted; defaults to ADULT, which every accent supports.
10327
+ */
10328
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
10329
+
11027
10330
  /**
11028
10331
  * Background noise setting
11029
10332
  */
@@ -11317,6 +10620,12 @@ export namespace CustomerFlowUpdateHappyPathResponse {
11317
10620
  | 'PT'
11318
10621
  | 'IL';
11319
10622
 
10623
+ /**
10624
+ * How old the caller sounds and behaves. Only ages the persona's accent has a
10625
+ * voice for are accepted; defaults to ADULT, which every accent supports.
10626
+ */
10627
+ age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
10628
+
11320
10629
  /**
11321
10630
  * Background noise setting
11322
10631
  */