@roarkanalytics/sdk 5.3.0 → 5.5.0

package/src/resources/config.ts

@@ -53,6 +53,7 @@ export interface Bundle {
     | Bundle.MetricConfig
     | Bundle.SimulationPlanConfig
     | Bundle.QaSimulationPlanConfig
+    | Bundle.SimulationGroupConfig
     | Bundle.AlertConfig
     | Bundle.ToolConfig
     | Bundle.ProjectConfig
@@ -286,6 +287,8 @@ export namespace Bundle {
 
       expectations?: Array<string>;
 
+      includeFlowExpectations?: boolean;
+
       persona?: string;
 
       prompt?: string;
@@ -744,6 +747,126 @@ export namespace Bundle {
     }
   }
 
+  export interface SimulationGroupConfig {
+    kind: 'simulationGroup';
+
+    name: string;
+
+    plans: Array<string>;
+
+    description?: string | null;
+
+    notify?: SimulationGroupConfig.Notify;
+
+    schedule?:
+      | SimulationGroupConfig.UnionMember0
+      | SimulationGroupConfig.UnionMember1
+      | SimulationGroupConfig.UnionMember2
+      | SimulationGroupConfig.UnionMember3
+      | SimulationGroupConfig.UnionMember4
+      | SimulationGroupConfig.UnionMember5;
+  }
+
+  export namespace SimulationGroupConfig {
+    export interface Notify {
+      email?: boolean | Array<string>;
+
+      slack?: Array<Notify.Slack>;
+    }
+
+    export namespace Notify {
+      export interface Slack {
+        channelId: string;
+
+        channelName: string;
+      }
+    }
+
+    export interface UnionMember0 {
+      type: 'hourly';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      minute?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember1 {
+      everyMinutes: number;
+
+      type: 'interval';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember2 {
+      time: string;
+
+      type: 'daily';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember3 {
+      days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+
+      time: string;
+
+      type: 'weekly';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember4 {
+      dayOfMonth: number;
+
+      time: string;
+
+      type: 'monthly';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember5 {
+      at: string;
+
+      type: 'once';
+
+      enabled?: boolean;
+
+      timezone?: string;
+    }
+  }
+
   export interface AlertConfig {
     kind: 'alert';
 
@@ -885,6 +1008,7 @@ export namespace Bundle {
       | ProjectConfig.MetricConfig
       | ProjectConfig.SimulationPlanConfig
       | ProjectConfig.QaSimulationPlanConfig
+      | ProjectConfig.SimulationGroupConfig
       | ProjectConfig.AlertConfig
       | ProjectConfig.ToolConfig
     >;
@@ -1121,6 +1245,8 @@ export namespace Bundle {
 
         expectations?: Array<string>;
 
+        includeFlowExpectations?: boolean;
+
         persona?: string;
 
         prompt?: string;
@@ -1579,6 +1705,126 @@ export namespace Bundle {
       }
     }
 
+    export interface SimulationGroupConfig {
+      kind: 'simulationGroup';
+
+      name: string;
+
+      plans: Array<string>;
+
+      description?: string | null;
+
+      notify?: SimulationGroupConfig.Notify;
+
+      schedule?:
+        | SimulationGroupConfig.UnionMember0
+        | SimulationGroupConfig.UnionMember1
+        | SimulationGroupConfig.UnionMember2
+        | SimulationGroupConfig.UnionMember3
+        | SimulationGroupConfig.UnionMember4
+        | SimulationGroupConfig.UnionMember5;
+    }
+
+    export namespace SimulationGroupConfig {
+      export interface Notify {
+        email?: boolean | Array<string>;
+
+        slack?: Array<Notify.Slack>;
+      }
+
+      export namespace Notify {
+        export interface Slack {
+          channelId: string;
+
+          channelName: string;
+        }
+      }
+
+      export interface UnionMember0 {
+        type: 'hourly';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        minute?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember1 {
+        everyMinutes: number;
+
+        type: 'interval';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember2 {
+        time: string;
+
+        type: 'daily';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember3 {
+        days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+
+        time: string;
+
+        type: 'weekly';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember4 {
+        dayOfMonth: number;
+
+        time: string;
+
+        type: 'monthly';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember5 {
+        at: string;
+
+        type: 'once';
+
+        enabled?: boolean;
+
+        timezone?: string;
+      }
+    }
+
     export interface AlertConfig {
       kind: 'alert';
 
@@ -1772,6 +2018,7 @@ export namespace ConfigApplyResponse {
         | 'collector'
         | 'metric'
         | 'simulationPlan'
+        | 'simulationGroup'
         | 'alert'
         | 'tool'
         | 'project'
@@ -1831,6 +2078,7 @@ export namespace ConfigDiffResponse {
         | 'collector'
         | 'metric'
         | 'simulationPlan'
+        | 'simulationGroup'
         | 'alert'
         | 'tool'
         | 'project'
@@ -1868,6 +2116,7 @@ export interface ConfigApplyParams {
     | ConfigApplyParams.MetricConfig
     | ConfigApplyParams.SimulationPlanConfig
     | ConfigApplyParams.QaSimulationPlanConfig
+    | ConfigApplyParams.SimulationGroupConfig
     | ConfigApplyParams.AlertConfig
     | ConfigApplyParams.ToolConfig
     | ConfigApplyParams.ProjectConfig
@@ -2101,6 +2350,8 @@ export namespace ConfigApplyParams {
 
       expectations?: Array<string>;
 
+      includeFlowExpectations?: boolean;
+
       persona?: string;
 
       prompt?: string;
@@ -2559,53 +2810,173 @@ export namespace ConfigApplyParams {
     }
   }
 
-  export interface AlertConfig {
-    kind: 'alert';
+  export interface SimulationGroupConfig {
+    kind: 'simulationGroup';
 
     name: string;
 
-    trigger:
-      | AlertConfig.AlertThresholdTrigger
-      | AlertConfig.AlertEventTrigger
-      | AlertConfig.AlertSimulationTrigger;
+    plans: Array<string>;
 
-    actions?: AlertConfig.Actions;
+    description?: string | null;
 
-    displayName?: string;
+    notify?: SimulationGroupConfig.Notify;
 
-    enabled?: boolean;
+    schedule?:
+      | SimulationGroupConfig.UnionMember0
+      | SimulationGroupConfig.UnionMember1
+      | SimulationGroupConfig.UnionMember2
+      | SimulationGroupConfig.UnionMember3
+      | SimulationGroupConfig.UnionMember4
+      | SimulationGroupConfig.UnionMember5;
   }
 
-  export namespace AlertConfig {
-    export interface AlertThresholdTrigger {
-      aggregation: 'COUNT' | 'RATE_PER_MINUTE' | 'MEAN';
-
-      metric: string;
+  export namespace SimulationGroupConfig {
+    export interface Notify {
+      email?: boolean | Array<string>;
 
-      operator: 'GT' | 'GTE' | 'LT' | 'LTE';
+      slack?: Array<Notify.Slack>;
+    }
 
-      thresholdValue: number;
+    export namespace Notify {
+      export interface Slack {
+        channelId: string;
 
-      type: 'threshold';
+        channelName: string;
+      }
+    }
 
-      windowMinutes: number;
+    export interface UnionMember0 {
+      type: 'hourly';
 
-      consecutiveOpen?: number;
+      enabled?: boolean;
 
-      consecutiveResolve?: number;
+      endDate?: string;
 
-      grouping?: 'NONE' | 'BY_AGENT';
+      maxRuns?: number;
 
-      metricVariant?: string;
+      minute?: number;
 
-      minSampleSize?: number;
+      timezone?: string;
     }
 
-    export interface AlertEventTrigger {
-      events: Array<
-        | 'CALL_ANALYSIS_COMPLETED'
-        | 'CALL_ANALYSIS_FAILED'
-        | 'CALL_ANALYSIS_CANCELLED'
+    export interface UnionMember1 {
+      everyMinutes: number;
+
+      type: 'interval';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember2 {
+      time: string;
+
+      type: 'daily';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember3 {
+      days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+
+      time: string;
+
+      type: 'weekly';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember4 {
+      dayOfMonth: number;
+
+      time: string;
+
+      type: 'monthly';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember5 {
+      at: string;
+
+      type: 'once';
+
+      enabled?: boolean;
+
+      timezone?: string;
+    }
+  }
+
+  export interface AlertConfig {
+    kind: 'alert';
+
+    name: string;
+
+    trigger:
+      | AlertConfig.AlertThresholdTrigger
+      | AlertConfig.AlertEventTrigger
+      | AlertConfig.AlertSimulationTrigger;
+
+    actions?: AlertConfig.Actions;
+
+    displayName?: string;
+
+    enabled?: boolean;
+  }
+
+  export namespace AlertConfig {
+    export interface AlertThresholdTrigger {
+      aggregation: 'COUNT' | 'RATE_PER_MINUTE' | 'MEAN';
+
+      metric: string;
+
+      operator: 'GT' | 'GTE' | 'LT' | 'LTE';
+
+      thresholdValue: number;
+
+      type: 'threshold';
+
+      windowMinutes: number;
+
+      consecutiveOpen?: number;
+
+      consecutiveResolve?: number;
+
+      grouping?: 'NONE' | 'BY_AGENT';
+
+      metricVariant?: string;
+
+      minSampleSize?: number;
+    }
+
+    export interface AlertEventTrigger {
+      events: Array<
+        | 'CALL_ANALYSIS_COMPLETED'
+        | 'CALL_ANALYSIS_FAILED'
+        | 'CALL_ANALYSIS_CANCELLED'
         | 'SIMULATION_RUN_PLAN_JOB_STARTED'
         | 'SIMULATION_RUN_PLAN_JOB_COMPLETED'
         | 'SIMULATION_RUN_PLAN_JOB_FAILED'
@@ -2700,6 +3071,7 @@ export namespace ConfigApplyParams {
       | ProjectConfig.MetricConfig
       | ProjectConfig.SimulationPlanConfig
       | ProjectConfig.QaSimulationPlanConfig
+      | ProjectConfig.SimulationGroupConfig
       | ProjectConfig.AlertConfig
       | ProjectConfig.ToolConfig
     >;
@@ -2936,6 +3308,8 @@ export namespace ConfigApplyParams {
 
         expectations?: Array<string>;
 
+        includeFlowExpectations?: boolean;
+
         persona?: string;
 
         prompt?: string;
@@ -3394,6 +3768,126 @@ export namespace ConfigApplyParams {
       }
     }
 
+    export interface SimulationGroupConfig {
+      kind: 'simulationGroup';
+
+      name: string;
+
+      plans: Array<string>;
+
+      description?: string | null;
+
+      notify?: SimulationGroupConfig.Notify;
+
+      schedule?:
+        | SimulationGroupConfig.UnionMember0
+        | SimulationGroupConfig.UnionMember1
+        | SimulationGroupConfig.UnionMember2
+        | SimulationGroupConfig.UnionMember3
+        | SimulationGroupConfig.UnionMember4
+        | SimulationGroupConfig.UnionMember5;
+    }
+
+    export namespace SimulationGroupConfig {
+      export interface Notify {
+        email?: boolean | Array<string>;
+
+        slack?: Array<Notify.Slack>;
+      }
+
+      export namespace Notify {
+        export interface Slack {
+          channelId: string;
+
+          channelName: string;
+        }
+      }
+
+      export interface UnionMember0 {
+        type: 'hourly';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        minute?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember1 {
+        everyMinutes: number;
+
+        type: 'interval';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember2 {
+        time: string;
+
+        type: 'daily';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember3 {
+        days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+
+        time: string;
+
+        type: 'weekly';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember4 {
+        dayOfMonth: number;
+
+        time: string;
+
+        type: 'monthly';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember5 {
+        at: string;
+
+        type: 'once';
+
+        enabled?: boolean;
+
+        timezone?: string;
+      }
+    }
+
     export interface AlertConfig {
       kind: 'alert';
 
@@ -3514,6 +4008,7 @@ export interface ConfigDiffParams {
     | ConfigDiffParams.MetricConfig
     | ConfigDiffParams.SimulationPlanConfig
     | ConfigDiffParams.QaSimulationPlanConfig
+    | ConfigDiffParams.SimulationGroupConfig
     | ConfigDiffParams.AlertConfig
     | ConfigDiffParams.ToolConfig
     | ConfigDiffParams.ProjectConfig
@@ -3747,6 +4242,8 @@ export namespace ConfigDiffParams {
 
       expectations?: Array<string>;
 
+      includeFlowExpectations?: boolean;
+
       persona?: string;
 
       prompt?: string;
@@ -4205,6 +4702,126 @@ export namespace ConfigDiffParams {
     }
   }
 
+  export interface SimulationGroupConfig {
+    kind: 'simulationGroup';
+
+    name: string;
+
+    plans: Array<string>;
+
+    description?: string | null;
+
+    notify?: SimulationGroupConfig.Notify;
+
+    schedule?:
+      | SimulationGroupConfig.UnionMember0
+      | SimulationGroupConfig.UnionMember1
+      | SimulationGroupConfig.UnionMember2
+      | SimulationGroupConfig.UnionMember3
+      | SimulationGroupConfig.UnionMember4
+      | SimulationGroupConfig.UnionMember5;
+  }
+
+  export namespace SimulationGroupConfig {
+    export interface Notify {
+      email?: boolean | Array<string>;
+
+      slack?: Array<Notify.Slack>;
+    }
+
+    export namespace Notify {
+      export interface Slack {
+        channelId: string;
+
+        channelName: string;
+      }
+    }
+
+    export interface UnionMember0 {
+      type: 'hourly';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      minute?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember1 {
+      everyMinutes: number;
+
+      type: 'interval';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember2 {
+      time: string;
+
+      type: 'daily';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember3 {
+      days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+
+      time: string;
+
+      type: 'weekly';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember4 {
+      dayOfMonth: number;
+
+      time: string;
+
+      type: 'monthly';
+
+      enabled?: boolean;
+
+      endDate?: string;
+
+      maxRuns?: number;
+
+      timezone?: string;
+    }
+
+    export interface UnionMember5 {
+      at: string;
+
+      type: 'once';
+
+      enabled?: boolean;
+
+      timezone?: string;
+    }
+  }
+
   export interface AlertConfig {
     kind: 'alert';
 
@@ -4346,6 +4963,7 @@ export namespace ConfigDiffParams {
       | ProjectConfig.MetricConfig
       | ProjectConfig.SimulationPlanConfig
       | ProjectConfig.QaSimulationPlanConfig
+      | ProjectConfig.SimulationGroupConfig
       | ProjectConfig.AlertConfig
       | ProjectConfig.ToolConfig
     >;
@@ -4582,6 +5200,8 @@ export namespace ConfigDiffParams {
 
         expectations?: Array<string>;
 
+        includeFlowExpectations?: boolean;
+
         persona?: string;
 
         prompt?: string;
@@ -5040,6 +5660,126 @@ export namespace ConfigDiffParams {
       }
     }
 
+    export interface SimulationGroupConfig {
+      kind: 'simulationGroup';
+
+      name: string;
+
+      plans: Array<string>;
+
+      description?: string | null;
+
+      notify?: SimulationGroupConfig.Notify;
+
+      schedule?:
+        | SimulationGroupConfig.UnionMember0
+        | SimulationGroupConfig.UnionMember1
+        | SimulationGroupConfig.UnionMember2
+        | SimulationGroupConfig.UnionMember3
+        | SimulationGroupConfig.UnionMember4
+        | SimulationGroupConfig.UnionMember5;
+    }
+
+    export namespace SimulationGroupConfig {
+      export interface Notify {
+        email?: boolean | Array<string>;
+
+        slack?: Array<Notify.Slack>;
+      }
+
+      export namespace Notify {
+        export interface Slack {
+          channelId: string;
+
+          channelName: string;
+        }
+      }
+
+      export interface UnionMember0 {
+        type: 'hourly';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        minute?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember1 {
+        everyMinutes: number;
+
+        type: 'interval';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember2 {
+        time: string;
+
+        type: 'daily';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember3 {
+        days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+
+        time: string;
+
+        type: 'weekly';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember4 {
+        dayOfMonth: number;
+
+        time: string;
+
+        type: 'monthly';
+
+        enabled?: boolean;
+
+        endDate?: string;
+
+        maxRuns?: number;
+
+        timezone?: string;
+      }
+
+      export interface UnionMember5 {
+        at: string;
+
+        type: 'once';
+
+        enabled?: boolean;
+
+        timezone?: string;
+      }
+    }
+
     export interface AlertConfig {
       kind: 'alert';