@roarkanalytics/sdk 2.31.0 → 2.33.0

package/src/resources/simulation-environment.ts

@@ -0,0 +1,147 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class SimulationEnvironment extends APIResource {
+  /**
+   * Returns a paginated list of environments: the project's own plus the
+   * environments Roark curates and shares across every project. Reference one by id
+   * when setting a customer flow variant's environment.
+   */
+  list(
+    query: SimulationEnvironmentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SimulationEnvironmentListResponse> {
+    return this._client.get('/v1/simulation/environment', { query, ...options });
+  }
+
+  /**
+   * Returns a single environment by its ID.
+   */
+  getByID(environmentID: string, options?: RequestOptions): APIPromise<SimulationEnvironmentGetByIDResponse> {
+    return this._client.get(path`/v1/simulation/environment/${environmentID}`, options);
+  }
+}
+
+/**
+ * Paginated list of environments: the project's own plus the shared Roark-curated
+ * ones
+ */
+export interface SimulationEnvironmentListResponse {
+  data: Array<SimulationEnvironmentListResponse.Data>;
+
+  pagination: SimulationEnvironmentListResponse.Pagination;
+}
+
+export namespace SimulationEnvironmentListResponse {
+  /**
+   * A simulation environment: the ambient conditions a customer flow variant runs
+   * under. The list includes both your own and the ones Roark curates for every
+   * project.
+   */
+  export interface Data {
+    id: string;
+
+    backgroundNoise:
+      | 'NONE'
+      | 'AIRPORT'
+      | 'CHILDREN_PLAYING'
+      | 'CITY'
+      | 'COFFEE_SHOP'
+      | 'DRIVING'
+      | 'OFFICE'
+      | 'THUNDERSTORM';
+
+    /**
+     * Creation timestamp in ISO 8601 format
+     */
+    createdAt: string;
+
+    name: string;
+
+    /**
+     * Last update timestamp in ISO 8601 format
+     */
+    updatedAt: string;
+
+    description?: string | null;
+  }
+
+  export 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 SimulationEnvironmentGetByIDResponse {
+  /**
+   * A simulation environment: the ambient conditions a customer flow variant runs
+   * under. The list includes both your own and the ones Roark curates for every
+   * project.
+   */
+  data: SimulationEnvironmentGetByIDResponse.Data;
+}
+
+export namespace SimulationEnvironmentGetByIDResponse {
+  /**
+   * A simulation environment: the ambient conditions a customer flow variant runs
+   * under. The list includes both your own and the ones Roark curates for every
+   * project.
+   */
+  export interface Data {
+    id: string;
+
+    backgroundNoise:
+      | 'NONE'
+      | 'AIRPORT'
+      | 'CHILDREN_PLAYING'
+      | 'CITY'
+      | 'COFFEE_SHOP'
+      | 'DRIVING'
+      | 'OFFICE'
+      | 'THUNDERSTORM';
+
+    /**
+     * Creation timestamp in ISO 8601 format
+     */
+    createdAt: string;
+
+    name: string;
+
+    /**
+     * Last update timestamp in ISO 8601 format
+     */
+    updatedAt: string;
+
+    description?: string | null;
+  }
+}
+
+export interface SimulationEnvironmentListParams {
+  after?: string;
+
+  limit?: number;
+}
+
+export declare namespace SimulationEnvironment {
+  export {
+    type SimulationEnvironmentListResponse as SimulationEnvironmentListResponse,
+    type SimulationEnvironmentGetByIDResponse as SimulationEnvironmentGetByIDResponse,
+    type SimulationEnvironmentListParams as SimulationEnvironmentListParams,
+  };
+}

package/src/resources/simulation-job.ts

@@ -69,6 +69,8 @@ export namespace SimulationJobGetByIDResponse {
      */
     processingStatus: string;
 
+    runPlan: Data.RunPlan;
+
     /**
      * Scenario used in a simulation
      */
@@ -130,7 +132,15 @@ export namespace SimulationJobGetByIDResponse {
       /**
        * Agent endpoint type
        */
-      type: 'PHONE' | 'WEBSOCKET' | 'LIVEKIT' | 'SMALL_WEBRTC' | 'ELEVENLABS_WS' | 'KORE' | 'GOOGLE_CES';
+      type:
+        | 'PHONE'
+        | 'WEBSOCKET'
+        | 'LIVEKIT'
+        | 'SMALL_WEBRTC'
+        | 'ELEVENLABS_WS'
+        | 'KORE'
+        | 'GOOGLE_CES'
+        | 'DAILY';
     }
 
     export interface Persona {
@@ -165,7 +175,8 @@ export namespace SimulationJobGetByIDResponse {
         | 'MY'
         | 'HK'
         | 'TR'
-        | 'PT';
+        | 'PT'
+        | 'IL';
 
       /**
        * Background noise setting
@@ -216,9 +227,10 @@ export namespace SimulationJobGetByIDResponse {
       idleMessageResetCountOnUserSpeechEnabled: boolean;
 
       /**
-       * Messages the persona will say when the agent goes silent during a call
+       * Messages the persona will say when the agent goes silent during a call. null =
+       * "Automatic": language-appropriate defaults are used at call time.
        */
-      idleMessages: Array<string>;
+      idleMessages: Array<string> | null;
 
       /**
        * Seconds of silence before the persona sends an idle message
@@ -250,7 +262,8 @@ export namespace SimulationJobGetByIDResponse {
         | 'MS'
         | 'ZH'
         | 'TR'
-        | 'PT';
+        | 'PT'
+        | 'HE';
 
       /**
        * How reliable the persona's memory is
@@ -283,6 +296,31 @@ export namespace SimulationJobGetByIDResponse {
        */
       speechPace: 'SUPER_SLOW' | 'SLOW' | 'NORMAL' | 'FAST' | 'SUPER_FAST';
 
+      /**
+       * Languages the persona can understand. Multilingual combinations are limited by
+       * multilingual speech recognition support.
+       */
+      understoodLanguages: Array<
+        | 'EN'
+        | 'ES'
+        | 'DE'
+        | 'HI'
+        | 'FR'
+        | 'NL'
+        | 'AR'
+        | 'EL'
+        | 'IT'
+        | 'ID'
+        | 'TH'
+        | 'JA'
+        | 'TL'
+        | 'MS'
+        | 'ZH'
+        | 'TR'
+        | 'PT'
+        | 'HE'
+      >;
+
       /**
        * Last update timestamp
        */
@@ -304,6 +342,24 @@ export namespace SimulationJobGetByIDResponse {
       secondaryLanguage?: 'EN' | null;
     }
 
+    export interface RunPlan {
+      /**
+       * Run plan ID
+       */
+      id: string;
+
+      /**
+       * Run plan name
+       */
+      name: string;
+
+      /**
+       * Run-plan-level variables resolved for this job, keyed by variable name. Values
+       * are stringified by their declared type.
+       */
+      variables: { [key: string]: string };
+    }
+
     /**
      * Scenario used in a simulation
      */
@@ -350,6 +406,8 @@ export namespace SimulationJobLookupResponse {
      */
     processingStatus: string;
 
+    runPlan: Data.RunPlan;
+
     /**
      * Scenario used in a simulation
      */
@@ -411,7 +469,15 @@ export namespace SimulationJobLookupResponse {
       /**
        * Agent endpoint type
        */
-      type: 'PHONE' | 'WEBSOCKET' | 'LIVEKIT' | 'SMALL_WEBRTC' | 'ELEVENLABS_WS' | 'KORE' | 'GOOGLE_CES';
+      type:
+        | 'PHONE'
+        | 'WEBSOCKET'
+        | 'LIVEKIT'
+        | 'SMALL_WEBRTC'
+        | 'ELEVENLABS_WS'
+        | 'KORE'
+        | 'GOOGLE_CES'
+        | 'DAILY';
     }
 
     export interface Persona {
@@ -446,7 +512,8 @@ export namespace SimulationJobLookupResponse {
         | 'MY'
         | 'HK'
         | 'TR'
-        | 'PT';
+        | 'PT'
+        | 'IL';
 
       /**
        * Background noise setting
@@ -497,9 +564,10 @@ export namespace SimulationJobLookupResponse {
       idleMessageResetCountOnUserSpeechEnabled: boolean;
 
       /**
-       * Messages the persona will say when the agent goes silent during a call
+       * Messages the persona will say when the agent goes silent during a call. null =
+       * "Automatic": language-appropriate defaults are used at call time.
        */
-      idleMessages: Array<string>;
+      idleMessages: Array<string> | null;
 
       /**
        * Seconds of silence before the persona sends an idle message
@@ -531,7 +599,8 @@ export namespace SimulationJobLookupResponse {
         | 'MS'
         | 'ZH'
         | 'TR'
-        | 'PT';
+        | 'PT'
+        | 'HE';
 
       /**
        * How reliable the persona's memory is
@@ -564,6 +633,31 @@ export namespace SimulationJobLookupResponse {
        */
       speechPace: 'SUPER_SLOW' | 'SLOW' | 'NORMAL' | 'FAST' | 'SUPER_FAST';
 
+      /**
+       * Languages the persona can understand. Multilingual combinations are limited by
+       * multilingual speech recognition support.
+       */
+      understoodLanguages: Array<
+        | 'EN'
+        | 'ES'
+        | 'DE'
+        | 'HI'
+        | 'FR'
+        | 'NL'
+        | 'AR'
+        | 'EL'
+        | 'IT'
+        | 'ID'
+        | 'TH'
+        | 'JA'
+        | 'TL'
+        | 'MS'
+        | 'ZH'
+        | 'TR'
+        | 'PT'
+        | 'HE'
+      >;
+
       /**
        * Last update timestamp
        */
@@ -585,6 +679,24 @@ export namespace SimulationJobLookupResponse {
       secondaryLanguage?: 'EN' | null;
     }
 
+    export interface RunPlan {
+      /**
+       * Run plan ID
+       */
+      id: string;
+
+      /**
+       * Run plan name
+       */
+      name: string;
+
+      /**
+       * Run-plan-level variables resolved for this job, keyed by variable name. Values
+       * are stringified by their declared type.
+       */
+      variables: { [key: string]: string };
+    }
+
     /**
      * Scenario used in a simulation
      */