@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.
- package/CHANGELOG.md +26 -0
- package/client.d.mts +9 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +9 -0
- package/client.d.ts.map +1 -1
- package/client.js +9 -0
- package/client.js.map +1 -1
- package/client.mjs +9 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/analytics.d.mts +354 -0
- package/resources/analytics.d.mts.map +1 -0
- package/resources/analytics.d.ts +354 -0
- package/resources/analytics.d.ts.map +1 -0
- package/resources/analytics.js +55 -0
- package/resources/analytics.js.map +1 -0
- package/resources/analytics.mjs +51 -0
- package/resources/analytics.mjs.map +1 -0
- package/resources/config.d.mts +626 -14
- package/resources/config.d.mts.map +1 -1
- package/resources/config.d.ts +626 -14
- package/resources/config.d.ts.map +1 -1
- package/resources/dashboard.d.mts +2280 -0
- package/resources/dashboard.d.mts.map +1 -0
- package/resources/dashboard.d.ts +2280 -0
- package/resources/dashboard.d.ts.map +1 -0
- package/resources/dashboard.js +170 -0
- package/resources/dashboard.js.map +1 -0
- package/resources/dashboard.mjs +166 -0
- package/resources/dashboard.mjs.map +1 -0
- package/resources/index.d.mts +3 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +7 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -0
- package/resources/index.mjs.map +1 -1
- package/resources/metric-policy.d.mts +311 -2
- package/resources/metric-policy.d.mts.map +1 -1
- package/resources/metric-policy.d.ts +311 -2
- package/resources/metric-policy.d.ts.map +1 -1
- package/resources/usage.d.mts +114 -0
- package/resources/usage.d.mts.map +1 -0
- package/resources/usage.d.ts +114 -0
- package/resources/usage.d.ts.map +1 -0
- package/resources/usage.js +27 -0
- package/resources/usage.js.map +1 -0
- package/resources/usage.mjs +23 -0
- package/resources/usage.mjs.map +1 -0
- package/src/client.ts +63 -0
- package/src/resources/analytics.ts +573 -0
- package/src/resources/config.ts +1498 -26
- package/src/resources/dashboard.ts +3752 -0
- package/src/resources/index.ts +27 -0
- package/src/resources/metric-policy.ts +353 -2
- package/src/resources/usage.ts +147 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/config.d.ts
CHANGED
|
@@ -34,7 +34,7 @@ export declare class Config extends APIResource {
|
|
|
34
34
|
diff(body: ConfigDiffParams, options?: RequestOptions): APIPromise<ConfigDiffResponse>;
|
|
35
35
|
}
|
|
36
36
|
export interface Bundle {
|
|
37
|
-
resources: Array<Bundle.AgentConfig | Bundle.HTTPRequestDefinitionConfig | Bundle.PersonaConfig | Bundle.ImprovFlowConfig | Bundle.ScriptedFlowConfig | Bundle.CollectorConfig | Bundle.MetricConfig | Bundle.SimulationPlanConfig | Bundle.QaSimulationPlanConfig | Bundle.SimulationGroupConfig | Bundle.AlertConfig | Bundle.ToolConfig | Bundle.ProjectConfig>;
|
|
37
|
+
resources: Array<Bundle.AgentConfig | Bundle.HTTPRequestDefinitionConfig | Bundle.PersonaConfig | Bundle.ImprovFlowConfig | Bundle.ScriptedFlowConfig | Bundle.CollectorConfig | Bundle.MetricConfig | Bundle.SimulationPlanConfig | Bundle.QaSimulationPlanConfig | Bundle.SimulationGroupConfig | Bundle.AlertConfig | Bundle.ToolConfig | Bundle.DashboardConfig | Bundle.ProjectConfig>;
|
|
38
38
|
prune?: boolean;
|
|
39
39
|
}
|
|
40
40
|
export declare namespace Bundle {
|
|
@@ -151,7 +151,7 @@ export declare namespace Bundle {
|
|
|
151
151
|
}
|
|
152
152
|
interface CollectorConfig {
|
|
153
153
|
kind: 'collector';
|
|
154
|
-
metrics: Array<string>;
|
|
154
|
+
metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
|
|
155
155
|
modality: 'call' | 'chat';
|
|
156
156
|
name: string;
|
|
157
157
|
displayName?: string;
|
|
@@ -159,6 +159,13 @@ export declare namespace Bundle {
|
|
|
159
159
|
status?: 'ACTIVE' | 'INACTIVE';
|
|
160
160
|
}
|
|
161
161
|
namespace CollectorConfig {
|
|
162
|
+
interface CollectorMetricConfig {
|
|
163
|
+
metric: string;
|
|
164
|
+
excludedPhrases?: Array<string>;
|
|
165
|
+
screeningBrief?: string;
|
|
166
|
+
verifiedProperties?: Array<string>;
|
|
167
|
+
voicemailScript?: string;
|
|
168
|
+
}
|
|
162
169
|
interface Filter {
|
|
163
170
|
conditions: Array<Filter.Condition>;
|
|
164
171
|
}
|
|
@@ -496,6 +503,101 @@ export declare namespace Bundle {
|
|
|
496
503
|
[key: string]: 'string' | 'number' | 'boolean';
|
|
497
504
|
};
|
|
498
505
|
}
|
|
506
|
+
interface DashboardConfig {
|
|
507
|
+
kind: 'dashboard';
|
|
508
|
+
name: string;
|
|
509
|
+
description?: string;
|
|
510
|
+
displayName?: string;
|
|
511
|
+
filters?: Array<DashboardConfig.Filter>;
|
|
512
|
+
isDefault?: boolean;
|
|
513
|
+
timeRange?: DashboardConfig.UnionMember0 | DashboardConfig.UnionMember1 | DashboardConfig.UnionMember2 | DashboardConfig.UnionMember3;
|
|
514
|
+
widgets?: Array<DashboardConfig.Widget>;
|
|
515
|
+
}
|
|
516
|
+
namespace DashboardConfig {
|
|
517
|
+
interface Filter {
|
|
518
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
519
|
+
value: string | number | boolean;
|
|
520
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
521
|
+
property?: string;
|
|
522
|
+
}
|
|
523
|
+
interface UnionMember0 {
|
|
524
|
+
type: 'LAST';
|
|
525
|
+
unit: 'DAYS' | 'WEEKS' | 'MONTHS';
|
|
526
|
+
value: number;
|
|
527
|
+
}
|
|
528
|
+
interface UnionMember1 {
|
|
529
|
+
period: 'TODAY' | 'YESTERDAY' | 'THIS_WEEK' | 'LAST_WEEK' | 'THIS_MONTH' | 'LAST_MONTH' | 'THIS_YEAR' | 'LAST_YEAR';
|
|
530
|
+
type: 'CALENDAR_ALIGNED';
|
|
531
|
+
}
|
|
532
|
+
interface UnionMember2 {
|
|
533
|
+
from: string;
|
|
534
|
+
to: string;
|
|
535
|
+
type: 'FIXED';
|
|
536
|
+
}
|
|
537
|
+
interface UnionMember3 {
|
|
538
|
+
from: string;
|
|
539
|
+
type: 'SINCE';
|
|
540
|
+
}
|
|
541
|
+
interface Widget {
|
|
542
|
+
measures: Array<Widget.Measure>;
|
|
543
|
+
name: string;
|
|
544
|
+
comparisonGroups?: Array<Widget.ComparisonGroup>;
|
|
545
|
+
comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
|
|
546
|
+
description?: string;
|
|
547
|
+
display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
|
|
548
|
+
filters?: Array<Widget.Filter>;
|
|
549
|
+
interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
|
|
550
|
+
size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
|
|
551
|
+
}
|
|
552
|
+
namespace Widget {
|
|
553
|
+
interface Measure {
|
|
554
|
+
aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
555
|
+
breakdown?: Measure.Breakdown;
|
|
556
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
557
|
+
distinctBy?: 'NONE' | 'CALL';
|
|
558
|
+
filters?: Array<Measure.Filter>;
|
|
559
|
+
isBaseline?: boolean;
|
|
560
|
+
metric?: string;
|
|
561
|
+
nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
562
|
+
nestedAggregationPercentile?: number;
|
|
563
|
+
passOperator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
564
|
+
passValue?: string | number | boolean;
|
|
565
|
+
percentile?: number;
|
|
566
|
+
type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
|
|
567
|
+
}
|
|
568
|
+
namespace Measure {
|
|
569
|
+
interface Breakdown {
|
|
570
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
|
|
571
|
+
property?: string;
|
|
572
|
+
}
|
|
573
|
+
interface Filter {
|
|
574
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
575
|
+
value: string | number | boolean;
|
|
576
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
577
|
+
property?: string;
|
|
578
|
+
}
|
|
579
|
+
}
|
|
580
|
+
interface ComparisonGroup {
|
|
581
|
+
filters: Array<ComparisonGroup.Filter>;
|
|
582
|
+
name: string;
|
|
583
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
584
|
+
}
|
|
585
|
+
namespace ComparisonGroup {
|
|
586
|
+
interface Filter {
|
|
587
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
588
|
+
value: string | number | boolean;
|
|
589
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
590
|
+
property?: string;
|
|
591
|
+
}
|
|
592
|
+
}
|
|
593
|
+
interface Filter {
|
|
594
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
595
|
+
value: string | number | boolean;
|
|
596
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
597
|
+
property?: string;
|
|
598
|
+
}
|
|
599
|
+
}
|
|
600
|
+
}
|
|
499
601
|
interface ProjectConfig {
|
|
500
602
|
kind: 'project';
|
|
501
603
|
name: string;
|
|
@@ -504,7 +606,7 @@ export declare namespace Bundle {
|
|
|
504
606
|
description?: string;
|
|
505
607
|
displayName?: string;
|
|
506
608
|
members?: Array<ProjectConfig.Member>;
|
|
507
|
-
resources?: Array<ProjectConfig.AgentConfig | ProjectConfig.HTTPRequestDefinitionConfig | ProjectConfig.PersonaConfig | ProjectConfig.ImprovFlowConfig | ProjectConfig.ScriptedFlowConfig | ProjectConfig.CollectorConfig | ProjectConfig.MetricConfig | ProjectConfig.SimulationPlanConfig | ProjectConfig.QaSimulationPlanConfig | ProjectConfig.SimulationGroupConfig | ProjectConfig.AlertConfig | ProjectConfig.ToolConfig>;
|
|
609
|
+
resources?: Array<ProjectConfig.AgentConfig | ProjectConfig.HTTPRequestDefinitionConfig | ProjectConfig.PersonaConfig | ProjectConfig.ImprovFlowConfig | ProjectConfig.ScriptedFlowConfig | ProjectConfig.CollectorConfig | ProjectConfig.MetricConfig | ProjectConfig.SimulationPlanConfig | ProjectConfig.QaSimulationPlanConfig | ProjectConfig.SimulationGroupConfig | ProjectConfig.AlertConfig | ProjectConfig.ToolConfig | ProjectConfig.DashboardConfig>;
|
|
508
610
|
}
|
|
509
611
|
namespace ProjectConfig {
|
|
510
612
|
interface Member {
|
|
@@ -624,7 +726,7 @@ export declare namespace Bundle {
|
|
|
624
726
|
}
|
|
625
727
|
interface CollectorConfig {
|
|
626
728
|
kind: 'collector';
|
|
627
|
-
metrics: Array<string>;
|
|
729
|
+
metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
|
|
628
730
|
modality: 'call' | 'chat';
|
|
629
731
|
name: string;
|
|
630
732
|
displayName?: string;
|
|
@@ -632,6 +734,13 @@ export declare namespace Bundle {
|
|
|
632
734
|
status?: 'ACTIVE' | 'INACTIVE';
|
|
633
735
|
}
|
|
634
736
|
namespace CollectorConfig {
|
|
737
|
+
interface CollectorMetricConfig {
|
|
738
|
+
metric: string;
|
|
739
|
+
excludedPhrases?: Array<string>;
|
|
740
|
+
screeningBrief?: string;
|
|
741
|
+
verifiedProperties?: Array<string>;
|
|
742
|
+
voicemailScript?: string;
|
|
743
|
+
}
|
|
635
744
|
interface Filter {
|
|
636
745
|
conditions: Array<Filter.Condition>;
|
|
637
746
|
}
|
|
@@ -969,6 +1078,101 @@ export declare namespace Bundle {
|
|
|
969
1078
|
[key: string]: 'string' | 'number' | 'boolean';
|
|
970
1079
|
};
|
|
971
1080
|
}
|
|
1081
|
+
interface DashboardConfig {
|
|
1082
|
+
kind: 'dashboard';
|
|
1083
|
+
name: string;
|
|
1084
|
+
description?: string;
|
|
1085
|
+
displayName?: string;
|
|
1086
|
+
filters?: Array<DashboardConfig.Filter>;
|
|
1087
|
+
isDefault?: boolean;
|
|
1088
|
+
timeRange?: DashboardConfig.UnionMember0 | DashboardConfig.UnionMember1 | DashboardConfig.UnionMember2 | DashboardConfig.UnionMember3;
|
|
1089
|
+
widgets?: Array<DashboardConfig.Widget>;
|
|
1090
|
+
}
|
|
1091
|
+
namespace DashboardConfig {
|
|
1092
|
+
interface Filter {
|
|
1093
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
1094
|
+
value: string | number | boolean;
|
|
1095
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
1096
|
+
property?: string;
|
|
1097
|
+
}
|
|
1098
|
+
interface UnionMember0 {
|
|
1099
|
+
type: 'LAST';
|
|
1100
|
+
unit: 'DAYS' | 'WEEKS' | 'MONTHS';
|
|
1101
|
+
value: number;
|
|
1102
|
+
}
|
|
1103
|
+
interface UnionMember1 {
|
|
1104
|
+
period: 'TODAY' | 'YESTERDAY' | 'THIS_WEEK' | 'LAST_WEEK' | 'THIS_MONTH' | 'LAST_MONTH' | 'THIS_YEAR' | 'LAST_YEAR';
|
|
1105
|
+
type: 'CALENDAR_ALIGNED';
|
|
1106
|
+
}
|
|
1107
|
+
interface UnionMember2 {
|
|
1108
|
+
from: string;
|
|
1109
|
+
to: string;
|
|
1110
|
+
type: 'FIXED';
|
|
1111
|
+
}
|
|
1112
|
+
interface UnionMember3 {
|
|
1113
|
+
from: string;
|
|
1114
|
+
type: 'SINCE';
|
|
1115
|
+
}
|
|
1116
|
+
interface Widget {
|
|
1117
|
+
measures: Array<Widget.Measure>;
|
|
1118
|
+
name: string;
|
|
1119
|
+
comparisonGroups?: Array<Widget.ComparisonGroup>;
|
|
1120
|
+
comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
|
|
1121
|
+
description?: string;
|
|
1122
|
+
display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
|
|
1123
|
+
filters?: Array<Widget.Filter>;
|
|
1124
|
+
interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
|
|
1125
|
+
size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
|
|
1126
|
+
}
|
|
1127
|
+
namespace Widget {
|
|
1128
|
+
interface Measure {
|
|
1129
|
+
aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
1130
|
+
breakdown?: Measure.Breakdown;
|
|
1131
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
1132
|
+
distinctBy?: 'NONE' | 'CALL';
|
|
1133
|
+
filters?: Array<Measure.Filter>;
|
|
1134
|
+
isBaseline?: boolean;
|
|
1135
|
+
metric?: string;
|
|
1136
|
+
nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
1137
|
+
nestedAggregationPercentile?: number;
|
|
1138
|
+
passOperator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
1139
|
+
passValue?: string | number | boolean;
|
|
1140
|
+
percentile?: number;
|
|
1141
|
+
type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
|
|
1142
|
+
}
|
|
1143
|
+
namespace Measure {
|
|
1144
|
+
interface Breakdown {
|
|
1145
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
|
|
1146
|
+
property?: string;
|
|
1147
|
+
}
|
|
1148
|
+
interface Filter {
|
|
1149
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
1150
|
+
value: string | number | boolean;
|
|
1151
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
1152
|
+
property?: string;
|
|
1153
|
+
}
|
|
1154
|
+
}
|
|
1155
|
+
interface ComparisonGroup {
|
|
1156
|
+
filters: Array<ComparisonGroup.Filter>;
|
|
1157
|
+
name: string;
|
|
1158
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
1159
|
+
}
|
|
1160
|
+
namespace ComparisonGroup {
|
|
1161
|
+
interface Filter {
|
|
1162
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
1163
|
+
value: string | number | boolean;
|
|
1164
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
1165
|
+
property?: string;
|
|
1166
|
+
}
|
|
1167
|
+
}
|
|
1168
|
+
interface Filter {
|
|
1169
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
1170
|
+
value: string | number | boolean;
|
|
1171
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
1172
|
+
property?: string;
|
|
1173
|
+
}
|
|
1174
|
+
}
|
|
1175
|
+
}
|
|
972
1176
|
}
|
|
973
1177
|
}
|
|
974
1178
|
export interface ConfigFlowStep {
|
|
@@ -1013,7 +1217,7 @@ export declare namespace ConfigApplyResponse {
|
|
|
1013
1217
|
namespace Data {
|
|
1014
1218
|
interface Change {
|
|
1015
1219
|
configKey: string;
|
|
1016
|
-
kind: 'agent' | 'persona' | 'httpRequestDefinition' | 'flow' | 'collector' | 'metric' | 'simulationPlan' | 'simulationGroup' | 'alert' | 'tool' | 'project' | 'member';
|
|
1220
|
+
kind: 'agent' | 'persona' | 'httpRequestDefinition' | 'flow' | 'collector' | 'metric' | 'simulationPlan' | 'simulationGroup' | 'alert' | 'tool' | 'dashboard' | 'project' | 'member';
|
|
1017
1221
|
name: string;
|
|
1018
1222
|
op: 'create' | 'update' | 'delete' | 'noop';
|
|
1019
1223
|
status: 'applied' | 'skipped' | 'failed';
|
|
@@ -1043,7 +1247,7 @@ export declare namespace ConfigDiffResponse {
|
|
|
1043
1247
|
namespace Data {
|
|
1044
1248
|
interface Change {
|
|
1045
1249
|
configKey: string;
|
|
1046
|
-
kind: 'agent' | 'persona' | 'httpRequestDefinition' | 'flow' | 'collector' | 'metric' | 'simulationPlan' | 'simulationGroup' | 'alert' | 'tool' | 'project' | 'member';
|
|
1250
|
+
kind: 'agent' | 'persona' | 'httpRequestDefinition' | 'flow' | 'collector' | 'metric' | 'simulationPlan' | 'simulationGroup' | 'alert' | 'tool' | 'dashboard' | 'project' | 'member';
|
|
1047
1251
|
name: string;
|
|
1048
1252
|
op: 'create' | 'update' | 'delete' | 'noop';
|
|
1049
1253
|
detail?: string;
|
|
@@ -1058,7 +1262,7 @@ export declare namespace ConfigDiffResponse {
|
|
|
1058
1262
|
}
|
|
1059
1263
|
}
|
|
1060
1264
|
export interface ConfigApplyParams {
|
|
1061
|
-
resources: Array<ConfigApplyParams.AgentConfig | ConfigApplyParams.HTTPRequestDefinitionConfig | ConfigApplyParams.PersonaConfig | ConfigApplyParams.ImprovFlowConfig | ConfigApplyParams.ScriptedFlowConfig | ConfigApplyParams.CollectorConfig | ConfigApplyParams.MetricConfig | ConfigApplyParams.SimulationPlanConfig | ConfigApplyParams.QaSimulationPlanConfig | ConfigApplyParams.SimulationGroupConfig | ConfigApplyParams.AlertConfig | ConfigApplyParams.ToolConfig | ConfigApplyParams.ProjectConfig>;
|
|
1265
|
+
resources: Array<ConfigApplyParams.AgentConfig | ConfigApplyParams.HTTPRequestDefinitionConfig | ConfigApplyParams.PersonaConfig | ConfigApplyParams.ImprovFlowConfig | ConfigApplyParams.ScriptedFlowConfig | ConfigApplyParams.CollectorConfig | ConfigApplyParams.MetricConfig | ConfigApplyParams.SimulationPlanConfig | ConfigApplyParams.QaSimulationPlanConfig | ConfigApplyParams.SimulationGroupConfig | ConfigApplyParams.AlertConfig | ConfigApplyParams.ToolConfig | ConfigApplyParams.DashboardConfig | ConfigApplyParams.ProjectConfig>;
|
|
1062
1266
|
prune?: boolean;
|
|
1063
1267
|
}
|
|
1064
1268
|
export declare namespace ConfigApplyParams {
|
|
@@ -1175,7 +1379,7 @@ export declare namespace ConfigApplyParams {
|
|
|
1175
1379
|
}
|
|
1176
1380
|
interface CollectorConfig {
|
|
1177
1381
|
kind: 'collector';
|
|
1178
|
-
metrics: Array<string>;
|
|
1382
|
+
metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
|
|
1179
1383
|
modality: 'call' | 'chat';
|
|
1180
1384
|
name: string;
|
|
1181
1385
|
displayName?: string;
|
|
@@ -1183,6 +1387,13 @@ export declare namespace ConfigApplyParams {
|
|
|
1183
1387
|
status?: 'ACTIVE' | 'INACTIVE';
|
|
1184
1388
|
}
|
|
1185
1389
|
namespace CollectorConfig {
|
|
1390
|
+
interface CollectorMetricConfig {
|
|
1391
|
+
metric: string;
|
|
1392
|
+
excludedPhrases?: Array<string>;
|
|
1393
|
+
screeningBrief?: string;
|
|
1394
|
+
verifiedProperties?: Array<string>;
|
|
1395
|
+
voicemailScript?: string;
|
|
1396
|
+
}
|
|
1186
1397
|
interface Filter {
|
|
1187
1398
|
conditions: Array<Filter.Condition>;
|
|
1188
1399
|
}
|
|
@@ -1520,6 +1731,101 @@ export declare namespace ConfigApplyParams {
|
|
|
1520
1731
|
[key: string]: 'string' | 'number' | 'boolean';
|
|
1521
1732
|
};
|
|
1522
1733
|
}
|
|
1734
|
+
interface DashboardConfig {
|
|
1735
|
+
kind: 'dashboard';
|
|
1736
|
+
name: string;
|
|
1737
|
+
description?: string;
|
|
1738
|
+
displayName?: string;
|
|
1739
|
+
filters?: Array<DashboardConfig.Filter>;
|
|
1740
|
+
isDefault?: boolean;
|
|
1741
|
+
timeRange?: DashboardConfig.UnionMember0 | DashboardConfig.UnionMember1 | DashboardConfig.UnionMember2 | DashboardConfig.UnionMember3;
|
|
1742
|
+
widgets?: Array<DashboardConfig.Widget>;
|
|
1743
|
+
}
|
|
1744
|
+
namespace DashboardConfig {
|
|
1745
|
+
interface Filter {
|
|
1746
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
1747
|
+
value: string | number | boolean;
|
|
1748
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
1749
|
+
property?: string;
|
|
1750
|
+
}
|
|
1751
|
+
interface UnionMember0 {
|
|
1752
|
+
type: 'LAST';
|
|
1753
|
+
unit: 'DAYS' | 'WEEKS' | 'MONTHS';
|
|
1754
|
+
value: number;
|
|
1755
|
+
}
|
|
1756
|
+
interface UnionMember1 {
|
|
1757
|
+
period: 'TODAY' | 'YESTERDAY' | 'THIS_WEEK' | 'LAST_WEEK' | 'THIS_MONTH' | 'LAST_MONTH' | 'THIS_YEAR' | 'LAST_YEAR';
|
|
1758
|
+
type: 'CALENDAR_ALIGNED';
|
|
1759
|
+
}
|
|
1760
|
+
interface UnionMember2 {
|
|
1761
|
+
from: string;
|
|
1762
|
+
to: string;
|
|
1763
|
+
type: 'FIXED';
|
|
1764
|
+
}
|
|
1765
|
+
interface UnionMember3 {
|
|
1766
|
+
from: string;
|
|
1767
|
+
type: 'SINCE';
|
|
1768
|
+
}
|
|
1769
|
+
interface Widget {
|
|
1770
|
+
measures: Array<Widget.Measure>;
|
|
1771
|
+
name: string;
|
|
1772
|
+
comparisonGroups?: Array<Widget.ComparisonGroup>;
|
|
1773
|
+
comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
|
|
1774
|
+
description?: string;
|
|
1775
|
+
display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
|
|
1776
|
+
filters?: Array<Widget.Filter>;
|
|
1777
|
+
interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
|
|
1778
|
+
size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
|
|
1779
|
+
}
|
|
1780
|
+
namespace Widget {
|
|
1781
|
+
interface Measure {
|
|
1782
|
+
aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
1783
|
+
breakdown?: Measure.Breakdown;
|
|
1784
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
1785
|
+
distinctBy?: 'NONE' | 'CALL';
|
|
1786
|
+
filters?: Array<Measure.Filter>;
|
|
1787
|
+
isBaseline?: boolean;
|
|
1788
|
+
metric?: string;
|
|
1789
|
+
nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
1790
|
+
nestedAggregationPercentile?: number;
|
|
1791
|
+
passOperator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
1792
|
+
passValue?: string | number | boolean;
|
|
1793
|
+
percentile?: number;
|
|
1794
|
+
type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
|
|
1795
|
+
}
|
|
1796
|
+
namespace Measure {
|
|
1797
|
+
interface Breakdown {
|
|
1798
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
|
|
1799
|
+
property?: string;
|
|
1800
|
+
}
|
|
1801
|
+
interface Filter {
|
|
1802
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
1803
|
+
value: string | number | boolean;
|
|
1804
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
1805
|
+
property?: string;
|
|
1806
|
+
}
|
|
1807
|
+
}
|
|
1808
|
+
interface ComparisonGroup {
|
|
1809
|
+
filters: Array<ComparisonGroup.Filter>;
|
|
1810
|
+
name: string;
|
|
1811
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
1812
|
+
}
|
|
1813
|
+
namespace ComparisonGroup {
|
|
1814
|
+
interface Filter {
|
|
1815
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
1816
|
+
value: string | number | boolean;
|
|
1817
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
1818
|
+
property?: string;
|
|
1819
|
+
}
|
|
1820
|
+
}
|
|
1821
|
+
interface Filter {
|
|
1822
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
1823
|
+
value: string | number | boolean;
|
|
1824
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
1825
|
+
property?: string;
|
|
1826
|
+
}
|
|
1827
|
+
}
|
|
1828
|
+
}
|
|
1523
1829
|
interface ProjectConfig {
|
|
1524
1830
|
kind: 'project';
|
|
1525
1831
|
name: string;
|
|
@@ -1528,7 +1834,7 @@ export declare namespace ConfigApplyParams {
|
|
|
1528
1834
|
description?: string;
|
|
1529
1835
|
displayName?: string;
|
|
1530
1836
|
members?: Array<ProjectConfig.Member>;
|
|
1531
|
-
resources?: Array<ProjectConfig.AgentConfig | ProjectConfig.HTTPRequestDefinitionConfig | ProjectConfig.PersonaConfig | ProjectConfig.ImprovFlowConfig | ProjectConfig.ScriptedFlowConfig | ProjectConfig.CollectorConfig | ProjectConfig.MetricConfig | ProjectConfig.SimulationPlanConfig | ProjectConfig.QaSimulationPlanConfig | ProjectConfig.SimulationGroupConfig | ProjectConfig.AlertConfig | ProjectConfig.ToolConfig>;
|
|
1837
|
+
resources?: Array<ProjectConfig.AgentConfig | ProjectConfig.HTTPRequestDefinitionConfig | ProjectConfig.PersonaConfig | ProjectConfig.ImprovFlowConfig | ProjectConfig.ScriptedFlowConfig | ProjectConfig.CollectorConfig | ProjectConfig.MetricConfig | ProjectConfig.SimulationPlanConfig | ProjectConfig.QaSimulationPlanConfig | ProjectConfig.SimulationGroupConfig | ProjectConfig.AlertConfig | ProjectConfig.ToolConfig | ProjectConfig.DashboardConfig>;
|
|
1532
1838
|
}
|
|
1533
1839
|
namespace ProjectConfig {
|
|
1534
1840
|
interface Member {
|
|
@@ -1648,7 +1954,7 @@ export declare namespace ConfigApplyParams {
|
|
|
1648
1954
|
}
|
|
1649
1955
|
interface CollectorConfig {
|
|
1650
1956
|
kind: 'collector';
|
|
1651
|
-
metrics: Array<string>;
|
|
1957
|
+
metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
|
|
1652
1958
|
modality: 'call' | 'chat';
|
|
1653
1959
|
name: string;
|
|
1654
1960
|
displayName?: string;
|
|
@@ -1656,6 +1962,13 @@ export declare namespace ConfigApplyParams {
|
|
|
1656
1962
|
status?: 'ACTIVE' | 'INACTIVE';
|
|
1657
1963
|
}
|
|
1658
1964
|
namespace CollectorConfig {
|
|
1965
|
+
interface CollectorMetricConfig {
|
|
1966
|
+
metric: string;
|
|
1967
|
+
excludedPhrases?: Array<string>;
|
|
1968
|
+
screeningBrief?: string;
|
|
1969
|
+
verifiedProperties?: Array<string>;
|
|
1970
|
+
voicemailScript?: string;
|
|
1971
|
+
}
|
|
1659
1972
|
interface Filter {
|
|
1660
1973
|
conditions: Array<Filter.Condition>;
|
|
1661
1974
|
}
|
|
@@ -1993,10 +2306,105 @@ export declare namespace ConfigApplyParams {
|
|
|
1993
2306
|
[key: string]: 'string' | 'number' | 'boolean';
|
|
1994
2307
|
};
|
|
1995
2308
|
}
|
|
2309
|
+
interface DashboardConfig {
|
|
2310
|
+
kind: 'dashboard';
|
|
2311
|
+
name: string;
|
|
2312
|
+
description?: string;
|
|
2313
|
+
displayName?: string;
|
|
2314
|
+
filters?: Array<DashboardConfig.Filter>;
|
|
2315
|
+
isDefault?: boolean;
|
|
2316
|
+
timeRange?: DashboardConfig.UnionMember0 | DashboardConfig.UnionMember1 | DashboardConfig.UnionMember2 | DashboardConfig.UnionMember3;
|
|
2317
|
+
widgets?: Array<DashboardConfig.Widget>;
|
|
2318
|
+
}
|
|
2319
|
+
namespace DashboardConfig {
|
|
2320
|
+
interface Filter {
|
|
2321
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
2322
|
+
value: string | number | boolean;
|
|
2323
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
2324
|
+
property?: string;
|
|
2325
|
+
}
|
|
2326
|
+
interface UnionMember0 {
|
|
2327
|
+
type: 'LAST';
|
|
2328
|
+
unit: 'DAYS' | 'WEEKS' | 'MONTHS';
|
|
2329
|
+
value: number;
|
|
2330
|
+
}
|
|
2331
|
+
interface UnionMember1 {
|
|
2332
|
+
period: 'TODAY' | 'YESTERDAY' | 'THIS_WEEK' | 'LAST_WEEK' | 'THIS_MONTH' | 'LAST_MONTH' | 'THIS_YEAR' | 'LAST_YEAR';
|
|
2333
|
+
type: 'CALENDAR_ALIGNED';
|
|
2334
|
+
}
|
|
2335
|
+
interface UnionMember2 {
|
|
2336
|
+
from: string;
|
|
2337
|
+
to: string;
|
|
2338
|
+
type: 'FIXED';
|
|
2339
|
+
}
|
|
2340
|
+
interface UnionMember3 {
|
|
2341
|
+
from: string;
|
|
2342
|
+
type: 'SINCE';
|
|
2343
|
+
}
|
|
2344
|
+
interface Widget {
|
|
2345
|
+
measures: Array<Widget.Measure>;
|
|
2346
|
+
name: string;
|
|
2347
|
+
comparisonGroups?: Array<Widget.ComparisonGroup>;
|
|
2348
|
+
comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
|
|
2349
|
+
description?: string;
|
|
2350
|
+
display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
|
|
2351
|
+
filters?: Array<Widget.Filter>;
|
|
2352
|
+
interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
|
|
2353
|
+
size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
|
|
2354
|
+
}
|
|
2355
|
+
namespace Widget {
|
|
2356
|
+
interface Measure {
|
|
2357
|
+
aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
2358
|
+
breakdown?: Measure.Breakdown;
|
|
2359
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
2360
|
+
distinctBy?: 'NONE' | 'CALL';
|
|
2361
|
+
filters?: Array<Measure.Filter>;
|
|
2362
|
+
isBaseline?: boolean;
|
|
2363
|
+
metric?: string;
|
|
2364
|
+
nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
2365
|
+
nestedAggregationPercentile?: number;
|
|
2366
|
+
passOperator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
2367
|
+
passValue?: string | number | boolean;
|
|
2368
|
+
percentile?: number;
|
|
2369
|
+
type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
|
|
2370
|
+
}
|
|
2371
|
+
namespace Measure {
|
|
2372
|
+
interface Breakdown {
|
|
2373
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
|
|
2374
|
+
property?: string;
|
|
2375
|
+
}
|
|
2376
|
+
interface Filter {
|
|
2377
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
2378
|
+
value: string | number | boolean;
|
|
2379
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
2380
|
+
property?: string;
|
|
2381
|
+
}
|
|
2382
|
+
}
|
|
2383
|
+
interface ComparisonGroup {
|
|
2384
|
+
filters: Array<ComparisonGroup.Filter>;
|
|
2385
|
+
name: string;
|
|
2386
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
2387
|
+
}
|
|
2388
|
+
namespace ComparisonGroup {
|
|
2389
|
+
interface Filter {
|
|
2390
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
2391
|
+
value: string | number | boolean;
|
|
2392
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
2393
|
+
property?: string;
|
|
2394
|
+
}
|
|
2395
|
+
}
|
|
2396
|
+
interface Filter {
|
|
2397
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
2398
|
+
value: string | number | boolean;
|
|
2399
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
2400
|
+
property?: string;
|
|
2401
|
+
}
|
|
2402
|
+
}
|
|
2403
|
+
}
|
|
1996
2404
|
}
|
|
1997
2405
|
}
|
|
1998
2406
|
export interface ConfigDiffParams {
|
|
1999
|
-
resources: Array<ConfigDiffParams.AgentConfig | ConfigDiffParams.HTTPRequestDefinitionConfig | ConfigDiffParams.PersonaConfig | ConfigDiffParams.ImprovFlowConfig | ConfigDiffParams.ScriptedFlowConfig | ConfigDiffParams.CollectorConfig | ConfigDiffParams.MetricConfig | ConfigDiffParams.SimulationPlanConfig | ConfigDiffParams.QaSimulationPlanConfig | ConfigDiffParams.SimulationGroupConfig | ConfigDiffParams.AlertConfig | ConfigDiffParams.ToolConfig | ConfigDiffParams.ProjectConfig>;
|
|
2407
|
+
resources: Array<ConfigDiffParams.AgentConfig | ConfigDiffParams.HTTPRequestDefinitionConfig | ConfigDiffParams.PersonaConfig | ConfigDiffParams.ImprovFlowConfig | ConfigDiffParams.ScriptedFlowConfig | ConfigDiffParams.CollectorConfig | ConfigDiffParams.MetricConfig | ConfigDiffParams.SimulationPlanConfig | ConfigDiffParams.QaSimulationPlanConfig | ConfigDiffParams.SimulationGroupConfig | ConfigDiffParams.AlertConfig | ConfigDiffParams.ToolConfig | ConfigDiffParams.DashboardConfig | ConfigDiffParams.ProjectConfig>;
|
|
2000
2408
|
prune?: boolean;
|
|
2001
2409
|
}
|
|
2002
2410
|
export declare namespace ConfigDiffParams {
|
|
@@ -2113,7 +2521,7 @@ export declare namespace ConfigDiffParams {
|
|
|
2113
2521
|
}
|
|
2114
2522
|
interface CollectorConfig {
|
|
2115
2523
|
kind: 'collector';
|
|
2116
|
-
metrics: Array<string>;
|
|
2524
|
+
metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
|
|
2117
2525
|
modality: 'call' | 'chat';
|
|
2118
2526
|
name: string;
|
|
2119
2527
|
displayName?: string;
|
|
@@ -2121,6 +2529,13 @@ export declare namespace ConfigDiffParams {
|
|
|
2121
2529
|
status?: 'ACTIVE' | 'INACTIVE';
|
|
2122
2530
|
}
|
|
2123
2531
|
namespace CollectorConfig {
|
|
2532
|
+
interface CollectorMetricConfig {
|
|
2533
|
+
metric: string;
|
|
2534
|
+
excludedPhrases?: Array<string>;
|
|
2535
|
+
screeningBrief?: string;
|
|
2536
|
+
verifiedProperties?: Array<string>;
|
|
2537
|
+
voicemailScript?: string;
|
|
2538
|
+
}
|
|
2124
2539
|
interface Filter {
|
|
2125
2540
|
conditions: Array<Filter.Condition>;
|
|
2126
2541
|
}
|
|
@@ -2458,6 +2873,101 @@ export declare namespace ConfigDiffParams {
|
|
|
2458
2873
|
[key: string]: 'string' | 'number' | 'boolean';
|
|
2459
2874
|
};
|
|
2460
2875
|
}
|
|
2876
|
+
interface DashboardConfig {
|
|
2877
|
+
kind: 'dashboard';
|
|
2878
|
+
name: string;
|
|
2879
|
+
description?: string;
|
|
2880
|
+
displayName?: string;
|
|
2881
|
+
filters?: Array<DashboardConfig.Filter>;
|
|
2882
|
+
isDefault?: boolean;
|
|
2883
|
+
timeRange?: DashboardConfig.UnionMember0 | DashboardConfig.UnionMember1 | DashboardConfig.UnionMember2 | DashboardConfig.UnionMember3;
|
|
2884
|
+
widgets?: Array<DashboardConfig.Widget>;
|
|
2885
|
+
}
|
|
2886
|
+
namespace DashboardConfig {
|
|
2887
|
+
interface Filter {
|
|
2888
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
2889
|
+
value: string | number | boolean;
|
|
2890
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
2891
|
+
property?: string;
|
|
2892
|
+
}
|
|
2893
|
+
interface UnionMember0 {
|
|
2894
|
+
type: 'LAST';
|
|
2895
|
+
unit: 'DAYS' | 'WEEKS' | 'MONTHS';
|
|
2896
|
+
value: number;
|
|
2897
|
+
}
|
|
2898
|
+
interface UnionMember1 {
|
|
2899
|
+
period: 'TODAY' | 'YESTERDAY' | 'THIS_WEEK' | 'LAST_WEEK' | 'THIS_MONTH' | 'LAST_MONTH' | 'THIS_YEAR' | 'LAST_YEAR';
|
|
2900
|
+
type: 'CALENDAR_ALIGNED';
|
|
2901
|
+
}
|
|
2902
|
+
interface UnionMember2 {
|
|
2903
|
+
from: string;
|
|
2904
|
+
to: string;
|
|
2905
|
+
type: 'FIXED';
|
|
2906
|
+
}
|
|
2907
|
+
interface UnionMember3 {
|
|
2908
|
+
from: string;
|
|
2909
|
+
type: 'SINCE';
|
|
2910
|
+
}
|
|
2911
|
+
interface Widget {
|
|
2912
|
+
measures: Array<Widget.Measure>;
|
|
2913
|
+
name: string;
|
|
2914
|
+
comparisonGroups?: Array<Widget.ComparisonGroup>;
|
|
2915
|
+
comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
|
|
2916
|
+
description?: string;
|
|
2917
|
+
display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
|
|
2918
|
+
filters?: Array<Widget.Filter>;
|
|
2919
|
+
interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
|
|
2920
|
+
size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
|
|
2921
|
+
}
|
|
2922
|
+
namespace Widget {
|
|
2923
|
+
interface Measure {
|
|
2924
|
+
aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
2925
|
+
breakdown?: Measure.Breakdown;
|
|
2926
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
2927
|
+
distinctBy?: 'NONE' | 'CALL';
|
|
2928
|
+
filters?: Array<Measure.Filter>;
|
|
2929
|
+
isBaseline?: boolean;
|
|
2930
|
+
metric?: string;
|
|
2931
|
+
nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
2932
|
+
nestedAggregationPercentile?: number;
|
|
2933
|
+
passOperator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
2934
|
+
passValue?: string | number | boolean;
|
|
2935
|
+
percentile?: number;
|
|
2936
|
+
type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
|
|
2937
|
+
}
|
|
2938
|
+
namespace Measure {
|
|
2939
|
+
interface Breakdown {
|
|
2940
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
|
|
2941
|
+
property?: string;
|
|
2942
|
+
}
|
|
2943
|
+
interface Filter {
|
|
2944
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
2945
|
+
value: string | number | boolean;
|
|
2946
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
2947
|
+
property?: string;
|
|
2948
|
+
}
|
|
2949
|
+
}
|
|
2950
|
+
interface ComparisonGroup {
|
|
2951
|
+
filters: Array<ComparisonGroup.Filter>;
|
|
2952
|
+
name: string;
|
|
2953
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
2954
|
+
}
|
|
2955
|
+
namespace ComparisonGroup {
|
|
2956
|
+
interface Filter {
|
|
2957
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
2958
|
+
value: string | number | boolean;
|
|
2959
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
2960
|
+
property?: string;
|
|
2961
|
+
}
|
|
2962
|
+
}
|
|
2963
|
+
interface Filter {
|
|
2964
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
2965
|
+
value: string | number | boolean;
|
|
2966
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
2967
|
+
property?: string;
|
|
2968
|
+
}
|
|
2969
|
+
}
|
|
2970
|
+
}
|
|
2461
2971
|
interface ProjectConfig {
|
|
2462
2972
|
kind: 'project';
|
|
2463
2973
|
name: string;
|
|
@@ -2466,7 +2976,7 @@ export declare namespace ConfigDiffParams {
|
|
|
2466
2976
|
description?: string;
|
|
2467
2977
|
displayName?: string;
|
|
2468
2978
|
members?: Array<ProjectConfig.Member>;
|
|
2469
|
-
resources?: Array<ProjectConfig.AgentConfig | ProjectConfig.HTTPRequestDefinitionConfig | ProjectConfig.PersonaConfig | ProjectConfig.ImprovFlowConfig | ProjectConfig.ScriptedFlowConfig | ProjectConfig.CollectorConfig | ProjectConfig.MetricConfig | ProjectConfig.SimulationPlanConfig | ProjectConfig.QaSimulationPlanConfig | ProjectConfig.SimulationGroupConfig | ProjectConfig.AlertConfig | ProjectConfig.ToolConfig>;
|
|
2979
|
+
resources?: Array<ProjectConfig.AgentConfig | ProjectConfig.HTTPRequestDefinitionConfig | ProjectConfig.PersonaConfig | ProjectConfig.ImprovFlowConfig | ProjectConfig.ScriptedFlowConfig | ProjectConfig.CollectorConfig | ProjectConfig.MetricConfig | ProjectConfig.SimulationPlanConfig | ProjectConfig.QaSimulationPlanConfig | ProjectConfig.SimulationGroupConfig | ProjectConfig.AlertConfig | ProjectConfig.ToolConfig | ProjectConfig.DashboardConfig>;
|
|
2470
2980
|
}
|
|
2471
2981
|
namespace ProjectConfig {
|
|
2472
2982
|
interface Member {
|
|
@@ -2586,7 +3096,7 @@ export declare namespace ConfigDiffParams {
|
|
|
2586
3096
|
}
|
|
2587
3097
|
interface CollectorConfig {
|
|
2588
3098
|
kind: 'collector';
|
|
2589
|
-
metrics: Array<string>;
|
|
3099
|
+
metrics: Array<string | CollectorConfig.CollectorMetricConfig>;
|
|
2590
3100
|
modality: 'call' | 'chat';
|
|
2591
3101
|
name: string;
|
|
2592
3102
|
displayName?: string;
|
|
@@ -2594,6 +3104,13 @@ export declare namespace ConfigDiffParams {
|
|
|
2594
3104
|
status?: 'ACTIVE' | 'INACTIVE';
|
|
2595
3105
|
}
|
|
2596
3106
|
namespace CollectorConfig {
|
|
3107
|
+
interface CollectorMetricConfig {
|
|
3108
|
+
metric: string;
|
|
3109
|
+
excludedPhrases?: Array<string>;
|
|
3110
|
+
screeningBrief?: string;
|
|
3111
|
+
verifiedProperties?: Array<string>;
|
|
3112
|
+
voicemailScript?: string;
|
|
3113
|
+
}
|
|
2597
3114
|
interface Filter {
|
|
2598
3115
|
conditions: Array<Filter.Condition>;
|
|
2599
3116
|
}
|
|
@@ -2931,6 +3448,101 @@ export declare namespace ConfigDiffParams {
|
|
|
2931
3448
|
[key: string]: 'string' | 'number' | 'boolean';
|
|
2932
3449
|
};
|
|
2933
3450
|
}
|
|
3451
|
+
interface DashboardConfig {
|
|
3452
|
+
kind: 'dashboard';
|
|
3453
|
+
name: string;
|
|
3454
|
+
description?: string;
|
|
3455
|
+
displayName?: string;
|
|
3456
|
+
filters?: Array<DashboardConfig.Filter>;
|
|
3457
|
+
isDefault?: boolean;
|
|
3458
|
+
timeRange?: DashboardConfig.UnionMember0 | DashboardConfig.UnionMember1 | DashboardConfig.UnionMember2 | DashboardConfig.UnionMember3;
|
|
3459
|
+
widgets?: Array<DashboardConfig.Widget>;
|
|
3460
|
+
}
|
|
3461
|
+
namespace DashboardConfig {
|
|
3462
|
+
interface Filter {
|
|
3463
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
3464
|
+
value: string | number | boolean;
|
|
3465
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
3466
|
+
property?: string;
|
|
3467
|
+
}
|
|
3468
|
+
interface UnionMember0 {
|
|
3469
|
+
type: 'LAST';
|
|
3470
|
+
unit: 'DAYS' | 'WEEKS' | 'MONTHS';
|
|
3471
|
+
value: number;
|
|
3472
|
+
}
|
|
3473
|
+
interface UnionMember1 {
|
|
3474
|
+
period: 'TODAY' | 'YESTERDAY' | 'THIS_WEEK' | 'LAST_WEEK' | 'THIS_MONTH' | 'LAST_MONTH' | 'THIS_YEAR' | 'LAST_YEAR';
|
|
3475
|
+
type: 'CALENDAR_ALIGNED';
|
|
3476
|
+
}
|
|
3477
|
+
interface UnionMember2 {
|
|
3478
|
+
from: string;
|
|
3479
|
+
to: string;
|
|
3480
|
+
type: 'FIXED';
|
|
3481
|
+
}
|
|
3482
|
+
interface UnionMember3 {
|
|
3483
|
+
from: string;
|
|
3484
|
+
type: 'SINCE';
|
|
3485
|
+
}
|
|
3486
|
+
interface Widget {
|
|
3487
|
+
measures: Array<Widget.Measure>;
|
|
3488
|
+
name: string;
|
|
3489
|
+
comparisonGroups?: Array<Widget.ComparisonGroup>;
|
|
3490
|
+
comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
|
|
3491
|
+
description?: string;
|
|
3492
|
+
display?: 'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE';
|
|
3493
|
+
filters?: Array<Widget.Filter>;
|
|
3494
|
+
interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
|
|
3495
|
+
size?: 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
|
|
3496
|
+
}
|
|
3497
|
+
namespace Widget {
|
|
3498
|
+
interface Measure {
|
|
3499
|
+
aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
3500
|
+
breakdown?: Measure.Breakdown;
|
|
3501
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
3502
|
+
distinctBy?: 'NONE' | 'CALL';
|
|
3503
|
+
filters?: Array<Measure.Filter>;
|
|
3504
|
+
isBaseline?: boolean;
|
|
3505
|
+
metric?: string;
|
|
3506
|
+
nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
|
|
3507
|
+
nestedAggregationPercentile?: number;
|
|
3508
|
+
passOperator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
3509
|
+
passValue?: string | number | boolean;
|
|
3510
|
+
percentile?: number;
|
|
3511
|
+
type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
|
|
3512
|
+
}
|
|
3513
|
+
namespace Measure {
|
|
3514
|
+
interface Breakdown {
|
|
3515
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
|
|
3516
|
+
property?: string;
|
|
3517
|
+
}
|
|
3518
|
+
interface Filter {
|
|
3519
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
3520
|
+
value: string | number | boolean;
|
|
3521
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
3522
|
+
property?: string;
|
|
3523
|
+
}
|
|
3524
|
+
}
|
|
3525
|
+
interface ComparisonGroup {
|
|
3526
|
+
filters: Array<ComparisonGroup.Filter>;
|
|
3527
|
+
name: string;
|
|
3528
|
+
color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
|
|
3529
|
+
}
|
|
3530
|
+
namespace ComparisonGroup {
|
|
3531
|
+
interface Filter {
|
|
3532
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
3533
|
+
value: string | number | boolean;
|
|
3534
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
3535
|
+
property?: string;
|
|
3536
|
+
}
|
|
3537
|
+
}
|
|
3538
|
+
interface Filter {
|
|
3539
|
+
type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET';
|
|
3540
|
+
value: string | number | boolean;
|
|
3541
|
+
operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
|
|
3542
|
+
property?: string;
|
|
3543
|
+
}
|
|
3544
|
+
}
|
|
3545
|
+
}
|
|
2934
3546
|
}
|
|
2935
3547
|
}
|
|
2936
3548
|
export declare namespace Config {
|