@roarkanalytics/sdk 2.21.0 → 2.21.1

package/resources/simulation.d.mts

@@ -0,0 +1,756 @@
+import { APIResource } from "../resource.mjs";
+import { APIPromise } from "../api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Simulation extends APIResource {
+    /**
+     * Retrieve details of a simulation plan job including all associated simulation
+     * jobs (calls)
+     */
+    getRunPlanJob(jobID: unknown, options?: RequestOptions): APIPromise<SimulationGetRunPlanJobResponse>;
+    /**
+     * Get a individual simulation run directly by its ID. This is generally part of a
+     * larger simulation run plan job.
+     */
+    getSimulationJobByID(jobID: unknown, options?: RequestOptions): APIPromise<SimulationGetSimulationJobByIDResponse>;
+    /**
+     * Returns a paginated list of simulation run plan jobs. Filter by status, plan ID,
+     * or label to find specific simulation batches.
+     */
+    listRunPlanJobs(query?: SimulationListRunPlanJobsParams | null | undefined, options?: RequestOptions): APIPromise<SimulationListRunPlanJobsResponse>;
+    /**
+     * Returns a paginated list of simulation scenarios for the authenticated project.
+     */
+    listScenarios(query?: SimulationListScenariosParams | null | undefined, options?: RequestOptions): APIPromise<SimulationListScenariosResponse>;
+    /**
+     * Find the matching simulation using the number used by the Roark simulation
+     * agent.
+     */
+    lookupSimulationJob(query: SimulationLookupSimulationJobParams, options?: RequestOptions): APIPromise<SimulationLookupSimulationJobResponse>;
+    /**
+     * Create and execute a job for an existing simulation run plan
+     */
+    startRunPlanJob(planID: unknown, options?: RequestOptions): 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;
+            /**
+             * 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: 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' | '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: Record<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 SimulationGetSimulationJobByIDResponse {
+    /**
+     * Simulation job with related entities
+     */
+    data: SimulationGetSimulationJobByIDResponse.Data;
+}
+export declare namespace SimulationGetSimulationJobByIDResponse {
+    /**
+     * Simulation job with related entities
+     */
+    interface Data {
+        /**
+         * Agent endpoint used in a simulation
+         */
+        agentEndpoint: Data.AgentEndpoint;
+        /**
+         * When the job was created
+         */
+        createdAt: string;
+        persona: Data.Persona;
+        /**
+         * Processing status
+         */
+        processingStatus: string;
+        /**
+         * Scenario used in a simulation
+         */
+        scenario: Data.Scenario;
+        /**
+         * Simulation job ID
+         */
+        simulationJobId: string;
+        /**
+         * Job status
+         */
+        status: string;
+        /**
+         * ID of the call created for this simulation job. Null if the call has not been
+         * created yet.
+         */
+        callId?: string | null;
+        /**
+         * When the 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 job started
+         */
+        startedAt?: string | null;
+    }
+    namespace Data {
+        /**
+         * 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' | '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: Record<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;
+        }
+    }
+}
+/**
+ * Paginated list of simulation run plan jobs
+ */
+export interface SimulationListRunPlanJobsResponse {
+    data: Array<SimulationListRunPlanJobsResponse.Data>;
+    pagination: SimulationListRunPlanJobsResponse.Pagination;
+}
+export declare namespace SimulationListRunPlanJobsResponse {
+    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: string;
+        /**
+         * How the job was triggered (SCHEDULED or USER_TRIGGERED_FROM_UI)
+         */
+        triggeredBy: string;
+        /**
+         * 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 SimulationListScenariosResponse {
+    data: Array<SimulationListScenariosResponse.Data>;
+    pagination: SimulationListScenariosResponse.Pagination;
+}
+export declare namespace SimulationListScenariosResponse {
+    interface Data {
+        /**
+         * Unique identifier of the scenario
+         */
+        id: string;
+        /**
+         * Creation timestamp in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Description of the scenario
+         */
+        description: string | null;
+        /**
+         * Name of the scenario (from the start node content)
+         */
+        name: string | null;
+        /**
+         * Ordered list of steps in the scenario (excludes the START node)
+         */
+        steps: Array<Data.Step>;
+        /**
+         * Last update timestamp in ISO 8601 format
+         */
+        updatedAt: string;
+    }
+    namespace Data {
+        interface Step {
+            /**
+             * Content/text of the step
+             */
+            content: string | null;
+            /**
+             * Type of step in the scenario
+             */
+            type: 'START' | 'AGENT_TURN' | 'CUSTOMER_TURN' | 'CUSTOMER_FIRST_MESSAGE' | 'CUSTOMER_SILENCE' | 'VOICEMAIL';
+        }
+    }
+    interface Pagination {
+        /**
+         * Whether there are more items to fetch
+         */
+        hasMore: boolean;
+        /**
+         * Cursor for the next page of items
+         */
+        nextCursor: string | null;
+        /**
+         * Total number of items
+         */
+        total: number;
+    }
+}
+export interface SimulationLookupSimulationJobResponse {
+    /**
+     * Simulation job with related entities
+     */
+    data: SimulationLookupSimulationJobResponse.Data;
+}
+export declare namespace SimulationLookupSimulationJobResponse {
+    /**
+     * Simulation job with related entities
+     */
+    interface Data {
+        /**
+         * Agent endpoint used in a simulation
+         */
+        agentEndpoint: Data.AgentEndpoint;
+        /**
+         * When the job was created
+         */
+        createdAt: string;
+        persona: Data.Persona;
+        /**
+         * Processing status
+         */
+        processingStatus: string;
+        /**
+         * Scenario used in a simulation
+         */
+        scenario: Data.Scenario;
+        /**
+         * Simulation job ID
+         */
+        simulationJobId: string;
+        /**
+         * Job status
+         */
+        status: string;
+        /**
+         * ID of the call created for this simulation job. Null if the call has not been
+         * created yet.
+         */
+        callId?: string | null;
+        /**
+         * When the 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 job started
+         */
+        startedAt?: string | null;
+    }
+    namespace Data {
+        /**
+         * 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' | '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: Record<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 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 SimulationListRunPlanJobsParams {
+    /**
+     * 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?: string;
+}
+export interface SimulationListScenariosParams {
+    after?: string;
+    limit?: number;
+}
+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
+     * case of an outbound simulation, this is the number you call from your agent.
+     */
+    roarkPhoneNumber: unknown;
+    /**
+     * ISO 8601 timestamp of when the call was received. Alternatively, any time
+     * between the start and end of the call is valid. Defaults to the current time,
+     * which fetches any jobs that are currently ongoing.
+     */
+    callReceivedAt?: unknown;
+}
+export declare namespace Simulation {
+    export { type SimulationGetRunPlanJobResponse as SimulationGetRunPlanJobResponse, type SimulationGetSimulationJobByIDResponse as SimulationGetSimulationJobByIDResponse, type SimulationListRunPlanJobsResponse as SimulationListRunPlanJobsResponse, type SimulationListScenariosResponse as SimulationListScenariosResponse, type SimulationLookupSimulationJobResponse as SimulationLookupSimulationJobResponse, type SimulationStartRunPlanJobResponse as SimulationStartRunPlanJobResponse, type SimulationListRunPlanJobsParams as SimulationListRunPlanJobsParams, type SimulationListScenariosParams as SimulationListScenariosParams, type SimulationLookupSimulationJobParams as SimulationLookupSimulationJobParams, };
+}
+//# sourceMappingURL=simulation.d.mts.map