@roarkanalytics/sdk 2.13.0 → 2.14.0

package/resources/simulation.d.ts

@@ -2,37 +2,253 @@ import { APIResource } from "../resource.js";
 import * as Core from "../core.js";
 export declare 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>;
+    /**
+     * 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>;
     /**
      * Find the matching simulation using the number used by the Roark simulation
      * agent.
      *
      * @example
      * ```ts
-     * const response = await client.simulation.lookupJob({
-     *   roarkPhoneNumber: {},
-     * });
+     * const response =
+     *   await client.simulation.lookupSimulationJob({
+     *     roarkPhoneNumber: {},
+     *   });
      * ```
      */
-    lookupJob(query: SimulationLookupJobParams, options?: Core.RequestOptions): Core.APIPromise<SimulationLookupJobResponse>;
+    lookupSimulationJob(query: SimulationLookupSimulationJobParams, options?: Core.RequestOptions): Core.APIPromise<SimulationLookupSimulationJobResponse>;
+    /**
+     * 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>;
+}
+export interface SimulationGetRunPlanJobResponse {
+    /**
+     * Simulation run plan job with all associated simulation jobs
+     */
+    data: SimulationGetRunPlanJobResponse.Data;
+}
+export declare namespace SimulationGetRunPlanJobResponse {
+    /**
+     * Simulation run plan job with all associated simulation jobs
+     */
+    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;
+    }
+    namespace Data {
+        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;
+        }
+        namespace SimulationJob {
+            /**
+             * Agent endpoint used in a simulation
+             */
+            interface AgentEndpoint {
+                /**
+                 * Agent endpoint ID
+                 */
+                id: string;
+                /**
+                 * Agent endpoint name
+                 */
+                name: string;
+                /**
+                 * Agent endpoint phone number
+                 */
+                phoneNumber: string | null;
+                /**
+                 * Agent endpoint type
+                 */
+                type: string;
+            }
+            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
+             */
+            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 declare namespace SimulationGetJobByIDResponse {
+export declare namespace SimulationGetSimulationJobByIDResponse {
     /**
      * Simulation job with related entities
      */
@@ -80,10 +296,6 @@ export declare namespace SimulationGetJobByIDResponse {
              * Agent endpoint ID
              */
             id: string;
-            /**
-             * Agent endpoint type
-             */
-            endpointType: string;
             /**
              * Agent endpoint name
              */
@@ -92,6 +304,10 @@ export declare namespace SimulationGetJobByIDResponse {
              * Agent endpoint phone number
              */
             phoneNumber: string | null;
+            /**
+             * Agent endpoint type
+             */
+            type: string;
         }
         interface Persona {
             /**
@@ -102,7 +318,7 @@ export declare 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
              */
@@ -134,7 +350,7 @@ export declare 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
              */
@@ -185,13 +401,13 @@ export declare namespace SimulationGetJobByIDResponse {
         }
     }
 }
-export interface SimulationLookupJobResponse {
+export interface SimulationLookupSimulationJobResponse {
     /**
      * Simulation job with related entities
      */
-    data: SimulationLookupJobResponse.Data;
+    data: SimulationLookupSimulationJobResponse.Data;
 }
-export declare namespace SimulationLookupJobResponse {
+export declare namespace SimulationLookupSimulationJobResponse {
     /**
      * Simulation job with related entities
      */
@@ -239,10 +455,6 @@ export declare namespace SimulationLookupJobResponse {
              * Agent endpoint ID
              */
             id: string;
-            /**
-             * Agent endpoint type
-             */
-            endpointType: string;
             /**
              * Agent endpoint name
              */
@@ -251,6 +463,10 @@ export declare namespace SimulationLookupJobResponse {
              * Agent endpoint phone number
              */
             phoneNumber: string | null;
+            /**
+             * Agent endpoint type
+             */
+            type: string;
         }
         interface Persona {
             /**
@@ -261,7 +477,7 @@ export declare 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
              */
@@ -293,7 +509,7 @@ export declare 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
              */
@@ -344,7 +560,36 @@ export declare namespace SimulationLookupJobResponse {
         }
     }
 }
-export interface SimulationLookupJobParams {
+export interface SimulationStartRunPlanJobResponse {
+    /**
+     * Response when triggering a simulation run plan
+     */
+    data: SimulationStartRunPlanJobResponse.Data;
+}
+export declare namespace SimulationStartRunPlanJobResponse {
+    /**
+     * Response when triggering a simulation run plan
+     */
+    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
@@ -359,6 +604,6 @@ export interface SimulationLookupJobParams {
     callReceivedAt?: unknown;
 }
 export declare namespace Simulation {
-    export { type SimulationGetJobByIDResponse as SimulationGetJobByIDResponse, type SimulationLookupJobResponse as SimulationLookupJobResponse, type SimulationLookupJobParams as SimulationLookupJobParams, };
+    export { type SimulationGetRunPlanJobResponse as SimulationGetRunPlanJobResponse, type SimulationGetSimulationJobByIDResponse as SimulationGetSimulationJobByIDResponse, type SimulationLookupSimulationJobResponse as SimulationLookupSimulationJobResponse, type SimulationStartRunPlanJobResponse as SimulationStartRunPlanJobResponse, type SimulationLookupSimulationJobParams as SimulationLookupSimulationJobParams, };
 }
 //# sourceMappingURL=simulation.d.ts.map

package/resources/simulation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"simulation.d.ts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAIxG;;;;;;;;;;OAUG;IACH,SAAS,CACP,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;CAGhD;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC,IAAI,CAAC;CACzC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QAExB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;;eAGG;YACH,MAAM,EAAE,IAAI,GAAG,YAAY,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAElG;;eAEG;YACH,eAAe,EACX,MAAM,GACN,SAAS,GACT,kBAAkB,GAClB,MAAM,GACN,aAAa,GACb,SAAS,GACT,QAAQ,GACR,cAAc,CAAC;YAEnB;;eAEG;YACH,WAAW,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;YAEzF;;eAEG;YACH,iBAAiB,EAAE,UAAU,GAAG,OAAO,CAAC;YAExC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;YAEtC;;eAEG;YACH,eAAe,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,aAAa,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;YAE9C;;eAEG;YACH,QAAQ,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAEvE;;eAEG;YACH,iBAAiB,EAAE,MAAM,GAAG,KAAK,CAAC;YAElC;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,UAAU,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAEvC;;eAEG;YACH,aAAa,EAAE,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC;YAE9C;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;YAEvC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;eAEG;YACH,iBAAiB,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;SACjC;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QAExB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;;eAGG;YACH,MAAM,EAAE,IAAI,GAAG,YAAY,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAElG;;eAEG;YACH,eAAe,EACX,MAAM,GACN,SAAS,GACT,kBAAkB,GAClB,MAAM,GACN,aAAa,GACb,SAAS,GACT,QAAQ,GACR,cAAc,CAAC;YAEnB;;eAEG;YACH,WAAW,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;YAEzF;;eAEG;YACH,iBAAiB,EAAE,UAAU,GAAG,OAAO,CAAC;YAExC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;YAEtC;;eAEG;YACH,eAAe,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,aAAa,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;YAE9C;;eAEG;YACH,QAAQ,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAEvE;;eAEG;YACH,iBAAiB,EAAE,MAAM,GAAG,KAAK,CAAC;YAElC;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,UAAU,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAEvC;;eAEG;YACH,aAAa,EAAE,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC;YAE9C;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;YAEvC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;eAEG;YACH,iBAAiB,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;SACjC;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"simulation.d.ts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,aAAa,CACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC;IAInD;;;;;;;;;;;OAWG;IACH,oBAAoB,CAClB,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,sCAAsC,CAAC;IAI1D;;;;;;;;;;;OAWG;IACH,mBAAmB,CACjB,KAAK,EAAE,mCAAmC,EAC1C,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,qCAAqC,CAAC;IAIzD;;;;;;;;;OASG;IACH,eAAe,CACb,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,iCAAiC,CAAC;CAGtD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,IAAI,EAAE,+BAA+B,CAAC,IAAI,CAAC;CAC5C;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE1C;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,aAAa;YAC5B;;eAEG;YACH,aAAa,EAAE,aAAa,CAAC,aAAa,CAAC;YAE3C;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;YAE/B;;eAEG;YACH,gBAAgB,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,QAAQ,EAAE,aAAa,CAAC,QAAQ,CAAC;YAEjC;;eAEG;YACH,eAAe,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;QAED,UAAiB,aAAa,CAAC;YAC7B;;eAEG;YACH,UAAiB,aAAa;gBAC5B;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;aACd;YAED,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;mBAGG;gBACH,MAAM,EACF,IAAI,GACJ,YAAY,GACZ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;gBAET;;mBAEG;gBACH,eAAe,EACX,MAAM,GACN,SAAS,GACT,kBAAkB,GAClB,MAAM,GACN,aAAa,GACb,SAAS,GACT,QAAQ,GACR,cAAc,CAAC;gBAEnB;;mBAEG;gBACH,WAAW,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;gBAEzF;;mBAEG;gBACH,iBAAiB,EAAE,UAAU,GAAG,OAAO,CAAC;gBAExC;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;gBAEtC;;mBAEG;gBACH,eAAe,EAAE,OAAO,CAAC;gBAEzB;;mBAEG;gBACH,aAAa,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;gBAE9C;;mBAEG;gBACH,QAAQ,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;gBAErF;;mBAEG;gBACH,iBAAiB,EAAE,MAAM,GAAG,KAAK,CAAC;gBAElC;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,UAAU,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;iBAAE,CAAC;gBAEvC;;mBAEG;gBACH,aAAa,EAAE,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC;gBAE9C;;mBAEG;gBACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;gBAEvC;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEhC;;mBAEG;gBACH,iBAAiB,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;aACjC;YAED;;eAEG;YACH,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aAC7B;SACF;KACF;CACF;AAED,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,IAAI,EAAE,sCAAsC,CAAC,IAAI,CAAC;CACnD;AAED,yBAAiB,sCAAsC,CAAC;IACtD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QAExB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;;eAGG;YACH,MAAM,EACF,IAAI,GACJ,YAAY,GACZ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;YAET;;eAEG;YACH,eAAe,EACX,MAAM,GACN,SAAS,GACT,kBAAkB,GAClB,MAAM,GACN,aAAa,GACb,SAAS,GACT,QAAQ,GACR,cAAc,CAAC;YAEnB;;eAEG;YACH,WAAW,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;YAEzF;;eAEG;YACH,iBAAiB,EAAE,UAAU,GAAG,OAAO,CAAC;YAExC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;YAEtC;;eAEG;YACH,eAAe,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,aAAa,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;YAE9C;;eAEG;YACH,QAAQ,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAErF;;eAEG;YACH,iBAAiB,EAAE,MAAM,GAAG,KAAK,CAAC;YAElC;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,UAAU,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAEvC;;eAEG;YACH,aAAa,EAAE,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC;YAE9C;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;YAEvC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;eAEG;YACH,iBAAiB,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;SACjC;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,IAAI,EAAE,qCAAqC,CAAC,IAAI,CAAC;CAClD;AAED,yBAAiB,qCAAqC,CAAC;IACrD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QAExB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;;eAGG;YACH,MAAM,EACF,IAAI,GACJ,YAAY,GACZ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;YAET;;eAEG;YACH,eAAe,EACX,MAAM,GACN,SAAS,GACT,kBAAkB,GAClB,MAAM,GACN,aAAa,GACb,SAAS,GACT,QAAQ,GACR,cAAc,CAAC;YAEnB;;eAEG;YACH,WAAW,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;YAEzF;;eAEG;YACH,iBAAiB,EAAE,UAAU,GAAG,OAAO,CAAC;YAExC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;YAEtC;;eAEG;YACH,eAAe,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,aAAa,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;YAE9C;;eAEG;YACH,QAAQ,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAErF;;eAEG;YACH,iBAAiB,EAAE,MAAM,GAAG,KAAK,CAAC;YAElC;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,UAAU,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAEvC;;eAEG;YACH,aAAa,EAAE,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC;YAE9C;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;YAEvC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;eAEG;YACH,iBAAiB,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;SACjC;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,mCAAmC;IAClD;;;;OAIG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}

package/resources/simulation.js

@@ -5,17 +5,32 @@ exports.Simulation = void 0;
 const resource_1 = require("../resource.js");
 class Simulation extends resource_1.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, options) {
+    getRunPlanJob(jobId, options) {
+        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, options) {
         return this._client.get(`/v1/simulation/job/${jobId}`, options);
     }
     /**
@@ -24,14 +39,28 @@ class Simulation extends resource_1.APIResource {
      *
      * @example
      * ```ts
-     * const response = await client.simulation.lookupJob({
-     *   roarkPhoneNumber: {},
-     * });
+     * const response =
+     *   await client.simulation.lookupSimulationJob({
+     *     roarkPhoneNumber: {},
+     *   });
      * ```
      */
-    lookupJob(query, options) {
+    lookupSimulationJob(query, options) {
         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, options) {
+        return this._client.post(`/v1/simulation/plan/${planId}/job`, options);
+    }
 }
 exports.Simulation = Simulation;
 //# sourceMappingURL=simulation.js.map

package/resources/simulation.js.map

@@ -1 +1 @@
-{"version":3,"file":"simulation.js","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,KAAc,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AAjCD,gCAiCC"}
+{"version":3,"file":"simulation.js","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;OAUG;IACH,aAAa,CACX,KAAc,EACd,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,oBAAoB,CAClB,KAAc,EACd,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,mBAAmB,CACjB,KAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CACb,MAAe,EACf,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,MAAM,MAAM,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;CACF;AAzED,gCAyEC"}

package/resources/simulation.mjs

@@ -2,17 +2,32 @@
 import { APIResource } from "../resource.mjs";
 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, options) {
+    getRunPlanJob(jobId, options) {
+        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, options) {
         return this._client.get(`/v1/simulation/job/${jobId}`, options);
     }
     /**
@@ -21,13 +36,27 @@ export class Simulation extends APIResource {
      *
      * @example
      * ```ts
-     * const response = await client.simulation.lookupJob({
-     *   roarkPhoneNumber: {},
-     * });
+     * const response =
+     *   await client.simulation.lookupSimulationJob({
+     *     roarkPhoneNumber: {},
+     *   });
      * ```
      */
-    lookupJob(query, options) {
+    lookupSimulationJob(query, options) {
         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, options) {
+        return this._client.post(`/v1/simulation/plan/${planId}/job`, options);
+    }
 }
 //# sourceMappingURL=simulation.mjs.map

package/resources/simulation.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"simulation.mjs","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,KAAc,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF"}
+{"version":3,"file":"simulation.mjs","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,aAAa,CACX,KAAc,EACd,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,oBAAoB,CAClB,KAAc,EACd,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,mBAAmB,CACjB,KAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CACb,MAAe,EACf,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,MAAM,MAAM,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;CACF"}