@roarkanalytics/sdk 3.9.0 → 3.11.0

package/src/resources/customer-flow.ts

@@ -461,6 +461,8 @@ export namespace CustomerFlowCreateResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -774,6 +776,8 @@ export namespace CustomerFlowCreateResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -1174,6 +1178,8 @@ export namespace CustomerFlowCreateResponse {
        * The brief the simulated customer improvises from.
        */
       prompt?: string | null;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -1485,6 +1491,8 @@ export namespace CustomerFlowCreateResponse {
        * The brief the simulated customer improvises from.
        */
       prompt?: string | null;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -1879,6 +1887,8 @@ export namespace CustomerFlowCreateResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -2185,6 +2195,8 @@ export namespace CustomerFlowCreateResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -2616,6 +2628,8 @@ export namespace CustomerFlowUpdateResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -2929,6 +2943,8 @@ export namespace CustomerFlowUpdateResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -3329,6 +3345,8 @@ export namespace CustomerFlowUpdateResponse {
        * The brief the simulated customer improvises from.
        */
       prompt?: string | null;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -3640,6 +3658,8 @@ export namespace CustomerFlowUpdateResponse {
        * The brief the simulated customer improvises from.
        */
       prompt?: string | null;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -4034,6 +4054,8 @@ export namespace CustomerFlowUpdateResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -4340,6 +4362,8 @@ export namespace CustomerFlowUpdateResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -4774,6 +4798,8 @@ export namespace CustomerFlowListResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -5087,6 +5113,8 @@ export namespace CustomerFlowListResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -5487,6 +5515,8 @@ export namespace CustomerFlowListResponse {
        * The brief the simulated customer improvises from.
        */
       prompt?: string | null;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -5798,6 +5828,8 @@ export namespace CustomerFlowListResponse {
        * The brief the simulated customer improvises from.
        */
       prompt?: string | null;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -6192,6 +6224,8 @@ export namespace CustomerFlowListResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -6498,6 +6532,8 @@ export namespace CustomerFlowListResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -6959,6 +6995,8 @@ export namespace CustomerFlowGetByIDResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -7272,6 +7310,8 @@ export namespace CustomerFlowGetByIDResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -7672,6 +7712,8 @@ export namespace CustomerFlowGetByIDResponse {
        * The brief the simulated customer improvises from.
        */
       prompt?: string | null;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -7983,6 +8025,8 @@ export namespace CustomerFlowGetByIDResponse {
        * The brief the simulated customer improvises from.
        */
       prompt?: string | null;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -8377,6 +8421,8 @@ export namespace CustomerFlowGetByIDResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace EdgeCase {
@@ -8683,6 +8729,8 @@ export namespace CustomerFlowGetByIDResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace HappyPath {
@@ -9026,6 +9074,8 @@ export namespace CustomerFlowReplaceGraphResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace ScriptedFlowVariant {
@@ -9337,6 +9387,8 @@ export namespace CustomerFlowReplaceGraphResponse {
        * The brief the simulated customer improvises from.
        */
       prompt?: string | null;
+
+      systemKey?: string | null;
     }
 
     export namespace ImprovFlowVariant {
@@ -9643,6 +9695,8 @@ export namespace CustomerFlowReplaceGraphResponse {
        * Last update timestamp in ISO 8601 format
        */
       updatedAt: string;
+
+      systemKey?: string | null;
     }
 
     export namespace VoicemailFlowVariant {
@@ -9969,6 +10023,8 @@ export namespace CustomerFlowUpdateHappyPathResponse {
      * Last update timestamp in ISO 8601 format
      */
     updatedAt: string;
+
+    systemKey?: string | null;
   }
 
   export namespace ScriptedFlowVariant {
@@ -10273,6 +10329,8 @@ export namespace CustomerFlowUpdateHappyPathResponse {
      * The brief the simulated customer improvises from.
      */
     prompt?: string | null;
+
+    systemKey?: string | null;
   }
 
   export namespace ImprovFlowVariant {
@@ -10572,6 +10630,8 @@ export namespace CustomerFlowUpdateHappyPathResponse {
      * Last update timestamp in ISO 8601 format
      */
     updatedAt: string;
+
+    systemKey?: string | null;
   }
 
   export namespace VoicemailFlowVariant {

package/src/resources/index.ts

@@ -164,6 +164,7 @@ export {
   type SimulationRunPlanJobListParams,
   type SimulationRunPlanJobStartParams,
 } from './simulation-run-plan-job';
+export { SimulationTemplate, type SimulationTemplateListResponse } from './simulation-template';
 export {
   Webhook,
   type WebhookCreateResponse,

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

@@ -179,6 +179,12 @@ export namespace SimulationRunPlanCreateResponse {
        */
       flows: Array<RunPlan.Flow>;
 
+      /**
+       * Whether this plan also collects each attached flow's own metrics, on top of its
+       * own list.
+       */
+      includeFlowMetrics: boolean;
+
       /**
        * Number of iterations to run for each test case
        */
@@ -256,7 +262,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
@@ -275,6 +281,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.
          */
@@ -286,13 +299,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.
            */
@@ -427,6 +448,12 @@ export namespace SimulationRunPlanUpdateResponse {
      */
     flows: Array<Data.Flow>;
 
+    /**
+     * Whether this plan also collects each attached flow's own metrics, on top of its
+     * own list.
+     */
+    includeFlowMetrics: boolean;
+
     /**
      * Number of iterations to run for each test case
      */
@@ -504,7 +531,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
@@ -523,6 +550,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.
        */
@@ -534,13 +568,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.
          */
@@ -639,6 +681,12 @@ export namespace SimulationRunPlanListResponse {
      */
     flows: Array<Data.Flow>;
 
+    /**
+     * Whether this plan also collects each attached flow's own metrics, on top of its
+     * own list.
+     */
+    includeFlowMetrics: boolean;
+
     /**
      * Number of iterations to run for each test case
      */
@@ -716,7 +764,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
@@ -735,6 +783,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.
        */
@@ -746,13 +801,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.
          */
@@ -879,6 +942,12 @@ export namespace SimulationRunPlanGetByIDResponse {
      */
     flows: Array<Data.Flow>;
 
+    /**
+     * Whether this plan also collects each attached flow's own metrics, on top of its
+     * own list.
+     */
+    includeFlowMetrics: boolean;
+
     /**
      * Number of iterations to run for each test case
      */
@@ -956,7 +1025,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
@@ -975,6 +1044,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.
        */
@@ -986,13 +1062,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.
          */
@@ -1103,6 +1187,20 @@ export interface SimulationRunPlanCreateParams {
    */
   flows?: Array<SimulationRunPlanCreateParams.Flow>;
 
+  /**
+   * Also collect each attached flow's own metrics, on top of the `metrics` named
+   * here.
+   *
+   * Default true, which is what you want when you brought your own flows and their
+   * graders. Set false for a run whose metric list is meant to be exhaustive: a
+   * template like Load Testing or Voicemail deliberately grades a narrow set, and
+   * inheriting every flow metric on top multiplies analysis cost across the volume
+   * without adding signal.
+   *
+   * GET /v1/simulation/template returns the value each template expects.
+   */
+  includeFlowMetrics?: boolean;
+
   /**
    * Number of iterations to run for each test case (1-10000)
    */
@@ -1178,7 +1276,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
@@ -1197,6 +1295,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.
      */
@@ -1208,13 +1313,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.
        */
@@ -1284,6 +1397,12 @@ export interface SimulationRunPlanUpdateParams {
    */
   flows?: Array<SimulationRunPlanUpdateParams.Flow>;
 
+  /**
+   * Whether to also collect each attached flow's own metrics, on top of this plan's
+   * list.
+   */
+  includeFlowMetrics?: boolean;
+
   /**
    * Whether this plan is hidden from GET /v1/simulation/plan.
    *
@@ -1353,7 +1472,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
@@ -1372,6 +1491,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.
      */
@@ -1383,13 +1509,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.
        */