@roarkanalytics/sdk 3.2.1 → 3.4.0

package/src/resources/customer-flow.ts

@@ -299,8 +299,12 @@ export namespace CustomerFlowCreateResponse {
     agents: Array<ScriptedCustomerFlow.Agent>;
 
     /**
-     * DETERMINISTIC runs one variant per path through the graph. ADAPTIVE collapses
-     * the paths into a single variant the simulated customer adapts across.
+     * How a run walks the graph. DETERMINISTIC ("Simulate every path" in the app)
+     * places one call per variant, each following its path exactly whatever the agent
+     * says. ADAPTIVE ("Adapt to your agent") collapses the paths into one call PER
+     * PERSONA, on which the simulated customer picks a branch from what the agent
+     * actually said. Both modes speak the exact authored lines, and neither changes
+     * how metrics or expectations grade.
      */
     branchingMode: 'DETERMINISTIC' | 'ADAPTIVE';
 
@@ -2450,8 +2454,12 @@ export namespace CustomerFlowUpdateResponse {
     agents: Array<ScriptedCustomerFlow.Agent>;
 
     /**
-     * DETERMINISTIC runs one variant per path through the graph. ADAPTIVE collapses
-     * the paths into a single variant the simulated customer adapts across.
+     * How a run walks the graph. DETERMINISTIC ("Simulate every path" in the app)
+     * places one call per variant, each following its path exactly whatever the agent
+     * says. ADAPTIVE ("Adapt to your agent") collapses the paths into one call PER
+     * PERSONA, on which the simulated customer picks a branch from what the agent
+     * actually said. Both modes speak the exact authored lines, and neither changes
+     * how metrics or expectations grade.
      */
     branchingMode: 'DETERMINISTIC' | 'ADAPTIVE';
 
@@ -4604,8 +4612,12 @@ export namespace CustomerFlowListResponse {
     agents: Array<ScriptedCustomerFlow.Agent>;
 
     /**
-     * DETERMINISTIC runs one variant per path through the graph. ADAPTIVE collapses
-     * the paths into a single variant the simulated customer adapts across.
+     * How a run walks the graph. DETERMINISTIC ("Simulate every path" in the app)
+     * places one call per variant, each following its path exactly whatever the agent
+     * says. ADAPTIVE ("Adapt to your agent") collapses the paths into one call PER
+     * PERSONA, on which the simulated customer picks a branch from what the agent
+     * actually said. Both modes speak the exact authored lines, and neither changes
+     * how metrics or expectations grade.
      */
     branchingMode: 'DETERMINISTIC' | 'ADAPTIVE';
 
@@ -6785,8 +6797,12 @@ export namespace CustomerFlowGetByIDResponse {
     agents: Array<ScriptedCustomerFlow.Agent>;
 
     /**
-     * DETERMINISTIC runs one variant per path through the graph. ADAPTIVE collapses
-     * the paths into a single variant the simulated customer adapts across.
+     * How a run walks the graph. DETERMINISTIC ("Simulate every path" in the app)
+     * places one call per variant, each following its path exactly whatever the agent
+     * says. ADAPTIVE ("Adapt to your agent") collapses the paths into one call PER
+     * PERSONA, on which the simulated customer picks a branch from what the agent
+     * actually said. Both modes speak the exact authored lines, and neither changes
+     * how metrics or expectations grade.
      */
     branchingMode: 'DETERMINISTIC' | 'ADAPTIVE';
 
@@ -10817,8 +10833,12 @@ export declare namespace CustomerFlowCreateParams {
     agentIds?: Array<string>;
 
     /**
-     * DETERMINISTIC (the default) runs one variant per path through the graph;
-     * ADAPTIVE collapses the paths into one call the simulated customer adapts across.
+     * How a run walks the graph. DETERMINISTIC ("Simulate every path" in the app)
+     * places one call per variant, each following its path exactly whatever the agent
+     * says. ADAPTIVE ("Adapt to your agent") collapses the paths into one call PER
+     * PERSONA, on which the simulated customer picks a branch from what the agent
+     * actually said. Both modes speak the exact authored lines, and neither changes
+     * how metrics or expectations grade. (DETERMINISTIC is the default.)
      */
     branchingMode?: 'DETERMINISTIC' | 'ADAPTIVE';
 
@@ -10924,7 +10944,12 @@ export interface CustomerFlowUpdateParams {
   agentIds?: Array<string>;
 
   /**
-   * Scripted flows only.
+   * Scripted flows only. How a run walks the graph. DETERMINISTIC ("Simulate every
+   * path" in the app) places one call per variant, each following its path exactly
+   * whatever the agent says. ADAPTIVE ("Adapt to your agent") collapses the paths
+   * into one call PER PERSONA, on which the simulated customer picks a branch from
+   * what the agent actually said. Both modes speak the exact authored lines, and
+   * neither changes how metrics or expectations grade.
    */
   branchingMode?: 'DETERMINISTIC' | 'ADAPTIVE';
 

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

@@ -159,6 +159,11 @@ export namespace SimulationRunPlanCreateResponse {
        */
       endCallReasons: Array<string>;
 
+      /**
+       * Whether this plan merges the customer's own live recording into each simulation.
+       */
+      enrichWithLiveConversation: boolean;
+
       /**
        * Deprecated: Use metrics instead. Evaluators included in this run plan.
        */
@@ -297,6 +302,12 @@ export namespace SimulationRunPlanCreateResponse {
 
       export interface Metric {
         id: string;
+
+        /**
+         * Which side of an enriched run this metric is scored on. `null` means the
+         * default, SIMULATED.
+         */
+        conversationSource: 'SIMULATED' | 'LIVE' | null;
       }
 
       export interface Persona {
@@ -396,6 +407,11 @@ export namespace SimulationRunPlanUpdateResponse {
      */
     endCallReasons: Array<string>;
 
+    /**
+     * Whether this plan merges the customer's own live recording into each simulation.
+     */
+    enrichWithLiveConversation: boolean;
+
     /**
      * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
@@ -534,6 +550,12 @@ export namespace SimulationRunPlanUpdateResponse {
 
     export interface Metric {
       id: string;
+
+      /**
+       * Which side of an enriched run this metric is scored on. `null` means the
+       * default, SIMULATED.
+       */
+      conversationSource: 'SIMULATED' | 'LIVE' | null;
     }
 
     export interface Persona {
@@ -597,6 +619,11 @@ export namespace SimulationRunPlanListResponse {
      */
     endCallReasons: Array<string>;
 
+    /**
+     * Whether this plan merges the customer's own live recording into each simulation.
+     */
+    enrichWithLiveConversation: boolean;
+
     /**
      * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
@@ -735,6 +762,12 @@ export namespace SimulationRunPlanListResponse {
 
     export interface Metric {
       id: string;
+
+      /**
+       * Which side of an enriched run this metric is scored on. `null` means the
+       * default, SIMULATED.
+       */
+      conversationSource: 'SIMULATED' | 'LIVE' | null;
     }
 
     export interface Persona {
@@ -826,6 +859,11 @@ export namespace SimulationRunPlanGetByIDResponse {
      */
     endCallReasons: Array<string>;
 
+    /**
+     * Whether this plan merges the customer's own live recording into each simulation.
+     */
+    enrichWithLiveConversation: boolean;
+
     /**
      * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
@@ -964,6 +1002,12 @@ export namespace SimulationRunPlanGetByIDResponse {
 
     export interface Metric {
       id: string;
+
+      /**
+       * Which side of an enriched run this metric is scored on. `null` means the
+       * default, SIMULATED.
+       */
+      conversationSource: 'SIMULATED' | 'LIVE' | null;
     }
 
     export interface Persona {
@@ -1032,6 +1076,22 @@ export interface SimulationRunPlanCreateParams {
    */
   endCallReasons?: Array<string>;
 
+  /**
+   * Merge the customer's own recording of the real call into each simulation, so
+   * metrics can be scored against the live leg as well as the simulated one. This is
+   * the API equivalent of the dashboard's live-enrichment toggle.
+   *
+   * With this on, the run provisions a phone number and holds each call open for up
+   * to 15 minutes waiting for a matching call to be posted to POST /v1/call. A call
+   * matches on the provisioned number (`roarkPhoneNumber` on the job) with a start
+   * time inside the simulation window. If nothing arrives, the simulation still
+   * completes and any `LIVE`-sourced metric produces no value.
+   *
+   * Required by any metric whose `requiresLiveConversation` is true: without it that
+   * metric is silently skipped.
+   */
+  enrichWithLiveConversation?: boolean;
+
   /**
    * Execution mode (PARALLEL or SEQUENTIAL)
    */
@@ -1082,6 +1142,18 @@ export namespace SimulationRunPlanCreateParams {
      */
     id?: string;
 
+    /**
+     * Which side of an enriched run this metric is scored on. Only meaningful with
+     * `enrichWithLiveConversation: true`, where a run has both a simulated
+     * conversation and the customer's own live recording of it.
+     *
+     * Defaults to `SIMULATED`. Use `LIVE` for a metric that must be measured against
+     * the real recording (audio quality, provider latency) rather than the simulated
+     * leg. `null` means the same as omitting it, so a plan read back from GET can be
+     * sent straight to PUT.
+     */
+    conversationSource?: 'SIMULATED' | 'LIVE' | null;
+
     /**
      * Alias of `slug` accepted for backwards compatibility. Use `slug` for new
      * integrations.
@@ -1195,6 +1267,12 @@ export interface SimulationRunPlanUpdateParams {
    */
   endCallReasons?: Array<string>;
 
+  /**
+   * Whether to merge the customer's own live recording into each simulation of this
+   * plan.
+   */
+  enrichWithLiveConversation?: boolean;
+
   /**
    * Execution mode (PARALLEL or SEQUENTIAL)
    */
@@ -1325,6 +1403,18 @@ export namespace SimulationRunPlanUpdateParams {
      */
     id?: string;
 
+    /**
+     * Which side of an enriched run this metric is scored on. Only meaningful with
+     * `enrichWithLiveConversation: true`, where a run has both a simulated
+     * conversation and the customer's own live recording of it.
+     *
+     * Defaults to `SIMULATED`. Use `LIVE` for a metric that must be measured against
+     * the real recording (audio quality, provider latency) rather than the simulated
+     * leg. `null` means the same as omitting it, so a plan read back from GET can be
+     * sent straight to PUT.
+     */
+    conversationSource?: 'SIMULATED' | 'LIVE' | null;
+
     /**
      * Alias of `slug` accepted for backwards compatibility. Use `slug` for new
      * integrations.

package/src/resources/simulation.ts

@@ -184,6 +184,22 @@ export declare namespace SimulationRunParams {
        */
       endCallReasons?: Array<string>;
 
+      /**
+       * Merge the customer's own recording of the real call into each simulation, so
+       * metrics can be scored against the live leg as well as the simulated one. This is
+       * the API equivalent of the dashboard's live-enrichment toggle.
+       *
+       * With this on, the run provisions a phone number and holds each call open for up
+       * to 15 minutes waiting for a matching call to be posted to POST /v1/call. A call
+       * matches on the provisioned number (`roarkPhoneNumber` on the job) with a start
+       * time inside the simulation window. If nothing arrives, the simulation still
+       * completes and any `LIVE`-sourced metric produces no value.
+       *
+       * Required by any metric whose `requiresLiveConversation` is true: without it that
+       * metric is silently skipped.
+       */
+      enrichWithLiveConversation?: boolean;
+
       /**
        * Execution mode (PARALLEL or SEQUENTIAL)
        */
@@ -240,6 +256,18 @@ export declare namespace SimulationRunParams {
          */
         id?: string;
 
+        /**
+         * Which side of an enriched run this metric is scored on. Only meaningful with
+         * `enrichWithLiveConversation: true`, where a run has both a simulated
+         * conversation and the customer's own live recording of it.
+         *
+         * Defaults to `SIMULATED`. Use `LIVE` for a metric that must be measured against
+         * the real recording (audio quality, provider latency) rather than the simulated
+         * leg. `null` means the same as omitting it, so a plan read back from GET can be
+         * sent straight to PUT.
+         */
+        conversationSource?: 'SIMULATED' | 'LIVE' | null;
+
         /**
          * Alias of `slug` accepted for backwards compatibility. Use `slug` for new
          * integrations.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.2.1'; // x-release-please-version
+export const VERSION = '3.4.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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