@roarkanalytics/sdk 5.7.0 → 5.9.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 (62) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/client.d.mts +9 -0
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +9 -0
  5. package/client.d.ts.map +1 -1
  6. package/client.js +9 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +9 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/analytics.d.mts +354 -0
  12. package/resources/analytics.d.mts.map +1 -0
  13. package/resources/analytics.d.ts +354 -0
  14. package/resources/analytics.d.ts.map +1 -0
  15. package/resources/analytics.js +55 -0
  16. package/resources/analytics.js.map +1 -0
  17. package/resources/analytics.mjs +51 -0
  18. package/resources/analytics.mjs.map +1 -0
  19. package/resources/config.d.mts +626 -14
  20. package/resources/config.d.mts.map +1 -1
  21. package/resources/config.d.ts +626 -14
  22. package/resources/config.d.ts.map +1 -1
  23. package/resources/dashboard.d.mts +2280 -0
  24. package/resources/dashboard.d.mts.map +1 -0
  25. package/resources/dashboard.d.ts +2280 -0
  26. package/resources/dashboard.d.ts.map +1 -0
  27. package/resources/dashboard.js +170 -0
  28. package/resources/dashboard.js.map +1 -0
  29. package/resources/dashboard.mjs +166 -0
  30. package/resources/dashboard.mjs.map +1 -0
  31. package/resources/index.d.mts +3 -0
  32. package/resources/index.d.mts.map +1 -1
  33. package/resources/index.d.ts +3 -0
  34. package/resources/index.d.ts.map +1 -1
  35. package/resources/index.js +7 -1
  36. package/resources/index.js.map +1 -1
  37. package/resources/index.mjs +3 -0
  38. package/resources/index.mjs.map +1 -1
  39. package/resources/metric-policy.d.mts +311 -2
  40. package/resources/metric-policy.d.mts.map +1 -1
  41. package/resources/metric-policy.d.ts +311 -2
  42. package/resources/metric-policy.d.ts.map +1 -1
  43. package/resources/usage.d.mts +114 -0
  44. package/resources/usage.d.mts.map +1 -0
  45. package/resources/usage.d.ts +114 -0
  46. package/resources/usage.d.ts.map +1 -0
  47. package/resources/usage.js +27 -0
  48. package/resources/usage.js.map +1 -0
  49. package/resources/usage.mjs +23 -0
  50. package/resources/usage.mjs.map +1 -0
  51. package/src/client.ts +63 -0
  52. package/src/resources/analytics.ts +573 -0
  53. package/src/resources/config.ts +1498 -26
  54. package/src/resources/dashboard.ts +3752 -0
  55. package/src/resources/index.ts +27 -0
  56. package/src/resources/metric-policy.ts +353 -2
  57. package/src/resources/usage.ts +147 -0
  58. package/src/version.ts +1 -1
  59. package/version.d.mts +1 -1
  60. package/version.d.ts +1 -1
  61. package/version.js +1 -1
  62. package/version.mjs +1 -1
