@roarkanalytics/sdk 3.10.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
        */
@@ -262,7 +275,7 @@ export namespace SimulationRunPlanCreateResponse {
         /**
          * The customer flow to run.
          */
-        id: string;
+        id?: string;
 
         /**
          * `"ALL"` runs every edge case the flow has when the run starts, so one added
@@ -281,6 +294,13 @@ export namespace SimulationRunPlanCreateResponse {
          */
         personaOverrideId?: string | null;
 
+        /**
+         * The Roark-curated flow to run, by its stable slug. Use instead of `id` for a run
+         * you keep in version control: a curated flow’s id differs between deployments,
+         * its slug does not. Your own flows have no slug and are named by `id`.
+         */
+        slug?: string;
+
         /**
          * Values for everything it resolves.
          */
@@ -292,13 +312,21 @@ export namespace SimulationRunPlanCreateResponse {
           /**
            * The edge case to run.
            */
-          id: string;
+          id?: string;
 
           /**
            * Run this one as that persona instead of its own.
            */
           personaOverrideId?: string | null;
 
+          /**
+           * The edge case to run, by its stable slug, matched within this flow. Use instead
+           * of `id` for a run you keep in version control: a curated edge case’s id differs
+           * between deployments and changes outright if it is renamed. Your own edge cases
+           * have no slug and are named by `id`.
+           */
+          slug?: string;
+
           /**
            * Values for this one only.
            */
@@ -433,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
      */
@@ -516,7 +557,7 @@ export namespace SimulationRunPlanUpdateResponse {
       /**
        * The customer flow to run.
        */
-      id: string;
+      id?: string;
 
       /**
        * `"ALL"` runs every edge case the flow has when the run starts, so one added
@@ -535,6 +576,13 @@ export namespace SimulationRunPlanUpdateResponse {
        */
       personaOverrideId?: string | null;
 
+      /**
+       * The Roark-curated flow to run, by its stable slug. Use instead of `id` for a run
+       * you keep in version control: a curated flow’s id differs between deployments,
+       * its slug does not. Your own flows have no slug and are named by `id`.
+       */
+      slug?: string;
+
       /**
        * Values for everything it resolves.
        */
@@ -546,13 +594,21 @@ export namespace SimulationRunPlanUpdateResponse {
         /**
          * The edge case to run.
          */
-        id: string;
+        id?: string;
 
         /**
          * Run this one as that persona instead of its own.
          */
         personaOverrideId?: string | null;
 
+        /**
+         * The edge case to run, by its stable slug, matched within this flow. Use instead
+         * of `id` for a run you keep in version control: a curated edge case’s id differs
+         * between deployments and changes outright if it is renamed. Your own edge cases
+         * have no slug and are named by `id`.
+         */
+        slug?: string;
+
         /**
          * Values for this one only.
          */
@@ -651,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
      */
@@ -734,7 +803,7 @@ export namespace SimulationRunPlanListResponse {
       /**
        * The customer flow to run.
        */
-      id: string;
+      id?: string;
 
       /**
        * `"ALL"` runs every edge case the flow has when the run starts, so one added
@@ -753,6 +822,13 @@ export namespace SimulationRunPlanListResponse {
        */
       personaOverrideId?: string | null;
 
+      /**
+       * The Roark-curated flow to run, by its stable slug. Use instead of `id` for a run
+       * you keep in version control: a curated flow’s id differs between deployments,
+       * its slug does not. Your own flows have no slug and are named by `id`.
+       */
+      slug?: string;
+
       /**
        * Values for everything it resolves.
        */
@@ -764,13 +840,21 @@ export namespace SimulationRunPlanListResponse {
         /**
          * The edge case to run.
          */
-        id: string;
+        id?: string;
 
         /**
          * Run this one as that persona instead of its own.
          */
         personaOverrideId?: string | null;
 
+        /**
+         * The edge case to run, by its stable slug, matched within this flow. Use instead
+         * of `id` for a run you keep in version control: a curated edge case’s id differs
+         * between deployments and changes outright if it is renamed. Your own edge cases
+         * have no slug and are named by `id`.
+         */
+        slug?: string;
+
         /**
          * Values for this one only.
          */
@@ -897,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
      */
@@ -980,7 +1077,7 @@ export namespace SimulationRunPlanGetByIDResponse {
       /**
        * The customer flow to run.
        */
-      id: string;
+      id?: string;
 
       /**
        * `"ALL"` runs every edge case the flow has when the run starts, so one added
@@ -999,6 +1096,13 @@ export namespace SimulationRunPlanGetByIDResponse {
        */
       personaOverrideId?: string | null;
 
+      /**
+       * The Roark-curated flow to run, by its stable slug. Use instead of `id` for a run
+       * you keep in version control: a curated flow’s id differs between deployments,
+       * its slug does not. Your own flows have no slug and are named by `id`.
+       */
+      slug?: string;
+
       /**
        * Values for everything it resolves.
        */
@@ -1010,13 +1114,21 @@ export namespace SimulationRunPlanGetByIDResponse {
         /**
          * The edge case to run.
          */
-        id: string;
+        id?: string;
 
         /**
          * Run this one as that persona instead of its own.
          */
         personaOverrideId?: string | null;
 
+        /**
+         * The edge case to run, by its stable slug, matched within this flow. Use instead
+         * of `id` for a run you keep in version control: a curated edge case’s id differs
+         * between deployments and changes outright if it is renamed. Your own edge cases
+         * have no slug and are named by `id`.
+         */
+        slug?: string;
+
         /**
          * Values for this one only.
          */
@@ -1127,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.
@@ -1216,7 +1344,7 @@ export namespace SimulationRunPlanCreateParams {
     /**
      * The customer flow to run.
      */
-    id: string;
+    id?: string;
 
     /**
      * `"ALL"` runs every edge case the flow has when the run starts, so one added
@@ -1235,6 +1363,13 @@ export namespace SimulationRunPlanCreateParams {
      */
     personaOverrideId?: string | null;
 
+    /**
+     * The Roark-curated flow to run, by its stable slug. Use instead of `id` for a run
+     * you keep in version control: a curated flow’s id differs between deployments,
+     * its slug does not. Your own flows have no slug and are named by `id`.
+     */
+    slug?: string;
+
     /**
      * Values for everything it resolves.
      */
@@ -1246,13 +1381,21 @@ export namespace SimulationRunPlanCreateParams {
       /**
        * The edge case to run.
        */
-      id: string;
+      id?: string;
 
       /**
        * Run this one as that persona instead of its own.
        */
       personaOverrideId?: string | null;
 
+      /**
+       * The edge case to run, by its stable slug, matched within this flow. Use instead
+       * of `id` for a run you keep in version control: a curated edge case’s id differs
+       * between deployments and changes outright if it is renamed. Your own edge cases
+       * have no slug and are named by `id`.
+       */
+      slug?: string;
+
       /**
        * Values for this one only.
        */
@@ -1322,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.
@@ -1397,7 +1546,7 @@ export namespace SimulationRunPlanUpdateParams {
     /**
      * The customer flow to run.
      */
-    id: string;
+    id?: string;
 
     /**
      * `"ALL"` runs every edge case the flow has when the run starts, so one added
@@ -1416,6 +1565,13 @@ export namespace SimulationRunPlanUpdateParams {
      */
     personaOverrideId?: string | null;
 
+    /**
+     * The Roark-curated flow to run, by its stable slug. Use instead of `id` for a run
+     * you keep in version control: a curated flow’s id differs between deployments,
+     * its slug does not. Your own flows have no slug and are named by `id`.
+     */
+    slug?: string;
+
     /**
      * Values for everything it resolves.
      */
@@ -1427,13 +1583,21 @@ export namespace SimulationRunPlanUpdateParams {
       /**
        * The edge case to run.
        */
-      id: string;
+      id?: string;
 
       /**
        * Run this one as that persona instead of its own.
        */
       personaOverrideId?: string | null;
 
+      /**
+       * The edge case to run, by its stable slug, matched within this flow. Use instead
+       * of `id` for a run you keep in version control: a curated edge case’s id differs
+       * between deployments and changes outright if it is renamed. Your own edge cases
+       * have no slug and are named by `id`.
+       */
+      slug?: string;
+
       /**
        * Values for this one only.
        */

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.