@roarkanalytics/sdk 3.11.0 → 3.12.0

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

@@ -216,6 +216,12 @@ export namespace SimulationRunPlanJobGetByIDResponse {
        */
       createdAt: string;
 
+      /**
+       * Present when the run was invalidated: it keeps its transcript and recording, but
+       * nothing scored it and it is excluded from every run total.
+       */
+      invalidation: SimulationJob.Invalidation | null;
+
       persona: SimulationJob.Persona;
 
       /**
@@ -313,6 +319,28 @@ export namespace SimulationRunPlanJobGetByIDResponse {
           | 'DAILY';
       }
 
+      /**
+       * Present when the run was invalidated: it keeps its transcript and recording, but
+       * nothing scored it and it is excluded from every run total.
+       */
+      export interface Invalidation {
+        /**
+         * When the run was invalidated.
+         */
+        invalidatedAt: string;
+
+        /**
+         * Why the result does not count. `SCRIPT_DIVERGED`: a strict flow went off script
+         * at a step whose off-script policy is HANG_UP_INVALIDATE.
+         */
+        reason: 'SCRIPT_DIVERGED';
+
+        /**
+         * One sentence: where the script was left and what your agent did instead.
+         */
+        detail?: string | null;
+      }
+
       export interface Persona {
         /**
          * Unique identifier of the persona
@@ -377,7 +405,10 @@ export namespace SimulationRunPlanJobGetByIDResponse {
           | 'FRUSTRATED'
           | 'SKEPTICAL'
           | 'RUSHED'
-          | 'DISTRACTED';
+          | 'DISTRACTED'
+          | 'ANGRY'
+          | 'ANXIOUS'
+          | 'SAD';
 
         /**
          * How the persona confirms information
@@ -519,6 +550,13 @@ export namespace SimulationRunPlanJobGetByIDResponse {
          */
         description?: string | null;
 
+        /**
+         * Label shown in place of the name across the dashboard (e.g. a short descriptor
+         * like "Irate Escalator"). The persona still identifies as `name` on calls. Omit
+         * or set null to display the name itself.
+         */
+        displayName?: string | null;
+
         /**
          * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
          */

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

@@ -179,12 +179,25 @@ export namespace SimulationRunPlanCreateResponse {
        */
       flows: Array<RunPlan.Flow>;
 
+      /**
+       * Whether this plan lets a run add metrics by itself off the attached flows, on
+       * top of its own list. False means the `metrics` list is the whole answer.
+       */
+      includeAutomaticMetrics: boolean;
+
       /**
        * Whether this plan also collects each attached flow's own metrics, on top of its
        * own list.
        */
       includeFlowMetrics: boolean;
 
+      /**
+       * Whether this plan is managed by config as code. A managed plan is reconciled
+       * from your config: PUT and DELETE on it return 409, and changes belong in the
+       * config file.
+       */
+      isConfigManaged: boolean;
+
       /**
        * Number of iterations to run for each test case
        */
@@ -448,12 +461,25 @@ export namespace SimulationRunPlanUpdateResponse {
      */
     flows: Array<Data.Flow>;
 
+    /**
+     * Whether this plan lets a run add metrics by itself off the attached flows, on
+     * top of its own list. False means the `metrics` list is the whole answer.
+     */
+    includeAutomaticMetrics: boolean;
+
     /**
      * Whether this plan also collects each attached flow's own metrics, on top of its
      * own list.
      */
     includeFlowMetrics: boolean;
 
+    /**
+     * Whether this plan is managed by config as code. A managed plan is reconciled
+     * from your config: PUT and DELETE on it return 409, and changes belong in the
+     * config file.
+     */
+    isConfigManaged: boolean;
+
     /**
      * Number of iterations to run for each test case
      */
@@ -681,12 +707,25 @@ export namespace SimulationRunPlanListResponse {
      */
     flows: Array<Data.Flow>;
 
+    /**
+     * Whether this plan lets a run add metrics by itself off the attached flows, on
+     * top of its own list. False means the `metrics` list is the whole answer.
+     */
+    includeAutomaticMetrics: boolean;
+
     /**
      * Whether this plan also collects each attached flow's own metrics, on top of its
      * own list.
      */
     includeFlowMetrics: boolean;
 
+    /**
+     * Whether this plan is managed by config as code. A managed plan is reconciled
+     * from your config: PUT and DELETE on it return 409, and changes belong in the
+     * config file.
+     */
+    isConfigManaged: boolean;
+
     /**
      * Number of iterations to run for each test case
      */
@@ -942,12 +981,25 @@ export namespace SimulationRunPlanGetByIDResponse {
      */
     flows: Array<Data.Flow>;
 
+    /**
+     * Whether this plan lets a run add metrics by itself off the attached flows, on
+     * top of its own list. False means the `metrics` list is the whole answer.
+     */
+    includeAutomaticMetrics: boolean;
+
     /**
      * Whether this plan also collects each attached flow's own metrics, on top of its
      * own list.
      */
     includeFlowMetrics: boolean;
 
+    /**
+     * Whether this plan is managed by config as code. A managed plan is reconciled
+     * from your config: PUT and DELETE on it return 409, and changes belong in the
+     * config file.
+     */
+    isConfigManaged: boolean;
+
     /**
      * Number of iterations to run for each test case
      */
@@ -1187,6 +1239,22 @@ export interface SimulationRunPlanCreateParams {
    */
   flows?: Array<SimulationRunPlanCreateParams.Flow>;
 
+  /**
+   * Let the run add metrics by itself off the attached flows, on top of the
+   * `metrics` named here.
+   *
+   * Two attach this way today: Agent Expectations wherever an attached flow has
+   * agent expectations written on it, and Keypad Entry wherever one has steps where
+   * the agent is expected to press keys. Both grade something authored on the flow
+   * that nothing else measures, which is why it is on by default.
+   *
+   * Set false when the `metrics` list is meant to be exhaustive: a plan testing only
+   * whether the caller can complete the flow may not want the agent graded on its
+   * expectations as well. False also pins the plan against any automatic metric
+   * Roark adds later.
+   */
+  includeAutomaticMetrics?: boolean;
+
   /**
    * Also collect each attached flow's own metrics, on top of the `metrics` named
    * here.
@@ -1397,6 +1465,12 @@ export interface SimulationRunPlanUpdateParams {
    */
   flows?: Array<SimulationRunPlanUpdateParams.Flow>;
 
+  /**
+   * Whether to let the run add metrics by itself off the attached flows. See
+   * `POST /v1/simulation/plan`.
+   */
+  includeAutomaticMetrics?: boolean;
+
   /**
    * Whether to also collect each attached flow's own metrics, on top of this plan's
    * list.

package/src/resources/simulation-template.ts

@@ -47,6 +47,17 @@ export namespace SimulationTemplateListResponse {
      */
     category: string;
 
+    /**
+     * The end-call conditions a run from this template uses unless the request sets
+     * its own.
+     *
+     * Empty for templates whose calls end when the agent says goodbye. Non-empty where
+     * the template runs scripted flows that finish on a verdict: the simulated caller
+     * hangs up on an end-call phrase or one of these, so a run that discards them
+     * would stay on the line until the duration cap.
+     */
+    defaultEndCallReasons: Array<string>;
+
     /**
      * The per-simulation cap a run from this template uses unless the request sets its
      * own.

package/src/resources/simulation.ts

@@ -219,6 +219,22 @@ export declare namespace SimulationRunParams {
        */
       flows?: Array<Plan.Flow>;
 
+      /**
+       * Let the run add metrics by itself off the attached flows, on top of the
+       * `metrics` named here.
+       *
+       * Two attach this way today: Agent Expectations wherever an attached flow has
+       * agent expectations written on it, and Keypad Entry wherever one has steps where
+       * the agent is expected to press keys. Both grade something authored on the flow
+       * that nothing else measures, which is why it is on by default.
+       *
+       * Set false when the `metrics` list is meant to be exhaustive: a plan testing only
+       * whether the caller can complete the flow may not want the agent graded on its
+       * expectations as well. False also pins the plan against any automatic metric
+       * Roark adds later.
+       */
+      includeAutomaticMetrics?: boolean;
+
       /**
        * Also collect each attached flow's own metrics, on top of the `metrics` named
        * here.
@@ -523,7 +539,8 @@ export declare namespace SimulationRunParams {
 
     /**
      * Semantic conditions that trigger end of call. The LLM evaluates the conversation
-     * against these conditions. Empty array disables the feature.
+     * against these conditions. Defaults to the template's `defaultEndCallReasons`, as
+     * returned by GET /v1/simulation/template. Pass an empty array to run with none.
      */
     endCallReasons?: Array<string>;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.11.0'; // x-release-please-version
+export const VERSION = '3.12.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.11.0";
+export declare const VERSION = "3.12.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 = '3.11.0'; // x-release-please-version
+exports.VERSION = '3.12.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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