@@ -56,6 +56,7 @@ export interface Bundle {
56
56
  | Bundle.SimulationGroupConfig
57
57
  | Bundle.AlertConfig
58
58
  | Bundle.ToolConfig
59
+ | Bundle.DashboardConfig
59
60
  | Bundle.ProjectConfig
60
61
  >;
61
62
 
@@ -338,7 +339,7 @@ export namespace Bundle {
338
339
  export interface CollectorConfig {
339
340
  kind: 'collector';
340
341
 
341
- metrics: Array<string>;
342
+ metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
342
343
 
343
344
  modality: 'call' | 'chat';
344
345
 
@@ -352,6 +353,18 @@ export namespace Bundle {
352
353
  }
353
354
 
354
355
  export namespace CollectorConfig {
356
+ export interface CollectorMetricConfig {
357
+ metric: string;
358
+
359
+ excludedPhrases?: Array<string>;
360
+
361
+ screeningBrief?: string;
362
+
363
+ verifiedProperties?: Array<string>;
364
+
365
+ voicemailScript?: string;
366
+ }
367
+
355
368
  export interface Filter {
356
369
  conditions: Array<Filter.Condition>;
357
370
  }
@@ -974,6 +987,238 @@ export namespace Bundle {
974
987
  parameters?: { [key: string]: 'string' | 'number' | 'boolean' };
975
988
  }
976
989
 
990
+ export interface DashboardConfig {
991
+ kind: 'dashboard';
992
+
993
+ name: string;
994
+
995
+ description?: string;
996
+
997
+ displayName?: string;
998
+
999
+ filters?: Array<DashboardConfig.Filter>;
1000
+
1001
+ isDefault?: boolean;
1002
+
1003
+ timeRange?:
1004
+ | DashboardConfig.UnionMember0
1005
+ | DashboardConfig.UnionMember1
1006
+ | DashboardConfig.UnionMember2
1007
+ | DashboardConfig.UnionMember3;
1008
+
1009
+ widgets?: Array<DashboardConfig.Widget>;
1010
+ }
1011
+
1012
+ export namespace DashboardConfig {
1013
+ export interface Filter {
1014
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
1015
+
1016
+ value: string | number | boolean;
1017
+
1018
+ operator?:
1019
+ | 'EQUALS'
1020
+ | 'NOT_EQUALS'
1021
+ | 'GREATER_THAN'
1022
+ | 'GREATER_THAN_OR_EQUAL_TO'
1023
+ | 'LESS_THAN'
1024
+ | 'LESS_THAN_OR_EQUAL_TO'
1025
+ | 'CONTAINS'
1026
+ | 'STARTS_WITH';
1027
+
1028
+ property?: string;
1029
+ }
1030
+
1031
+ export interface UnionMember0 {
1032
+ type: 'LAST';
1033
+
1034
+ unit: 'DAYS' | 'WEEKS' | 'MONTHS';
1035
+
1036
+ value: number;
1037
+ }
1038
+
1039
+ export interface UnionMember1 {
1040
+ period:
1041
+ | 'TODAY'
1042
+ | 'YESTERDAY'
1043
+ | 'THIS_WEEK'
1044
+ | 'LAST_WEEK'
1045
+ | 'THIS_MONTH'
1046
+ | 'LAST_MONTH'
1047
+ | 'THIS_YEAR'
1048
+ | 'LAST_YEAR';
1049
+
1050
+ type: 'CALENDAR_ALIGNED';
1051
+ }
1052
+
1053
+ export interface UnionMember2 {
1054
+ from: string;
1055
+
1056
+ to: string;
1057
+
1058
+ type: 'FIXED';
1059
+ }
1060
+
1061
+ export interface UnionMember3 {
1062
+ from: string;
1063
+
1064
+ type: 'SINCE';
1065
+ }
1066
+
1067
+ export interface Widget {
1068
+ measures: Array<Widget.Measure>;
1069
+
1070
+ name: string;
1071
+
1072
+ comparisonGroups?: Array<Widget.ComparisonGroup>;
1073
+
1074
+ comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
1075
+
1076
+ description?: string;
1077
+
1078
+ display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
1079
+
1080
+ filters?: Array<Widget.Filter>;
1081
+
1082
+ interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
1083
+
1084
+ size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
1085
+ }
1086
+
1087
+ export namespace Widget {
1088
+ export interface Measure {
1089
+ aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
1090
+
1091
+ breakdown?: Measure.Breakdown;
1092
+
1093
+ color?:
1094
+ | 'GREEN'
1095
+ | 'RED'
1096
+ | 'ORANGE'
1097
+ | 'PURPLE'
1098
+ | 'GREY'
1099
+ | 'BLUE'
1100
+ | 'PEACH'
1101
+ | 'TEAL'
1102
+ | 'INDIGO'
1103
+ | 'AMBER'
1104
+ | 'ROSE'
1105
+ | 'CYAN';
1106
+
1107
+ distinctBy?: 'NONE' | 'CALL';
1108
+
1109
+ filters?: Array<Measure.Filter>;
1110
+
1111
+ isBaseline?: boolean;
1112
+
1113
+ metric?: string;
1114
+
1115
+ nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
1116
+
1117
+ nestedAggregationPercentile?: number;
1118
+
1119
+ passOperator?:
1120
+ | 'EQUALS'
1121
+ | 'NOT_EQUALS'
1122
+ | 'GREATER_THAN'
1123
+ | 'GREATER_THAN_OR_EQUAL_TO'
1124
+ | 'LESS_THAN'
1125
+ | 'LESS_THAN_OR_EQUAL_TO'
1126
+ | 'CONTAINS'
1127
+ | 'STARTS_WITH';
1128
+
1129
+ passValue?: string | number | boolean;
1130
+
1131
+ percentile?: number;
1132
+
1133
+ type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
1134
+ }
1135
+
1136
+ export namespace Measure {
1137
+ export interface Breakdown {
1138
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
1139
+
1140
+ property?: string;
1141
+ }
1142
+
1143
+ export interface Filter {
1144
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
1145
+
1146
+ value: string | number | boolean;
1147
+
1148
+ operator?:
1149
+ | 'EQUALS'
1150
+ | 'NOT_EQUALS'
1151
+ | 'GREATER_THAN'
1152
+ | 'GREATER_THAN_OR_EQUAL_TO'
1153
+ | 'LESS_THAN'
1154
+ | 'LESS_THAN_OR_EQUAL_TO'
1155
+ | 'CONTAINS'
1156
+ | 'STARTS_WITH';
1157
+
1158
+ property?: string;
1159
+ }
1160
+ }
1161
+
1162
+ export interface ComparisonGroup {
1163
+ filters: Array<ComparisonGroup.Filter>;
1164
+
1165
+ name: string;
1166
+
1167
+ color?:
1168
+ | 'GREEN'
1169
+ | 'RED'
1170
+ | 'ORANGE'
1171
+ | 'PURPLE'
1172
+ | 'GREY'
1173
+ | 'BLUE'
1174
+ | 'PEACH'
1175
+ | 'TEAL'
1176
+ | 'INDIGO'
1177
+ | 'AMBER'
1178
+ | 'ROSE'
1179
+ | 'CYAN';
1180
+ }
1181
+
1182
+ export namespace ComparisonGroup {
1183
+ export interface Filter {
1184
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
1185
+
1186
+ value: string | number | boolean;
1187
+
1188
+ operator?:
1189
+ | 'EQUALS'
1190
+ | 'NOT_EQUALS'
1191
+ | 'GREATER_THAN'
1192
+ | 'GREATER_THAN_OR_EQUAL_TO'
1193
+ | 'LESS_THAN'
1194
+ | 'LESS_THAN_OR_EQUAL_TO'
1195
+ | 'CONTAINS'
1196
+ | 'STARTS_WITH';
1197
+
1198
+ property?: string;
1199
+ }
1200
+ }
1201
+
1202
+ export interface Filter {
1203
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
1204
+
1205
+ value: string | number | boolean;
1206
+
1207
+ operator?:
1208
+ | 'EQUALS'
1209
+ | 'NOT_EQUALS'
1210
+ | 'GREATER_THAN'
1211
+ | 'GREATER_THAN_OR_EQUAL_TO'
1212
+ | 'LESS_THAN'
1213
+ | 'LESS_THAN_OR_EQUAL_TO'
1214
+ | 'CONTAINS'
1215
+ | 'STARTS_WITH';
1216
+
1217
+ property?: string;
1218
+ }
1219
+ }
1220
+ }
1221
+
977
1222
  export interface ProjectConfig {
978
1223
  kind: 'project';
979
1224
 
@@ -1011,6 +1256,7 @@ export namespace Bundle {
1011
1256
  | ProjectConfig.SimulationGroupConfig
1012
1257
  | ProjectConfig.AlertConfig
1013
1258
  | ProjectConfig.ToolConfig
1259
+ | ProjectConfig.DashboardConfig
1014
1260
  >;
1015
1261
  }
1016
1262
 
@@ -1296,7 +1542,7 @@ export namespace Bundle {
1296
1542
  export interface CollectorConfig {
1297
1543
  kind: 'collector';
1298
1544
 
1299
- metrics: Array<string>;
1545
+ metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
1300
1546
 
1301
1547
  modality: 'call' | 'chat';
1302
1548
 
@@ -1310,6 +1556,18 @@ export namespace Bundle {
1310
1556
  }
1311
1557
 
1312
1558
  export namespace CollectorConfig {
1559
+ export interface CollectorMetricConfig {
1560
+ metric: string;
1561
+
1562
+ excludedPhrases?: Array<string>;
1563
+
1564
+ screeningBrief?: string;
1565
+
1566
+ verifiedProperties?: Array<string>;
1567
+
1568
+ voicemailScript?: string;
1569
+ }
1570
+
1313
1571
  export interface Filter {
1314
1572
  conditions: Array<Filter.Condition>;
1315
1573
  }
@@ -1931,6 +2189,238 @@ export namespace Bundle {
1931
2189
 
1932
2190
  parameters?: { [key: string]: 'string' | 'number' | 'boolean' };
1933
2191
  }
2192
+
2193
+ export interface DashboardConfig {
2194
+ kind: 'dashboard';
2195
+
2196
+ name: string;
2197
+
2198
+ description?: string;
2199
+
2200
+ displayName?: string;
2201
+
2202
+ filters?: Array<DashboardConfig.Filter>;
2203
+
2204
+ isDefault?: boolean;
2205
+
2206
+ timeRange?:
2207
+ | DashboardConfig.UnionMember0
2208
+ | DashboardConfig.UnionMember1
2209
+ | DashboardConfig.UnionMember2
2210
+ | DashboardConfig.UnionMember3;
2211
+
2212
+ widgets?: Array<DashboardConfig.Widget>;
2213
+ }
2214
+
2215
+ export namespace DashboardConfig {
2216
+ export interface Filter {
2217
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
2218
+
2219
+ value: string | number | boolean;
2220
+
2221
+ operator?:
2222
+ | 'EQUALS'
2223
+ | 'NOT_EQUALS'
2224
+ | 'GREATER_THAN'
2225
+ | 'GREATER_THAN_OR_EQUAL_TO'
2226
+ | 'LESS_THAN'
2227
+ | 'LESS_THAN_OR_EQUAL_TO'
2228
+ | 'CONTAINS'
2229
+ | 'STARTS_WITH';
2230
+
2231
+ property?: string;
2232
+ }
2233
+
2234
+ export interface UnionMember0 {
2235
+ type: 'LAST';
2236
+
2237
+ unit: 'DAYS' | 'WEEKS' | 'MONTHS';
2238
+
2239
+ value: number;
2240
+ }
2241
+
2242
+ export interface UnionMember1 {
2243
+ period:
2244
+ | 'TODAY'
2245
+ | 'YESTERDAY'
2246
+ | 'THIS_WEEK'
2247
+ | 'LAST_WEEK'
2248
+ | 'THIS_MONTH'
2249
+ | 'LAST_MONTH'
2250
+ | 'THIS_YEAR'
2251
+ | 'LAST_YEAR';
2252
+
2253
+ type: 'CALENDAR_ALIGNED';
2254
+ }
2255
+
2256
+ export interface UnionMember2 {
2257
+ from: string;
2258
+
2259
+ to: string;
2260
+
2261
+ type: 'FIXED';
2262
+ }
2263
+
2264
+ export interface UnionMember3 {
2265
+ from: string;
2266
+
2267
+ type: 'SINCE';
2268
+ }
2269
+
2270
+ export interface Widget {
2271
+ measures: Array<Widget.Measure>;
2272
+
2273
+ name: string;
2274
+
2275
+ comparisonGroups?: Array<Widget.ComparisonGroup>;
2276
+
2277
+ comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
2278
+
2279
+ description?: string;
2280
+
2281
+ display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
2282
+
2283
+ filters?: Array<Widget.Filter>;
2284
+
2285
+ interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
2286
+
2287
+ size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
2288
+ }
2289
+
2290
+ export namespace Widget {
2291
+ export interface Measure {
2292
+ aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
2293
+
2294
+ breakdown?: Measure.Breakdown;
2295
+
2296
+ color?:
2297
+ | 'GREEN'
2298
+ | 'RED'
2299
+ | 'ORANGE'
2300
+ | 'PURPLE'
2301
+ | 'GREY'
2302
+ | 'BLUE'
2303
+ | 'PEACH'
2304
+ | 'TEAL'
2305
+ | 'INDIGO'
2306
+ | 'AMBER'
2307
+ | 'ROSE'
2308
+ | 'CYAN';
2309
+
2310
+ distinctBy?: 'NONE' | 'CALL';
2311
+
2312
+ filters?: Array<Measure.Filter>;
2313
+
2314
+ isBaseline?: boolean;
2315
+
2316
+ metric?: string;
2317
+
2318
+ nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
2319
+
2320
+ nestedAggregationPercentile?: number;
2321
+
2322
+ passOperator?:
2323
+ | 'EQUALS'
2324
+ | 'NOT_EQUALS'
2325
+ | 'GREATER_THAN'
2326
+ | 'GREATER_THAN_OR_EQUAL_TO'
2327
+ | 'LESS_THAN'
2328
+ | 'LESS_THAN_OR_EQUAL_TO'
2329
+ | 'CONTAINS'
2330
+ | 'STARTS_WITH';
2331
+
2332
+ passValue?: string | number | boolean;
2333
+
2334
+ percentile?: number;
2335
+
2336
+ type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
2337
+ }
2338
+
2339
+ export namespace Measure {
2340
+ export interface Breakdown {
2341
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
2342
+
2343
+ property?: string;
2344
+ }
2345
+
2346
+ export interface Filter {
2347
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
2348
+
2349
+ value: string | number | boolean;
2350
+
2351
+ operator?:
2352
+ | 'EQUALS'
2353
+ | 'NOT_EQUALS'
2354
+ | 'GREATER_THAN'
2355
+ | 'GREATER_THAN_OR_EQUAL_TO'
2356
+ | 'LESS_THAN'
2357
+ | 'LESS_THAN_OR_EQUAL_TO'
2358
+ | 'CONTAINS'
2359
+ | 'STARTS_WITH';
2360
+
2361
+ property?: string;
2362
+ }
2363
+ }
2364
+
2365
+ export interface ComparisonGroup {
2366
+ filters: Array<ComparisonGroup.Filter>;
2367
+
2368
+ name: string;
2369
+
2370
+ color?:
2371
+ | 'GREEN'
2372
+ | 'RED'
2373
+ | 'ORANGE'
2374
+ | 'PURPLE'
2375
+ | 'GREY'
2376
+ | 'BLUE'
2377
+ | 'PEACH'
2378
+ | 'TEAL'
2379
+ | 'INDIGO'
2380
+ | 'AMBER'
2381
+ | 'ROSE'
2382
+ | 'CYAN';
2383
+ }
2384
+
2385
+ export namespace ComparisonGroup {
2386
+ export interface Filter {
2387
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
2388
+
2389
+ value: string | number | boolean;
2390
+
2391
+ operator?:
2392
+ | 'EQUALS'
2393
+ | 'NOT_EQUALS'
2394
+ | 'GREATER_THAN'
2395
+ | 'GREATER_THAN_OR_EQUAL_TO'
2396
+ | 'LESS_THAN'
2397
+ | 'LESS_THAN_OR_EQUAL_TO'
2398
+ | 'CONTAINS'
2399
+ | 'STARTS_WITH';
2400
+
2401
+ property?: string;
2402
+ }
2403
+ }
2404
+
2405
+ export interface Filter {
2406
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
2407
+
2408
+ value: string | number | boolean;
2409
+
2410
+ operator?:
2411
+ | 'EQUALS'
2412
+ | 'NOT_EQUALS'
2413
+ | 'GREATER_THAN'
2414
+ | 'GREATER_THAN_OR_EQUAL_TO'
2415
+ | 'LESS_THAN'
2416
+ | 'LESS_THAN_OR_EQUAL_TO'
2417
+ | 'CONTAINS'
2418
+ | 'STARTS_WITH';
2419
+
2420
+ property?: string;
2421
+ }
2422
+ }
2423
+ }
1934
2424
  }
1935
2425
  }
1936
2426
 
@@ -2021,6 +2511,7 @@ export namespace ConfigApplyResponse {
2021
2511
  | 'simulationGroup'
2022
2512
  | 'alert'
2023
2513
  | 'tool'
2514
+ | 'dashboard'
2024
2515
  | 'project'
2025
2516
  | 'member';
2026
2517
 
@@ -2081,6 +2572,7 @@ export namespace ConfigDiffResponse {
2081
2572
  | 'simulationGroup'
2082
2573
  | 'alert'
2083
2574
  | 'tool'
2575
+ | 'dashboard'
2084
2576
  | 'project'
2085
2577
  | 'member';
2086
2578
 
@@ -2119,6 +2611,7 @@ export interface ConfigApplyParams {
2119
2611
  | ConfigApplyParams.SimulationGroupConfig
2120
2612
  | ConfigApplyParams.AlertConfig
2121
2613
  | ConfigApplyParams.ToolConfig
2614
+ | ConfigApplyParams.DashboardConfig
2122
2615
  | ConfigApplyParams.ProjectConfig
2123
2616
  >;
2124
2617
 
@@ -2401,7 +2894,7 @@ export namespace ConfigApplyParams {
2401
2894
  export interface CollectorConfig {
2402
2895
  kind: 'collector';
2403
2896
 
2404
- metrics: Array<string>;
2897
+ metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
2405
2898
 
2406
2899
  modality: 'call' | 'chat';
2407
2900
 
@@ -2415,6 +2908,18 @@ export namespace ConfigApplyParams {
2415
2908
  }
2416
2909
 
2417
2910
  export namespace CollectorConfig {
2911
+ export interface CollectorMetricConfig {
2912
+ metric: string;
2913
+
2914
+ excludedPhrases?: Array<string>;
2915
+
2916
+ screeningBrief?: string;
2917
+
2918
+ verifiedProperties?: Array<string>;
2919
+
2920
+ voicemailScript?: string;
2921
+ }
2922
+
2418
2923
  export interface Filter {
2419
2924
  conditions: Array<Filter.Condition>;
2420
2925
  }
@@ -3037,34 +3542,266 @@ export namespace ConfigApplyParams {
3037
3542
  parameters?: { [key: string]: 'string' | 'number' | 'boolean' };
3038
3543
  }
3039
3544
 
3040
- export interface ProjectConfig {
3041
- kind: 'project';
3545
+ export interface DashboardConfig {
3546
+ kind: 'dashboard';
3042
3547
 
3043
3548
  name: string;
3044
3549
 
3045
- category?:
3046
- | 'HEALTHCARE'
3047
- | 'FINANCIAL'
3048
- | 'RETAIL'
3049
- | 'HOSPITALITY'
3050
- | 'AUTOMOTIVE'
3051
- | 'GOVERNMENT'
3052
- | 'EDUCATION'
3053
- | 'REAL_ESTATE'
3054
- | 'OTHER';
3055
-
3056
- dataStorageRegion?: 'US_EAST_1' | 'EU_WEST_1';
3057
-
3058
3550
  description?: string;
3059
3551
 
3060
3552
  displayName?: string;
3061
3553
 
3062
- members?: Array<ProjectConfig.Member>;
3554
+ filters?: Array<DashboardConfig.Filter>;
3063
3555
 
3064
- resources?: Array<
3065
- | ProjectConfig.AgentConfig
3066
- | ProjectConfig.HTTPRequestDefinitionConfig
3067
- | ProjectConfig.PersonaConfig
3556
+ isDefault?: boolean;
3557
+
3558
+ timeRange?:
3559
+ | DashboardConfig.UnionMember0
3560
+ | DashboardConfig.UnionMember1
3561
+ | DashboardConfig.UnionMember2
3562
+ | DashboardConfig.UnionMember3;
3563
+
3564
+ widgets?: Array<DashboardConfig.Widget>;
3565
+ }
3566
+
3567
+ export namespace DashboardConfig {
3568
+ export interface Filter {
3569
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
3570
+
3571
+ value: string | number | boolean;
3572
+
3573
+ operator?:
3574
+ | 'EQUALS'
3575
+ | 'NOT_EQUALS'
3576
+ | 'GREATER_THAN'
3577
+ | 'GREATER_THAN_OR_EQUAL_TO'
3578
+ | 'LESS_THAN'
3579
+ | 'LESS_THAN_OR_EQUAL_TO'
3580
+ | 'CONTAINS'
3581
+ | 'STARTS_WITH';
3582
+
3583
+ property?: string;
3584
+ }
3585
+
3586
+ export interface UnionMember0 {
3587
+ type: 'LAST';
3588
+
3589
+ unit: 'DAYS' | 'WEEKS' | 'MONTHS';
3590
+
3591
+ value: number;
3592
+ }
3593
+
3594
+ export interface UnionMember1 {
3595
+ period:
3596
+ | 'TODAY'
3597
+ | 'YESTERDAY'
3598
+ | 'THIS_WEEK'
3599
+ | 'LAST_WEEK'
3600
+ | 'THIS_MONTH'
3601
+ | 'LAST_MONTH'
3602
+ | 'THIS_YEAR'
3603
+ | 'LAST_YEAR';
3604
+
3605
+ type: 'CALENDAR_ALIGNED';
3606
+ }
3607
+
3608
+ export interface UnionMember2 {
3609
+ from: string;
3610
+
3611
+ to: string;
3612
+
3613
+ type: 'FIXED';
3614
+ }
3615
+
3616
+ export interface UnionMember3 {
3617
+ from: string;
3618
+
3619
+ type: 'SINCE';
3620
+ }
3621
+
3622
+ export interface Widget {
3623
+ measures: Array<Widget.Measure>;
3624
+
3625
+ name: string;
3626
+
3627
+ comparisonGroups?: Array<Widget.ComparisonGroup>;
3628
+
3629
+ comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
3630
+
3631
+ description?: string;
3632
+
3633
+ display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
3634
+
3635
+ filters?: Array<Widget.Filter>;
3636
+
3637
+ interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
3638
+
3639
+ size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
3640
+ }
3641
+
3642
+ export namespace Widget {
3643
+ export interface Measure {
3644
+ aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
3645
+
3646
+ breakdown?: Measure.Breakdown;
3647
+
3648
+ color?:
3649
+ | 'GREEN'
3650
+ | 'RED'
3651
+ | 'ORANGE'
3652
+ | 'PURPLE'
3653
+ | 'GREY'
3654
+ | 'BLUE'
3655
+ | 'PEACH'
3656
+ | 'TEAL'
3657
+ | 'INDIGO'
3658
+ | 'AMBER'
3659
+ | 'ROSE'
3660
+ | 'CYAN';
3661
+
3662
+ distinctBy?: 'NONE' | 'CALL';
3663
+
3664
+ filters?: Array<Measure.Filter>;
3665
+
3666
+ isBaseline?: boolean;
3667
+
3668
+ metric?: string;
3669
+
3670
+ nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
3671
+
3672
+ nestedAggregationPercentile?: number;
3673
+
3674
+ passOperator?:
3675
+ | 'EQUALS'
3676
+ | 'NOT_EQUALS'
3677
+ | 'GREATER_THAN'
3678
+ | 'GREATER_THAN_OR_EQUAL_TO'
3679
+ | 'LESS_THAN'
3680
+ | 'LESS_THAN_OR_EQUAL_TO'
3681
+ | 'CONTAINS'
3682
+ | 'STARTS_WITH';
3683
+
3684
+ passValue?: string | number | boolean;
3685
+
3686
+ percentile?: number;
3687
+
3688
+ type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
3689
+ }
3690
+
3691
+ export namespace Measure {
3692
+ export interface Breakdown {
3693
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
3694
+
3695
+ property?: string;
3696
+ }
3697
+
3698
+ export interface Filter {
3699
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
3700
+
3701
+ value: string | number | boolean;
3702
+
3703
+ operator?:
3704
+ | 'EQUALS'
3705
+ | 'NOT_EQUALS'
3706
+ | 'GREATER_THAN'
3707
+ | 'GREATER_THAN_OR_EQUAL_TO'
3708
+ | 'LESS_THAN'
3709
+ | 'LESS_THAN_OR_EQUAL_TO'
3710
+ | 'CONTAINS'
3711
+ | 'STARTS_WITH';
3712
+
3713
+ property?: string;
3714
+ }
3715
+ }
3716
+
3717
+ export interface ComparisonGroup {
3718
+ filters: Array<ComparisonGroup.Filter>;
3719
+
3720
+ name: string;
3721
+
3722
+ color?:
3723
+ | 'GREEN'
3724
+ | 'RED'
3725
+ | 'ORANGE'
3726
+ | 'PURPLE'
3727
+ | 'GREY'
3728
+ | 'BLUE'
3729
+ | 'PEACH'
3730
+ | 'TEAL'
3731
+ | 'INDIGO'
3732
+ | 'AMBER'
3733
+ | 'ROSE'
3734
+ | 'CYAN';
3735
+ }
3736
+
3737
+ export namespace ComparisonGroup {
3738
+ export interface Filter {
3739
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
3740
+
3741
+ value: string | number | boolean;
3742
+
3743
+ operator?:
3744
+ | 'EQUALS'
3745
+ | 'NOT_EQUALS'
3746
+ | 'GREATER_THAN'
3747
+ | 'GREATER_THAN_OR_EQUAL_TO'
3748
+ | 'LESS_THAN'
3749
+ | 'LESS_THAN_OR_EQUAL_TO'
3750
+ | 'CONTAINS'
3751
+ | 'STARTS_WITH';
3752
+
3753
+ property?: string;
3754
+ }
3755
+ }
3756
+
3757
+ export interface Filter {
3758
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
3759
+
3760
+ value: string | number | boolean;
3761
+
3762
+ operator?:
3763
+ | 'EQUALS'
3764
+ | 'NOT_EQUALS'
3765
+ | 'GREATER_THAN'
3766
+ | 'GREATER_THAN_OR_EQUAL_TO'
3767
+ | 'LESS_THAN'
3768
+ | 'LESS_THAN_OR_EQUAL_TO'
3769
+ | 'CONTAINS'
3770
+ | 'STARTS_WITH';
3771
+
3772
+ property?: string;
3773
+ }
3774
+ }
3775
+ }
3776
+
3777
+ export interface ProjectConfig {
3778
+ kind: 'project';
3779
+
3780
+ name: string;
3781
+
3782
+ category?:
3783
+ | 'HEALTHCARE'
3784
+ | 'FINANCIAL'
3785
+ | 'RETAIL'
3786
+ | 'HOSPITALITY'
3787
+ | 'AUTOMOTIVE'
3788
+ | 'GOVERNMENT'
3789
+ | 'EDUCATION'
3790
+ | 'REAL_ESTATE'
3791
+ | 'OTHER';
3792
+
3793
+ dataStorageRegion?: 'US_EAST_1' | 'EU_WEST_1';
3794
+
3795
+ description?: string;
3796
+
3797
+ displayName?: string;
3798
+
3799
+ members?: Array<ProjectConfig.Member>;
3800
+
3801
+ resources?: Array<
3802
+ | ProjectConfig.AgentConfig
3803
+ | ProjectConfig.HTTPRequestDefinitionConfig
3804
+ | ProjectConfig.PersonaConfig
3068
3805
  | ProjectConfig.ImprovFlowConfig
3069
3806
  | ProjectConfig.ScriptedFlowConfig
3070
3807
  | ProjectConfig.CollectorConfig
@@ -3074,6 +3811,7 @@ export namespace ConfigApplyParams {
3074
3811
  | ProjectConfig.SimulationGroupConfig
3075
3812
  | ProjectConfig.AlertConfig
3076
3813
  | ProjectConfig.ToolConfig
3814
+ | ProjectConfig.DashboardConfig
3077
3815
  >;
3078
3816
  }
3079
3817
 
@@ -3359,7 +4097,7 @@ export namespace ConfigApplyParams {
3359
4097
  export interface CollectorConfig {
3360
4098
  kind: 'collector';
3361
4099
 
3362
- metrics: Array<string>;
4100
+ metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
3363
4101
 
3364
4102
  modality: 'call' | 'chat';
3365
4103
 
@@ -3373,6 +4111,18 @@ export namespace ConfigApplyParams {
3373
4111
  }
3374
4112
 
3375
4113
  export namespace CollectorConfig {
4114
+ export interface CollectorMetricConfig {
4115
+ metric: string;
4116
+
4117
+ excludedPhrases?: Array<string>;
4118
+
4119
+ screeningBrief?: string;
4120
+
4121
+ verifiedProperties?: Array<string>;
4122
+
4123
+ voicemailScript?: string;
4124
+ }
4125
+
3376
4126
  export interface Filter {
3377
4127
  conditions: Array<Filter.Condition>;
3378
4128
  }
@@ -3994,6 +4744,238 @@ export namespace ConfigApplyParams {
3994
4744
 
3995
4745
  parameters?: { [key: string]: 'string' | 'number' | 'boolean' };
3996
4746
  }
4747
+
4748
+ export interface DashboardConfig {
4749
+ kind: 'dashboard';
4750
+
4751
+ name: string;
4752
+
4753
+ description?: string;
4754
+
4755
+ displayName?: string;
4756
+
4757
+ filters?: Array<DashboardConfig.Filter>;
4758
+
4759
+ isDefault?: boolean;
4760
+
4761
+ timeRange?:
4762
+ | DashboardConfig.UnionMember0
4763
+ | DashboardConfig.UnionMember1
4764
+ | DashboardConfig.UnionMember2
4765
+ | DashboardConfig.UnionMember3;
4766
+
4767
+ widgets?: Array<DashboardConfig.Widget>;
4768
+ }
4769
+
4770
+ export namespace DashboardConfig {
4771
+ export interface Filter {
4772
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
4773
+
4774
+ value: string | number | boolean;
4775
+
4776
+ operator?:
4777
+ | 'EQUALS'
4778
+ | 'NOT_EQUALS'
4779
+ | 'GREATER_THAN'
4780
+ | 'GREATER_THAN_OR_EQUAL_TO'
4781
+ | 'LESS_THAN'
4782
+ | 'LESS_THAN_OR_EQUAL_TO'
4783
+ | 'CONTAINS'
4784
+ | 'STARTS_WITH';
4785
+
4786
+ property?: string;
4787
+ }
4788
+
4789
+ export interface UnionMember0 {
4790
+ type: 'LAST';
4791
+
4792
+ unit: 'DAYS' | 'WEEKS' | 'MONTHS';
4793
+
4794
+ value: number;
4795
+ }
4796
+
4797
+ export interface UnionMember1 {
4798
+ period:
4799
+ | 'TODAY'
4800
+ | 'YESTERDAY'
4801
+ | 'THIS_WEEK'
4802
+ | 'LAST_WEEK'
4803
+ | 'THIS_MONTH'
4804
+ | 'LAST_MONTH'
4805
+ | 'THIS_YEAR'
4806
+ | 'LAST_YEAR';
4807
+
4808
+ type: 'CALENDAR_ALIGNED';
4809
+ }
4810
+
4811
+ export interface UnionMember2 {
4812
+ from: string;
4813
+
4814
+ to: string;
4815
+
4816
+ type: 'FIXED';
4817
+ }
4818
+
4819
+ export interface UnionMember3 {
4820
+ from: string;
4821
+
4822
+ type: 'SINCE';
4823
+ }
4824
+
4825
+ export interface Widget {
4826
+ measures: Array<Widget.Measure>;
4827
+
4828
+ name: string;
4829
+
4830
+ comparisonGroups?: Array<Widget.ComparisonGroup>;
4831
+
4832
+ comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
4833
+
4834
+ description?: string;
4835
+
4836
+ display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
4837
+
4838
+ filters?: Array<Widget.Filter>;
4839
+
4840
+ interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
4841
+
4842
+ size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
4843
+ }
4844
+
4845
+ export namespace Widget {
4846
+ export interface Measure {
4847
+ aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
4848
+
4849
+ breakdown?: Measure.Breakdown;
4850
+
4851
+ color?:
4852
+ | 'GREEN'
4853
+ | 'RED'
4854
+ | 'ORANGE'
4855
+ | 'PURPLE'
4856
+ | 'GREY'
4857
+ | 'BLUE'
4858
+ | 'PEACH'
4859
+ | 'TEAL'
4860
+ | 'INDIGO'
4861
+ | 'AMBER'
4862
+ | 'ROSE'
4863
+ | 'CYAN';
4864
+
4865
+ distinctBy?: 'NONE' | 'CALL';
4866
+
4867
+ filters?: Array<Measure.Filter>;
4868
+
4869
+ isBaseline?: boolean;
4870
+
4871
+ metric?: string;
4872
+
4873
+ nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
4874
+
4875
+ nestedAggregationPercentile?: number;
4876
+
4877
+ passOperator?:
4878
+ | 'EQUALS'
4879
+ | 'NOT_EQUALS'
4880
+ | 'GREATER_THAN'
4881
+ | 'GREATER_THAN_OR_EQUAL_TO'
4882
+ | 'LESS_THAN'
4883
+ | 'LESS_THAN_OR_EQUAL_TO'
4884
+ | 'CONTAINS'
4885
+ | 'STARTS_WITH';
4886
+
4887
+ passValue?: string | number | boolean;
4888
+
4889
+ percentile?: number;
4890
+
4891
+ type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
4892
+ }
4893
+
4894
+ export namespace Measure {
4895
+ export interface Breakdown {
4896
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
4897
+
4898
+ property?: string;
4899
+ }
4900
+
4901
+ export interface Filter {
4902
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
4903
+
4904
+ value: string | number | boolean;
4905
+
4906
+ operator?:
4907
+ | 'EQUALS'
4908
+ | 'NOT_EQUALS'
4909
+ | 'GREATER_THAN'
4910
+ | 'GREATER_THAN_OR_EQUAL_TO'
4911
+ | 'LESS_THAN'
4912
+ | 'LESS_THAN_OR_EQUAL_TO'
4913
+ | 'CONTAINS'
4914
+ | 'STARTS_WITH';
4915
+
4916
+ property?: string;
4917
+ }
4918
+ }
4919
+
4920
+ export interface ComparisonGroup {
4921
+ filters: Array<ComparisonGroup.Filter>;
4922
+
4923
+ name: string;
4924
+
4925
+ color?:
4926
+ | 'GREEN'
4927
+ | 'RED'
4928
+ | 'ORANGE'
4929
+ | 'PURPLE'
4930
+ | 'GREY'
4931
+ | 'BLUE'
4932
+ | 'PEACH'
4933
+ | 'TEAL'
4934
+ | 'INDIGO'
4935
+ | 'AMBER'
4936
+ | 'ROSE'
4937
+ | 'CYAN';
4938
+ }
4939
+
4940
+ export namespace ComparisonGroup {
4941
+ export interface Filter {
4942
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
4943
+
4944
+ value: string | number | boolean;
4945
+
4946
+ operator?:
4947
+ | 'EQUALS'
4948
+ | 'NOT_EQUALS'
4949
+ | 'GREATER_THAN'
4950
+ | 'GREATER_THAN_OR_EQUAL_TO'
4951
+ | 'LESS_THAN'
4952
+ | 'LESS_THAN_OR_EQUAL_TO'
4953
+ | 'CONTAINS'
4954
+ | 'STARTS_WITH';
4955
+
4956
+ property?: string;
4957
+ }
4958
+ }
4959
+
4960
+ export interface Filter {
4961
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
4962
+
4963
+ value: string | number | boolean;
4964
+
4965
+ operator?:
4966
+ | 'EQUALS'
4967
+ | 'NOT_EQUALS'
4968
+ | 'GREATER_THAN'
4969
+ | 'GREATER_THAN_OR_EQUAL_TO'
4970
+ | 'LESS_THAN'
4971
+ | 'LESS_THAN_OR_EQUAL_TO'
4972
+ | 'CONTAINS'
4973
+ | 'STARTS_WITH';
4974
+
4975
+ property?: string;
4976
+ }
4977
+ }
4978
+ }
3997
4979
  }
3998
4980
  }
3999
4981
 
@@ -4011,6 +4993,7 @@ export interface ConfigDiffParams {
4011
4993
  | ConfigDiffParams.SimulationGroupConfig
4012
4994
  | ConfigDiffParams.AlertConfig
4013
4995
  | ConfigDiffParams.ToolConfig
4996
+ | ConfigDiffParams.DashboardConfig
4014
4997
  | ConfigDiffParams.ProjectConfig
4015
4998
  >;
4016
4999
 
@@ -4293,7 +5276,7 @@ export namespace ConfigDiffParams {
4293
5276
  export interface CollectorConfig {
4294
5277
  kind: 'collector';
4295
5278
 
4296
- metrics: Array<string>;
5279
+ metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
4297
5280
 
4298
5281
  modality: 'call' | 'chat';
4299
5282
 
@@ -4307,6 +5290,18 @@ export namespace ConfigDiffParams {
4307
5290
  }
4308
5291
 
4309
5292
  export namespace CollectorConfig {
5293
+ export interface CollectorMetricConfig {
5294
+ metric: string;
5295
+
5296
+ excludedPhrases?: Array<string>;
5297
+
5298
+ screeningBrief?: string;
5299
+
5300
+ verifiedProperties?: Array<string>;
5301
+
5302
+ voicemailScript?: string;
5303
+ }
5304
+
4310
5305
  export interface Filter {
4311
5306
  conditions: Array<Filter.Condition>;
4312
5307
  }
@@ -4929,6 +5924,238 @@ export namespace ConfigDiffParams {
4929
5924
  parameters?: { [key: string]: 'string' | 'number' | 'boolean' };
4930
5925
  }
4931
5926
 
5927
+ export interface DashboardConfig {
5928
+ kind: 'dashboard';
5929
+
5930
+ name: string;
5931
+
5932
+ description?: string;
5933
+
5934
+ displayName?: string;
5935
+
5936
+ filters?: Array<DashboardConfig.Filter>;
5937
+
5938
+ isDefault?: boolean;
5939
+
5940
+ timeRange?:
5941
+ | DashboardConfig.UnionMember0
5942
+ | DashboardConfig.UnionMember1
5943
+ | DashboardConfig.UnionMember2
5944
+ | DashboardConfig.UnionMember3;
5945
+
5946
+ widgets?: Array<DashboardConfig.Widget>;
5947
+ }
5948
+
5949
+ export namespace DashboardConfig {
5950
+ export interface Filter {
5951
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
5952
+
5953
+ value: string | number | boolean;
5954
+
5955
+ operator?:
5956
+ | 'EQUALS'
5957
+ | 'NOT_EQUALS'
5958
+ | 'GREATER_THAN'
5959
+ | 'GREATER_THAN_OR_EQUAL_TO'
5960
+ | 'LESS_THAN'
5961
+ | 'LESS_THAN_OR_EQUAL_TO'
5962
+ | 'CONTAINS'
5963
+ | 'STARTS_WITH';
5964
+
5965
+ property?: string;
5966
+ }
5967
+
5968
+ export interface UnionMember0 {
5969
+ type: 'LAST';
5970
+
5971
+ unit: 'DAYS' | 'WEEKS' | 'MONTHS';
5972
+
5973
+ value: number;
5974
+ }
5975
+
5976
+ export interface UnionMember1 {
5977
+ period:
5978
+ | 'TODAY'
5979
+ | 'YESTERDAY'
5980
+ | 'THIS_WEEK'
5981
+ | 'LAST_WEEK'
5982
+ | 'THIS_MONTH'
5983
+ | 'LAST_MONTH'
5984
+ | 'THIS_YEAR'
5985
+ | 'LAST_YEAR';
5986
+
5987
+ type: 'CALENDAR_ALIGNED';
5988
+ }
5989
+
5990
+ export interface UnionMember2 {
5991
+ from: string;
5992
+
5993
+ to: string;
5994
+
5995
+ type: 'FIXED';
5996
+ }
5997
+
5998
+ export interface UnionMember3 {
5999
+ from: string;
6000
+
6001
+ type: 'SINCE';
6002
+ }
6003
+
6004
+ export interface Widget {
6005
+ measures: Array<Widget.Measure>;
6006
+
6007
+ name: string;
6008
+
6009
+ comparisonGroups?: Array<Widget.ComparisonGroup>;
6010
+
6011
+ comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
6012
+
6013
+ description?: string;
6014
+
6015
+ display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
6016
+
6017
+ filters?: Array<Widget.Filter>;
6018
+
6019
+ interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
6020
+
6021
+ size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
6022
+ }
6023
+
6024
+ export namespace Widget {
6025
+ export interface Measure {
6026
+ aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
6027
+
6028
+ breakdown?: Measure.Breakdown;
6029
+
6030
+ color?:
6031
+ | 'GREEN'
6032
+ | 'RED'
6033
+ | 'ORANGE'
6034
+ | 'PURPLE'
6035
+ | 'GREY'
6036
+ | 'BLUE'
6037
+ | 'PEACH'
6038
+ | 'TEAL'
6039
+ | 'INDIGO'
6040
+ | 'AMBER'
6041
+ | 'ROSE'
6042
+ | 'CYAN';
6043
+
6044
+ distinctBy?: 'NONE' | 'CALL';
6045
+
6046
+ filters?: Array<Measure.Filter>;
6047
+
6048
+ isBaseline?: boolean;
6049
+
6050
+ metric?: string;
6051
+
6052
+ nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
6053
+
6054
+ nestedAggregationPercentile?: number;
6055
+
6056
+ passOperator?:
6057
+ | 'EQUALS'
6058
+ | 'NOT_EQUALS'
6059
+ | 'GREATER_THAN'
6060
+ | 'GREATER_THAN_OR_EQUAL_TO'
6061
+ | 'LESS_THAN'
6062
+ | 'LESS_THAN_OR_EQUAL_TO'
6063
+ | 'CONTAINS'
6064
+ | 'STARTS_WITH';
6065
+
6066
+ passValue?: string | number | boolean;
6067
+
6068
+ percentile?: number;
6069
+
6070
+ type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
6071
+ }
6072
+
6073
+ export namespace Measure {
6074
+ export interface Breakdown {
6075
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
6076
+
6077
+ property?: string;
6078
+ }
6079
+
6080
+ export interface Filter {
6081
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
6082
+
6083
+ value: string | number | boolean;
6084
+
6085
+ operator?:
6086
+ | 'EQUALS'
6087
+ | 'NOT_EQUALS'
6088
+ | 'GREATER_THAN'
6089
+ | 'GREATER_THAN_OR_EQUAL_TO'
6090
+ | 'LESS_THAN'
6091
+ | 'LESS_THAN_OR_EQUAL_TO'
6092
+ | 'CONTAINS'
6093
+ | 'STARTS_WITH';
6094
+
6095
+ property?: string;
6096
+ }
6097
+ }
6098
+
6099
+ export interface ComparisonGroup {
6100
+ filters: Array<ComparisonGroup.Filter>;
6101
+
6102
+ name: string;
6103
+
6104
+ color?:
6105
+ | 'GREEN'
6106
+ | 'RED'
6107
+ | 'ORANGE'
6108
+ | 'PURPLE'
6109
+ | 'GREY'
6110
+ | 'BLUE'
6111
+ | 'PEACH'
6112
+ | 'TEAL'
6113
+ | 'INDIGO'
6114
+ | 'AMBER'
6115
+ | 'ROSE'
6116
+ | 'CYAN';
6117
+ }
6118
+
6119
+ export namespace ComparisonGroup {
6120
+ export interface Filter {
6121
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
6122
+
6123
+ value: string | number | boolean;
6124
+
6125
+ operator?:
6126
+ | 'EQUALS'
6127
+ | 'NOT_EQUALS'
6128
+ | 'GREATER_THAN'
6129
+ | 'GREATER_THAN_OR_EQUAL_TO'
6130
+ | 'LESS_THAN'
6131
+ | 'LESS_THAN_OR_EQUAL_TO'
6132
+ | 'CONTAINS'
6133
+ | 'STARTS_WITH';
6134
+
6135
+ property?: string;
6136
+ }
6137
+ }
6138
+
6139
+ export interface Filter {
6140
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
6141
+
6142
+ value: string | number | boolean;
6143
+
6144
+ operator?:
6145
+ | 'EQUALS'
6146
+ | 'NOT_EQUALS'
6147
+ | 'GREATER_THAN'
6148
+ | 'GREATER_THAN_OR_EQUAL_TO'
6149
+ | 'LESS_THAN'
6150
+ | 'LESS_THAN_OR_EQUAL_TO'
6151
+ | 'CONTAINS'
6152
+ | 'STARTS_WITH';
6153
+
6154
+ property?: string;
6155
+ }
6156
+ }
6157
+ }
6158
+
4932
6159
  export interface ProjectConfig {
4933
6160
  kind: 'project';
4934
6161
 
@@ -4966,6 +6193,7 @@ export namespace ConfigDiffParams {
4966
6193
  | ProjectConfig.SimulationGroupConfig
4967
6194
  | ProjectConfig.AlertConfig
4968
6195
  | ProjectConfig.ToolConfig
6196
+ | ProjectConfig.DashboardConfig
4969
6197
  >;
4970
6198
  }
4971
6199
 
@@ -5251,7 +6479,7 @@ export namespace ConfigDiffParams {
5251
6479
  export interface CollectorConfig {
5252
6480
  kind: 'collector';
5253
6481
 
5254
- metrics: Array<string>;
6482
+ metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
5255
6483
 
5256
6484
  modality: 'call' | 'chat';
5257
6485
 
@@ -5265,6 +6493,18 @@ export namespace ConfigDiffParams {
5265
6493
  }
5266
6494
 
5267
6495
  export namespace CollectorConfig {
6496
+ export interface CollectorMetricConfig {
6497
+ metric: string;
6498
+
6499
+ excludedPhrases?: Array<string>;
6500
+
6501
+ screeningBrief?: string;
6502
+
6503
+ verifiedProperties?: Array<string>;
6504
+
6505
+ voicemailScript?: string;
6506
+ }
6507
+
5268
6508
  export interface Filter {
5269
6509
  conditions: Array<Filter.Condition>;
5270
6510
  }
@@ -5886,6 +7126,238 @@ export namespace ConfigDiffParams {
5886
7126
 
5887
7127
  parameters?: { [key: string]: 'string' | 'number' | 'boolean' };
5888
7128
  }
7129
+
7130
+ export interface DashboardConfig {
7131
+ kind: 'dashboard';
7132
+
7133
+ name: string;
7134
+
7135
+ description?: string;
7136
+
7137
+ displayName?: string;
7138
+
7139
+ filters?: Array<DashboardConfig.Filter>;
7140
+
7141
+ isDefault?: boolean;
7142
+
7143
+ timeRange?:
7144
+ | DashboardConfig.UnionMember0
7145
+ | DashboardConfig.UnionMember1
7146
+ | DashboardConfig.UnionMember2
7147
+ | DashboardConfig.UnionMember3;
7148
+
7149
+ widgets?: Array<DashboardConfig.Widget>;
7150
+ }
7151
+
7152
+ export namespace DashboardConfig {
7153
+ export interface Filter {
7154
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
7155
+
7156
+ value: string | number | boolean;
7157
+
7158
+ operator?:
7159
+ | 'EQUALS'
7160
+ | 'NOT_EQUALS'
7161
+ | 'GREATER_THAN'
7162
+ | 'GREATER_THAN_OR_EQUAL_TO'
7163
+ | 'LESS_THAN'
7164
+ | 'LESS_THAN_OR_EQUAL_TO'
7165
+ | 'CONTAINS'
7166
+ | 'STARTS_WITH';
7167
+
7168
+ property?: string;
7169
+ }
7170
+
7171
+ export interface UnionMember0 {
7172
+ type: 'LAST';
7173
+
7174
+ unit: 'DAYS' | 'WEEKS' | 'MONTHS';
7175
+
7176
+ value: number;
7177
+ }
7178
+
7179
+ export interface UnionMember1 {
7180
+ period:
7181
+ | 'TODAY'
7182
+ | 'YESTERDAY'
7183
+ | 'THIS_WEEK'
7184
+ | 'LAST_WEEK'
7185
+ | 'THIS_MONTH'
7186
+ | 'LAST_MONTH'
7187
+ | 'THIS_YEAR'
7188
+ | 'LAST_YEAR';
7189
+
7190
+ type: 'CALENDAR_ALIGNED';
7191
+ }
7192
+
7193
+ export interface UnionMember2 {
7194
+ from: string;
7195
+
7196
+ to: string;
7197
+
7198
+ type: 'FIXED';
7199
+ }
7200
+
7201
+ export interface UnionMember3 {
7202
+ from: string;
7203
+
7204
+ type: 'SINCE';
7205
+ }
7206
+
7207
+ export interface Widget {
7208
+ measures: Array<Widget.Measure>;
7209
+
7210
+ name: string;
7211
+
7212
+ comparisonGroups?: Array<Widget.ComparisonGroup>;
7213
+
7214
+ comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
7215
+
7216
+ description?: string;
7217
+
7218
+ display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
7219
+
7220
+ filters?: Array<Widget.Filter>;
7221
+
7222
+ interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
7223
+
7224
+ size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
7225
+ }
7226
+
7227
+ export namespace Widget {
7228
+ export interface Measure {
7229
+ aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
7230
+
7231
+ breakdown?: Measure.Breakdown;
7232
+
7233
+ color?:
7234
+ | 'GREEN'
7235
+ | 'RED'
7236
+ | 'ORANGE'
7237
+ | 'PURPLE'
7238
+ | 'GREY'
7239
+ | 'BLUE'
7240
+ | 'PEACH'
7241
+ | 'TEAL'
7242
+ | 'INDIGO'
7243
+ | 'AMBER'
7244
+ | 'ROSE'
7245
+ | 'CYAN';
7246
+
7247
+ distinctBy?: 'NONE' | 'CALL';
7248
+
7249
+ filters?: Array<Measure.Filter>;
7250
+
7251
+ isBaseline?: boolean;
7252
+
7253
+ metric?: string;
7254
+
7255
+ nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
7256
+
7257
+ nestedAggregationPercentile?: number;
7258
+
7259
+ passOperator?:
7260
+ | 'EQUALS'
7261
+ | 'NOT_EQUALS'
7262
+ | 'GREATER_THAN'
7263
+ | 'GREATER_THAN_OR_EQUAL_TO'
7264
+ | 'LESS_THAN'
7265
+ | 'LESS_THAN_OR_EQUAL_TO'
7266
+ | 'CONTAINS'
7267
+ | 'STARTS_WITH';
7268
+
7269
+ passValue?: string | number | boolean;
7270
+
7271
+ percentile?: number;
7272
+
7273
+ type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
7274
+ }
7275
+
7276
+ export namespace Measure {
7277
+ export interface Breakdown {
7278
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
7279
+
7280
+ property?: string;
7281
+ }
7282
+
7283
+ export interface Filter {
7284
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
7285
+
7286
+ value: string | number | boolean;
7287
+
7288
+ operator?:
7289
+ | 'EQUALS'
7290
+ | 'NOT_EQUALS'
7291
+ | 'GREATER_THAN'
7292
+ | 'GREATER_THAN_OR_EQUAL_TO'
7293
+ | 'LESS_THAN'
7294
+ | 'LESS_THAN_OR_EQUAL_TO'
7295
+ | 'CONTAINS'
7296
+ | 'STARTS_WITH';
7297
+
7298
+ property?: string;
7299
+ }
7300
+ }
7301
+
7302
+ export interface ComparisonGroup {
7303
+ filters: Array<ComparisonGroup.Filter>;
7304
+
7305
+ name: string;
7306
+
7307
+ color?:
7308
+ | 'GREEN'
7309
+ | 'RED'
7310
+ | 'ORANGE'
7311
+ | 'PURPLE'
7312
+ | 'GREY'
7313
+ | 'BLUE'
7314
+ | 'PEACH'
7315
+ | 'TEAL'
7316
+ | 'INDIGO'
7317
+ | 'AMBER'
7318
+ | 'ROSE'
7319
+ | 'CYAN';
7320
+ }
7321
+
7322
+ export namespace ComparisonGroup {
7323
+ export interface Filter {
7324
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
7325
+
7326
+ value: string | number | boolean;
7327
+
7328
+ operator?:
7329
+ | 'EQUALS'
7330
+ | 'NOT_EQUALS'
7331
+ | 'GREATER_THAN'
7332
+ | 'GREATER_THAN_OR_EQUAL_TO'
7333
+ | 'LESS_THAN'
7334
+ | 'LESS_THAN_OR_EQUAL_TO'
7335
+ | 'CONTAINS'
7336
+ | 'STARTS_WITH';
7337
+
7338
+ property?: string;
7339
+ }
7340
+ }
7341
+
7342
+ export interface Filter {
7343
+ type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
7344
+
7345
+ value: string | number | boolean;
7346
+
7347
+ operator?:
7348
+ | 'EQUALS'
7349
+ | 'NOT_EQUALS'
7350
+ | 'GREATER_THAN'
7351
+ | 'GREATER_THAN_OR_EQUAL_TO'
7352
+ | 'LESS_THAN'
7353
+ | 'LESS_THAN_OR_EQUAL_TO'
7354
+ | 'CONTAINS'
7355
+ | 'STARTS_WITH';
7356
+
7357
+ property?: string;
7358
+ }
7359
+ }
7360
+ }
5889
7361
  }
5890
7362
  }
5891
7363