@roarkanalytics/sdk 4.19.0 → 4.20.0

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

@@ -712,6 +712,12 @@ export namespace SimulationRunPlanJobGetByIDResponse {
          */
         displayName?: string | null;
 
+        /**
+         * The E.164 number every call with this persona uses, when Roark has pinned one
+         * for your project. Present only when set; read-only.
+         */
+        phoneNumber?: string;
+
         /**
          * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
          */
@@ -941,7 +947,11 @@ export namespace SimulationRunPlanJobGetByIDResponse {
        * Every criterion the run missed. Empty when it passed.
        */
       failures: Array<
-        Verdict.UnionMember0 | Verdict.UnionMember1 | Verdict.UnionMember2 | Verdict.UnionMember3
+        | Verdict.UnionMember0
+        | Verdict.UnionMember1
+        | Verdict.UnionMember2
+        | Verdict.UnionMember3
+        | Verdict.UnionMember4
       >;
 
       /**
@@ -1040,7 +1050,38 @@ export namespace SimulationRunPlanJobGetByIDResponse {
         type: 'INCOMPLETE_COVERAGE';
       }
 
+      /**
+       * Your agent never spoke on more than `maxShare` percent of the run. Those
+       * simulations are left out of every check, so the run fails on them whatever the
+       * checks say.
+       */
       export interface UnionMember2 {
+        /**
+         * The largest share of simulations, 0-100, your agent may never speak on while the
+         * run can pass.
+         */
+        maxShare: number;
+
+        /**
+         * Simulations your agent answered and never spoke on.
+         */
+        neverSpokeCalls: number;
+
+        /**
+         * Every simulation of the run that reached your agent.
+         */
+        totalCalls: number;
+
+        type: 'AGENT_NEVER_SPOKE';
+
+        /**
+         * The agent as the run tested it. Null when the simulations tested more than one
+         * agent.
+         */
+        agentName?: string | null;
+      }
+
+      export interface UnionMember3 {
         metricDefinitionId: string;
 
         type: 'METRIC_NOT_EVALUATED';
@@ -1051,7 +1092,7 @@ export namespace SimulationRunPlanJobGetByIDResponse {
         metricName?: string | null;
       }
 
-      export interface UnionMember3 {
+      export interface UnionMember4 {
         /**
          * Whether the missed minimum was the 80% default (`true`) or this metric's own.
          */

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

@@ -22,7 +22,6 @@ export class SimulationRunPlan extends APIResource {
    *     ],
    *     direction: 'INBOUND',
    *     maxSimulationDurationSeconds: 300,
-   *     metrics: [{}],
    *     name: 'My Run Plan',
    *   });
    * ```
@@ -1466,12 +1465,6 @@ export interface SimulationRunPlanCreateParams {
    */
   maxSimulationDurationSeconds: number;
 
-  /**
-   * Metric definitions to include in this run plan. Reference each by `id` (UUID) or
-   * `slug`.
-   */
-  metrics: Array<SimulationRunPlanCreateParams.Metric>;
-
   /**
    * Name of the run plan
    */
@@ -1626,6 +1619,17 @@ export interface SimulationRunPlanCreateParams {
    */
   maxConcurrentJobs?: number;
 
+  /**
+   * Metric definitions to include in this run plan. Reference each by `id` (UUID) or
+   * `slug`.
+   *
+   * Optional when the attached `flows` carry the grading: metrics a flow declares
+   * itself (with `includeFlowMetrics`), or the Agent Expectations and Keypad Entry
+   * metrics a run adds for flows with expectations or expected keypad entries (with
+   * `includeAutomaticMetrics`). A plan with nothing to grade is rejected with a 400.
+   */
+  metrics?: Array<SimulationRunPlanCreateParams.Metric>;
+
   /**
    * Personas to include in this run plan. Required with `scenarios`; ignored with
    * `flows`, where each variant carries its own persona.
@@ -1649,47 +1653,6 @@ export namespace SimulationRunPlanCreateParams {
     id: string;
   }
 
-  export interface Metric {
-    /**
-     * Metric definition UUID. Provide either this or `slug`, not both.
-     */
-    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.
-     */
-    metricId?: string;
-
-    /**
-     * THE BAR, and the only thing that decides pass/fail. The share of the run's
-     * simulations that must pass this check, 0-100.
-     *
-     * Applied to this check alone and never pooled: silence duration at 40 and word
-     * count at 80 means the run fails unless 40% of sims clear silence AND 80% clear
-     * word count. Omit or `null` for the 80% default.
-     */
-    minPassRate?: number | null;
-
-    /**
-     * Stable metric slug (e.g. `customer_satisfaction`). Provide either this or `id`,
-     * not both.
-     */
-    slug?: string;
-  }
-
   /**
    * One customer flow attached to a run plan, and which of its ways of running you
    * cover.
@@ -1795,6 +1758,47 @@ export namespace SimulationRunPlanCreateParams {
     }
   }
 
+  export interface Metric {
+    /**
+     * Metric definition UUID. Provide either this or `slug`, not both.
+     */
+    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.
+     */
+    metricId?: string;
+
+    /**
+     * THE BAR, and the only thing that decides pass/fail. The share of the run's
+     * simulations that must pass this check, 0-100.
+     *
+     * Applied to this check alone and never pooled: silence duration at 40 and word
+     * count at 80 means the run fails unless 40% of sims clear silence AND 80% clear
+     * word count. Omit or `null` for the 80% default.
+     */
+    minPassRate?: number | null;
+
+    /**
+     * Stable metric slug (e.g. `customer_satisfaction`). Provide either this or `id`,
+     * not both.
+     */
+    slug?: string;
+  }
+
   export interface Persona {
     id: string;
   }

package/src/resources/simulation.ts

@@ -58,7 +58,6 @@ export class Simulation extends APIResource {
    *     ],
    *     direction: 'INBOUND',
    *     maxSimulationDurationSeconds: 300,
-   *     metrics: [{}],
    *   },
    * });
    * ```
@@ -269,12 +268,6 @@ export declare namespace SimulationRunParams {
        */
       maxSimulationDurationSeconds: number;
 
-      /**
-       * Metric definitions to include in this run plan. Reference each by `id` (UUID) or
-       * `slug`.
-       */
-      metrics: Array<Plan.Metric>;
-
       /**
        * The reference value of `comparisonProperty`, for example `NONE` for
        * `BACKGROUND_NOISE` or `NORMAL` for `SPEECH_PACE`: shown first in the results.
@@ -417,6 +410,17 @@ export declare namespace SimulationRunParams {
        */
       maxConcurrentJobs?: number;
 
+      /**
+       * Metric definitions to include in this run plan. Reference each by `id` (UUID) or
+       * `slug`.
+       *
+       * Optional when the attached `flows` carry the grading: metrics a flow declares
+       * itself (with `includeFlowMetrics`), or the Agent Expectations and Keypad Entry
+       * metrics a run adds for flows with expectations or expected keypad entries (with
+       * `includeAutomaticMetrics`). A plan with nothing to grade is rejected with a 400.
+       */
+      metrics?: Array<Plan.Metric>;
+
       /**
        * What to call this. Generated from the date when omitted, and required with
        * `saveAsPlan`.
@@ -446,47 +450,6 @@ export declare namespace SimulationRunParams {
         id: string;
       }
 
-      export interface Metric {
-        /**
-         * Metric definition UUID. Provide either this or `slug`, not both.
-         */
-        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.
-         */
-        metricId?: string;
-
-        /**
-         * THE BAR, and the only thing that decides pass/fail. The share of the run's
-         * simulations that must pass this check, 0-100.
-         *
-         * Applied to this check alone and never pooled: silence duration at 40 and word
-         * count at 80 means the run fails unless 40% of sims clear silence AND 80% clear
-         * word count. Omit or `null` for the 80% default.
-         */
-        minPassRate?: number | null;
-
-        /**
-         * Stable metric slug (e.g. `customer_satisfaction`). Provide either this or `id`,
-         * not both.
-         */
-        slug?: string;
-      }
-
       /**
        * One customer flow attached to a run plan, and which of its ways of running you
        * cover.
@@ -592,6 +555,47 @@ export declare namespace SimulationRunParams {
         }
       }
 
+      export interface Metric {
+        /**
+         * Metric definition UUID. Provide either this or `slug`, not both.
+         */
+        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.
+         */
+        metricId?: string;
+
+        /**
+         * THE BAR, and the only thing that decides pass/fail. The share of the run's
+         * simulations that must pass this check, 0-100.
+         *
+         * Applied to this check alone and never pooled: silence duration at 40 and word
+         * count at 80 means the run fails unless 40% of sims clear silence AND 80% clear
+         * word count. Omit or `null` for the 80% default.
+         */
+        minPassRate?: number | null;
+
+        /**
+         * Stable metric slug (e.g. `customer_satisfaction`). Provide either this or `id`,
+         * not both.
+         */
+        slug?: string;
+      }
+
       export interface Persona {
         id: string;
       }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.19.0'; // x-release-please-version
+export const VERSION = '4.20.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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