@roarkanalytics/sdk 3.11.0 → 3.13.0

package/src/resources/index.ts

@@ -20,6 +20,28 @@ export {
   type AgentEndpointUpdateParams,
   type AgentEndpointListParams,
 } from './agent-endpoint';
+export {
+  AgentPrompt,
+  type AgentPromptUpdateResponse,
+  type AgentPromptListResponse,
+  type AgentPromptListVersionsResponse,
+  type AgentPromptUpdateParams,
+  type AgentPromptListVersionsParams,
+} from './agent-prompt';
+export {
+  Benchmark,
+  type BenchmarkGetLeaderboardResponse,
+  type BenchmarkGetTargetResponse,
+  type BenchmarkListMetricsResponse,
+  type BenchmarkListSuitesResponse,
+  type BenchmarkListTargetHistoryResponse,
+  type BenchmarkListTargetScoreSamplesResponse,
+  type BenchmarkGetLeaderboardParams,
+  type BenchmarkGetTargetParams,
+  type BenchmarkListMetricsParams,
+  type BenchmarkListTargetHistoryParams,
+  type BenchmarkListTargetScoreSamplesParams,
+} from './benchmark';
 export {
   Call,
   type CallCreateResponse,
@@ -51,12 +73,14 @@ export {
   type CustomerFlowUpdateResponse,
   type CustomerFlowListResponse,
   type CustomerFlowDeleteResponse,
+  type CustomerFlowDuplicateResponse,
   type CustomerFlowGetByIDResponse,
   type CustomerFlowReplaceGraphResponse,
   type CustomerFlowUpdateHappyPathResponse,
   type CustomerFlowCreateParams,
   type CustomerFlowUpdateParams,
   type CustomerFlowListParams,
+  type CustomerFlowDuplicateParams,
   type CustomerFlowReplaceGraphParams,
   type CustomerFlowUpdateHappyPathParams,
 } from './customer-flow';
@@ -125,8 +149,13 @@ export {
 export { Simulation, type SimulationRunResponse, type SimulationRunParams } from './simulation';
 export {
   SimulationEnvironment,
+  type SimulationEnvironmentCreateResponse,
+  type SimulationEnvironmentUpdateResponse,
   type SimulationEnvironmentListResponse,
+  type SimulationEnvironmentDeleteResponse,
   type SimulationEnvironmentGetByIDResponse,
+  type SimulationEnvironmentCreateParams,
+  type SimulationEnvironmentUpdateParams,
   type SimulationEnvironmentListParams,
 } from './simulation-environment';
 export {
@@ -159,6 +188,7 @@ export {
 export {
   SimulationRunPlanJob,
   type SimulationRunPlanJobListResponse,
+  type SimulationRunPlanJobCancelResponse,
   type SimulationRunPlanJobGetByIDResponse,
   type SimulationRunPlanJobStartResponse,
   type SimulationRunPlanJobListParams,

package/src/resources/simulation-environment.ts

@@ -6,6 +6,49 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class SimulationEnvironment extends APIResource {
+  /**
+   * Creates an environment for the project: a noise bed and the level it plays at.
+   * Reference it by id when setting a customer flow variant's environment. Roark's
+   * curated presets always play at the default level, so this is how a project gets
+   * the same bed louder or quieter.
+   *
+   * @example
+   * ```ts
+   * const simulationEnvironment =
+   *   await client.simulationEnvironment.create({
+   *     backgroundNoise: 'OFFICE',
+   *     name: 'Busy call centre',
+   *   });
+   * ```
+   */
+  create(
+    body: SimulationEnvironmentCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<SimulationEnvironmentCreateResponse> {
+    return this._client.post('/v1/simulation/environment', { body, ...options });
+  }
+
+  /**
+   * Updates one of the project's environments. Only the fields sent are changed.
+   * Runs already built keep the snapshot they were built with. Roark-curated
+   * environments cannot be edited (403).
+   *
+   * @example
+   * ```ts
+   * const simulationEnvironment =
+   *   await client.simulationEnvironment.update(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  update(
+    environmentID: string,
+    body: SimulationEnvironmentUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SimulationEnvironmentUpdateResponse> {
+    return this._client.put(path`/v1/simulation/environment/${environmentID}`, { body, ...options });
+  }
+
   /**
    * Returns a paginated list of environments: the project's own plus the
    * environments Roark curates and shares across every project. Reference one by id
@@ -24,6 +67,24 @@ export class SimulationEnvironment extends APIResource {
     return this._client.get('/v1/simulation/environment', { query, ...options });
   }
 
+  /**
+   * Soft-deletes one of the project's environments. It disappears from reads and
+   * cannot be picked for new runs; runs already built keep their snapshot. Refused
+   * (409) while a live customer flow variant still uses it: move those variants
+   * first. Roark-curated environments cannot be deleted (403).
+   *
+   * @example
+   * ```ts
+   * const simulationEnvironment =
+   *   await client.simulationEnvironment.delete(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  delete(environmentID: string, options?: RequestOptions): APIPromise<SimulationEnvironmentDeleteResponse> {
+    return this._client.delete(path`/v1/simulation/environment/${environmentID}`, options);
+  }
+
   /**
    * Returns a single environment by its ID.
    *
@@ -39,6 +100,98 @@ export class SimulationEnvironment extends APIResource {
   }
 }
 
+export interface SimulationEnvironmentCreateResponse {
+  /**
+   * A simulation environment: the ambient conditions a customer flow variant runs
+   * under. The list includes both your own and the ones Roark curates for every
+   * project.
+   */
+  data: SimulationEnvironmentCreateResponse.Data;
+}
+
+export namespace SimulationEnvironmentCreateResponse {
+  /**
+   * A simulation environment: the ambient conditions a customer flow variant runs
+   * under. The list includes both your own and the ones Roark curates for every
+   * project.
+   */
+  export interface Data {
+    id: string;
+
+    backgroundNoise:
+      | 'NONE'
+      | 'AIRPORT'
+      | 'CHILDREN_PLAYING'
+      | 'CITY'
+      | 'COFFEE_SHOP'
+      | 'DRIVING'
+      | 'OFFICE'
+      | 'THUNDERSTORM';
+
+    backgroundNoiseVolume: number;
+
+    /**
+     * Creation timestamp in ISO 8601 format
+     */
+    createdAt: string;
+
+    name: string;
+
+    /**
+     * Last update timestamp in ISO 8601 format
+     */
+    updatedAt: string;
+
+    description?: string | null;
+  }
+}
+
+export interface SimulationEnvironmentUpdateResponse {
+  /**
+   * A simulation environment: the ambient conditions a customer flow variant runs
+   * under. The list includes both your own and the ones Roark curates for every
+   * project.
+   */
+  data: SimulationEnvironmentUpdateResponse.Data;
+}
+
+export namespace SimulationEnvironmentUpdateResponse {
+  /**
+   * A simulation environment: the ambient conditions a customer flow variant runs
+   * under. The list includes both your own and the ones Roark curates for every
+   * project.
+   */
+  export interface Data {
+    id: string;
+
+    backgroundNoise:
+      | 'NONE'
+      | 'AIRPORT'
+      | 'CHILDREN_PLAYING'
+      | 'CITY'
+      | 'COFFEE_SHOP'
+      | 'DRIVING'
+      | 'OFFICE'
+      | 'THUNDERSTORM';
+
+    backgroundNoiseVolume: number;
+
+    /**
+     * Creation timestamp in ISO 8601 format
+     */
+    createdAt: string;
+
+    name: string;
+
+    /**
+     * Last update timestamp in ISO 8601 format
+     */
+    updatedAt: string;
+
+    description?: string | null;
+  }
+}
+
 /**
  * Paginated list of environments: the project's own plus the shared Roark-curated
  * ones
@@ -68,6 +221,8 @@ export namespace SimulationEnvironmentListResponse {
       | 'OFFICE'
       | 'THUNDERSTORM';
 
+    backgroundNoiseVolume: number;
+
     /**
      * Creation timestamp in ISO 8601 format
      */
@@ -101,6 +256,24 @@ export namespace SimulationEnvironmentListResponse {
   }
 }
 
+export interface SimulationEnvironmentDeleteResponse {
+  data: SimulationEnvironmentDeleteResponse.Data;
+}
+
+export namespace SimulationEnvironmentDeleteResponse {
+  export interface Data {
+    /**
+     * Unique identifier of the deleted environment
+     */
+    id: string;
+
+    /**
+     * Always true when the environment was deleted
+     */
+    deleted: true;
+  }
+}
+
 export interface SimulationEnvironmentGetByIDResponse {
   /**
    * A simulation environment: the ambient conditions a customer flow variant runs
@@ -129,6 +302,8 @@ export namespace SimulationEnvironmentGetByIDResponse {
       | 'OFFICE'
       | 'THUNDERSTORM';
 
+    backgroundNoiseVolume: number;
+
     /**
      * Creation timestamp in ISO 8601 format
      */
@@ -145,6 +320,70 @@ export namespace SimulationEnvironmentGetByIDResponse {
   }
 }
 
+export interface SimulationEnvironmentCreateParams {
+  /**
+   * The noise bed played underneath the simulated caller. NONE plays nothing.
+   */
+  backgroundNoise:
+    | 'NONE'
+    | 'AIRPORT'
+    | 'CHILDREN_PLAYING'
+    | 'CITY'
+    | 'COFFEE_SHOP'
+    | 'DRIVING'
+    | 'OFFICE'
+    | 'THUNDERSTORM';
+
+  /**
+   * Display name, shown wherever a flow variant references the environment
+   */
+  name: string;
+
+  /**
+   * How loud the bed plays, as a gain from 0 (silent) to 1 (as loud as the caller).
+   * Defaults to 0.1, which sits well under the caller. Ignored on Vapi endpoints,
+   * which have no level control.
+   */
+  backgroundNoiseVolume?: number;
+
+  /**
+   * Optional note on when to use this environment
+   */
+  description?: string | null;
+}
+
+export interface SimulationEnvironmentUpdateParams {
+  /**
+   * The noise bed played underneath the simulated caller. NONE plays nothing.
+   */
+  backgroundNoise?:
+    | 'NONE'
+    | 'AIRPORT'
+    | 'CHILDREN_PLAYING'
+    | 'CITY'
+    | 'COFFEE_SHOP'
+    | 'DRIVING'
+    | 'OFFICE'
+    | 'THUNDERSTORM';
+
+  /**
+   * How loud the bed plays, as a gain from 0 (silent) to 1 (as loud as the caller).
+   * Defaults to 0.1, which sits well under the caller. Ignored on Vapi endpoints,
+   * which have no level control.
+   */
+  backgroundNoiseVolume?: number;
+
+  /**
+   * Optional note on when to use this environment
+   */
+  description?: string | null;
+
+  /**
+   * Display name, shown wherever a flow variant references the environment
+   */
+  name?: string;
+}
+
 export interface SimulationEnvironmentListParams {
   after?: string;
 
@@ -153,8 +392,13 @@ export interface SimulationEnvironmentListParams {
 
 export declare namespace SimulationEnvironment {
   export {
+    type SimulationEnvironmentCreateResponse as SimulationEnvironmentCreateResponse,
+    type SimulationEnvironmentUpdateResponse as SimulationEnvironmentUpdateResponse,
     type SimulationEnvironmentListResponse as SimulationEnvironmentListResponse,
+    type SimulationEnvironmentDeleteResponse as SimulationEnvironmentDeleteResponse,
     type SimulationEnvironmentGetByIDResponse as SimulationEnvironmentGetByIDResponse,
+    type SimulationEnvironmentCreateParams as SimulationEnvironmentCreateParams,
+    type SimulationEnvironmentUpdateParams as SimulationEnvironmentUpdateParams,
     type SimulationEnvironmentListParams as SimulationEnvironmentListParams,
   };
 }

package/src/resources/simulation-job.ts

@@ -68,6 +68,12 @@ export namespace SimulationJobGetByIDResponse {
      */
     enrichment: Data.Enrichment;
 
+    /**
+     * Present when the run was invalidated: it keeps its transcript and recording, but
+     * nothing scored it and it is excluded from every run total.
+     */
+    invalidation: Data.Invalidation | null;
+
     persona: Data.Persona;
 
     /**
@@ -195,6 +201,28 @@ export namespace SimulationJobGetByIDResponse {
       waitStartedAt?: string | null;
     }
 
+    /**
+     * Present when the run was invalidated: it keeps its transcript and recording, but
+     * nothing scored it and it is excluded from every run total.
+     */
+    export interface Invalidation {
+      /**
+       * When the run was invalidated.
+       */
+      invalidatedAt: string;
+
+      /**
+       * Why the result does not count. `SCRIPT_DIVERGED`: a strict flow went off script
+       * at a step whose off-script policy is HANG_UP_INVALIDATE.
+       */
+      reason: 'SCRIPT_DIVERGED';
+
+      /**
+       * One sentence: where the script was left and what your agent did instead.
+       */
+      detail?: string | null;
+    }
+
     export interface Persona {
       /**
        * Unique identifier of the persona
@@ -252,7 +280,17 @@ export namespace SimulationJobGetByIDResponse {
       /**
        * Base emotional state of the persona
        */
-      baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
+      baseEmotion:
+        | 'NEUTRAL'
+        | 'CHEERFUL'
+        | 'CONFUSED'
+        | 'FRUSTRATED'
+        | 'SKEPTICAL'
+        | 'RUSHED'
+        | 'DISTRACTED'
+        | 'ANGRY'
+        | 'ANXIOUS'
+        | 'SAD';
 
       /**
        * How the persona confirms information
@@ -340,9 +378,10 @@ export namespace SimulationJobGetByIDResponse {
 
       /**
        * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED)
+       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
+       * for several seconds.
        */
-      responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
+      responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
       /**
        * Speech clarity of the persona
@@ -394,6 +433,13 @@ export namespace SimulationJobGetByIDResponse {
        */
       description?: string | null;
 
+      /**
+       * Label shown in place of the name across the dashboard (e.g. a short descriptor
+       * like "Irate Escalator"). The persona still identifies as `name` on calls. Omit
+       * or set null to display the name itself.
+       */
+      displayName?: string | null;
+
       /**
        * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
        */
@@ -463,6 +509,12 @@ export namespace SimulationJobLookupResponse {
      */
     enrichment: Data.Enrichment;
 
+    /**
+     * Present when the run was invalidated: it keeps its transcript and recording, but
+     * nothing scored it and it is excluded from every run total.
+     */
+    invalidation: Data.Invalidation | null;
+
     persona: Data.Persona;
 
     /**
@@ -590,6 +642,28 @@ export namespace SimulationJobLookupResponse {
       waitStartedAt?: string | null;
     }
 
+    /**
+     * Present when the run was invalidated: it keeps its transcript and recording, but
+     * nothing scored it and it is excluded from every run total.
+     */
+    export interface Invalidation {
+      /**
+       * When the run was invalidated.
+       */
+      invalidatedAt: string;
+
+      /**
+       * Why the result does not count. `SCRIPT_DIVERGED`: a strict flow went off script
+       * at a step whose off-script policy is HANG_UP_INVALIDATE.
+       */
+      reason: 'SCRIPT_DIVERGED';
+
+      /**
+       * One sentence: where the script was left and what your agent did instead.
+       */
+      detail?: string | null;
+    }
+
     export interface Persona {
       /**
        * Unique identifier of the persona
@@ -647,7 +721,17 @@ export namespace SimulationJobLookupResponse {
       /**
        * Base emotional state of the persona
        */
-      baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
+      baseEmotion:
+        | 'NEUTRAL'
+        | 'CHEERFUL'
+        | 'CONFUSED'
+        | 'FRUSTRATED'
+        | 'SKEPTICAL'
+        | 'RUSHED'
+        | 'DISTRACTED'
+        | 'ANGRY'
+        | 'ANXIOUS'
+        | 'SAD';
 
       /**
        * How the persona confirms information
@@ -735,9 +819,10 @@ export namespace SimulationJobLookupResponse {
 
       /**
        * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED)
+       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
+       * for several seconds.
        */
-      responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
+      responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
       /**
        * Speech clarity of the persona
@@ -789,6 +874,13 @@ export namespace SimulationJobLookupResponse {
        */
       description?: string | null;
 
+      /**
+       * Label shown in place of the name across the dashboard (e.g. a short descriptor
+       * like "Irate Escalator"). The persona still identifies as `name` on calls. Omit
+       * or set null to display the name itself.
+       */
+      displayName?: string | null;
+
       /**
        * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
        */