@roarkanalytics/sdk 3.10.0 → 3.12.0

package/src/resources/config.ts

@@ -49,6 +49,7 @@ export interface Bundle {
     | Bundle.ScriptedFlowConfig
     | Bundle.CollectorConfig
     | Bundle.MetricConfig
+    | Bundle.SimulationPlanConfig
     | Bundle.AlertConfig
   >;
 
@@ -65,18 +66,22 @@ export namespace Bundle {
 
     description?: string | null;
 
+    displayName?: string;
+
     endpoints?: Array<AgentConfig.Endpoint>;
+
+    prompt?: string | null;
   }
 
   export namespace AgentConfig {
     export interface Endpoint {
-      direction: 'INCOMING' | 'OUTGOING' | 'INCOMING_AND_OUTGOING';
-
-      name: string;
-
       value: string;
 
+      direction?: 'INCOMING' | 'OUTGOING' | 'INCOMING_AND_OUTGOING';
+
       environment?: string;
+
+      type?: 'PHONE' | 'WEBSOCKET';
     }
   }
 
@@ -146,7 +151,17 @@ export namespace Bundle {
 
     backstoryPrompt?: string | null;
 
-    baseEmotion?: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
+    baseEmotion?:
+      | 'NEUTRAL'
+      | 'CHEERFUL'
+      | 'CONFUSED'
+      | 'FRUSTRATED'
+      | 'SKEPTICAL'
+      | 'RUSHED'
+      | 'DISTRACTED'
+      | 'ANGRY'
+      | 'ANXIOUS'
+      | 'SAD';
 
     confirmationStyle?: 'EXPLICIT' | 'VAGUE';
 
@@ -257,6 +272,8 @@ export namespace Bundle {
 
     type: 'scripted';
 
+    adherence?: 'LOOSE' | 'STRICT';
+
     agents?: Array<string>;
 
     branchingMode?: 'DETERMINISTIC' | 'ADAPTIVE';
@@ -265,9 +282,25 @@ export namespace Bundle {
 
     expectations?: Array<string>;
 
+    offScript?: ScriptedFlowConfig.OffScript;
+
     title?: string;
   }
 
+  export namespace ScriptedFlowConfig {
+    export interface OffScript {
+      maxAttempts?: number;
+
+      reaction?: 'STAY_SILENT' | 'REPEAT' | 'RESPOND' | 'SAY';
+
+      sayLine?: string;
+
+      then?: 'HANG_UP' | 'MOVE_ON' | 'ADAPT' | 'HANG_UP_INVALIDATE';
+
+      waitSeconds?: number;
+    }
+  }
+
   export interface CollectorConfig {
     kind: 'collector';
 
@@ -364,6 +397,64 @@ export namespace Bundle {
     }
   }
 
+  export interface SimulationPlanConfig {
+    agentEndpoints: Array<SimulationPlanConfig.AgentEndpoint>;
+
+    direction: 'INBOUND' | 'OUTBOUND';
+
+    flows: Array<SimulationPlanConfig.Flow>;
+
+    kind: 'simulationPlan';
+
+    maxDurationSeconds: number;
+
+    metrics: Array<string>;
+
+    name: string;
+
+    description?: string | null;
+
+    endCallPhrases?: Array<string>;
+
+    endCallReasons?: Array<string>;
+
+    enrichWithLiveConversation?: boolean;
+
+    executionMode?: 'PARALLEL' | 'SEQUENTIAL_SAME_RUN_PLAN' | 'SEQUENTIAL_PROJECT';
+
+    includeAutomaticMetrics?: boolean;
+
+    includeFlowMetrics?: boolean;
+
+    iterations?: number;
+
+    maxConcurrentJobs?: number;
+
+    silenceTimeoutSeconds?: number;
+  }
+
+  export namespace SimulationPlanConfig {
+    export interface AgentEndpoint {
+      agent: string;
+
+      direction?: 'INCOMING' | 'OUTGOING' | 'INCOMING_AND_OUTGOING';
+
+      value?: string;
+    }
+
+    export interface Flow {
+      edgeCases?: Array<string>;
+
+      flow?: string;
+
+      happyPath?: boolean;
+
+      personaOverride?: string;
+
+      system?: string;
+    }
+  }
+
   export interface AlertConfig {
     kind: 'alert';
 
@@ -435,7 +526,7 @@ export namespace Bundle {
 
       deliveryFormat?: 'MESSAGE' | 'PDF';
 
-      runPlan?: string;
+      plan?: string;
     }
 
     export interface Actions {
@@ -459,6 +550,7 @@ export interface ConfigFlowStep {
     | 'AGENT_TURN'
     | 'CUSTOMER_TURN'
     | 'CUSTOMER_FIRST_MESSAGE'
+    | 'CUSTOMER_VERBATIM_TURN'
     | 'CUSTOMER_SILENCE'
     | 'CUSTOMER_DTMF'
     | 'AGENT_DTMF'
@@ -473,6 +565,8 @@ export interface ConfigFlowStep {
 
   mergeInto?: Array<string>;
 
+  offScript?: ConfigFlowStep.OffScript;
+
   ref?: string;
 
   silenceDurationSeconds?: number;
@@ -480,6 +574,20 @@ export interface ConfigFlowStep {
   steps?: Array<ConfigAPI.ConfigFlowStep>;
 }
 
+export namespace ConfigFlowStep {
+  export interface OffScript {
+    maxAttempts?: number;
+
+    reaction?: 'STAY_SILENT' | 'REPEAT' | 'RESPOND' | 'SAY';
+
+    sayLine?: string;
+
+    then?: 'HANG_UP' | 'MOVE_ON' | 'ADAPT' | 'HANG_UP_INVALIDATE';
+
+    waitSeconds?: number;
+  }
+}
+
 export interface ConfigApplyResponse {
   data: ConfigApplyResponse.Data;
 }
@@ -495,7 +603,7 @@ export namespace ConfigApplyResponse {
     export interface Change {
       configKey: string;
 
-      kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric' | 'alert';
+      kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric' | 'simulationPlan' | 'alert';
 
       name: string;
 
@@ -539,7 +647,7 @@ export namespace ConfigDiffResponse {
     export interface Change {
       configKey: string;
 
-      kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric' | 'alert';
+      kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric' | 'simulationPlan' | 'alert';
 
       name: string;
 
@@ -568,6 +676,7 @@ export interface ConfigApplyParams {
     | ConfigApplyParams.ScriptedFlowConfig
     | ConfigApplyParams.CollectorConfig
     | ConfigApplyParams.MetricConfig
+    | ConfigApplyParams.SimulationPlanConfig
     | ConfigApplyParams.AlertConfig
   >;
 
@@ -584,18 +693,22 @@ export namespace ConfigApplyParams {
 
     description?: string | null;
 
+    displayName?: string;
+
     endpoints?: Array<AgentConfig.Endpoint>;
+
+    prompt?: string | null;
   }
 
   export namespace AgentConfig {
     export interface Endpoint {
-      direction: 'INCOMING' | 'OUTGOING' | 'INCOMING_AND_OUTGOING';
-
-      name: string;
-
       value: string;
 
+      direction?: 'INCOMING' | 'OUTGOING' | 'INCOMING_AND_OUTGOING';
+
       environment?: string;
+
+      type?: 'PHONE' | 'WEBSOCKET';
     }
   }
 
@@ -665,7 +778,17 @@ export namespace ConfigApplyParams {
 
     backstoryPrompt?: string | null;
 
-    baseEmotion?: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
+    baseEmotion?:
+      | 'NEUTRAL'
+      | 'CHEERFUL'
+      | 'CONFUSED'
+      | 'FRUSTRATED'
+      | 'SKEPTICAL'
+      | 'RUSHED'
+      | 'DISTRACTED'
+      | 'ANGRY'
+      | 'ANXIOUS'
+      | 'SAD';
 
     confirmationStyle?: 'EXPLICIT' | 'VAGUE';
 
@@ -776,6 +899,8 @@ export namespace ConfigApplyParams {
 
     type: 'scripted';
 
+    adherence?: 'LOOSE' | 'STRICT';
+
     agents?: Array<string>;
 
     branchingMode?: 'DETERMINISTIC' | 'ADAPTIVE';
@@ -784,9 +909,25 @@ export namespace ConfigApplyParams {
 
     expectations?: Array<string>;
 
+    offScript?: ScriptedFlowConfig.OffScript;
+
     title?: string;
   }
 
+  export namespace ScriptedFlowConfig {
+    export interface OffScript {
+      maxAttempts?: number;
+
+      reaction?: 'STAY_SILENT' | 'REPEAT' | 'RESPOND' | 'SAY';
+
+      sayLine?: string;
+
+      then?: 'HANG_UP' | 'MOVE_ON' | 'ADAPT' | 'HANG_UP_INVALIDATE';
+
+      waitSeconds?: number;
+    }
+  }
+
   export interface CollectorConfig {
     kind: 'collector';
 
@@ -883,6 +1024,64 @@ export namespace ConfigApplyParams {
     }
   }
 
+  export interface SimulationPlanConfig {
+    agentEndpoints: Array<SimulationPlanConfig.AgentEndpoint>;
+
+    direction: 'INBOUND' | 'OUTBOUND';
+
+    flows: Array<SimulationPlanConfig.Flow>;
+
+    kind: 'simulationPlan';
+
+    maxDurationSeconds: number;
+
+    metrics: Array<string>;
+
+    name: string;
+
+    description?: string | null;
+
+    endCallPhrases?: Array<string>;
+
+    endCallReasons?: Array<string>;
+
+    enrichWithLiveConversation?: boolean;
+
+    executionMode?: 'PARALLEL' | 'SEQUENTIAL_SAME_RUN_PLAN' | 'SEQUENTIAL_PROJECT';
+
+    includeAutomaticMetrics?: boolean;
+
+    includeFlowMetrics?: boolean;
+
+    iterations?: number;
+
+    maxConcurrentJobs?: number;
+
+    silenceTimeoutSeconds?: number;
+  }
+
+  export namespace SimulationPlanConfig {
+    export interface AgentEndpoint {
+      agent: string;
+
+      direction?: 'INCOMING' | 'OUTGOING' | 'INCOMING_AND_OUTGOING';
+
+      value?: string;
+    }
+
+    export interface Flow {
+      edgeCases?: Array<string>;
+
+      flow?: string;
+
+      happyPath?: boolean;
+
+      personaOverride?: string;
+
+      system?: string;
+    }
+  }
+
   export interface AlertConfig {
     kind: 'alert';
 
@@ -954,7 +1153,7 @@ export namespace ConfigApplyParams {
 
       deliveryFormat?: 'MESSAGE' | 'PDF';
 
-      runPlan?: string;
+      plan?: string;
     }
 
     export interface Actions {
@@ -981,6 +1180,7 @@ export interface ConfigDiffParams {
     | ConfigDiffParams.ScriptedFlowConfig
     | ConfigDiffParams.CollectorConfig
     | ConfigDiffParams.MetricConfig
+    | ConfigDiffParams.SimulationPlanConfig
     | ConfigDiffParams.AlertConfig
   >;
 
@@ -997,18 +1197,22 @@ export namespace ConfigDiffParams {
 
     description?: string | null;
 
+    displayName?: string;
+
     endpoints?: Array<AgentConfig.Endpoint>;
+
+    prompt?: string | null;
   }
 
   export namespace AgentConfig {
     export interface Endpoint {
-      direction: 'INCOMING' | 'OUTGOING' | 'INCOMING_AND_OUTGOING';
-
-      name: string;
-
       value: string;
 
+      direction?: 'INCOMING' | 'OUTGOING' | 'INCOMING_AND_OUTGOING';
+
       environment?: string;
+
+      type?: 'PHONE' | 'WEBSOCKET';
     }
   }
 
@@ -1078,7 +1282,17 @@ export namespace ConfigDiffParams {
 
     backstoryPrompt?: string | null;
 
-    baseEmotion?: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
+    baseEmotion?:
+      | 'NEUTRAL'
+      | 'CHEERFUL'
+      | 'CONFUSED'
+      | 'FRUSTRATED'
+      | 'SKEPTICAL'
+      | 'RUSHED'
+      | 'DISTRACTED'
+      | 'ANGRY'
+      | 'ANXIOUS'
+      | 'SAD';
 
     confirmationStyle?: 'EXPLICIT' | 'VAGUE';
 
@@ -1189,6 +1403,8 @@ export namespace ConfigDiffParams {
 
     type: 'scripted';
 
+    adherence?: 'LOOSE' | 'STRICT';
+
     agents?: Array<string>;
 
     branchingMode?: 'DETERMINISTIC' | 'ADAPTIVE';
@@ -1197,9 +1413,25 @@ export namespace ConfigDiffParams {
 
     expectations?: Array<string>;
 
+    offScript?: ScriptedFlowConfig.OffScript;
+
     title?: string;
   }
 
+  export namespace ScriptedFlowConfig {
+    export interface OffScript {
+      maxAttempts?: number;
+
+      reaction?: 'STAY_SILENT' | 'REPEAT' | 'RESPOND' | 'SAY';
+
+      sayLine?: string;
+
+      then?: 'HANG_UP' | 'MOVE_ON' | 'ADAPT' | 'HANG_UP_INVALIDATE';
+
+      waitSeconds?: number;
+    }
+  }
+
   export interface CollectorConfig {
     kind: 'collector';
 
@@ -1296,6 +1528,64 @@ export namespace ConfigDiffParams {
     }
   }
 
+  export interface SimulationPlanConfig {
+    agentEndpoints: Array<SimulationPlanConfig.AgentEndpoint>;
+
+    direction: 'INBOUND' | 'OUTBOUND';
+
+    flows: Array<SimulationPlanConfig.Flow>;
+
+    kind: 'simulationPlan';
+
+    maxDurationSeconds: number;
+
+    metrics: Array<string>;
+
+    name: string;
+
+    description?: string | null;
+
+    endCallPhrases?: Array<string>;
+
+    endCallReasons?: Array<string>;
+
+    enrichWithLiveConversation?: boolean;
+
+    executionMode?: 'PARALLEL' | 'SEQUENTIAL_SAME_RUN_PLAN' | 'SEQUENTIAL_PROJECT';
+
+    includeAutomaticMetrics?: boolean;
+
+    includeFlowMetrics?: boolean;
+
+    iterations?: number;
+
+    maxConcurrentJobs?: number;
+
+    silenceTimeoutSeconds?: number;
+  }
+
+  export namespace SimulationPlanConfig {
+    export interface AgentEndpoint {
+      agent: string;
+
+      direction?: 'INCOMING' | 'OUTGOING' | 'INCOMING_AND_OUTGOING';
+
+      value?: string;
+    }
+
+    export interface Flow {
+      edgeCases?: Array<string>;
+
+      flow?: string;
+
+      happyPath?: boolean;
+
+      personaOverride?: string;
+
+      system?: string;
+    }
+  }
+
   export interface AlertConfig {
     kind: 'alert';
 
@@ -1367,7 +1657,7 @@ export namespace ConfigDiffParams {
 
       deliveryFormat?: 'MESSAGE' | 'PDF';
 
-      runPlan?: string;
+      plan?: string;
     }
 
     export interface Actions {