@roarkanalytics/sdk 2.13.0 → 2.14.0

package/src/resources/evaluation.ts

@@ -25,48 +25,48 @@ export class Evaluation extends APIResource {
     return this._client.get(`/v1/evaluation/evaluators/${evaluatorId}`, options);
   }
 
+  /**
+   * Retrieve details of a specific evaluation job
+   */
+  getJob(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobResponse> {
+    return this._client.get(`/v1/evaluation/job/${jobId}`, options);
+  }
+
   /**
    * Returns a list of evaluators with their blocks and configuration for the
    * authenticated project.
    */
-  getEvaluators(
-    query?: EvaluationGetEvaluatorsParams,
+  listEvaluators(
+    query?: EvaluationListEvaluatorsParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<EvaluationGetEvaluatorsResponse>;
-  getEvaluators(options?: Core.RequestOptions): Core.APIPromise<EvaluationGetEvaluatorsResponse>;
-  getEvaluators(
-    query: EvaluationGetEvaluatorsParams | Core.RequestOptions = {},
+  ): Core.APIPromise<EvaluationListEvaluatorsResponse>;
+  listEvaluators(options?: Core.RequestOptions): Core.APIPromise<EvaluationListEvaluatorsResponse>;
+  listEvaluators(
+    query: EvaluationListEvaluatorsParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.APIPromise<EvaluationGetEvaluatorsResponse> {
+  ): Core.APIPromise<EvaluationListEvaluatorsResponse> {
     if (isRequestOptions(query)) {
-      return this.getEvaluators({}, query);
+      return this.listEvaluators({}, query);
     }
     return this._client.get('/v1/evaluation/evaluators', { query, ...options });
   }
 
-  /**
-   * Retrieve details of a specific evaluation job
-   */
-  getJob(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobResponse> {
-    return this._client.get(`/v1/evaluation/job/${jobId}`, options);
-  }
-
   /**
    * Retrieve paginated details of a specific evaluation job runs
    */
-  getJobRuns(
+  listJobRuns(
     jobId: string,
-    query?: EvaluationGetJobRunsParams,
+    query?: EvaluationListJobRunsParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<EvaluationGetJobRunsResponse>;
-  getJobRuns(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobRunsResponse>;
-  getJobRuns(
+  ): Core.APIPromise<EvaluationListJobRunsResponse>;
+  listJobRuns(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationListJobRunsResponse>;
+  listJobRuns(
     jobId: string,
-    query: EvaluationGetJobRunsParams | Core.RequestOptions = {},
+    query: EvaluationListJobRunsParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.APIPromise<EvaluationGetJobRunsResponse> {
+  ): Core.APIPromise<EvaluationListJobRunsResponse> {
     if (isRequestOptions(query)) {
-      return this.getJobRuns(jobId, {}, query);
+      return this.listJobRuns(jobId, {}, query);
     }
     return this._client.get(`/v1/evaluation/job/${jobId}/runs`, { query, ...options });
   }
@@ -545,22 +545,92 @@ export namespace EvaluationGetEvaluatorByIDResponse {
   }
 }
 
+export interface EvaluationGetJobResponse {
+  /**
+   * Evaluation job response payload
+   */
+  data: EvaluationGetJobResponse.Data;
+}
+
+export namespace EvaluationGetJobResponse {
+  /**
+   * Evaluation job response payload
+   */
+  export interface Data {
+    /**
+     * ID of the evaluation job
+     */
+    id: string;
+
+    /**
+     * Status of the evaluation job
+     */
+    status: 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+
+    /**
+     * Call being evaluated
+     */
+    call?: Data.Call;
+
+    /**
+     * Dataset being evaluated
+     */
+    dataset?: Data.Dataset;
+  }
+
+  export namespace Data {
+    /**
+     * Call being evaluated
+     */
+    export interface Call {
+      /**
+       * ID of the call being evaluated
+       */
+      id: string | null;
+    }
+
+    /**
+     * Dataset being evaluated
+     */
+    export interface Dataset {
+      /**
+       * ID of the dataset
+       */
+      id: string | null;
+
+      /**
+       * Calls in the dataset
+       */
+      calls: Array<Dataset.Call>;
+    }
+
+    export namespace Dataset {
+      export interface Call {
+        /**
+         * ID of the call
+         */
+        id: string | null;
+      }
+    }
+  }
+}
+
 /**
  * Response containing evaluators and pagination info
  */
-export interface EvaluationGetEvaluatorsResponse {
+export interface EvaluationListEvaluatorsResponse {
   /**
    * Array of evaluators with their blocks
    */
-  data: Array<EvaluationGetEvaluatorsResponse.Data>;
+  data: Array<EvaluationListEvaluatorsResponse.Data>;
 
   /**
    * Pagination information
    */
-  pagination: EvaluationGetEvaluatorsResponse.Pagination;
+  pagination: EvaluationListEvaluatorsResponse.Pagination;
 }
 
-export namespace EvaluationGetEvaluatorsResponse {
+export namespace EvaluationListEvaluatorsResponse {
   /**
    * Evaluator with its configured blocks
    */
@@ -1032,84 +1102,14 @@ export namespace EvaluationGetEvaluatorsResponse {
   }
 }
 
-export interface EvaluationGetJobResponse {
-  /**
-   * Evaluation job response payload
-   */
-  data: EvaluationGetJobResponse.Data;
-}
-
-export namespace EvaluationGetJobResponse {
-  /**
-   * Evaluation job response payload
-   */
-  export interface Data {
-    /**
-     * ID of the evaluation job
-     */
-    id: string;
-
-    /**
-     * Status of the evaluation job
-     */
-    status: 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILURE';
-
-    /**
-     * Call being evaluated
-     */
-    call?: Data.Call;
-
-    /**
-     * Dataset being evaluated
-     */
-    dataset?: Data.Dataset;
-  }
-
-  export namespace Data {
-    /**
-     * Call being evaluated
-     */
-    export interface Call {
-      /**
-       * ID of the call being evaluated
-       */
-      id: string | null;
-    }
-
-    /**
-     * Dataset being evaluated
-     */
-    export interface Dataset {
-      /**
-       * ID of the dataset
-       */
-      id: string | null;
-
-      /**
-       * Calls in the dataset
-       */
-      calls: Array<Dataset.Call>;
-    }
-
-    export namespace Dataset {
-      export interface Call {
-        /**
-         * ID of the call
-         */
-        id: string | null;
-      }
-    }
-  }
-}
-
-export interface EvaluationGetJobRunsResponse {
+export interface EvaluationListJobRunsResponse {
   /**
    * Evaluation job runs response payload
    */
-  data: EvaluationGetJobRunsResponse.Data;
+  data: EvaluationListJobRunsResponse.Data;
 }
 
-export namespace EvaluationGetJobRunsResponse {
+export namespace EvaluationListJobRunsResponse {
   /**
    * Evaluation job runs response payload
    */
@@ -1339,6 +1339,11 @@ export interface EvaluationCreateJobParams {
    */
   call?: EvaluationCreateJobParams.Call;
 
+  /**
+   * ID of an existing call to evaluate
+   */
+  callId?: string;
+
   dataset?: EvaluationCreateJobParams.Dataset;
 }
 
@@ -1437,7 +1442,7 @@ export namespace EvaluationCreateJobParams {
 
   export namespace Call {
     export interface Participant {
-      role: 'AGENT' | 'CUSTOMER';
+      role: 'AGENT' | 'CUSTOMER' | 'SIMULATED_CUSTOMER' | 'BACKGROUND_SPEAKER';
 
       isSimulated?: boolean;
 
@@ -1598,7 +1603,7 @@ export namespace EvaluationCreateJobParams {
 
     export namespace Call {
       export interface Participant {
-        role: 'AGENT' | 'CUSTOMER';
+        role: 'AGENT' | 'CUSTOMER' | 'SIMULATED_CUSTOMER' | 'BACKGROUND_SPEAKER';
 
         isSimulated?: boolean;
 
@@ -1657,7 +1662,7 @@ export namespace EvaluationCreateJobParams {
   }
 }
 
-export interface EvaluationGetEvaluatorsParams {
+export interface EvaluationListEvaluatorsParams {
   /**
    * Cursor for pagination - evaluator ID to start after
    */
@@ -1669,7 +1674,7 @@ export interface EvaluationGetEvaluatorsParams {
   limit?: string;
 }
 
-export interface EvaluationGetJobRunsParams {
+export interface EvaluationListJobRunsParams {
   /**
    * Number of items to return per page
    */
@@ -1685,11 +1690,11 @@ export declare namespace Evaluation {
   export {
     type EvaluationCreateJobResponse as EvaluationCreateJobResponse,
     type EvaluationGetEvaluatorByIDResponse as EvaluationGetEvaluatorByIDResponse,
-    type EvaluationGetEvaluatorsResponse as EvaluationGetEvaluatorsResponse,
     type EvaluationGetJobResponse as EvaluationGetJobResponse,
-    type EvaluationGetJobRunsResponse as EvaluationGetJobRunsResponse,
+    type EvaluationListEvaluatorsResponse as EvaluationListEvaluatorsResponse,
+    type EvaluationListJobRunsResponse as EvaluationListJobRunsResponse,
     type EvaluationCreateJobParams as EvaluationCreateJobParams,
-    type EvaluationGetEvaluatorsParams as EvaluationGetEvaluatorsParams,
-    type EvaluationGetJobRunsParams as EvaluationGetJobRunsParams,
+    type EvaluationListEvaluatorsParams as EvaluationListEvaluatorsParams,
+    type EvaluationListJobRunsParams as EvaluationListJobRunsParams,
   };
 }

package/src/resources/index.ts

@@ -2,22 +2,26 @@
 
 export {
   Call,
+  type CallCreateResponse,
+  type CallListResponse,
   type CallGetByIDResponse,
-  type CallGetEvaluationRunsResponse,
-  type CallGetMetricsResponse,
-  type CallGetSentimentRunsResponse,
-  type CallGetMetricsParams,
+  type CallListEvaluationRunsResponse,
+  type CallListMetricsResponse,
+  type CallListSentimentRunsResponse,
+  type CallCreateParams,
+  type CallListParams,
+  type CallListMetricsParams,
 } from './call';
 export {
   Evaluation,
   type EvaluationCreateJobResponse,
   type EvaluationGetEvaluatorByIDResponse,
-  type EvaluationGetEvaluatorsResponse,
   type EvaluationGetJobResponse,
-  type EvaluationGetJobRunsResponse,
+  type EvaluationListEvaluatorsResponse,
+  type EvaluationListJobRunsResponse,
   type EvaluationCreateJobParams,
-  type EvaluationGetEvaluatorsParams,
-  type EvaluationGetJobRunsParams,
+  type EvaluationListEvaluatorsParams,
+  type EvaluationListJobRunsParams,
 } from './evaluation';
 export { Health, type HealthGetResponse } from './health';
 export {
@@ -27,20 +31,22 @@ export {
   type IntegrationCreateRetellCallParams,
   type IntegrationCreateVapiCallParams,
 } from './integrations';
-export { Metric, type MetricGetDefinitionsResponse } from './metric';
+export { Metric, type MetricListDefinitionsResponse } from './metric';
 export {
   Persona,
   type PersonaCreateResponse,
   type PersonaUpdateResponse,
-  type PersonaFindAllResponse,
+  type PersonaListResponse,
   type PersonaGetByIDResponse,
   type PersonaCreateParams,
   type PersonaUpdateParams,
-  type PersonaFindAllParams,
+  type PersonaListParams,
 } from './persona';
 export {
   Simulation,
-  type SimulationGetJobByIDResponse,
-  type SimulationLookupJobResponse,
-  type SimulationLookupJobParams,
+  type SimulationGetRunPlanJobResponse,
+  type SimulationGetSimulationJobByIDResponse,
+  type SimulationLookupSimulationJobResponse,
+  type SimulationStartRunPlanJobResponse,
+  type SimulationLookupSimulationJobParams,
 } from './simulation';

package/src/resources/metric.ts

@@ -9,19 +9,19 @@ export class Metric extends APIResource {
    * system-generated and custom metrics. Only returns metrics from enabled analysis
    * packages.
    */
-  getDefinitions(options?: Core.RequestOptions): Core.APIPromise<MetricGetDefinitionsResponse> {
+  listDefinitions(options?: Core.RequestOptions): Core.APIPromise<MetricListDefinitionsResponse> {
     return this._client.get('/v1/metric/definitions', options);
   }
 }
 
-export interface MetricGetDefinitionsResponse {
+export interface MetricListDefinitionsResponse {
   /**
    * Metrics response payload
    */
-  data: Array<MetricGetDefinitionsResponse.Data>;
+  data: Array<MetricListDefinitionsResponse.Data>;
 }
 
-export namespace MetricGetDefinitionsResponse {
+export namespace MetricListDefinitionsResponse {
   /**
    * Metric definition data
    */
@@ -86,5 +86,5 @@ export namespace MetricGetDefinitionsResponse {
 }
 
 export declare namespace Metric {
-  export { type MetricGetDefinitionsResponse as MetricGetDefinitionsResponse };
+  export { type MetricListDefinitionsResponse as MetricListDefinitionsResponse };
 }

package/src/resources/persona.ts

@@ -52,20 +52,17 @@ export class Persona extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.persona.findAll();
+   * const personas = await client.persona.list();
    * ```
    */
-  findAll(
-    query?: PersonaFindAllParams,
+  list(query?: PersonaListParams, options?: Core.RequestOptions): Core.APIPromise<PersonaListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<PersonaListResponse>;
+  list(
+    query: PersonaListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.APIPromise<PersonaFindAllResponse>;
-  findAll(options?: Core.RequestOptions): Core.APIPromise<PersonaFindAllResponse>;
-  findAll(
-    query: PersonaFindAllParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PersonaFindAllResponse> {
+  ): Core.APIPromise<PersonaListResponse> {
     if (isRequestOptions(query)) {
-      return this.findAll({}, query);
+      return this.list({}, query);
     }
     return this._client.get('/v1/persona', { query, ...options });
   }
@@ -98,7 +95,21 @@ export namespace PersonaCreateResponse {
      * 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
@@ -146,7 +157,7 @@ export namespace PersonaCreateResponse {
     /**
      * 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
@@ -205,7 +216,21 @@ export namespace PersonaUpdateResponse {
      * 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
@@ -253,7 +278,7 @@ export namespace PersonaUpdateResponse {
     /**
      * 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
@@ -297,13 +322,13 @@ export namespace PersonaUpdateResponse {
   }
 }
 
-export interface PersonaFindAllResponse {
-  data: Array<PersonaFindAllResponse.Data>;
+export interface PersonaListResponse {
+  data: Array<PersonaListResponse.Data>;
 
-  pagination: PersonaFindAllResponse.Pagination;
+  pagination: PersonaListResponse.Pagination;
 }
 
-export namespace PersonaFindAllResponse {
+export namespace PersonaListResponse {
   export interface Data {
     /**
      * Unique identifier of the persona
@@ -314,7 +339,21 @@ export namespace PersonaFindAllResponse {
      * 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
@@ -362,7 +401,7 @@ export namespace PersonaFindAllResponse {
     /**
      * 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
@@ -438,7 +477,21 @@ export namespace PersonaGetByIDResponse {
      * 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
@@ -486,7 +539,7 @@ export namespace PersonaGetByIDResponse {
     /**
      * 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
@@ -535,7 +588,21 @@ export interface PersonaCreateParams {
    * 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';
 
   /**
    * Gender of the persona
@@ -545,7 +612,7 @@ export interface PersonaCreateParams {
   /**
    * 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';
 
   /**
    * The name the agent will identify as during conversations
@@ -621,7 +688,21 @@ export interface PersonaUpdateParams {
    * 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
@@ -669,7 +750,7 @@ export interface PersonaUpdateParams {
   /**
    * 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
@@ -702,7 +783,7 @@ export interface PersonaUpdateParams {
   speechPace?: 'SLOW' | 'NORMAL' | 'FAST';
 }
 
-export interface PersonaFindAllParams {
+export interface PersonaListParams {
   after?: string;
 
   limit?: number;
@@ -714,10 +795,10 @@ export declare namespace Persona {
   export {
     type PersonaCreateResponse as PersonaCreateResponse,
     type PersonaUpdateResponse as PersonaUpdateResponse,
-    type PersonaFindAllResponse as PersonaFindAllResponse,
+    type PersonaListResponse as PersonaListResponse,
     type PersonaGetByIDResponse as PersonaGetByIDResponse,
     type PersonaCreateParams as PersonaCreateParams,
     type PersonaUpdateParams as PersonaUpdateParams,
-    type PersonaFindAllParams as PersonaFindAllParams,
+    type PersonaListParams as PersonaListParams,
   };
 }