@roarkanalytics/sdk 3.9.0 → 3.10.0

package/resources/simulation-template.js

@@ -0,0 +1,31 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimulationTemplate = void 0;
+const resource_1 = require("../core/resource.js");
+class SimulationTemplate extends resource_1.APIResource {
+    /**
+     * Returns the built-in simulation templates, each resolved against this project:
+     * the metric and check definitions it collects, and the flows it runs with the
+     * variants it covers.
+     *
+     * A template is a preset rather than a stored object, so building a run from one
+     * produces an ordinary run plan you own and can edit afterwards. Pass a `slug` as
+     * `template` to POST /v1/simulation/run.
+     *
+     * Every entry is complete, so there is no per-template endpoint to follow up with,
+     * and the list is a fixed catalogue rather than a paginated one. Only templates a
+     * request can actually run are listed.
+     *
+     * @example
+     * ```ts
+     * const simulationTemplates =
+     *   await client.simulationTemplate.list();
+     * ```
+     */
+    list(options) {
+        return this._client.get('/v1/simulation/template', options);
+    }
+}
+exports.SimulationTemplate = SimulationTemplate;
+//# sourceMappingURL=simulation-template.js.map

package/resources/simulation-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulation-template.js","sourceRoot":"","sources":["../src/resources/simulation-template.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,kBAAmB,SAAQ,sBAAW;IACjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;CACF;AAvBD,gDAuBC"}

package/resources/simulation-template.mjs

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+export class SimulationTemplate extends APIResource {
+    /**
+     * Returns the built-in simulation templates, each resolved against this project:
+     * the metric and check definitions it collects, and the flows it runs with the
+     * variants it covers.
+     *
+     * A template is a preset rather than a stored object, so building a run from one
+     * produces an ordinary run plan you own and can edit afterwards. Pass a `slug` as
+     * `template` to POST /v1/simulation/run.
+     *
+     * Every entry is complete, so there is no per-template endpoint to follow up with,
+     * and the list is a fixed catalogue rather than a paginated one. Only templates a
+     * request can actually run are listed.
+     *
+     * @example
+     * ```ts
+     * const simulationTemplates =
+     *   await client.simulationTemplate.list();
+     * ```
+     */
+    list(options) {
+        return this._client.get('/v1/simulation/template', options);
+    }
+}
+//# sourceMappingURL=simulation-template.mjs.map

package/resources/simulation-template.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulation-template.mjs","sourceRoot":"","sources":["../src/resources/simulation-template.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IACjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;CACF"}

package/resources/simulation.d.mts

@@ -169,6 +169,19 @@ export declare namespace SimulationRunParams {
              * once with a different persona override or different variables.
              */
             flows?: Array<Plan.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)
              */

package/resources/simulation.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"simulation.d.mts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;;WAGG;QACH,MAAM,EACF,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,GACZ,oBAAoB,CAAC;KAC1B;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,uBAAuB,GAC3C,mBAAmB,CAAC,uBAAuB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,uBAAuB;QACtC;;WAEG;QACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;QAEnC;;;;;;;WAOG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAE1C;;eAEG;YACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,4BAA4B,EAAE,MAAM,CAAC;YAErC;;;eAGG;YACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE5B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;eAGG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;;;;;;;;;;;eAaG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,aAAa,CAAC,EAAE,UAAU,GAAG,0BAA0B,GAAG,oBAAoB,CAAC;YAE/E;;;eAGG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEzB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,QAAQ,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/B;;;eAGG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEjC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;SAChC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,aAAa;gBAC5B,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,CAAC;gBAEZ;;;;;;;;;mBASG;gBACH,kBAAkB,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;gBAEjD;;;mBAGG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;mBAGG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;YAED;;;;;;eAMG;YACH,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;;mBAIG;gBACH,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAE7C;;mBAEG;gBACH,SAAS,CAAC,EAAE,OAAO,CAAC;gBAEpB;;mBAEG;gBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElC;;mBAEG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;YAED,UAAiB,IAAI,CAAC;gBACpB,UAAiB,YAAY;oBAC3B;;uBAEG;oBACH,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;oBAElC;;uBAEG;oBACH,SAAS,CAAC,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;iBACvC;aACF;YAED,UAAiB,OAAO;gBACtB,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;mBAGG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;SACF;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,uBAAuB;QACtC;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"simulation.d.mts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;;WAGG;QACH,MAAM,EACF,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,GACZ,oBAAoB,CAAC;KAC1B;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,uBAAuB,GAC3C,mBAAmB,CAAC,uBAAuB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,uBAAuB;QACtC;;WAEG;QACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;QAEnC;;;;;;;WAOG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAE1C;;eAEG;YACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,4BAA4B,EAAE,MAAM,CAAC;YAErC;;;eAGG;YACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE5B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;eAGG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;;;;;;;;;;;eAaG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,aAAa,CAAC,EAAE,UAAU,GAAG,0BAA0B,GAAG,oBAAoB,CAAC;YAE/E;;;eAGG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEzB;;;;;;;;;;;eAWG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,QAAQ,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/B;;;eAGG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEjC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;SAChC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,aAAa;gBAC5B,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,CAAC;gBAEZ;;;;;;;;;mBASG;gBACH,kBAAkB,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;gBAEjD;;;mBAGG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;mBAGG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;YAED;;;;;;eAMG;YACH,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;;mBAIG;gBACH,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAE7C;;mBAEG;gBACH,SAAS,CAAC,EAAE,OAAO,CAAC;gBAEpB;;mBAEG;gBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElC;;mBAEG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;YAED,UAAiB,IAAI,CAAC;gBACpB,UAAiB,YAAY;oBAC3B;;uBAEG;oBACH,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;oBAElC;;uBAEG;oBACH,SAAS,CAAC,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;iBACvC;aACF;YAED,UAAiB,OAAO;gBACtB,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;mBAGG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;SACF;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,uBAAuB;QACtC;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/simulation.d.ts

