@roarkanalytics/sdk 2.13.0 → 2.14.0

package/src/resources/simulation.ts

@@ -5,17 +5,39 @@ import * as Core from '../core';
 
 export class Simulation extends APIResource {
   /**
-   * Get a individual simulation run directly by its ID. This is generally part of a
-   * larger simulation run plan job.
+   * Retrieve details of a simulation plan job including all associated simulation
+   * jobs (calls)
    *
    * @example
    * ```ts
-   * const response = await client.simulation.getJobById(
+   * const response = await client.simulation.getRunPlanJob(
    *   '7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f',
    * );
    * ```
    */
-  getJobById(jobId: unknown, options?: Core.RequestOptions): Core.APIPromise<SimulationGetJobByIDResponse> {
+  getRunPlanJob(
+    jobId: unknown,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SimulationGetRunPlanJobResponse> {
+    return this._client.get(`/v1/simulation/plan/job/${jobId}`, options);
+  }
+
+  /**
+   * Get a individual simulation run directly by its ID. This is generally part of a
+   * larger simulation run plan job.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.simulation.getSimulationJobById(
+   *     '7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f',
+   *   );
+   * ```
+   */
+  getSimulationJobById(
+    jobId: unknown,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SimulationGetSimulationJobByIDResponse> {
     return this._client.get(`/v1/simulation/job/${jobId}`, options);
   }
 
@@ -25,27 +47,297 @@ export class Simulation extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.simulation.lookupJob({
-   *   roarkPhoneNumber: {},
-   * });
+   * const response =
+   *   await client.simulation.lookupSimulationJob({
+   *     roarkPhoneNumber: {},
+   *   });
    * ```
    */
-  lookupJob(
-    query: SimulationLookupJobParams,
+  lookupSimulationJob(
+    query: SimulationLookupSimulationJobParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<SimulationLookupJobResponse> {
+  ): Core.APIPromise<SimulationLookupSimulationJobResponse> {
     return this._client.get('/v1/simulation/job/lookup', { query, ...options });
   }
+
+  /**
+   * Create and execute a job for an existing simulation run plan
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulation.startRunPlanJob(
+   *   '7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f',
+   * );
+   * ```
+   */
+  startRunPlanJob(
+    planId: unknown,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SimulationStartRunPlanJobResponse> {
+    return this._client.post(`/v1/simulation/plan/${planId}/job`, options);
+  }
+}
+
+export interface SimulationGetRunPlanJobResponse {
+  /**
+   * Simulation run plan job with all associated simulation jobs
+   */
+  data: SimulationGetRunPlanJobResponse.Data;
+}
+
+export namespace SimulationGetRunPlanJobResponse {
+  /**
+   * Simulation run plan job with all associated simulation jobs
+   */
+  export interface Data {
+    /**
+     * When the job was created
+     */
+    createdAt: string;
+
+    /**
+     * List of simulation jobs (calls) in this run plan job
+     */
+    simulationJobs: Array<Data.SimulationJob>;
+
+    /**
+     * ID of the simulation run plan
+     */
+    simulationRunPlanId: string;
+
+    /**
+     * ID of the simulation run plan job
+     */
+    simulationRunPlanJobId: string;
+
+    /**
+     * Job status
+     */
+    status: string;
+
+    /**
+     * When the job ended
+     */
+    endedAt?: string | null;
+
+    /**
+     * When the job started
+     */
+    startedAt?: string | null;
+  }
+
+  export namespace Data {
+    export interface SimulationJob {
+      /**
+       * Agent endpoint used in a simulation
+       */
+      agentEndpoint: SimulationJob.AgentEndpoint;
+
+      /**
+       * When the simulation job was created
+       */
+      createdAt: string;
+
+      persona: SimulationJob.Persona;
+
+      /**
+       * Processing status
+       */
+      processingStatus: string;
+
+      /**
+       * Scenario used in a simulation
+       */
+      scenario: SimulationJob.Scenario;
+
+      /**
+       * Simulation job ID
+       */
+      simulationJobId: string;
+
+      /**
+       * Job status
+       */
+      status: string;
+
+      /**
+       * When the simulation job completed
+       */
+      completedAt?: string | null;
+
+      /**
+       * When the simulation job started
+       */
+      startedAt?: string | null;
+    }
+
+    export namespace SimulationJob {
+      /**
+       * Agent endpoint used in a simulation
+       */
+      export interface AgentEndpoint {
+        /**
+         * Agent endpoint ID
+         */
+        id: string;
+
+        /**
+         * Agent endpoint name
+         */
+        name: string;
+
+        /**
+         * Agent endpoint phone number
+         */
+        phoneNumber: string | null;
+
+        /**
+         * Agent endpoint type
+         */
+        type: string;
+      }
+
+      export interface Persona {
+        /**
+         * Unique identifier of the persona
+         */
+        id: string;
+
+        /**
+         * Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
+         * optional variants
+         */
+        accent:
+          | 'US'
+          | 'US_X_SOUTH'
+          | 'GB'
+          | 'ES'
+          | 'DE'
+          | 'IN'
+          | 'FR'
+          | 'NL'
+          | 'SA'
+          | 'GR'
+          | 'AU'
+          | 'IT'
+          | 'ID'
+          | 'TH';
+
+        /**
+         * Background noise setting
+         */
+        backgroundNoise:
+          | 'NONE'
+          | 'AIRPORT'
+          | 'CHILDREN_PLAYING'
+          | 'CITY'
+          | 'COFFEE_SHOP'
+          | 'DRIVING'
+          | 'OFFICE'
+          | 'THUNDERSTORM';
+
+        /**
+         * Base emotional state of the persona
+         */
+        baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
+
+        /**
+         * How the persona confirms information
+         */
+        confirmationStyle: 'EXPLICIT' | 'VAGUE';
+
+        /**
+         * Creation timestamp
+         */
+        createdAt: string;
+
+        /**
+         * Gender of the persona
+         */
+        gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
+
+        /**
+         * Whether the persona uses filler words like "um" and "uh"
+         */
+        hasDisfluencies: boolean;
+
+        /**
+         * How clearly the persona expresses their intentions
+         */
+        intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
+
+        /**
+         * Primary language ISO 639-1 code for the persona
+         */
+        language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
+
+        /**
+         * How reliable the persona's memory is
+         */
+        memoryReliability: 'HIGH' | 'LOW';
+
+        /**
+         * The name the agent will identify as during conversations
+         */
+        name: string;
+
+        /**
+         * Additional custom properties about the persona
+         */
+        properties: { [key: string]: unknown };
+
+        /**
+         * Speech clarity of the persona
+         */
+        speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
+
+        /**
+         * Speech pace of the persona
+         */
+        speechPace: 'SLOW' | 'NORMAL' | 'FAST';
+
+        /**
+         * Last update timestamp
+         */
+        updatedAt: string;
+
+        /**
+         * Background story and behavioral patterns for the persona
+         */
+        backstoryPrompt?: string | null;
+
+        /**
+         * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
+         */
+        secondaryLanguage?: 'EN' | null;
+      }
+
+      /**
+       * Scenario used in a simulation
+       */
+      export interface Scenario {
+        /**
+         * Scenario ID
+         */
+        id: string;
+
+        /**
+         * Scenario description
+         */
+        description?: string | null;
+      }
+    }
+  }
 }
 
-export interface SimulationGetJobByIDResponse {
+export interface SimulationGetSimulationJobByIDResponse {
   /**
    * Simulation job with related entities
    */
-  data: SimulationGetJobByIDResponse.Data;
+  data: SimulationGetSimulationJobByIDResponse.Data;
 }
 
-export namespace SimulationGetJobByIDResponse {
+export namespace SimulationGetSimulationJobByIDResponse {
   /**
    * Simulation job with related entities
    */
@@ -103,11 +395,6 @@ export namespace SimulationGetJobByIDResponse {
        */
       id: string;
 
-      /**
-       * Agent endpoint type
-       */
-      endpointType: string;
-
       /**
        * Agent endpoint name
        */
@@ -117,6 +404,11 @@ export namespace SimulationGetJobByIDResponse {
        * Agent endpoint phone number
        */
       phoneNumber: string | null;
+
+      /**
+       * Agent endpoint type
+       */
+      type: string;
     }
 
     export interface Persona {
@@ -129,7 +421,21 @@ export namespace SimulationGetJobByIDResponse {
        * Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
        * optional variants
        */
-      accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT';
+      accent:
+        | 'US'
+        | 'US_X_SOUTH'
+        | 'GB'
+        | 'ES'
+        | 'DE'
+        | 'IN'
+        | 'FR'
+        | 'NL'
+        | 'SA'
+        | 'GR'
+        | 'AU'
+        | 'IT'
+        | 'ID'
+        | 'TH';
 
       /**
        * Background noise setting
@@ -177,7 +483,7 @@ export namespace SimulationGetJobByIDResponse {
       /**
        * Primary language ISO 639-1 code for the persona
        */
-      language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT';
+      language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
 
       /**
        * How reliable the persona's memory is
@@ -237,14 +543,14 @@ export namespace SimulationGetJobByIDResponse {
   }
 }
 
-export interface SimulationLookupJobResponse {
+export interface SimulationLookupSimulationJobResponse {
   /**
    * Simulation job with related entities
    */
-  data: SimulationLookupJobResponse.Data;
+  data: SimulationLookupSimulationJobResponse.Data;
 }
 
-export namespace SimulationLookupJobResponse {
+export namespace SimulationLookupSimulationJobResponse {
   /**
    * Simulation job with related entities
    */
@@ -302,11 +608,6 @@ export namespace SimulationLookupJobResponse {
        */
       id: string;
 
-      /**
-       * Agent endpoint type
-       */
-      endpointType: string;
-
       /**
        * Agent endpoint name
        */
@@ -316,6 +617,11 @@ export namespace SimulationLookupJobResponse {
        * Agent endpoint phone number
        */
       phoneNumber: string | null;
+
+      /**
+       * Agent endpoint type
+       */
+      type: string;
     }
 
     export interface Persona {
@@ -328,7 +634,21 @@ export namespace SimulationLookupJobResponse {
        * Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
        * optional variants
        */
-      accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT';
+      accent:
+        | 'US'
+        | 'US_X_SOUTH'
+        | 'GB'
+        | 'ES'
+        | 'DE'
+        | 'IN'
+        | 'FR'
+        | 'NL'
+        | 'SA'
+        | 'GR'
+        | 'AU'
+        | 'IT'
+        | 'ID'
+        | 'TH';
 
       /**
        * Background noise setting
@@ -376,7 +696,7 @@ export namespace SimulationLookupJobResponse {
       /**
        * Primary language ISO 639-1 code for the persona
        */
-      language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT';
+      language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
 
       /**
        * How reliable the persona's memory is
@@ -436,7 +756,41 @@ export namespace SimulationLookupJobResponse {
   }
 }
 
-export interface SimulationLookupJobParams {
+export interface SimulationStartRunPlanJobResponse {
+  /**
+   * Response when triggering a simulation run plan
+   */
+  data: SimulationStartRunPlanJobResponse.Data;
+}
+
+export namespace SimulationStartRunPlanJobResponse {
+  /**
+   * Response when triggering a simulation run plan
+   */
+  export interface Data {
+    /**
+     * When the job was created
+     */
+    createdAt: string;
+
+    /**
+     * ID of the simulation run plan that was executed
+     */
+    simulationRunPlanId: string;
+
+    /**
+     * ID of the simulation run plan job that was created
+     */
+    simulationRunPlanJobId: string;
+
+    /**
+     * Initial status of the job
+     */
+    status: string;
+  }
+}
+
+export interface SimulationLookupSimulationJobParams {
   /**
    * Phone number provisioned by Roark for the simulation job in E.164 format. In the
    * case of an inbound simulation, this is the number that calls your agent; in the
@@ -454,8 +808,10 @@ export interface SimulationLookupJobParams {
 
 export declare namespace Simulation {
   export {
-    type SimulationGetJobByIDResponse as SimulationGetJobByIDResponse,
-    type SimulationLookupJobResponse as SimulationLookupJobResponse,
-    type SimulationLookupJobParams as SimulationLookupJobParams,
+    type SimulationGetRunPlanJobResponse as SimulationGetRunPlanJobResponse,
+    type SimulationGetSimulationJobByIDResponse as SimulationGetSimulationJobByIDResponse,
+    type SimulationLookupSimulationJobResponse as SimulationLookupSimulationJobResponse,
+    type SimulationStartRunPlanJobResponse as SimulationStartRunPlanJobResponse,
+    type SimulationLookupSimulationJobParams as SimulationLookupSimulationJobParams,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.13.0'; // x-release-please-version
+export const VERSION = '2.14.0'; // x-release-please-version

package/version.d.ts

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

package/version.mjs

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