@roarkanalytics/sdk 2.9.1 → 2.10.0

package/src/resources/persona.ts

@@ -12,17 +12,9 @@ export class Persona extends APIResource {
    * ```ts
    * const persona = await client.persona.create({
    *   accent: 'US',
-   *   backgroundNoise: 'NONE',
-   *   baseEmotion: 'NEUTRAL',
-   *   confirmationStyle: 'EXPLICIT',
    *   gender: 'MALE',
-   *   hasDisfluencies: false,
-   *   intentClarity: 'CLEAR',
    *   language: 'EN',
-   *   memoryReliability: 'HIGH',
-   *   name: 'Alex Morgan',
-   *   speechClarity: 'CLEAR',
-   *   speechPace: 'NORMAL',
+   *   name: 'name',
    * });
    * ```
    */
@@ -35,27 +27,23 @@ export class Persona extends APIResource {
    *
    * @example
    * ```ts
-   * const persona = await client.persona.update('personaId', {
-   *   accent: 'US',
-   *   backgroundNoise: 'NONE',
-   *   baseEmotion: 'NEUTRAL',
-   *   confirmationStyle: 'EXPLICIT',
-   *   gender: 'MALE',
-   *   hasDisfluencies: false,
-   *   intentClarity: 'CLEAR',
-   *   language: 'EN',
-   *   memoryReliability: 'HIGH',
-   *   name: 'Alex Morgan',
-   *   speechClarity: 'CLEAR',
-   *   speechPace: 'NORMAL',
-   * });
+   * const persona = await client.persona.update('personaId');
    * ```
    */
   update(
     personaId: string,
-    body: PersonaUpdateParams,
+    body?: PersonaUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PersonaUpdateResponse>;
+  update(personaId: string, options?: Core.RequestOptions): Core.APIPromise<PersonaUpdateResponse>;
+  update(
+    personaId: string,
+    body: PersonaUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<PersonaUpdateResponse> {
+    if (isRequestOptions(body)) {
+      return this.update(personaId, {}, body);
+    }
     return this._client.put(`/v1/persona/${personaId}`, { body, ...options });
   }
 
@@ -107,14 +95,23 @@ export namespace PersonaCreateResponse {
     id: string;
 
     /**
-     * Accent of the persona
+     * 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';
 
     /**
      * Background noise setting
      */
-    backgroundNoise: 'NONE' | 'OFFICE';
+    backgroundNoise:
+      | 'NONE'
+      | 'AIRPORT'
+      | 'CHILDREN_PLAYING'
+      | 'CITY'
+      | 'COFFEE_SHOP'
+      | 'DRIVING'
+      | 'OFFICE'
+      | 'THUNDERSTORM';
 
     /**
      * Base emotional state of the persona
@@ -147,7 +144,7 @@ export namespace PersonaCreateResponse {
     intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
     /**
-     * Primary language for the persona
+     * Primary language ISO 639-1 code for the persona
      */
     language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL';
 
@@ -161,6 +158,11 @@ export namespace PersonaCreateResponse {
      */
     name: string;
 
+    /**
+     * Additional custom properties about the persona
+     */
+    properties: { [key: string]: unknown };
+
     /**
      * Speech clarity of the persona
      */
@@ -182,12 +184,7 @@ export namespace PersonaCreateResponse {
     backstoryPrompt?: string | null;
 
     /**
-     * Additional custom properties about the persona
-     */
-    properties?: { [key: string]: unknown };
-
-    /**
-     * Secondary language for code-switching (e.g., Hinglish, Spanglish)
+     * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
      */
     secondaryLanguage?: 'EN' | null;
   }
@@ -205,14 +202,23 @@ export namespace PersonaUpdateResponse {
     id: string;
 
     /**
-     * Accent of the persona
+     * 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';
 
     /**
      * Background noise setting
      */
-    backgroundNoise: 'NONE' | 'OFFICE';
+    backgroundNoise:
+      | 'NONE'
+      | 'AIRPORT'
+      | 'CHILDREN_PLAYING'
+      | 'CITY'
+      | 'COFFEE_SHOP'
+      | 'DRIVING'
+      | 'OFFICE'
+      | 'THUNDERSTORM';
 
     /**
      * Base emotional state of the persona
@@ -245,7 +251,7 @@ export namespace PersonaUpdateResponse {
     intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
     /**
-     * Primary language for the persona
+     * Primary language ISO 639-1 code for the persona
      */
     language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL';
 
@@ -259,6 +265,11 @@ export namespace PersonaUpdateResponse {
      */
     name: string;
 
+    /**
+     * Additional custom properties about the persona
+     */
+    properties: { [key: string]: unknown };
+
     /**
      * Speech clarity of the persona
      */
@@ -280,12 +291,7 @@ export namespace PersonaUpdateResponse {
     backstoryPrompt?: string | null;
 
     /**
-     * Additional custom properties about the persona
-     */
-    properties?: { [key: string]: unknown };
-
-    /**
-     * Secondary language for code-switching (e.g., Hinglish, Spanglish)
+     * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
      */
     secondaryLanguage?: 'EN' | null;
   }
@@ -305,14 +311,23 @@ export namespace PersonaFindAllResponse {
     id: string;
 
     /**
-     * Accent of the persona
+     * 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';
 
     /**
      * Background noise setting
      */
-    backgroundNoise: 'NONE' | 'OFFICE';
+    backgroundNoise:
+      | 'NONE'
+      | 'AIRPORT'
+      | 'CHILDREN_PLAYING'
+      | 'CITY'
+      | 'COFFEE_SHOP'
+      | 'DRIVING'
+      | 'OFFICE'
+      | 'THUNDERSTORM';
 
     /**
      * Base emotional state of the persona
@@ -345,7 +360,7 @@ export namespace PersonaFindAllResponse {
     intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
     /**
-     * Primary language for the persona
+     * Primary language ISO 639-1 code for the persona
      */
     language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL';
 
@@ -359,6 +374,11 @@ export namespace PersonaFindAllResponse {
      */
     name: string;
 
+    /**
+     * Additional custom properties about the persona
+     */
+    properties: { [key: string]: unknown };
+
     /**
      * Speech clarity of the persona
      */
@@ -380,12 +400,7 @@ export namespace PersonaFindAllResponse {
     backstoryPrompt?: string | null;
 
     /**
-     * Additional custom properties about the persona
-     */
-    properties?: { [key: string]: unknown };
-
-    /**
-     * Secondary language for code-switching (e.g., Hinglish, Spanglish)
+     * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
      */
     secondaryLanguage?: 'EN' | null;
   }
@@ -420,14 +435,23 @@ export namespace PersonaGetByIDResponse {
     id: string;
 
     /**
-     * Accent of the persona
+     * 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';
 
     /**
      * Background noise setting
      */
-    backgroundNoise: 'NONE' | 'OFFICE';
+    backgroundNoise:
+      | 'NONE'
+      | 'AIRPORT'
+      | 'CHILDREN_PLAYING'
+      | 'CITY'
+      | 'COFFEE_SHOP'
+      | 'DRIVING'
+      | 'OFFICE'
+      | 'THUNDERSTORM';
 
     /**
      * Base emotional state of the persona
@@ -460,7 +484,7 @@ export namespace PersonaGetByIDResponse {
     intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
     /**
-     * Primary language for the persona
+     * Primary language ISO 639-1 code for the persona
      */
     language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL';
 
@@ -474,6 +498,11 @@ export namespace PersonaGetByIDResponse {
      */
     name: string;
 
+    /**
+     * Additional custom properties about the persona
+     */
+    properties: { [key: string]: unknown };
+
     /**
      * Speech clarity of the persona
      */
@@ -495,12 +524,7 @@ export namespace PersonaGetByIDResponse {
     backstoryPrompt?: string | null;
 
     /**
-     * Additional custom properties about the persona
-     */
-    properties?: { [key: string]: unknown };
-
-    /**
-     * Secondary language for code-switching (e.g., Hinglish, Spanglish)
+     * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
      */
     secondaryLanguage?: 'EN' | null;
   }
@@ -508,156 +532,174 @@ export namespace PersonaGetByIDResponse {
 
 export interface PersonaCreateParams {
   /**
-   * Accent of the persona
+   * 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';
 
   /**
-   * Background noise setting
+   * Gender of the persona
    */
-  backgroundNoise: 'NONE' | 'OFFICE';
+  gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
 
   /**
-   * Base emotional state of the persona
+   * Primary language ISO 639-1 code for the persona
    */
-  baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
+  language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL';
 
   /**
-   * How the persona confirms information
+   * The name the agent will identify as during conversations
    */
-  confirmationStyle: 'EXPLICIT' | 'VAGUE';
+  name: string;
 
   /**
-   * Gender of the persona
+   * Background noise setting
    */
-  gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
+  backgroundNoise?:
+    | 'NONE'
+    | 'AIRPORT'
+    | 'CHILDREN_PLAYING'
+    | 'CITY'
+    | 'COFFEE_SHOP'
+    | 'DRIVING'
+    | 'OFFICE'
+    | 'THUNDERSTORM';
 
   /**
-   * Whether the persona uses filler words like "um" and "uh"
+   * Background story and behavioral patterns for the persona
    */
-  hasDisfluencies: boolean;
+  backstoryPrompt?: string | null;
 
   /**
-   * How clearly the persona expresses their intentions
+   * Base emotional state of the persona
    */
-  intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
+  baseEmotion?: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
 
   /**
-   * Primary language for the persona
+   * How the persona confirms information
    */
-  language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL';
+  confirmationStyle?: 'EXPLICIT' | 'VAGUE';
 
   /**
-   * How reliable the persona's memory is
+   * Whether the persona uses filler words like "um" and "uh"
    */
-  memoryReliability: 'HIGH' | 'LOW';
+  hasDisfluencies?: boolean;
 
   /**
-   * The name the agent will identify as during conversations
+   * How clearly the persona expresses their intentions
    */
-  name: string;
+  intentClarity?: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
   /**
-   * Speech clarity of the persona
+   * How reliable the persona's memory is
    */
-  speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
+  memoryReliability?: 'HIGH' | 'LOW';
 
   /**
-   * Speech pace of the persona
+   * Additional custom properties about the persona
    */
-  speechPace: 'SLOW' | 'NORMAL' | 'FAST';
+  properties?: { [key: string]: unknown };
 
   /**
-   * Background story and behavioral patterns for the persona
+   * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
    */
-  backstoryPrompt?: string | null;
+  secondaryLanguage?: 'EN' | null;
 
   /**
-   * Additional custom properties about the persona
+   * Speech clarity of the persona
    */
-  properties?: { [key: string]: unknown };
+  speechClarity?: 'CLEAR' | 'VAGUE' | 'RAMBLING';
 
   /**
-   * Secondary language for code-switching (e.g., Hinglish, Spanglish)
+   * Speech pace of the persona
    */
-  secondaryLanguage?: 'EN' | null;
+  speechPace?: 'SLOW' | 'NORMAL' | 'FAST';
 }
 
 export interface PersonaUpdateParams {
   /**
-   * Accent of the persona
+   * 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';
+  accent?: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU';
 
   /**
    * Background noise setting
    */
-  backgroundNoise: 'NONE' | 'OFFICE';
+  backgroundNoise?:
+    | 'NONE'
+    | 'AIRPORT'
+    | 'CHILDREN_PLAYING'
+    | 'CITY'
+    | 'COFFEE_SHOP'
+    | 'DRIVING'
+    | 'OFFICE'
+    | 'THUNDERSTORM';
+
+  /**
+   * Background story and behavioral patterns for the persona
+   */
+  backstoryPrompt?: string | null;
 
   /**
    * Base emotional state of the persona
    */
-  baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
+  baseEmotion?: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
 
   /**
    * How the persona confirms information
    */
-  confirmationStyle: 'EXPLICIT' | 'VAGUE';
+  confirmationStyle?: 'EXPLICIT' | 'VAGUE';
 
   /**
    * Gender of the persona
    */
-  gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
+  gender?: 'MALE' | 'FEMALE' | 'NEUTRAL';
 
   /**
    * Whether the persona uses filler words like "um" and "uh"
    */
-  hasDisfluencies: boolean;
+  hasDisfluencies?: boolean;
 
   /**
    * How clearly the persona expresses their intentions
    */
-  intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
+  intentClarity?: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
   /**
-   * Primary language for the persona
+   * Primary language ISO 639-1 code for the persona
    */
-  language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL';
+  language?: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL';
 
   /**
    * How reliable the persona's memory is
    */
-  memoryReliability: 'HIGH' | 'LOW';
+  memoryReliability?: 'HIGH' | 'LOW';
 
   /**
    * The name the agent will identify as during conversations
    */
-  name: string;
+  name?: string;
 
   /**
-   * Speech clarity of the persona
-   */
-  speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
-
-  /**
-   * Speech pace of the persona
+   * Additional custom properties about the persona
    */
-  speechPace: 'SLOW' | 'NORMAL' | 'FAST';
+  properties?: { [key: string]: unknown };
 
   /**
-   * Background story and behavioral patterns for the persona
+   * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
    */
-  backstoryPrompt?: string | null;
+  secondaryLanguage?: 'EN' | null;
 
   /**
-   * Additional custom properties about the persona
+   * Speech clarity of the persona
    */
-  properties?: { [key: string]: unknown };
+  speechClarity?: 'CLEAR' | 'VAGUE' | 'RAMBLING';
 
   /**
-   * Secondary language for code-switching (e.g., Hinglish, Spanglish)
+   * Speech pace of the persona
    */
-  secondaryLanguage?: 'EN' | null;
+  speechPace?: 'SLOW' | 'NORMAL' | 'FAST';
 }
 
 export interface PersonaFindAllParams {