@roarkanalytics/sdk 2.21.2 → 2.23.0

package/resources/simulation-run-plan-job.d.mts

@@ -0,0 +1,359 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class SimulationRunPlanJob extends APIResource {
+    /**
+     * Returns a paginated list of simulation run plan jobs. Filter by status, plan ID,
+     * or label to find specific simulation batches.
+     *
+     * @example
+     * ```ts
+     * const simulationRunPlanJobs =
+     *   await client.simulationRunPlanJob.list();
+     * ```
+     */
+    list(query?: SimulationRunPlanJobListParams | null | undefined, options?: RequestOptions): APIPromise<SimulationRunPlanJobListResponse>;
+    /**
+     * Retrieve details of a simulation plan job including all associated simulation
+     * jobs (calls)
+     *
+     * @example
+     * ```ts
+     * const response = await client.simulationRunPlanJob.getByID(
+     *   '7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f',
+     * );
+     * ```
+     */
+    getByID(jobID: unknown, options?: RequestOptions): APIPromise<SimulationRunPlanJobGetByIDResponse>;
+    /**
+     * Create and execute a job for an existing simulation run plan
+     *
+     * @example
+     * ```ts
+     * const response = await client.simulationRunPlanJob.start(
+     *   '7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f',
+     * );
+     * ```
+     */
+    start(planID: unknown, options?: RequestOptions): APIPromise<SimulationRunPlanJobStartResponse>;
+}
+/**
+ * Paginated list of simulation run plan jobs
+ */
+export interface SimulationRunPlanJobListResponse {
+    data: Array<SimulationRunPlanJobListResponse.Data>;
+    pagination: SimulationRunPlanJobListResponse.Pagination;
+}
+export declare namespace SimulationRunPlanJobListResponse {
+    interface Data {
+        /**
+         * When the job was created
+         */
+        createdAt: string;
+        /**
+         * ID of the simulation run plan
+         */
+        simulationRunPlanId: string;
+        /**
+         * ID of the simulation run plan job
+         */
+        simulationRunPlanJobId: string;
+        /**
+         * Job status
+         */
+        status: 'PENDING' | 'QUEUED' | 'CREATING_SNAPSHOTS' | 'CREATING_SIMULATIONS' | 'RUNNING_SIMULATIONS' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'CANCELLED' | 'CANCELLING';
+        /**
+         * How the job was triggered (SCHEDULED, USER_TRIGGERED_FROM_UI,
+         * TRIGGERED_FROM_API, or RE_RUN)
+         */
+        triggeredBy: 'SCHEDULED' | 'USER_TRIGGERED_FROM_UI' | 'RE_RUN' | 'TRIGGERED_FROM_API';
+        /**
+         * When the job ended
+         */
+        endedAt?: string | null;
+        /**
+         * When the job started
+         */
+        startedAt?: string | null;
+    }
+    interface Pagination {
+        /**
+         * Whether there are more results available
+         */
+        hasMore: boolean;
+        /**
+         * Total number of matching plan jobs
+         */
+        total: number;
+        /**
+         * Cursor to use for fetching the next page
+         */
+        nextCursor?: string | null;
+    }
+}
+export interface SimulationRunPlanJobGetByIDResponse {
+    /**
+     * Simulation run plan job with all associated simulation jobs
+     */
+    data: SimulationRunPlanJobGetByIDResponse.Data;
+}
+export declare namespace SimulationRunPlanJobGetByIDResponse {
+    /**
+     * 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: 'PENDING' | 'QUEUED' | 'CREATING_SNAPSHOTS' | 'CREATING_SIMULATIONS' | 'RUNNING_SIMULATIONS' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'CANCELLED' | 'CANCELLING';
+        /**
+         * 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: 'CONNECTING' | 'WAITING_FOR_OUTBOUND_CALL' | 'SIMULATING' | 'ANALYZING' | 'EVALUATING' | 'COMPLETED';
+            /**
+             * Scenario used in a simulation
+             */
+            scenario: SimulationJob.Scenario;
+            /**
+             * Simulation job ID
+             */
+            simulationJobId: string;
+            /**
+             * Job status
+             */
+            status: 'PENDING' | 'QUEUED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'CANCELLED' | 'CANCELLING';
+            /**
+             * ID of the call created for this simulation job. Null if the call has not been
+             * created yet.
+             */
+            callId?: string | null;
+            /**
+             * When the simulation job completed
+             */
+            completedAt?: string | null;
+            /**
+             * Phone number provisioned by Roark for this simulation job in E.164 format. Null
+             * if the simulation job is queued and has not been assigned a phone number yet.
+             */
+            roarkPhoneNumber?: 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: 'PHONE' | 'WEBSOCKET';
+            }
+            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' | 'JP';
+                /**
+                 * 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' | 'JA';
+                /**
+                 * 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;
+                /**
+                 * Human-readable description of the persona
+                 */
+                description?: 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 SimulationRunPlanJobStartResponse {
+    /**
+     * Response when triggering a simulation run plan
+     */
+    data: SimulationRunPlanJobStartResponse.Data;
+}
+export declare namespace SimulationRunPlanJobStartResponse {
+    /**
+     * 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: 'PENDING' | 'QUEUED' | 'CREATING_SNAPSHOTS' | 'CREATING_SIMULATIONS' | 'RUNNING_SIMULATIONS' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'CANCELLED' | 'CANCELLING';
+    }
+}
+export interface SimulationRunPlanJobListParams {
+    /**
+     * Cursor for pagination - use the nextCursor value from a previous response
+     */
+    after?: string;
+    /**
+     * Filter by label ID attached to the plan job. Use this if you know the label ID.
+     */
+    labelId?: string;
+    /**
+     * Filter by label name attached to the plan job. More user-friendly alternative to
+     * labelId. Case-insensitive.
+     */
+    labelName?: string;
+    /**
+     * Maximum number of plan jobs to return (default: 20, max: 50)
+     */
+    limit?: number;
+    /**
+     * Filter by simulation run plan ID
+     */
+    simulationRunPlanId?: string;
+    /**
+     * Filter by plan job status (PENDING, CREATING_SNAPSHOTS, CREATING_SIMULATIONS,
+     * RUNNING_SIMULATIONS, COMPLETED, FAILED, TIMED_OUT, CANCELLED, CANCELLING)
+     */
+    status?: 'PENDING' | 'QUEUED' | 'CREATING_SNAPSHOTS' | 'CREATING_SIMULATIONS' | 'RUNNING_SIMULATIONS' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'CANCELLED' | 'CANCELLING';
+}
+export declare namespace SimulationRunPlanJob {
+    export { type SimulationRunPlanJobListResponse as SimulationRunPlanJobListResponse, type SimulationRunPlanJobGetByIDResponse as SimulationRunPlanJobGetByIDResponse, type SimulationRunPlanJobStartResponse as SimulationRunPlanJobStartResponse, type SimulationRunPlanJobListParams as SimulationRunPlanJobListParams, };
+}
+//# sourceMappingURL=simulation-run-plan-job.d.mts.map

