@roarkanalytics/sdk 3.9.0 → 3.10.0

package/src/resources/simulation-template.ts

@@ -0,0 +1,190 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+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?: RequestOptions): APIPromise<SimulationTemplateListResponse> {
+    return this._client.get('/v1/simulation/template', options);
+  }
+}
+
+/**
+ * The built-in simulation templates.
+ */
+export interface SimulationTemplateListResponse {
+  data: Array<SimulationTemplateListResponse.Data>;
+}
+
+export namespace SimulationTemplateListResponse {
+  /**
+   * A built-in simulation template, resolved against this project: what it measures
+   * and what it runs.
+   */
+  export interface Data {
+    /**
+     * Grouping used in the dashboard library
+     */
+    category: string;
+
+    /**
+     * The per-simulation cap a run from this template uses unless the request sets its
+     * own.
+     */
+    defaultMaxSimulationDurationSeconds: number;
+
+    /**
+     * What this template tests
+     */
+    description: string;
+
+    /**
+     * The flows this template runs, and which of their ways of running it covers.
+     *
+     * Empty means the template presets only what to measure, and a run has to say what
+     * to measure it on: pass `flows` to POST /v1/simulation/run. When it is not empty
+     * you can still pass `flows` to narrow it, naming a subset of the ids listed here.
+     */
+    flows: Array<Data.Flow>;
+
+    /**
+     * Whether runs from this template also collect each attached flow's own metrics,
+     * on top of the template's set.
+     */
+    includeFlowMetrics: boolean;
+
+    /**
+     * The metrics this template collects, resolved to this project's definitions.
+     */
+    metrics: Array<Data.Metric>;
+
+    /**
+     * Stable identifier. Name this in a run request.
+     */
+    slug: string;
+
+    /**
+     * The Pass/Fail checks this template attaches alongside its metrics.
+     */
+    thresholds: Array<Data.Threshold>;
+
+    /**
+     * Display name
+     */
+    title: string;
+  }
+
+  export namespace Data {
+    export interface Flow {
+      /**
+       * Customer flow ID
+       */
+      id: string;
+
+      /**
+       * The other ways of running this flow that this template covers.
+       */
+      edgeCases: Array<Flow.EdgeCase>;
+
+      /**
+       * The flow's default way of running, when this template covers it. Null when it
+       * does not, or the flow has none.
+       */
+      happyPath: Flow.HappyPath | null;
+
+      /**
+       * The stable slug of a Roark-curated flow, null for one of your own.
+       *
+       * Prefer this over `id` when you are storing a run in version control: a curated
+       * flow is a global row, so its id is the same for every project but differs
+       * between deployments, while the slug is stable wherever the flow exists. Both are
+       * accepted by a run request.
+       */
+      slug: string | null;
+
+      /**
+       * Flow title
+       */
+      title: string;
+    }
+
+    export namespace Flow {
+      export interface EdgeCase {
+        /**
+         * Customer flow variant ID
+         */
+        id: string;
+
+        /**
+         * The stable slug of a Roark-curated edge case, null for one of your own.
+         *
+         * Prefer this over `id` in a run you keep in version control. A curated edge case
+         * is a global row, so its id differs between deployments, and renaming one
+         * replaces the row and its id outright. The slug survives both.
+         */
+        slug: string | null;
+
+        /**
+         * What this way of running the flow is called
+         */
+        title: string;
+      }
+
+      /**
+       * The flow's default way of running, when this template covers it. Null when it
+       * does not, or the flow has none.
+       */
+      export interface HappyPath {
+        title: string;
+      }
+    }
+
+    export interface Metric {
+      /**
+       * Metric definition ID
+       */
+      id: string;
+
+      /**
+       * Stable metric slug, e.g. "response_time"
+       */
+      slug: string;
+    }
+
+    export interface Threshold {
+      /**
+       * Metric definition ID
+       */
+      id: string;
+
+      /**
+       * Stable metric slug, e.g. "response_time"
+       */
+      slug: string;
+    }
+  }
+}
+
+export declare namespace SimulationTemplate {
+  export { type SimulationTemplateListResponse as SimulationTemplateListResponse };
+}

package/src/resources/simulation.ts

@@ -211,6 +211,20 @@ export declare namespace SimulationRunParams {
        */
       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/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.9.0'; // x-release-please-version
+export const VERSION = '3.10.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.d.ts

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

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.js

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

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}

package/version.mjs

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

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}