@roarkanalytics/sdk 2.23.1 → 2.25.0

package/src/resources/simulation-run-plan.ts

@@ -18,10 +18,10 @@ export class SimulationRunPlan extends APIResource {
    *       { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
    *     ],
    *     direction: 'INBOUND',
-   *     evaluators: [
+   *     maxSimulationDurationSeconds: 300,
+   *     metrics: [
    *       { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
    *     ],
-   *     maxSimulationDurationSeconds: 300,
    *     name: 'My Run Plan',
    *     personas: [
    *       { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
@@ -154,7 +154,12 @@ export namespace SimulationRunPlanCreateResponse {
       direction: 'INBOUND' | 'OUTBOUND';
 
       /**
-       * Evaluators included in this run plan
+       * Phrases that trigger end of call. Empty array means disabled.
+       */
+      endCallPhrases: Array<string>;
+
+      /**
+       * Deprecated: Use metrics instead. Evaluators included in this run plan.
        */
       evaluators: Array<RunPlan.Evaluator>;
 
@@ -178,6 +183,11 @@ export namespace SimulationRunPlanCreateResponse {
        */
       maxSimulationDurationSeconds: number;
 
+      /**
+       * Metric definitions included in this run plan
+       */
+      metrics: Array<RunPlan.Metric>;
+
       /**
        * Name of the run plan
        */
@@ -223,6 +233,10 @@ export namespace SimulationRunPlanCreateResponse {
         id: string;
       }
 
+      export interface Metric {
+        id: string;
+      }
+
       export interface Persona {
         id: string;
       }
@@ -302,7 +316,12 @@ export namespace SimulationRunPlanUpdateResponse {
     direction: 'INBOUND' | 'OUTBOUND';
 
     /**
-     * Evaluators included in this run plan
+     * Phrases that trigger end of call. Empty array means disabled.
+     */
+    endCallPhrases: Array<string>;
+
+    /**
+     * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
     evaluators: Array<Data.Evaluator>;
 
@@ -326,6 +345,11 @@ export namespace SimulationRunPlanUpdateResponse {
      */
     maxSimulationDurationSeconds: number;
 
+    /**
+     * Metric definitions included in this run plan
+     */
+    metrics: Array<Data.Metric>;
+
     /**
      * Name of the run plan
      */
@@ -371,6 +395,10 @@ export namespace SimulationRunPlanUpdateResponse {
       id: string;
     }
 
+    export interface Metric {
+      id: string;
+    }
+
     export interface Persona {
       id: string;
     }
@@ -416,7 +444,12 @@ export namespace SimulationRunPlanListResponse {
     direction: 'INBOUND' | 'OUTBOUND';
 
     /**
-     * Evaluators included in this run plan
+     * Phrases that trigger end of call. Empty array means disabled.
+     */
+    endCallPhrases: Array<string>;
+
+    /**
+     * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
     evaluators: Array<Data.Evaluator>;
 
@@ -440,6 +473,11 @@ export namespace SimulationRunPlanListResponse {
      */
     maxSimulationDurationSeconds: number;
 
+    /**
+     * Metric definitions included in this run plan
+     */
+    metrics: Array<Data.Metric>;
+
     /**
      * Name of the run plan
      */
@@ -485,6 +523,10 @@ export namespace SimulationRunPlanListResponse {
       id: string;
     }
 
+    export interface Metric {
+      id: string;
+    }
+
     export interface Persona {
       id: string;
     }
@@ -558,7 +600,12 @@ export namespace SimulationRunPlanGetByIDResponse {
     direction: 'INBOUND' | 'OUTBOUND';
 
     /**
-     * Evaluators included in this run plan
+     * Phrases that trigger end of call. Empty array means disabled.
+     */
+    endCallPhrases: Array<string>;
+
+    /**
+     * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
     evaluators: Array<Data.Evaluator>;
 
@@ -582,6 +629,11 @@ export namespace SimulationRunPlanGetByIDResponse {
      */
     maxSimulationDurationSeconds: number;
 
+    /**
+     * Metric definitions included in this run plan
+     */
+    metrics: Array<Data.Metric>;
+
     /**
      * Name of the run plan
      */
@@ -627,6 +679,10 @@ export namespace SimulationRunPlanGetByIDResponse {
       id: string;
     }
 
+    export interface Metric {
+      id: string;
+    }
+
     export interface Persona {
       id: string;
     }
@@ -649,14 +705,14 @@ export interface SimulationRunPlanCreateParams {
   direction: 'INBOUND' | 'OUTBOUND';
 
   /**
-   * Evaluators to include in this run plan
+   * Maximum duration in seconds for each simulation
    */
-  evaluators: Array<SimulationRunPlanCreateParams.Evaluator>;
+  maxSimulationDurationSeconds: number;
 
   /**
-   * Maximum duration in seconds for each simulation
+   * Metric definitions to include in this run plan
    */
-  maxSimulationDurationSeconds: number;
+  metrics: Array<SimulationRunPlanCreateParams.Metric>;
 
   /**
    * Name of the run plan
@@ -669,7 +725,8 @@ export interface SimulationRunPlanCreateParams {
   personas: Array<SimulationRunPlanCreateParams.Persona>;
 
   /**
-   * Scenarios to include in this run plan
+   * Scenarios to include in this run plan. The same scenario ID can appear multiple
+   * times with different variables.
    */
   scenarios: Array<SimulationRunPlanCreateParams.Scenario>;
 
@@ -683,6 +740,11 @@ export interface SimulationRunPlanCreateParams {
    */
   description?: string;
 
+  /**
+   * Phrases that trigger end of call. Empty array disables the feature.
+   */
+  endCallPhrases?: Array<string>;
+
   /**
    * Execution mode (PARALLEL or SEQUENTIAL)
    */
@@ -710,7 +772,7 @@ export namespace SimulationRunPlanCreateParams {
     id: string;
   }
 
-  export interface Evaluator {
+  export interface Metric {
     id: string;
   }
 
@@ -719,7 +781,16 @@ export namespace SimulationRunPlanCreateParams {
   }
 
   export interface Scenario {
+    /**
+     * Scenario ID
+     */
     id: string;
+
+    /**
+     * Template variables for this scenario instance. The same scenario can appear
+     * multiple times with different variables.
+     */
+    variables?: { [key: string]: string };
   }
 }
 
@@ -740,9 +811,9 @@ export interface SimulationRunPlanUpdateParams {
   direction?: 'INBOUND' | 'OUTBOUND';
 
   /**
-   * Evaluators to include in this run plan
+   * Phrases that trigger end of call. Empty array disables the feature.
    */
-  evaluators?: Array<SimulationRunPlanUpdateParams.Evaluator>;
+  endCallPhrases?: Array<string>;
 
   /**
    * Execution mode (PARALLEL or SEQUENTIAL)
@@ -765,6 +836,11 @@ export interface SimulationRunPlanUpdateParams {
    */
   maxSimulationDurationSeconds?: number;
 
+  /**
+   * Metric definitions to include in this run plan
+   */
+  metrics?: Array<SimulationRunPlanUpdateParams.Metric>;
+
   /**
    * Name of the run plan
    */
@@ -776,7 +852,8 @@ export interface SimulationRunPlanUpdateParams {
   personas?: Array<SimulationRunPlanUpdateParams.Persona>;
 
   /**
-   * Scenarios to include in this run plan
+   * Scenarios to include in this run plan. The same scenario ID can appear multiple
+   * times with different variables.
    */
   scenarios?: Array<SimulationRunPlanUpdateParams.Scenario>;
 
@@ -791,7 +868,7 @@ export namespace SimulationRunPlanUpdateParams {
     id: string;
   }
 
-  export interface Evaluator {
+  export interface Metric {
     id: string;
   }
 
@@ -800,7 +877,16 @@ export namespace SimulationRunPlanUpdateParams {
   }
 
   export interface Scenario {
+    /**
+     * Scenario ID
+     */
     id: string;
+
+    /**
+     * Template variables for this scenario instance. The same scenario can appear
+     * multiple times with different variables.
+     */
+    variables?: { [key: string]: string };
   }
 }
 

package/src/resources/simulation-scenario.ts

@@ -110,7 +110,14 @@ export namespace SimulationScenarioCreateResponse {
         | 'CUSTOMER_TURN'
         | 'CUSTOMER_FIRST_MESSAGE'
         | 'CUSTOMER_SILENCE'
+        | 'CUSTOMER_DTMF'
         | 'VOICEMAIL';
+
+      /**
+       * DTMF digits to send during this step (e.g. 1w2w3#). Valid characters: 0-9, \*,
+       * #, w/W for pauses.
+       */
+      dtmfDigits?: string | null;
     }
   }
 }
@@ -173,7 +180,14 @@ export namespace SimulationScenarioUpdateResponse {
         | 'CUSTOMER_TURN'
         | 'CUSTOMER_FIRST_MESSAGE'
         | 'CUSTOMER_SILENCE'
+        | 'CUSTOMER_DTMF'
         | 'VOICEMAIL';
+
+      /**
+       * DTMF digits to send during this step (e.g. 1w2w3#). Valid characters: 0-9, \*,
+       * #, w/W for pauses.
+       */
+      dtmfDigits?: string | null;
     }
   }
 }
@@ -238,7 +252,14 @@ export namespace SimulationScenarioListResponse {
         | 'CUSTOMER_TURN'
         | 'CUSTOMER_FIRST_MESSAGE'
         | 'CUSTOMER_SILENCE'
+        | 'CUSTOMER_DTMF'
         | 'VOICEMAIL';
+
+      /**
+       * DTMF digits to send during this step (e.g. 1w2w3#). Valid characters: 0-9, \*,
+       * #, w/W for pauses.
+       */
+      dtmfDigits?: string | null;
     }
   }
 
@@ -331,7 +352,14 @@ export namespace SimulationScenarioGetByIDResponse {
         | 'CUSTOMER_TURN'
         | 'CUSTOMER_FIRST_MESSAGE'
         | 'CUSTOMER_SILENCE'
+        | 'CUSTOMER_DTMF'
         | 'VOICEMAIL';
+
+      /**
+       * DTMF digits to send during this step (e.g. 1w2w3#). Valid characters: 0-9, \*,
+       * #, w/W for pauses.
+       */
+      dtmfDigits?: string | null;
     }
   }
 }
@@ -361,7 +389,13 @@ export namespace SimulationScenarioCreateParams {
     /**
      * The type of this step
      */
-    type: 'AGENT_TURN' | 'CUSTOMER_TURN' | 'CUSTOMER_FIRST_MESSAGE' | 'CUSTOMER_SILENCE' | 'VOICEMAIL';
+    type:
+      | 'AGENT_TURN'
+      | 'CUSTOMER_TURN'
+      | 'CUSTOMER_FIRST_MESSAGE'
+      | 'CUSTOMER_SILENCE'
+      | 'CUSTOMER_DTMF'
+      | 'VOICEMAIL';
   }
 }
 
@@ -399,7 +433,13 @@ export namespace SimulationScenarioUpdateParams {
     /**
      * The type of the new step
      */
-    type: 'AGENT_TURN' | 'CUSTOMER_TURN' | 'CUSTOMER_FIRST_MESSAGE' | 'CUSTOMER_SILENCE' | 'VOICEMAIL';
+    type:
+      | 'AGENT_TURN'
+      | 'CUSTOMER_TURN'
+      | 'CUSTOMER_FIRST_MESSAGE'
+      | 'CUSTOMER_SILENCE'
+      | 'CUSTOMER_DTMF'
+      | 'VOICEMAIL';
   }
 
   /**
@@ -424,7 +464,13 @@ export namespace SimulationScenarioUpdateParams {
     /**
      * The new type of the step (optional)
      */
-    type?: 'AGENT_TURN' | 'CUSTOMER_TURN' | 'CUSTOMER_FIRST_MESSAGE' | 'CUSTOMER_SILENCE' | 'VOICEMAIL';
+    type?:
+      | 'AGENT_TURN'
+      | 'CUSTOMER_TURN'
+      | 'CUSTOMER_FIRST_MESSAGE'
+      | 'CUSTOMER_SILENCE'
+      | 'CUSTOMER_DTMF'
+      | 'VOICEMAIL';
   }
 
   /**

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.23.1'; // x-release-please-version
+export const VERSION = '2.25.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.23.1";
+export declare const VERSION = "2.25.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.23.1";
+export declare const VERSION = "2.25.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.23.1'; // x-release-please-version
+exports.VERSION = '2.25.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.23.1'; // x-release-please-version
+export const VERSION = '2.25.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map