@roarkanalytics/sdk 5.14.0 → 5.16.0

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

@@ -279,6 +279,12 @@ export namespace SimulationRunPlanCreateResponse {
        */
       noResponseRetryBackoffSeconds: number;
 
+      /**
+       * Where each run's report announces itself once it is ready. Email off and no
+       * Slack channels means the plan sends none.
+       */
+      notifications: RunPlan.Notifications;
+
       /**
        * Personas included in this run plan. Only meaningful alongside `scenarios`.
        */
@@ -448,6 +454,30 @@ export namespace SimulationRunPlanCreateResponse {
         minPassRate: number | null;
       }
 
+      /**
+       * Where each run's report announces itself once it is ready. Email off and no
+       * Slack channels means the plan sends none.
+       */
+      export interface Notifications {
+        email: Notifications.Email;
+
+        slack: Array<Notifications.Slack>;
+      }
+
+      export namespace Notifications {
+        export interface Email {
+          enabled: boolean;
+
+          recipients: Array<string>;
+        }
+
+        export interface Slack {
+          channelId: string;
+
+          channelName: string;
+        }
+      }
+
       export interface Persona {
         id: string;
       }
@@ -659,6 +689,12 @@ export namespace SimulationRunPlanUpdateResponse {
      */
     noResponseRetryBackoffSeconds: number;
 
+    /**
+     * Where each run's report announces itself once it is ready. Email off and no
+     * Slack channels means the plan sends none.
+     */
+    notifications: Data.Notifications;
+
     /**
      * Personas included in this run plan. Only meaningful alongside `scenarios`.
      */
@@ -828,6 +864,30 @@ export namespace SimulationRunPlanUpdateResponse {
       minPassRate: number | null;
     }
 
+    /**
+     * Where each run's report announces itself once it is ready. Email off and no
+     * Slack channels means the plan sends none.
+     */
+    export interface Notifications {
+      email: Notifications.Email;
+
+      slack: Array<Notifications.Slack>;
+    }
+
+    export namespace Notifications {
+      export interface Email {
+        enabled: boolean;
+
+        recipients: Array<string>;
+      }
+
+      export interface Slack {
+        channelId: string;
+
+        channelName: string;
+      }
+    }
+
     export interface Persona {
       id: string;
     }
@@ -1003,6 +1063,12 @@ export namespace SimulationRunPlanListResponse {
      */
     noResponseRetryBackoffSeconds: number;
 
+    /**
+     * Where each run's report announces itself once it is ready. Email off and no
+     * Slack channels means the plan sends none.
+     */
+    notifications: Data.Notifications;
+
     /**
      * Personas included in this run plan. Only meaningful alongside `scenarios`.
      */
@@ -1172,6 +1238,30 @@ export namespace SimulationRunPlanListResponse {
       minPassRate: number | null;
     }
 
+    /**
+     * Where each run's report announces itself once it is ready. Email off and no
+     * Slack channels means the plan sends none.
+     */
+    export interface Notifications {
+      email: Notifications.Email;
+
+      slack: Array<Notifications.Slack>;
+    }
+
+    export namespace Notifications {
+      export interface Email {
+        enabled: boolean;
+
+        recipients: Array<string>;
+      }
+
+      export interface Slack {
+        channelId: string;
+
+        channelName: string;
+      }
+    }
+
     export interface Persona {
       id: string;
     }
@@ -1375,6 +1465,12 @@ export namespace SimulationRunPlanGetByIDResponse {
      */
     noResponseRetryBackoffSeconds: number;
 
+    /**
+     * Where each run's report announces itself once it is ready. Email off and no
+     * Slack channels means the plan sends none.
+     */
+    notifications: Data.Notifications;
+
     /**
      * Personas included in this run plan. Only meaningful alongside `scenarios`.
      */
@@ -1544,6 +1640,30 @@ export namespace SimulationRunPlanGetByIDResponse {
       minPassRate: number | null;
     }
 
+    /**
+     * Where each run's report announces itself once it is ready. Email off and no
+     * Slack channels means the plan sends none.
+     */
+    export interface Notifications {
+      email: Notifications.Email;
+
+      slack: Array<Notifications.Slack>;
+    }
+
+    export namespace Notifications {
+      export interface Email {
+        enabled: boolean;
+
+        recipients: Array<string>;
+      }
+
+      export interface Slack {
+        channelId: string;
+
+        channelName: string;
+      }
+    }
+
     export interface Persona {
       id: string;
     }
@@ -1785,6 +1905,13 @@ export declare namespace SimulationRunPlanCreateParams {
      */
     noResponseRetryBackoffSeconds?: number;
 
+    /**
+     * Email and/or Slack delivery of each run's report once it is ready, with the
+     * report PDF attached. Each run announces once, off its first report. Omitted: no
+     * notifications.
+     */
+    notifications?: CreateRunPlanFromConfig.Notifications;
+
     /**
      * Personas to include in this run plan. Required with `scenarios`; ignored with
      * `flows`, where each variant carries its own persona.
@@ -1976,6 +2103,48 @@ export declare namespace SimulationRunPlanCreateParams {
       slug?: string;
     }
 
+    /**
+     * Email and/or Slack delivery of each run's report once it is ready, with the
+     * report PDF attached. Each run announces once, off its first report. Omitted: no
+     * notifications.
+     */
+    export interface Notifications {
+      email?: Notifications.Email;
+
+      /**
+       * Channels in the project's connected Slack workspace to post the report to (at
+       * most 10). Slack must be connected to the project first.
+       */
+      slack?: Array<Notifications.Slack>;
+    }
+
+    export namespace Notifications {
+      export interface Email {
+        /**
+         * Whether each run's report is emailed when it is ready.
+         */
+        enabled: boolean;
+
+        /**
+         * Addresses to email (at most 50), Roark users or not: the email attaches the
+         * report PDF. Empty emails every member of the project.
+         */
+        recipients?: Array<string>;
+      }
+
+      export interface Slack {
+        /**
+         * The Slack channel id
+         */
+        channelId: string;
+
+        /**
+         * The channel name, shown in Roark
+         */
+        channelName: string;
+      }
+    }
+
     export interface Persona {
       id: string;
     }
@@ -2142,6 +2311,13 @@ export declare namespace SimulationRunPlanCreateParams {
      */
     noResponseRetryBackoffSeconds?: number;
 
+    /**
+     * Email and/or Slack delivery of each run's report once it is ready, with the
+     * report PDF attached. Each run announces once, off its first report. Omitted: no
+     * notifications.
+     */
+    notifications?: CreateRunPlanFromTemplate.Notifications;
+
     /**
      * For `question-answer-check`: the persona that asks the questions.
      */
@@ -2332,6 +2508,48 @@ export declare namespace SimulationRunPlanCreateParams {
       }
     }
 
+    /**
+     * Email and/or Slack delivery of each run's report once it is ready, with the
+     * report PDF attached. Each run announces once, off its first report. Omitted: no
+     * notifications.
+     */
+    export interface Notifications {
+      email?: Notifications.Email;
+
+      /**
+       * Channels in the project's connected Slack workspace to post the report to (at
+       * most 10). Slack must be connected to the project first.
+       */
+      slack?: Array<Notifications.Slack>;
+    }
+
+    export namespace Notifications {
+      export interface Email {
+        /**
+         * Whether each run's report is emailed when it is ready.
+         */
+        enabled: boolean;
+
+        /**
+         * Addresses to email (at most 50), Roark users or not: the email attaches the
+         * report PDF. Empty emails every member of the project.
+         */
+        recipients?: Array<string>;
+      }
+
+      export interface Slack {
+        /**
+         * The Slack channel id
+         */
+        channelId: string;
+
+        /**
+         * The channel name, shown in Roark
+         */
+        channelName: string;
+      }
+    }
+
     export interface Question {
       /**
        * The question the caller asks the agent.
@@ -2508,6 +2726,11 @@ export interface SimulationRunPlanUpdateParams {
    */
   noResponseRetryBackoffSeconds?: number;
 
+  /**
+   * Where each run's report announces itself once it is ready.
+   */
+  notifications?: SimulationRunPlanUpdateParams.Notifications | null;
+
   /**
    * Personas to include in this run plan
    */
@@ -2699,6 +2922,46 @@ export namespace SimulationRunPlanUpdateParams {
     slug?: string;
   }
 
+  /**
+   * Where each run's report announces itself once it is ready.
+   */
+  export interface Notifications {
+    email?: Notifications.Email;
+
+    /**
+     * Channels in the project's connected Slack workspace to post the report to (at
+     * most 10). Slack must be connected to the project first.
+     */
+    slack?: Array<Notifications.Slack>;
+  }
+
+  export namespace Notifications {
+    export interface Email {
+      /**
+       * Whether each run's report is emailed when it is ready.
+       */
+      enabled: boolean;
+
+      /**
+       * Addresses to email (at most 50), Roark users or not: the email attaches the
+       * report PDF. Empty emails every member of the project.
+       */
+      recipients?: Array<string>;
+    }
+
+    export interface Slack {
+      /**
+       * The Slack channel id
+       */
+      channelId: string;
+
+      /**
+       * The channel name, shown in Roark
+       */
+      channelName: string;
+    }
+  }
+
   export interface Persona {
     id: string;
   }

package/src/resources/simulation.ts

@@ -198,6 +198,7 @@ export interface SimulationMockToolParams {
 export type SimulationRunParams =
   | SimulationRunParams.RunSimulationFromConfig
   | SimulationRunParams.RunSimulationFromPlanID
+  | SimulationRunParams.RunSimulationFromConfigKey
   | SimulationRunParams.RunSimulationFromTemplate;
 
 export declare namespace SimulationRunParams {
@@ -784,6 +785,81 @@ export declare namespace SimulationRunParams {
     }
   }
 
+  export interface RunSimulationFromConfigKey {
+    /**
+     * The config key of a plan to run, as applied from config as code
+     * (`simulationPlan/<name>`). Runs a config-managed plan by name, with no id
+     * lookup. Unique per project.
+     */
+    planConfigKey: string;
+
+    /**
+     * Values for the {{variables}} the run resolves, overriding whatever the plan has
+     * pinned.
+     *
+     * An object applies them to the whole run:
+     *
+     * { "orderNumber": "12345", "tier": "gold" }
+     *
+     * An array applies them per flow, or to just its happy path or one of its edge
+     * cases, when a single set will not do. Each entry carries what it applies to:
+     *
+     * [ { "flowId": "550e8400-...", "variables": { "orderNumber": "12345" } }, {
+     * "flowId": "550e8400-...", "happyPath": true, "variables": { "orderNumber":
+     * "55555" } }, { "flowId": "550e8400-...", "edgeCaseId": "7a3d2e1f-...",
+     * "variables": { "orderNumber": "67890" } } ]
+     *
+     * An entry that narrows to neither covers everything that flow resolves. A flow
+     * this plan does not attach, or an edge case that does not belong to the flow, is
+     * rejected rather than ignored.
+     *
+     * A plan built on scenarios rather than customer flows targets them the same way,
+     * with `scenarioId` in place of `flowId`. That form is deprecated alongside
+     * scenarios themselves, and still accepted so runs against those plans keep
+     * working.
+     */
+    variables?:
+      | { [key: string]: string }
+      | Array<RunSimulationFromConfigKey.UnionMember1>
+      | Array<RunSimulationFromConfigKey.UnionMember2>;
+  }
+
+  export namespace RunSimulationFromConfigKey {
+    export interface UnionMember1 {
+      /**
+       * A customer flow this plan runs.
+       */
+      flowId: string;
+
+      /**
+       * The values to apply.
+       */
+      variables: { [key: string]: string };
+
+      /**
+       * Narrow to one edge case of that flow.
+       */
+      edgeCaseId?: string;
+
+      /**
+       * Narrow to the flow's happy path.
+       */
+      happyPath?: true;
+    }
+
+    export interface UnionMember2 {
+      /**
+       * ID of the scenario to apply variables to
+       */
+      scenarioId: string;
+
+      /**
+       * Key-value pairs for this scenario
+       */
+      variables: { [key: string]: string };
+    }
+  }
+
   export interface RunSimulationFromTemplate {
     /**
      * The agent endpoints to call. No template can know these.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.14.0'; // x-release-please-version
+export const VERSION = '5.16.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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