@roarkanalytics/sdk 4.19.0 → 4.21.0

package/src/resources/simulation-job.ts

@@ -57,6 +57,13 @@ export namespace SimulationJobGetByIDResponse {
      */
     agentEndpoint: Data.AgentEndpoint;
 
+    /**
+     * This simulation’s place among its test case’s attempts: 1 for the first, 2 for
+     * the first retry. Above 1 only when the plan retries simulations your agent never
+     * spoke on.
+     */
+    attemptNumber: number;
+
     /**
      * The background noise the call actually ran with. `persona.backgroundNoise` is
      * only what the persona was set to; a flow’s environment overrides it, and on a
@@ -107,6 +114,12 @@ export namespace SimulationJobGetByIDResponse {
      */
     queuePosition: number | null;
 
+    /**
+     * The simulation this one retries, because your agent never spoke on it. Null on a
+     * test case’s first attempt.
+     */
+    retryOfSimulationJobId: string | null;
+
     runPlan: Data.RunPlan;
 
     /**
@@ -114,13 +127,19 @@ export namespace SimulationJobGetByIDResponse {
      */
     scenario: Data.Scenario;
 
+    /**
+     * When a `RETRY_SCHEDULED` retry dials, ISO 8601. Null on a first attempt.
+     */
+    scheduledAt: string | null;
+
     /**
      * Simulation job ID
      */
     simulationJobId: string;
 
     /**
-     * Job status
+     * Job status. `RETRY_SCHEDULED` is a retry of a simulation your agent never spoke
+     * on, waiting out the plan’s `noResponseRetryBackoffSeconds` before it dials.
      */
     status: string;
 
@@ -534,6 +553,12 @@ export namespace SimulationJobGetByIDResponse {
        */
       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)
        */
@@ -592,6 +617,13 @@ export namespace SimulationJobLookupResponse {
      */
     agentEndpoint: Data.AgentEndpoint;
 
+    /**
+     * This simulation’s place among its test case’s attempts: 1 for the first, 2 for
+     * the first retry. Above 1 only when the plan retries simulations your agent never
+     * spoke on.
+     */
+    attemptNumber: number;
+
     /**
      * The background noise the call actually ran with. `persona.backgroundNoise` is
      * only what the persona was set to; a flow’s environment overrides it, and on a
@@ -642,6 +674,12 @@ export namespace SimulationJobLookupResponse {
      */
     queuePosition: number | null;
 
+    /**
+     * The simulation this one retries, because your agent never spoke on it. Null on a
+     * test case’s first attempt.
+     */
+    retryOfSimulationJobId: string | null;
+
     runPlan: Data.RunPlan;
 
     /**
@@ -649,13 +687,19 @@ export namespace SimulationJobLookupResponse {
      */
     scenario: Data.Scenario;
 
+    /**
+     * When a `RETRY_SCHEDULED` retry dials, ISO 8601. Null on a first attempt.
+     */
+    scheduledAt: string | null;
+
     /**
      * Simulation job ID
      */
     simulationJobId: string;
 
     /**
-     * Job status
+     * Job status. `RETRY_SCHEDULED` is a retry of a simulation your agent never spoke
+     * on, waiting out the plan’s `noResponseRetryBackoffSeconds` before it dials.
      */
     status: string;
 
@@ -1069,6 +1113,12 @@ export namespace SimulationJobLookupResponse {
        */
       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)
        */

package/src/resources/simulation-persona.ts

@@ -314,6 +314,12 @@ export namespace SimulationPersonaCreateResponse {
      */
     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)
      */
@@ -561,6 +567,12 @@ export namespace SimulationPersonaUpdateResponse {
      */
     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)
      */
@@ -810,6 +822,12 @@ export namespace SimulationPersonaListResponse {
      */
     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)
      */
@@ -1074,6 +1092,12 @@ export namespace SimulationPersonaGetByIDResponse {
      */
     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)
      */

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

@@ -212,13 +212,27 @@ export namespace SimulationRunPlanJobGetByIDResponse {
    * Simulation run plan job with all associated simulation jobs
    */
   export interface Data {
+    /**
+     * The run’s simulations against its test cases. Differs from a plain job count
+     * only when the plan retries simulations your agent never spoke on.
+     */
+    attemptSummary: Data.AttemptSummary;
+
     /**
      * When the job was created
      */
     createdAt: string;
 
     /**
-     * List of simulation jobs (calls) in this run plan job
+     * Retries waiting out their backoff, soonest first. While this is not empty the
+     * run is waiting, not stuck: it settles only once every test case has a final
+     * attempt. Empty when nothing is scheduled.
+     */
+    pendingRetries: Array<Data.PendingRetry>;
+
+    /**
+     * List of simulation jobs (calls) in this run plan job, every attempt included: a
+     * simulation your agent never spoke on stays listed after a retry replaces it.
      */
     simulationJobs: Array<Data.SimulationJob>;
 
@@ -280,12 +294,80 @@ export namespace SimulationRunPlanJobGetByIDResponse {
   }
 
   export namespace Data {
+    /**
+     * The run’s simulations against its test cases. Differs from a plain job count
+     * only when the plan retries simulations your agent never spoke on.
+     */
+    export interface AttemptSummary {
+      /**
+       * Every simulation placed, retries included. Each is a separate, billed call.
+       */
+      attemptCount: number;
+
+      /**
+       * Simulations placed as a retry of one your agent never spoke on.
+       */
+      retryCount: number;
+
+      /**
+       * Simulations your agent never spoke on, including the ones a retry replaced.
+       */
+      silentAttemptCount: number;
+
+      /**
+       * Test cases whose final attempt your agent still never spoke on. This is what the
+       * `AGENT_NEVER_SPOKE` verdict failure counts.
+       */
+      stillSilentTestCaseCount: number;
+
+      /**
+       * Test cases in the run. Each one has a single final attempt that its result is
+       * read from.
+       */
+      testCaseCount: number;
+    }
+
+    /**
+     * A retry of a simulation your agent never spoke on, waiting out its backoff
+     * before it dials.
+     */
+    export interface PendingRetry {
+      /**
+       * Its place among its test case’s attempts, 2 for the first retry.
+       */
+      attemptNumber: number;
+
+      /**
+       * The most attempts a test case can get on this run: the plan’s
+       * `maxNoResponseRetries` plus 1.
+       */
+      maxAttempts: number;
+
+      /**
+       * When the retry dials, ISO 8601. It may wait longer behind the run’s concurrency
+       * limit.
+       */
+      scheduledAt: string | null;
+
+      /**
+       * The scheduled retry.
+       */
+      simulationJobId: string;
+    }
+
     export interface SimulationJob {
       /**
        * Agent endpoint used in a simulation
        */
       agentEndpoint: SimulationJob.AgentEndpoint;
 
+      /**
+       * This simulation’s place among its test case’s attempts: 1 for the first, 2 for
+       * the first retry. Above 1 only when the plan retries simulations your agent never
+       * spoke on.
+       */
+      attemptNumber: number;
+
       /**
        * The background noise the call actually ran with. `persona.backgroundNoise` is
        * only what the persona was set to; a flow’s environment overrides it, and on a
@@ -325,18 +407,30 @@ export namespace SimulationRunPlanJobGetByIDResponse {
         | 'COLLECTING_METRICS'
         | 'COMPLETED';
 
+      /**
+       * The simulation this one retries, because your agent never spoke on it. Null on a
+       * test case’s first attempt.
+       */
+      retryOfSimulationJobId: string | null;
+
       /**
        * Scenario used in a simulation
        */
       scenario: SimulationJob.Scenario;
 
+      /**
+       * When a `RETRY_SCHEDULED` retry dials, ISO 8601. Null on a first attempt.
+       */
+      scheduledAt: string | null;
+
       /**
        * Simulation job ID
        */
       simulationJobId: string;
 
       /**
-       * Job status
+       * Job status. `RETRY_SCHEDULED` is a retry of a simulation your agent never spoke
+       * on, waiting out the plan’s `noResponseRetryBackoffSeconds` before it dials.
        */
       status:
         | 'PENDING'
@@ -346,7 +440,8 @@ export namespace SimulationRunPlanJobGetByIDResponse {
         | 'FAILED'
         | 'TIMED_OUT'
         | 'CANCELLED'
-        | 'CANCELLING';
+        | 'CANCELLING'
+        | 'RETRY_SCHEDULED';
 
       /**
        * ID of the call created for this simulation job. Null if the call has not been
@@ -712,6 +807,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)
          */
@@ -783,6 +884,13 @@ export namespace SimulationRunPlanJobGetByIDResponse {
        */
       minimumDetectableGap: number | null;
 
+      /**
+       * The values your agent never spoke on significantly more often than the rest of
+       * the run, most significant first, tested the same way as `worseValues`. Empty on
+       * a run with no silent simulations.
+       */
+      neverSpokeValues: Array<SweepAttribution.NeverSpokeValue>;
+
       /**
        * How many values had enough counted simulations to be compared.
        */
@@ -876,6 +984,47 @@ export namespace SimulationRunPlanJobGetByIDResponse {
         }
       }
 
+      /**
+       * A value your agent never spoke on significantly more often than the rest of the
+       * run.
+       */
+      export interface NeverSpokeValue {
+        /**
+         * How likely a difference at least this large would be by chance alone, after
+         * correcting across the values (Benjamini-Hochberg).
+         */
+        adjustedPValue: number;
+
+        /**
+         * Simulations run at this value.
+         */
+        attempted: number;
+
+        label: string;
+
+        /**
+         * Simulations run across every other value combined.
+         */
+        restAttempted: number;
+
+        /**
+         * Simulations your agent never spoke on across every other value combined.
+         */
+        restSilentAttempts: number;
+
+        /**
+         * Retries placed at this value because your agent never spoke.
+         */
+        retries: number;
+
+        /**
+         * Simulations at this value your agent never spoke on, retried or not.
+         */
+        silentAttempts: number;
+
+        value: string;
+      }
+
       /**
        * One value of the swept property.
        */
@@ -902,6 +1051,12 @@ export namespace SimulationRunPlanJobGetByIDResponse {
          */
         label: string;
 
+        /**
+         * Of `attempted`, the retries of simulations your agent never spoke on. Zero
+         * unless the plan retries silent simulations.
+         */
+        retries: number;
+
         /**
          * The mean of each check's pass rate at this value, 0-100, the same rule as the
          * run's `score`. Descriptive only: a lower score alone never makes a value worse.
@@ -909,6 +1064,12 @@ export namespace SimulationRunPlanJobGetByIDResponse {
          */
         score: number | null;
 
+        /**
+         * Of `attempted`, the simulations your agent never spoke on, whether or not a
+         * retry followed. They are invalidated, so they are never in `counted`.
+         */
+        silentAttempts: number;
+
         /**
          * Whether this value had at least `minArmCalls` counted simulations. A value below
          * that is "insufficient data": it is reported with its numbers but never compared
@@ -941,7 +1102,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 +1205,46 @@ 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;
+
+        /**
+         * Test cases your agent never spoke on, judged on each test case’s last attempt: a
+         * silent simulation a retry later reached your agent on does not count here.
+         */
+        neverSpokeCalls: number;
+
+        /**
+         * Every test case of the run whose last attempt 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;
+
+        /**
+         * Every simulation your agent never spoke on, including the ones a retry replaced.
+         * Above `neverSpokeCalls` only when the plan retries silent simulations
+         * (`maxNoResponseRetries`).
+         */
+        silentAttempts?: number;
+      }
+
+      export interface UnionMember3 {
         metricDefinitionId: string;
 
         type: 'METRIC_NOT_EVALUATED';
@@ -1051,7 +1255,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.
          */