@roarkanalytics/sdk 5.3.0 → 5.5.0

package/resources/config.d.ts

@@ -34,7 +34,7 @@ export declare class Config extends APIResource {
     diff(body: ConfigDiffParams, options?: RequestOptions): APIPromise<ConfigDiffResponse>;
 }
 export interface Bundle {
-    resources: Array<Bundle.AgentConfig | Bundle.HTTPRequestDefinitionConfig | Bundle.PersonaConfig | Bundle.ImprovFlowConfig | Bundle.ScriptedFlowConfig | Bundle.CollectorConfig | Bundle.MetricConfig | Bundle.SimulationPlanConfig | Bundle.QaSimulationPlanConfig | Bundle.AlertConfig | Bundle.ToolConfig | Bundle.ProjectConfig>;
+    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>;
     prune?: boolean;
 }
 export declare namespace Bundle {
@@ -121,6 +121,7 @@ export declare namespace Bundle {
             name: string;
             environment?: string;
             expectations?: Array<string>;
+            includeFlowExpectations?: boolean;
             persona?: string;
             prompt?: string;
             title?: string;
@@ -373,6 +374,74 @@ export declare namespace Bundle {
             timezone?: string;
         }
     }
+    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;
+    }
+    namespace SimulationGroupConfig {
+        interface Notify {
+            email?: boolean | Array<string>;
+            slack?: Array<Notify.Slack>;
+        }
+        namespace Notify {
+            interface Slack {
+                channelId: string;
+                channelName: string;
+            }
+        }
+        interface UnionMember0 {
+            type: 'hourly';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            minute?: number;
+            timezone?: string;
+        }
+        interface UnionMember1 {
+            everyMinutes: number;
+            type: 'interval';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember2 {
+            time: string;
+            type: 'daily';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember3 {
+            days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+            time: string;
+            type: 'weekly';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember4 {
+            dayOfMonth: number;
+            time: string;
+            type: 'monthly';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember5 {
+            at: string;
+            type: 'once';
+            enabled?: boolean;
+            timezone?: string;
+        }
+    }
     interface AlertConfig {
         kind: 'alert';
         name: string;
@@ -435,7 +504,7 @@ export declare namespace Bundle {
         description?: string;
         displayName?: string;
         members?: Array<ProjectConfig.Member>;
-        resources?: Array<ProjectConfig.AgentConfig | ProjectConfig.HTTPRequestDefinitionConfig | ProjectConfig.PersonaConfig | ProjectConfig.ImprovFlowConfig | ProjectConfig.ScriptedFlowConfig | ProjectConfig.CollectorConfig | ProjectConfig.MetricConfig | ProjectConfig.SimulationPlanConfig | ProjectConfig.QaSimulationPlanConfig | ProjectConfig.AlertConfig | ProjectConfig.ToolConfig>;
+        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>;
     }
     namespace ProjectConfig {
         interface Member {
@@ -525,6 +594,7 @@ export declare namespace Bundle {
                 name: string;
                 environment?: string;
                 expectations?: Array<string>;
+                includeFlowExpectations?: boolean;
                 persona?: string;
                 prompt?: string;
                 title?: string;
@@ -777,6 +847,74 @@ export declare namespace Bundle {
                 timezone?: string;
             }
         }
+        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;
+        }
+        namespace SimulationGroupConfig {
+            interface Notify {
+                email?: boolean | Array<string>;
+                slack?: Array<Notify.Slack>;
+            }
+            namespace Notify {
+                interface Slack {
+                    channelId: string;
+                    channelName: string;
+                }
+            }
+            interface UnionMember0 {
+                type: 'hourly';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                minute?: number;
+                timezone?: string;
+            }
+            interface UnionMember1 {
+                everyMinutes: number;
+                type: 'interval';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember2 {
+                time: string;
+                type: 'daily';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember3 {
+                days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+                time: string;
+                type: 'weekly';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember4 {
+                dayOfMonth: number;
+                time: string;
+                type: 'monthly';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember5 {
+                at: string;
+                type: 'once';
+                enabled?: boolean;
+                timezone?: string;
+            }
+        }
         interface AlertConfig {
             kind: 'alert';
             name: string;
@@ -875,7 +1013,7 @@ export declare namespace ConfigApplyResponse {
     namespace Data {
         interface Change {
             configKey: string;
-            kind: 'agent' | 'persona' | 'httpRequestDefinition' | 'flow' | 'collector' | 'metric' | 'simulationPlan' | 'alert' | 'tool' | 'project' | 'member';
+            kind: 'agent' | 'persona' | 'httpRequestDefinition' | 'flow' | 'collector' | 'metric' | 'simulationPlan' | 'simulationGroup' | 'alert' | 'tool' | 'project' | 'member';
             name: string;
             op: 'create' | 'update' | 'delete' | 'noop';
             status: 'applied' | 'skipped' | 'failed';
@@ -905,7 +1043,7 @@ export declare namespace ConfigDiffResponse {
     namespace Data {
         interface Change {
             configKey: string;
-            kind: 'agent' | 'persona' | 'httpRequestDefinition' | 'flow' | 'collector' | 'metric' | 'simulationPlan' | 'alert' | 'tool' | 'project' | 'member';
+            kind: 'agent' | 'persona' | 'httpRequestDefinition' | 'flow' | 'collector' | 'metric' | 'simulationPlan' | 'simulationGroup' | 'alert' | 'tool' | 'project' | 'member';
             name: string;
             op: 'create' | 'update' | 'delete' | 'noop';
             detail?: string;
@@ -920,7 +1058,7 @@ export declare namespace ConfigDiffResponse {
     }
 }
 export interface ConfigApplyParams {
-    resources: Array<ConfigApplyParams.AgentConfig | ConfigApplyParams.HTTPRequestDefinitionConfig | ConfigApplyParams.PersonaConfig | ConfigApplyParams.ImprovFlowConfig | ConfigApplyParams.ScriptedFlowConfig | ConfigApplyParams.CollectorConfig | ConfigApplyParams.MetricConfig | ConfigApplyParams.SimulationPlanConfig | ConfigApplyParams.QaSimulationPlanConfig | ConfigApplyParams.AlertConfig | ConfigApplyParams.ToolConfig | ConfigApplyParams.ProjectConfig>;
+    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>;
     prune?: boolean;
 }
 export declare namespace ConfigApplyParams {
@@ -1007,6 +1145,7 @@ export declare namespace ConfigApplyParams {
             name: string;
             environment?: string;
             expectations?: Array<string>;
+            includeFlowExpectations?: boolean;
             persona?: string;
             prompt?: string;
             title?: string;
@@ -1259,6 +1398,74 @@ export declare namespace ConfigApplyParams {
             timezone?: string;
         }
     }
+    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;
+    }
+    namespace SimulationGroupConfig {
+        interface Notify {
+            email?: boolean | Array<string>;
+            slack?: Array<Notify.Slack>;
+        }
+        namespace Notify {
+            interface Slack {
+                channelId: string;
+                channelName: string;
+            }
+        }
+        interface UnionMember0 {
+            type: 'hourly';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            minute?: number;
+            timezone?: string;
+        }
+        interface UnionMember1 {
+            everyMinutes: number;
+            type: 'interval';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember2 {
+            time: string;
+            type: 'daily';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember3 {
+            days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+            time: string;
+            type: 'weekly';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember4 {
+            dayOfMonth: number;
+            time: string;
+            type: 'monthly';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember5 {
+            at: string;
+            type: 'once';
+            enabled?: boolean;
+            timezone?: string;
+        }
+    }
     interface AlertConfig {
         kind: 'alert';
         name: string;
@@ -1321,7 +1528,7 @@ export declare namespace ConfigApplyParams {
         description?: string;
         displayName?: string;
         members?: Array<ProjectConfig.Member>;
-        resources?: Array<ProjectConfig.AgentConfig | ProjectConfig.HTTPRequestDefinitionConfig | ProjectConfig.PersonaConfig | ProjectConfig.ImprovFlowConfig | ProjectConfig.ScriptedFlowConfig | ProjectConfig.CollectorConfig | ProjectConfig.MetricConfig | ProjectConfig.SimulationPlanConfig | ProjectConfig.QaSimulationPlanConfig | ProjectConfig.AlertConfig | ProjectConfig.ToolConfig>;
+        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>;
     }
     namespace ProjectConfig {
         interface Member {
@@ -1411,6 +1618,7 @@ export declare namespace ConfigApplyParams {
                 name: string;
                 environment?: string;
                 expectations?: Array<string>;
+                includeFlowExpectations?: boolean;
                 persona?: string;
                 prompt?: string;
                 title?: string;
@@ -1663,6 +1871,74 @@ export declare namespace ConfigApplyParams {
                 timezone?: string;
             }
         }
+        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;
+        }
+        namespace SimulationGroupConfig {
+            interface Notify {
+                email?: boolean | Array<string>;
+                slack?: Array<Notify.Slack>;
+            }
+            namespace Notify {
+                interface Slack {
+                    channelId: string;
+                    channelName: string;
+                }
+            }
+            interface UnionMember0 {
+                type: 'hourly';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                minute?: number;
+                timezone?: string;
+            }
+            interface UnionMember1 {
+                everyMinutes: number;
+                type: 'interval';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember2 {
+                time: string;
+                type: 'daily';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember3 {
+                days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+                time: string;
+                type: 'weekly';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember4 {
+                dayOfMonth: number;
+                time: string;
+                type: 'monthly';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember5 {
+                at: string;
+                type: 'once';
+                enabled?: boolean;
+                timezone?: string;
+            }
+        }
         interface AlertConfig {
             kind: 'alert';
             name: string;
@@ -1720,7 +1996,7 @@ export declare namespace ConfigApplyParams {
     }
 }
 export interface ConfigDiffParams {
-    resources: Array<ConfigDiffParams.AgentConfig | ConfigDiffParams.HTTPRequestDefinitionConfig | ConfigDiffParams.PersonaConfig | ConfigDiffParams.ImprovFlowConfig | ConfigDiffParams.ScriptedFlowConfig | ConfigDiffParams.CollectorConfig | ConfigDiffParams.MetricConfig | ConfigDiffParams.SimulationPlanConfig | ConfigDiffParams.QaSimulationPlanConfig | ConfigDiffParams.AlertConfig | ConfigDiffParams.ToolConfig | ConfigDiffParams.ProjectConfig>;
+    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>;
     prune?: boolean;
 }
 export declare namespace ConfigDiffParams {
@@ -1807,6 +2083,7 @@ export declare namespace ConfigDiffParams {
             name: string;
             environment?: string;
             expectations?: Array<string>;
+            includeFlowExpectations?: boolean;
             persona?: string;
             prompt?: string;
             title?: string;
@@ -2059,6 +2336,74 @@ export declare namespace ConfigDiffParams {
             timezone?: string;
         }
     }
+    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;
+    }
+    namespace SimulationGroupConfig {
+        interface Notify {
+            email?: boolean | Array<string>;
+            slack?: Array<Notify.Slack>;
+        }
+        namespace Notify {
+            interface Slack {
+                channelId: string;
+                channelName: string;
+            }
+        }
+        interface UnionMember0 {
+            type: 'hourly';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            minute?: number;
+            timezone?: string;
+        }
+        interface UnionMember1 {
+            everyMinutes: number;
+            type: 'interval';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember2 {
+            time: string;
+            type: 'daily';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember3 {
+            days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+            time: string;
+            type: 'weekly';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember4 {
+            dayOfMonth: number;
+            time: string;
+            type: 'monthly';
+            enabled?: boolean;
+            endDate?: string;
+            maxRuns?: number;
+            timezone?: string;
+        }
+        interface UnionMember5 {
+            at: string;
+            type: 'once';
+            enabled?: boolean;
+            timezone?: string;
+        }
+    }
     interface AlertConfig {
         kind: 'alert';
         name: string;
@@ -2121,7 +2466,7 @@ export declare namespace ConfigDiffParams {
         description?: string;
         displayName?: string;
         members?: Array<ProjectConfig.Member>;
-        resources?: Array<ProjectConfig.AgentConfig | ProjectConfig.HTTPRequestDefinitionConfig | ProjectConfig.PersonaConfig | ProjectConfig.ImprovFlowConfig | ProjectConfig.ScriptedFlowConfig | ProjectConfig.CollectorConfig | ProjectConfig.MetricConfig | ProjectConfig.SimulationPlanConfig | ProjectConfig.QaSimulationPlanConfig | ProjectConfig.AlertConfig | ProjectConfig.ToolConfig>;
+        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>;
     }
     namespace ProjectConfig {
         interface Member {
@@ -2211,6 +2556,7 @@ export declare namespace ConfigDiffParams {
                 name: string;
                 environment?: string;
                 expectations?: Array<string>;
+                includeFlowExpectations?: boolean;
                 persona?: string;
                 prompt?: string;
                 title?: string;
@@ -2463,6 +2809,74 @@ export declare namespace ConfigDiffParams {
                 timezone?: string;
             }
         }
+        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;
+        }
+        namespace SimulationGroupConfig {
+            interface Notify {
+                email?: boolean | Array<string>;
+                slack?: Array<Notify.Slack>;
+            }
+            namespace Notify {
+                interface Slack {
+                    channelId: string;
+                    channelName: string;
+                }
+            }
+            interface UnionMember0 {
+                type: 'hourly';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                minute?: number;
+                timezone?: string;
+            }
+            interface UnionMember1 {
+                everyMinutes: number;
+                type: 'interval';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember2 {
+                time: string;
+                type: 'daily';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember3 {
+                days: Array<'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'>;
+                time: string;
+                type: 'weekly';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember4 {
+                dayOfMonth: number;
+                time: string;
+                type: 'monthly';
+                enabled?: boolean;
+                endDate?: string;
+                maxRuns?: number;
+                timezone?: string;
+            }
+            interface UnionMember5 {
+                at: string;
+                type: 'once';
+                enabled?: boolean;
+                timezone?: string;
+            }
+        }
         interface AlertConfig {
             kind: 'alert';
             name: string;