@@ -169,6 +169,19 @@ export declare namespace SimulationRunParams {
              * once with a different persona override or different variables.
              */
             flows?: Array<Plan.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)
              */

package/resources/simulation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"simulation.d.ts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;;WAGG;QACH,MAAM,EACF,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,GACZ,oBAAoB,CAAC;KAC1B;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,uBAAuB,GAC3C,mBAAmB,CAAC,uBAAuB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,uBAAuB;QACtC;;WAEG;QACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;QAEnC;;;;;;;WAOG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAE1C;;eAEG;YACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,4BAA4B,EAAE,MAAM,CAAC;YAErC;;;eAGG;YACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE5B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;eAGG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;;;;;;;;;;;eAaG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,aAAa,CAAC,EAAE,UAAU,GAAG,0BAA0B,GAAG,oBAAoB,CAAC;YAE/E;;;eAGG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEzB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,QAAQ,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/B;;;eAGG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEjC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;SAChC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,aAAa;gBAC5B,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,CAAC;gBAEZ;;;;;;;;;mBASG;gBACH,kBAAkB,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;gBAEjD;;;mBAGG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;mBAGG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;YAED;;;;;;eAMG;YACH,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;;mBAIG;gBACH,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAE7C;;mBAEG;gBACH,SAAS,CAAC,EAAE,OAAO,CAAC;gBAEpB;;mBAEG;gBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElC;;mBAEG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;YAED,UAAiB,IAAI,CAAC;gBACpB,UAAiB,YAAY;oBAC3B;;uBAEG;oBACH,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;oBAElC;;uBAEG;oBACH,SAAS,CAAC,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;iBACvC;aACF;YAED,UAAiB,OAAO;gBACtB,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;mBAGG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;SACF;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,uBAAuB;QACtC;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"simulation.d.ts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;;WAGG;QACH,MAAM,EACF,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,GACZ,oBAAoB,CAAC;KAC1B;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,uBAAuB,GAC3C,mBAAmB,CAAC,uBAAuB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,uBAAuB;QACtC;;WAEG;QACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;QAEnC;;;;;;;WAOG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAE1C;;eAEG;YACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,4BAA4B,EAAE,MAAM,CAAC;YAErC;;;eAGG;YACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE5B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;eAGG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;;;;;;;;;;;eAaG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,aAAa,CAAC,EAAE,UAAU,GAAG,0BAA0B,GAAG,oBAAoB,CAAC;YAE/E;;;eAGG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEzB;;;;;;;;;;;eAWG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,QAAQ,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/B;;;eAGG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEjC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;SAChC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,aAAa;gBAC5B,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,CAAC;gBAEZ;;;;;;;;;mBASG;gBACH,kBAAkB,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;gBAEjD;;;mBAGG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;mBAGG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;YAED;;;;;;eAMG;YACH,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;;mBAIG;gBACH,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAE7C;;mBAEG;gBACH,SAAS,CAAC,EAAE,OAAO,CAAC;gBAEpB;;mBAEG;gBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElC;;mBAEG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;YAED,UAAiB,IAAI,CAAC;gBACpB,UAAiB,YAAY;oBAC3B;;uBAEG;oBACH,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;oBAElC;;uBAEG;oBACH,SAAS,CAAC,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;iBACvC;aACF;YAED,UAAiB,OAAO;gBACtB,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;mBAGG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;SACF;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,uBAAuB;QACtC;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/src/client.ts

