@roarkanalytics/sdk 2.9.1 → 2.11.0

package/resources/simulation.d.ts

@@ -2,7 +2,8 @@ import { APIResource } from "../resource.js";
 import * as Core from "../core.js";
 export declare class Simulation extends APIResource {
     /**
-     * Find a simulation job directly by its ID
+     * Get a individual simulation run directly by its ID. This is generally part of a
+     * larger simulation run plan job.
      *
      * @example
      * ```ts
@@ -13,7 +14,7 @@ export declare class Simulation extends APIResource {
      */
     getJobById(jobId: unknown, options?: Core.RequestOptions): Core.APIPromise<SimulationGetJobByIDResponse>;
     /**
-     * Find the matching simulation job using the number used by the Roark simulation
+     * Find the matching simulation using the number used by the Roark simulation
      * agent.
      *
      * @example
@@ -37,23 +38,20 @@ export declare namespace SimulationGetJobByIDResponse {
      */
     interface Data {
         /**
-         * Agent endpoint used in the simulation
+         * Agent endpoint used in a simulation
          */
         agentEndpoint: Data.AgentEndpoint;
         /**
          * When the job was created
          */
         createdAt: string;
-        /**
-         * Persona used in the simulation
-         */
         persona: Data.Persona;
         /**
          * Processing status
          */
         processingStatus: string;
         /**
-         * Scenario used in the simulation
+         * Scenario used in a simulation
          */
         scenario: Data.Scenario;
         /**
@@ -75,7 +73,7 @@ export declare namespace SimulationGetJobByIDResponse {
     }
     namespace Data {
         /**
-         * Agent endpoint used in the simulation
+         * Agent endpoint used in a simulation
          */
         interface AgentEndpoint {
             /**
@@ -95,65 +93,85 @@ export declare namespace SimulationGetJobByIDResponse {
              */
             phoneNumber: string | null;
         }
-        /**
-         * Persona used in the simulation
-         */
         interface Persona {
             /**
-             * Persona ID
+             * Unique identifier of the persona
              */
             id: string;
             /**
-             * Accent of the persona
+             * Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
+             * optional variants
              */
-            accent: string;
+            accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU';
             /**
              * Background noise setting
              */
-            backgroundNoise: string;
+            backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
             /**
-             * Base emotion of the persona
+             * Base emotional state of the persona
              */
-            baseEmotion: string;
+            baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
             /**
              * How the persona confirms information
              */
-            confirmationStyle: string;
+            confirmationStyle: 'EXPLICIT' | 'VAGUE';
             /**
-             * Whether persona has speech disfluencies
+             * Creation timestamp
              */
-            disfluencies: boolean;
+            createdAt: string;
             /**
              * Gender of the persona
              */
-            gender: string;
+            gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
             /**
-             * How clearly the persona expresses intent
+             * Whether the persona uses filler words like "um" and "uh"
              */
-            intentClarity: string;
+            hasDisfluencies: boolean;
             /**
-             * Language of the persona
+             * How clearly the persona expresses their intentions
              */
-            language: string;
+            intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
             /**
-             * Reliability of persona memory
+             * Primary language ISO 639-1 code for the persona
              */
-            memoryReliability: string;
+            language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL';
             /**
-             * Persona name
+             * How reliable the persona's memory is
+             */
+            memoryReliability: 'HIGH' | 'LOW';
+            /**
+             * The name the agent will identify as during conversations
              */
             name: string;
             /**
-             * Speech clarity
+             * 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
              */
-            speechClarity: string;
+            backstoryPrompt?: string | null;
             /**
-             * Speech pace
+             * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
              */
-            speechPace: string;
+            secondaryLanguage?: 'EN' | null;
         }
         /**
-         * Scenario used in the simulation
+         * Scenario used in a simulation
          */
         interface Scenario {
             /**
@@ -179,23 +197,20 @@ export declare namespace SimulationLookupJobResponse {
      */
     interface Data {
         /**
-         * Agent endpoint used in the simulation
+         * Agent endpoint used in a simulation
          */
         agentEndpoint: Data.AgentEndpoint;
         /**
          * When the job was created
          */
         createdAt: string;
-        /**
-         * Persona used in the simulation
-         */
         persona: Data.Persona;
         /**
          * Processing status
          */
         processingStatus: string;
         /**
-         * Scenario used in the simulation
+         * Scenario used in a simulation
          */
         scenario: Data.Scenario;
         /**
@@ -217,7 +232,7 @@ export declare namespace SimulationLookupJobResponse {
     }
     namespace Data {
         /**
-         * Agent endpoint used in the simulation
+         * Agent endpoint used in a simulation
          */
         interface AgentEndpoint {
             /**
@@ -237,65 +252,85 @@ export declare namespace SimulationLookupJobResponse {
              */
             phoneNumber: string | null;
         }
-        /**
-         * Persona used in the simulation
-         */
         interface Persona {
             /**
-             * Persona ID
+             * Unique identifier of the persona
              */
             id: string;
             /**
-             * Accent of the persona
+             * Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
+             * optional variants
              */
-            accent: string;
+            accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU';
             /**
              * Background noise setting
              */
-            backgroundNoise: string;
+            backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
             /**
-             * Base emotion of the persona
+             * Base emotional state of the persona
              */
-            baseEmotion: string;
+            baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
             /**
              * How the persona confirms information
              */
-            confirmationStyle: string;
+            confirmationStyle: 'EXPLICIT' | 'VAGUE';
             /**
-             * Whether persona has speech disfluencies
+             * Creation timestamp
              */
-            disfluencies: boolean;
+            createdAt: string;
             /**
              * Gender of the persona
              */
-            gender: string;
+            gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
             /**
-             * How clearly the persona expresses intent
+             * Whether the persona uses filler words like "um" and "uh"
              */
-            intentClarity: string;
+            hasDisfluencies: boolean;
             /**
-             * Language of the persona
+             * How clearly the persona expresses their intentions
              */
-            language: string;
+            intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
             /**
-             * Reliability of persona memory
+             * Primary language ISO 639-1 code for the persona
              */
-            memoryReliability: string;
+            language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL';
             /**
-             * Persona name
+             * How reliable the persona's memory is
+             */
+            memoryReliability: 'HIGH' | 'LOW';
+            /**
+             * The name the agent will identify as during conversations
              */
             name: string;
             /**
-             * Speech clarity
+             * 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
              */
-            speechClarity: string;
+            backstoryPrompt?: string | null;
             /**
-             * Speech pace
+             * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
              */
-            speechPace: string;
+            secondaryLanguage?: 'EN' | null;
         }
         /**
-         * Scenario used in the simulation
+         * Scenario used in a simulation
          */
         interface Scenario {
             /**

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;;;;;;;;;OASG;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;;WAEG;QACH,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;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,eAAe,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,YAAY,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;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;;WAEG;QACH,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;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,eAAe,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,YAAY,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;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,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,CAAC;YAE3F;;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,CAAC;YAEhE;;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,CAAC;YAE3F;;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,CAAC;YAEhE;;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"}

package/resources/simulation.js

@@ -5,7 +5,8 @@ exports.Simulation = void 0;
 const resource_1 = require("../resource.js");
 class Simulation extends resource_1.APIResource {
     /**
-     * Find a simulation job directly by its ID
+     * Get a individual simulation run directly by its ID. This is generally part of a
+     * larger simulation run plan job.
      *
      * @example
      * ```ts
@@ -18,7 +19,7 @@ class Simulation extends resource_1.APIResource {
         return this._client.get(`/v1/simulation/job/${jobId}`, options);
     }
     /**
-     * Find the matching simulation job using the number used by the Roark simulation
+     * Find the matching simulation using the number used by the Roark simulation
      * agent.
      *
      * @example

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;;;;;;;;;OASG;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;AAhCD,gCAgCC"}
+{"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"}

package/resources/simulation.mjs

@@ -2,7 +2,8 @@
 import { APIResource } from "../resource.mjs";
 export class Simulation extends APIResource {
     /**
-     * Find a simulation job directly by its ID
+     * Get a individual simulation run directly by its ID. This is generally part of a
+     * larger simulation run plan job.
      *
      * @example
      * ```ts
@@ -15,7 +16,7 @@ export class Simulation extends APIResource {
         return this._client.get(`/v1/simulation/job/${jobId}`, options);
     }
     /**
-     * Find the matching simulation job using the number used by the Roark simulation
+     * Find the matching simulation using the number used by the Roark simulation
      * agent.
      *
      * @example

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;;;;;;;;;OASG;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,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"}

package/src/index.ts

@@ -6,7 +6,13 @@ import * as Core from './core';
 import * as Errors from './error';
 import * as Uploads from './uploads';
 import * as API from './resources/index';
-import { Call, CallGetEvaluationRunsResponse, CallGetSentimentRunsResponse } from './resources/call';
+import {
+  Call,
+  CallGetEvaluationRunsResponse,
+  CallGetMetricsParams,
+  CallGetMetricsResponse,
+  CallGetSentimentRunsResponse,
+} from './resources/call';
 import {
   Evaluation,
   EvaluationCreateJobParams,
@@ -26,6 +32,7 @@ import {
   IntegrationCreateVapiCallResponse,
   Integrations,
 } from './resources/integrations';
+import { Metric, MetricGetDefinitionsResponse } from './resources/metric';
 import {
   Persona,
   PersonaCreateParams,
@@ -162,6 +169,7 @@ export class Roark extends Core.APIClient {
   health: API.Health = new API.Health(this);
   evaluation: API.Evaluation = new API.Evaluation(this);
   call: API.Call = new API.Call(this);
+  metric: API.Metric = new API.Metric(this);
   integrations: API.Integrations = new API.Integrations(this);
   simulation: API.Simulation = new API.Simulation(this);
   persona: API.Persona = new API.Persona(this);
@@ -216,6 +224,7 @@ export class Roark extends Core.APIClient {
 Roark.Health = Health;
 Roark.Evaluation = Evaluation;
 Roark.Call = Call;
+Roark.Metric = Metric;
 Roark.Integrations = Integrations;
 Roark.Simulation = Simulation;
 Roark.Persona = Persona;
@@ -240,9 +249,13 @@ export declare namespace Roark {
   export {
     Call as Call,
     type CallGetEvaluationRunsResponse as CallGetEvaluationRunsResponse,
+    type CallGetMetricsResponse as CallGetMetricsResponse,
     type CallGetSentimentRunsResponse as CallGetSentimentRunsResponse,
+    type CallGetMetricsParams as CallGetMetricsParams,
   };
 
+  export { Metric as Metric, type MetricGetDefinitionsResponse as MetricGetDefinitionsResponse };
+
   export {
     Integrations as Integrations,
     type IntegrationCreateRetellCallResponse as IntegrationCreateRetellCallResponse,