package/resources/simulation-run-plan-job.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulation-run-plan-job.d.mts","sourceRoot":"","sources":["../src/resources/simulation-run-plan-job.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;OAUG;IACH,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAIlG;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,IAAI,EAAE,KAAK,CAAC,gCAAgC,CAAC,IAAI,CAAC,CAAC;IAEnD,UAAU,EAAE,gCAAgC,CAAC,UAAU,CAAC;CACzD;AAED,yBAAiB,gCAAgC,CAAC;IAChD,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,EACF,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,CAAC;QAEjB;;;WAGG;QACH,WAAW,EAAE,WAAW,GAAG,wBAAwB,GAAG,QAAQ,GAAG,oBAAoB,CAAC;QAEtF;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,IAAI,EAAE,mCAAmC,CAAC,IAAI,CAAC;CAChD;AAED,yBAAiB,mCAAmC,CAAC;IACnD;;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,EACF,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,CAAC;QAEjB;;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,EACZ,YAAY,GACZ,2BAA2B,GAC3B,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,WAAW,CAAC;YAEhB;;eAEG;YACH,QAAQ,EAAE,aAAa,CAAC,QAAQ,CAAC;YAEjC;;eAEG;YACH,eAAe,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,MAAM,EACF,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,CAAC;YAEjB;;;eAGG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;eAGG;YACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEjC;;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,OAAO,GAAG,WAAW,CAAC;aAC7B;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,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,GAAG,IAAI,CAAC;gBAE5F;;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,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;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,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,EACF,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,CAAC;KAClB;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,MAAM,CAAC,EACH,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}