@@ -181,6 +181,7 @@ import {
   SimulationRunPlanJobStartParams,
   SimulationRunPlanJobStartResponse,
 } from './resources/simulation-run-plan-job';
+import { SimulationTemplate, SimulationTemplateListResponse } from './resources/simulation-template';
 import {
   Webhook,
   WebhookCreateParams,
@@ -919,6 +920,7 @@ export class Roark {
   simulationRunPlanJob: API.SimulationRunPlanJob = new API.SimulationRunPlanJob(this);
   simulationPersona: API.SimulationPersona = new API.SimulationPersona(this);
   simulationEnvironment: API.SimulationEnvironment = new API.SimulationEnvironment(this);
+  simulationTemplate: API.SimulationTemplate = new API.SimulationTemplate(this);
   customerFlow: API.CustomerFlow = new API.CustomerFlow(this);
   customerFlowEdgeCase: API.CustomerFlowEdgeCase = new API.CustomerFlowEdgeCase(this);
   agent: API.Agent = new API.Agent(this);
@@ -940,6 +942,7 @@ Roark.SimulationRunPlan = SimulationRunPlan;
 Roark.SimulationRunPlanJob = SimulationRunPlanJob;
 Roark.SimulationPersona = SimulationPersona;
 Roark.SimulationEnvironment = SimulationEnvironment;
+Roark.SimulationTemplate = SimulationTemplate;
 Roark.CustomerFlow = CustomerFlow;
 Roark.CustomerFlowEdgeCase = CustomerFlowEdgeCase;
 Roark.Agent = Agent;
@@ -1065,6 +1068,11 @@ export declare namespace Roark {
     type SimulationEnvironmentListParams as SimulationEnvironmentListParams,
   };
 
+  export {
+    SimulationTemplate as SimulationTemplate,
+    type SimulationTemplateListResponse as SimulationTemplateListResponse,
+  };
+
   export {
     CustomerFlow as CustomerFlow,
     type FlowStep as FlowStep,

package/src/resources/customer-flow-edge-case.ts

@@ -162,6 +162,8 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
      * Last update timestamp in ISO 8601 format
      */
     updatedAt: string;
+
+    systemKey?: string | null;
   }
 
   export namespace ScriptedFlowVariant {
@@ -466,6 +468,8 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
      * The brief the simulated customer improvises from.
      */
     prompt?: string | null;
+
+    systemKey?: string | null;
   }
 
   export namespace ImprovFlowVariant {
@@ -765,6 +769,8 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
      * Last update timestamp in ISO 8601 format
      */
     updatedAt: string;
+
+    systemKey?: string | null;
   }
 
   export namespace VoicemailFlowVariant {
@@ -1083,6 +1089,8 @@ export namespace CustomerFlowEdgeCaseAddResponse {
      * Last update timestamp in ISO 8601 format
      */
     updatedAt: string;
+
+    systemKey?: string | null;
   }
 
   export namespace ScriptedFlowVariant {
@@ -1387,6 +1395,8 @@ export namespace CustomerFlowEdgeCaseAddResponse {
      * The brief the simulated customer improvises from.
      */
     prompt?: string | null;
+
+    systemKey?: string | null;
   }
 
   export namespace ImprovFlowVariant {
@@ -1686,6 +1696,8 @@ export namespace CustomerFlowEdgeCaseAddResponse {
      * Last update timestamp in ISO 8601 format
      */
     updatedAt: string;
+
+    systemKey?: string | null;
   }
 
   export namespace VoicemailFlowVariant {
@@ -2004,6 +2016,8 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
      * Last update timestamp in ISO 8601 format
      */
     updatedAt: string;
+
+    systemKey?: string | null;
   }
 
   export namespace ScriptedFlowVariant {
@@ -2308,6 +2322,8 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
      * The brief the simulated customer improvises from.
      */
     prompt?: string | null;
+
+    systemKey?: string | null;
   }
 
   export namespace ImprovFlowVariant {
@@ -2607,6 +2623,8 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
      * Last update timestamp in ISO 8601 format
      */
     updatedAt: string;
+
+    systemKey?: string | null;
   }
 
   export namespace VoicemailFlowVariant {

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
        */
@@ -427,6 +433,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
      */
@@ -639,6 +651,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
      */
@@ -879,6 +897,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
      */
@@ -1103,6 +1127,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)
    */
@@ -1284,6 +1322,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.
    *