@roarkanalytics/sdk 3.14.0 → 3.15.0

package/src/resources/customer-flow-edge-case.ts

@@ -472,6 +472,12 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
      */
     environment: ImprovFlowVariant.Environment | null;
 
+    /**
+     * The personas this brief hands the phone to, in order of first mention. Empty
+     * when the brief inherits the happy path's: read the happy path's list.
+     */
+    handoffPersonas: Array<ImprovFlowVariant.HandoffPersona>;
+
     isGenerated: boolean;
 
     /**
@@ -493,7 +499,9 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
     updatedAt: string;
 
     /**
-     * The brief the simulated customer improvises from.
+     * The brief the simulated customer improvises from. A `@{persona:<id>}` mention
+     * hands the phone to that persona mid-call; the sentences around the mention say
+     * when.
      */
     prompt?: string | null;
 
@@ -552,10 +560,7 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
       description?: string | null;
     }
 
-    /**
-     * The persona this runs as instead of the happy path's. Null means it inherits.
-     */
-    export interface PersonaOverride {
+    export interface HandoffPersona {
       /**
        * Unique identifier of the persona
        */
@@ -781,105 +786,6 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
        */
       secondaryLanguage?: 'EN' | null;
     }
-  }
-
-  /**
-   * One voicemail greeting.
-   */
-  export interface VoicemailFlowVariant {
-    id: string;
-
-    /**
-     * Graded on top of the flow's own expectations, for this variant only.
-     */
-    additionalExpectations: Array<VoicemailFlowVariant.AdditionalExpectation>;
-
-    /**
-     * Creation timestamp in ISO 8601 format
-     */
-    createdAt: string;
-
-    /**
-     * 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.
-     */
-    environment: VoicemailFlowVariant.Environment | null;
-
-    isGenerated: boolean;
-
-    /**
-     * The persona this runs as instead of the happy path's. Null means it inherits.
-     */
-    personaOverride: VoicemailFlowVariant.PersonaOverride | null;
-
-    precededByCustomerFlowId: string | null;
-
-    precededByCustomerFlowVariantId: string | null;
-
-    title: string;
-
-    type: 'VOICEMAIL';
-
-    /**
-     * Last update timestamp in ISO 8601 format
-     */
-    updatedAt: string;
-
-    systemKey?: string | null;
-  }
-
-  export namespace VoicemailFlowVariant {
-    /**
-     * One thing the agent under test is graded against.
-     */
-    export interface AdditionalExpectation {
-      id: string;
-
-      /**
-       * What the agent under test is graded against.
-       */
-      prompt: string;
-    }
-
-    /**
-     * 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 Environment {
-      id: string;
-
-      backgroundNoise:
-        | 'NONE'
-        | 'AIRPORT'
-        | 'CHILDREN_PLAYING'
-        | 'CITY'
-        | 'COFFEE_SHOP'
-        | 'CONSTRUCTION'
-        | 'CRYING_BABY'
-        | 'DRIVING'
-        | 'LIBRARY'
-        | 'OFFICE'
-        | 'THUNDERSTORM'
-        | 'TRAIN';
-
-      backgroundNoiseVolume: number;
-
-      /**
-       * Creation timestamp in ISO 8601 format
-       */
-      createdAt: string;
-
-      name: string;
-
-      /**
-       * Last update timestamp in ISO 8601 format
-       */
-      updatedAt: string;
-
-      description?: string | null;
-    }
 
     /**
      * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -1111,30 +1017,17 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
       secondaryLanguage?: 'EN' | null;
     }
   }
-}
-
-export interface CustomerFlowEdgeCaseAddResponse {
-  /**
-   * One way of running a customer flow.
-   */
-  data:
-    | CustomerFlowEdgeCaseAddResponse.ScriptedFlowVariant
-    | CustomerFlowEdgeCaseAddResponse.ImprovFlowVariant
-    | CustomerFlowEdgeCaseAddResponse.VoicemailFlowVariant;
-}
 
-export namespace CustomerFlowEdgeCaseAddResponse {
   /**
-   * One path through a scripted flow. The path engine owns which paths exist, so
-   * editing the graph is what creates and removes these.
+   * One voicemail greeting.
    */
-  export interface ScriptedFlowVariant {
+  export interface VoicemailFlowVariant {
     id: string;
 
     /**
      * Graded on top of the flow's own expectations, for this variant only.
      */
-    additionalExpectations: Array<ScriptedFlowVariant.AdditionalExpectation>;
+    additionalExpectations: Array<VoicemailFlowVariant.AdditionalExpectation>;
 
     /**
      * Creation timestamp in ISO 8601 format
@@ -1146,28 +1039,22 @@ export namespace CustomerFlowEdgeCaseAddResponse {
      * under. The list includes both your own and the ones Roark curates for every
      * project.
      */
-    environment: ScriptedFlowVariant.Environment | null;
+    environment: VoicemailFlowVariant.Environment | null;
 
     isGenerated: boolean;
 
     /**
      * The persona this runs as instead of the happy path's. Null means it inherits.
      */
-    personaOverride: ScriptedFlowVariant.PersonaOverride | null;
+    personaOverride: VoicemailFlowVariant.PersonaOverride | null;
 
     precededByCustomerFlowId: string | null;
 
     precededByCustomerFlowVariantId: string | null;
 
-    /**
-     * The one path through the graph this variant runs, in order. Linear by
-     * construction, so these steps never nest.
-     */
-    steps: Array<CustomerFlowAPI.FlowStep>;
-
     title: string;
 
-    type: 'SCRIPTED';
+    type: 'VOICEMAIL';
 
     /**
      * Last update timestamp in ISO 8601 format
@@ -1177,7 +1064,7 @@ export namespace CustomerFlowEdgeCaseAddResponse {
     systemKey?: string | null;
   }
 
-  export namespace ScriptedFlowVariant {
+  export namespace VoicemailFlowVariant {
     /**
      * One thing the agent under test is graded against.
      */
@@ -1459,17 +1346,30 @@ export namespace CustomerFlowEdgeCaseAddResponse {
       secondaryLanguage?: 'EN' | null;
     }
   }
+}
 
+export interface CustomerFlowEdgeCaseAddResponse {
   /**
-   * One brief to run an improv flow with.
+   * One way of running a customer flow.
    */
-  export interface ImprovFlowVariant {
+  data:
+    | CustomerFlowEdgeCaseAddResponse.ScriptedFlowVariant
+    | CustomerFlowEdgeCaseAddResponse.ImprovFlowVariant
+    | CustomerFlowEdgeCaseAddResponse.VoicemailFlowVariant;
+}
+
+export namespace CustomerFlowEdgeCaseAddResponse {
+  /**
+   * One path through a scripted flow. The path engine owns which paths exist, so
+   * editing the graph is what creates and removes these.
+   */
+  export interface ScriptedFlowVariant {
     id: string;
 
     /**
      * Graded on top of the flow's own expectations, for this variant only.
      */
-    additionalExpectations: Array<ImprovFlowVariant.AdditionalExpectation>;
+    additionalExpectations: Array<ScriptedFlowVariant.AdditionalExpectation>;
 
     /**
      * Creation timestamp in ISO 8601 format
@@ -1481,37 +1381,38 @@ export namespace CustomerFlowEdgeCaseAddResponse {
      * under. The list includes both your own and the ones Roark curates for every
      * project.
      */
-    environment: ImprovFlowVariant.Environment | null;
+    environment: ScriptedFlowVariant.Environment | null;
 
     isGenerated: boolean;
 
     /**
      * The persona this runs as instead of the happy path's. Null means it inherits.
      */
-    personaOverride: ImprovFlowVariant.PersonaOverride | null;
+    personaOverride: ScriptedFlowVariant.PersonaOverride | null;
 
     precededByCustomerFlowId: string | null;
 
     precededByCustomerFlowVariantId: string | null;
 
+    /**
+     * The one path through the graph this variant runs, in order. Linear by
+     * construction, so these steps never nest.
+     */
+    steps: Array<CustomerFlowAPI.FlowStep>;
+
     title: string;
 
-    type: 'IMPROV';
+    type: 'SCRIPTED';
 
     /**
      * Last update timestamp in ISO 8601 format
      */
     updatedAt: string;
 
-    /**
-     * The brief the simulated customer improvises from.
-     */
-    prompt?: string | null;
-
     systemKey?: string | null;
   }
 
-  export namespace ImprovFlowVariant {
+  export namespace ScriptedFlowVariant {
     /**
      * One thing the agent under test is graded against.
      */
@@ -1795,15 +1696,15 @@ export namespace CustomerFlowEdgeCaseAddResponse {
   }
 
   /**
-   * One voicemail greeting.
+   * One brief to run an improv flow with.
    */
-  export interface VoicemailFlowVariant {
+  export interface ImprovFlowVariant {
     id: string;
 
     /**
      * Graded on top of the flow's own expectations, for this variant only.
      */
-    additionalExpectations: Array<VoicemailFlowVariant.AdditionalExpectation>;
+    additionalExpectations: Array<ImprovFlowVariant.AdditionalExpectation>;
 
     /**
      * Creation timestamp in ISO 8601 format
@@ -1815,14 +1716,20 @@ export namespace CustomerFlowEdgeCaseAddResponse {
      * under. The list includes both your own and the ones Roark curates for every
      * project.
      */
-    environment: VoicemailFlowVariant.Environment | null;
+    environment: ImprovFlowVariant.Environment | null;
+
+    /**
+     * The personas this brief hands the phone to, in order of first mention. Empty
+     * when the brief inherits the happy path's: read the happy path's list.
+     */
+    handoffPersonas: Array<ImprovFlowVariant.HandoffPersona>;
 
     isGenerated: boolean;
 
     /**
      * The persona this runs as instead of the happy path's. Null means it inherits.
      */
-    personaOverride: VoicemailFlowVariant.PersonaOverride | null;
+    personaOverride: ImprovFlowVariant.PersonaOverride | null;
 
     precededByCustomerFlowId: string | null;
 
@@ -1830,17 +1737,24 @@ export namespace CustomerFlowEdgeCaseAddResponse {
 
     title: string;
 
-    type: 'VOICEMAIL';
+    type: 'IMPROV';
 
     /**
      * Last update timestamp in ISO 8601 format
      */
     updatedAt: string;
 
+    /**
+     * The brief the simulated customer improvises from. A `@{persona:<id>}` mention
+     * hands the phone to that persona mid-call; the sentences around the mention say
+     * when.
+     */
+    prompt?: string | null;
+
     systemKey?: string | null;
   }
 
-  export namespace VoicemailFlowVariant {
+  export namespace ImprovFlowVariant {
     /**
      * One thing the agent under test is graded against.
      */
@@ -1892,10 +1806,7 @@ export namespace CustomerFlowEdgeCaseAddResponse {
       description?: string | null;
     }
 
-    /**
-     * The persona this runs as instead of the happy path's. Null means it inherits.
-     */
-    export interface PersonaOverride {
+    export interface HandoffPersona {
       /**
        * Unique identifier of the persona
        */
@@ -2121,60 +2032,619 @@ export namespace CustomerFlowEdgeCaseAddResponse {
        */
       secondaryLanguage?: 'EN' | null;
     }
-  }
-}
-
-export interface CustomerFlowEdgeCasePromoteResponse {
-  /**
-   * One way of running a customer flow.
-   */
-  data:
-    | CustomerFlowEdgeCasePromoteResponse.ScriptedFlowVariant
-    | CustomerFlowEdgeCasePromoteResponse.ImprovFlowVariant
-    | CustomerFlowEdgeCasePromoteResponse.VoicemailFlowVariant;
-}
-
-export namespace CustomerFlowEdgeCasePromoteResponse {
-  /**
-   * One path through a scripted flow. The path engine owns which paths exist, so
-   * editing the graph is what creates and removes these.
-   */
-  export interface ScriptedFlowVariant {
-    id: string;
-
-    /**
-     * Graded on top of the flow's own expectations, for this variant only.
-     */
-    additionalExpectations: Array<ScriptedFlowVariant.AdditionalExpectation>;
-
-    /**
-     * Creation timestamp in ISO 8601 format
-     */
-    createdAt: string;
-
-    /**
-     * 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.
-     */
-    environment: ScriptedFlowVariant.Environment | null;
-
-    isGenerated: boolean;
 
     /**
      * The persona this runs as instead of the happy path's. Null means it inherits.
      */
-    personaOverride: ScriptedFlowVariant.PersonaOverride | null;
-
-    precededByCustomerFlowId: string | null;
-
-    precededByCustomerFlowVariantId: string | null;
-
-    /**
-     * The one path through the graph this variant runs, in order. Linear by
-     * construction, so these steps never nest.
-     */
-    steps: Array<CustomerFlowAPI.FlowStep>;
+    export interface PersonaOverride {
+      /**
+       * 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'
+        | 'NZ'
+        | 'PH'
+        | 'SG'
+        | 'MY'
+        | 'HK'
+        | 'TR'
+        | 'PT'
+        | 'IL';
+
+      /**
+       * How old the caller sounds and behaves. Only ages the persona's accent has a
+       * voice for are accepted; defaults to ADULT, which every accent supports.
+       */
+      age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
+      /**
+       * Background noise setting
+       */
+      backgroundNoise:
+        | 'NONE'
+        | 'AIRPORT'
+        | 'CHILDREN_PLAYING'
+        | 'CITY'
+        | 'COFFEE_SHOP'
+        | 'CONSTRUCTION'
+        | 'CRYING_BABY'
+        | 'DRIVING'
+        | 'LIBRARY'
+        | 'OFFICE'
+        | 'THUNDERSTORM'
+        | 'TRAIN';
+
+      /**
+       * Base emotional state of the persona
+       */
+      baseEmotion:
+        | 'NEUTRAL'
+        | 'CHEERFUL'
+        | 'CONFUSED'
+        | 'FRUSTRATED'
+        | 'SKEPTICAL'
+        | 'RUSHED'
+        | 'DISTRACTED'
+        | 'ANGRY'
+        | 'ANXIOUS'
+        | 'SAD';
+
+      /**
+       * How the persona confirms information
+       */
+      confirmationStyle: 'EXPLICIT' | 'VAGUE';
+
+      /**
+       * Creation timestamp
+       */
+      createdAt: string;
+
+      /**
+       * Gender of the persona
+       */
+      gender: 'MALE' | 'FEMALE';
+
+      /**
+       * Whether the persona uses filler words like "um" and "uh"
+       */
+      hasDisfluencies: boolean;
+
+      /**
+       * Maximum number of idle messages the persona will send before giving up
+       */
+      idleMessageMaxSpokenCount: number;
+
+      /**
+       * Whether the idle message counter resets when the agent speaks
+       */
+      idleMessageResetCountOnUserSpeechEnabled: boolean;
+
+      /**
+       * 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> | null;
+
+      /**
+       * Seconds of silence before the persona sends an idle message
+       */
+      idleTimeoutSeconds: number;
+
+      /**
+       * 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'
+        | 'TL'
+        | 'MS'
+        | 'ZH'
+        | 'TR'
+        | 'PT'
+        | 'HE';
+
+      /**
+       * 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: { [key: string]: unknown };
+
+      /**
+       * Controls how quickly the persona responds to pauses in conversation (QUICK,
+       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
+       * for several seconds.
+       */
+      responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
+
+      /**
+       * Speech clarity of the persona
+       */
+      speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
+
+      /**
+       * Speech pace of the persona
+       */
+      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
+       */
+      updatedAt: string;
+
+      /**
+       * Background story and behavioral patterns for the persona
+       */
+      backstoryPrompt?: string | null;
+
+      /**
+       * Human-readable description of the persona
+       */
+      description?: string | null;
+
+      /**
+       * Label shown in place of the name across the dashboard (e.g. a short descriptor
+       * like "Irate Escalator"). The persona still identifies as `name` on calls. Omit
+       * or set null to display the name itself.
+       */
+      displayName?: string | null;
+
+      /**
+       * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
+       */
+      secondaryLanguage?: 'EN' | null;
+    }
+  }
+
+  /**
+   * One voicemail greeting.
+   */
+  export interface VoicemailFlowVariant {
+    id: string;
+
+    /**
+     * Graded on top of the flow's own expectations, for this variant only.
+     */
+    additionalExpectations: Array<VoicemailFlowVariant.AdditionalExpectation>;
+
+    /**
+     * Creation timestamp in ISO 8601 format
+     */
+    createdAt: string;
+
+    /**
+     * 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.
+     */
+    environment: VoicemailFlowVariant.Environment | null;
+
+    isGenerated: boolean;
+
+    /**
+     * The persona this runs as instead of the happy path's. Null means it inherits.
+     */
+    personaOverride: VoicemailFlowVariant.PersonaOverride | null;
+
+    precededByCustomerFlowId: string | null;
+
+    precededByCustomerFlowVariantId: string | null;
+
+    title: string;
+
+    type: 'VOICEMAIL';
+
+    /**
+     * Last update timestamp in ISO 8601 format
+     */
+    updatedAt: string;
+
+    systemKey?: string | null;
+  }
+
+  export namespace VoicemailFlowVariant {
+    /**
+     * One thing the agent under test is graded against.
+     */
+    export interface AdditionalExpectation {
+      id: string;
+
+      /**
+       * What the agent under test is graded against.
+       */
+      prompt: string;
+    }
+
+    /**
+     * 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 Environment {
+      id: string;
+
+      backgroundNoise:
+        | 'NONE'
+        | 'AIRPORT'
+        | 'CHILDREN_PLAYING'
+        | 'CITY'
+        | 'COFFEE_SHOP'
+        | 'CONSTRUCTION'
+        | 'CRYING_BABY'
+        | 'DRIVING'
+        | 'LIBRARY'
+        | 'OFFICE'
+        | 'THUNDERSTORM'
+        | 'TRAIN';
+
+      backgroundNoiseVolume: number;
+
+      /**
+       * Creation timestamp in ISO 8601 format
+       */
+      createdAt: string;
+
+      name: string;
+
+      /**
+       * Last update timestamp in ISO 8601 format
+       */
+      updatedAt: string;
+
+      description?: string | null;
+    }
+
+    /**
+     * The persona this runs as instead of the happy path's. Null means it inherits.
+     */
+    export interface PersonaOverride {
+      /**
+       * 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'
+        | 'NZ'
+        | 'PH'
+        | 'SG'
+        | 'MY'
+        | 'HK'
+        | 'TR'
+        | 'PT'
+        | 'IL';
+
+      /**
+       * How old the caller sounds and behaves. Only ages the persona's accent has a
+       * voice for are accepted; defaults to ADULT, which every accent supports.
+       */
+      age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
+      /**
+       * Background noise setting
+       */
+      backgroundNoise:
+        | 'NONE'
+        | 'AIRPORT'
+        | 'CHILDREN_PLAYING'
+        | 'CITY'
+        | 'COFFEE_SHOP'
+        | 'CONSTRUCTION'
+        | 'CRYING_BABY'
+        | 'DRIVING'
+        | 'LIBRARY'
+        | 'OFFICE'
+        | 'THUNDERSTORM'
+        | 'TRAIN';
+
+      /**
+       * Base emotional state of the persona
+       */
+      baseEmotion:
+        | 'NEUTRAL'
+        | 'CHEERFUL'
+        | 'CONFUSED'
+        | 'FRUSTRATED'
+        | 'SKEPTICAL'
+        | 'RUSHED'
+        | 'DISTRACTED'
+        | 'ANGRY'
+        | 'ANXIOUS'
+        | 'SAD';
+
+      /**
+       * How the persona confirms information
+       */
+      confirmationStyle: 'EXPLICIT' | 'VAGUE';
+
+      /**
+       * Creation timestamp
+       */
+      createdAt: string;
+
+      /**
+       * Gender of the persona
+       */
+      gender: 'MALE' | 'FEMALE';
+
+      /**
+       * Whether the persona uses filler words like "um" and "uh"
+       */
+      hasDisfluencies: boolean;
+
+      /**
+       * Maximum number of idle messages the persona will send before giving up
+       */
+      idleMessageMaxSpokenCount: number;
+
+      /**
+       * Whether the idle message counter resets when the agent speaks
+       */
+      idleMessageResetCountOnUserSpeechEnabled: boolean;
+
+      /**
+       * 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> | null;
+
+      /**
+       * Seconds of silence before the persona sends an idle message
+       */
+      idleTimeoutSeconds: number;
+
+      /**
+       * 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'
+        | 'TL'
+        | 'MS'
+        | 'ZH'
+        | 'TR'
+        | 'PT'
+        | 'HE';
+
+      /**
+       * 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: { [key: string]: unknown };
+
+      /**
+       * Controls how quickly the persona responds to pauses in conversation (QUICK,
+       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
+       * for several seconds.
+       */
+      responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
+
+      /**
+       * Speech clarity of the persona
+       */
+      speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
+
+      /**
+       * Speech pace of the persona
+       */
+      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
+       */
+      updatedAt: string;
+
+      /**
+       * Background story and behavioral patterns for the persona
+       */
+      backstoryPrompt?: string | null;
+
+      /**
+       * Human-readable description of the persona
+       */
+      description?: string | null;
+
+      /**
+       * Label shown in place of the name across the dashboard (e.g. a short descriptor
+       * like "Irate Escalator"). The persona still identifies as `name` on calls. Omit
+       * or set null to display the name itself.
+       */
+      displayName?: string | null;
+
+      /**
+       * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
+       */
+      secondaryLanguage?: 'EN' | null;
+    }
+  }
+}
+
+export interface CustomerFlowEdgeCasePromoteResponse {
+  /**
+   * One way of running a customer flow.
+   */
+  data:
+    | CustomerFlowEdgeCasePromoteResponse.ScriptedFlowVariant
+    | CustomerFlowEdgeCasePromoteResponse.ImprovFlowVariant
+    | CustomerFlowEdgeCasePromoteResponse.VoicemailFlowVariant;
+}
+
+export namespace CustomerFlowEdgeCasePromoteResponse {
+  /**
+   * One path through a scripted flow. The path engine owns which paths exist, so
+   * editing the graph is what creates and removes these.
+   */
+  export interface ScriptedFlowVariant {
+    id: string;
+
+    /**
+     * Graded on top of the flow's own expectations, for this variant only.
+     */
+    additionalExpectations: Array<ScriptedFlowVariant.AdditionalExpectation>;
+
+    /**
+     * Creation timestamp in ISO 8601 format
+     */
+    createdAt: string;
+
+    /**
+     * 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.
+     */
+    environment: ScriptedFlowVariant.Environment | null;
+
+    isGenerated: boolean;
+
+    /**
+     * The persona this runs as instead of the happy path's. Null means it inherits.
+     */
+    personaOverride: ScriptedFlowVariant.PersonaOverride | null;
+
+    precededByCustomerFlowId: string | null;
+
+    precededByCustomerFlowVariantId: string | null;
+
+    /**
+     * The one path through the graph this variant runs, in order. Linear by
+     * construction, so these steps never nest.
+     */
+    steps: Array<CustomerFlowAPI.FlowStep>;
 
     title: string;
 
@@ -2494,6 +2964,12 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
      */
     environment: ImprovFlowVariant.Environment | null;
 
+    /**
+     * The personas this brief hands the phone to, in order of first mention. Empty
+     * when the brief inherits the happy path's: read the happy path's list.
+     */
+    handoffPersonas: Array<ImprovFlowVariant.HandoffPersona>;
+
     isGenerated: boolean;
 
     /**
@@ -2515,7 +2991,9 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
     updatedAt: string;
 
     /**
-     * The brief the simulated customer improvises from.
+     * The brief the simulated customer improvises from. A `@{persona:<id>}` mention
+     * hands the phone to that persona mid-call; the sentences around the mention say
+     * when.
      */
     prompt?: string | null;
 
@@ -2574,6 +3052,233 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
       description?: string | null;
     }
 
+    export interface HandoffPersona {
+      /**
+       * 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'
+        | 'NZ'
+        | 'PH'
+        | 'SG'
+        | 'MY'
+        | 'HK'
+        | 'TR'
+        | 'PT'
+        | 'IL';
+
+      /**
+       * How old the caller sounds and behaves. Only ages the persona's accent has a
+       * voice for are accepted; defaults to ADULT, which every accent supports.
+       */
+      age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
+      /**
+       * Background noise setting
+       */
+      backgroundNoise:
+        | 'NONE'
+        | 'AIRPORT'
+        | 'CHILDREN_PLAYING'
+        | 'CITY'
+        | 'COFFEE_SHOP'
+        | 'CONSTRUCTION'
+        | 'CRYING_BABY'
+        | 'DRIVING'
+        | 'LIBRARY'
+        | 'OFFICE'
+        | 'THUNDERSTORM'
+        | 'TRAIN';
+
+      /**
+       * Base emotional state of the persona
+       */
+      baseEmotion:
+        | 'NEUTRAL'
+        | 'CHEERFUL'
+        | 'CONFUSED'
+        | 'FRUSTRATED'
+        | 'SKEPTICAL'
+        | 'RUSHED'
+        | 'DISTRACTED'
+        | 'ANGRY'
+        | 'ANXIOUS'
+        | 'SAD';
+
+      /**
+       * How the persona confirms information
+       */
+      confirmationStyle: 'EXPLICIT' | 'VAGUE';
+
+      /**
+       * Creation timestamp
+       */
+      createdAt: string;
+
+      /**
+       * Gender of the persona
+       */
+      gender: 'MALE' | 'FEMALE';
+
+      /**
+       * Whether the persona uses filler words like "um" and "uh"
+       */
+      hasDisfluencies: boolean;
+
+      /**
+       * Maximum number of idle messages the persona will send before giving up
+       */
+      idleMessageMaxSpokenCount: number;
+
+      /**
+       * Whether the idle message counter resets when the agent speaks
+       */
+      idleMessageResetCountOnUserSpeechEnabled: boolean;
+
+      /**
+       * 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> | null;
+
+      /**
+       * Seconds of silence before the persona sends an idle message
+       */
+      idleTimeoutSeconds: number;
+
+      /**
+       * 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'
+        | 'TL'
+        | 'MS'
+        | 'ZH'
+        | 'TR'
+        | 'PT'
+        | 'HE';
+
+      /**
+       * 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: { [key: string]: unknown };
+
+      /**
+       * Controls how quickly the persona responds to pauses in conversation (QUICK,
+       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
+       * for several seconds.
+       */
+      responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
+
+      /**
+       * Speech clarity of the persona
+       */
+      speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
+
+      /**
+       * Speech pace of the persona
+       */
+      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
+       */
+      updatedAt: string;
+
+      /**
+       * Background story and behavioral patterns for the persona
+       */
+      backstoryPrompt?: string | null;
+
+      /**
+       * Human-readable description of the persona
+       */
+      description?: string | null;
+
+      /**
+       * Label shown in place of the name across the dashboard (e.g. a short descriptor
+       * like "Irate Escalator"). The persona still identifies as `name` on calls. Omit
+       * or set null to display the name itself.
+       */
+      displayName?: string | null;
+
+      /**
+       * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
+       */
+      secondaryLanguage?: 'EN' | null;
+    }
+
     /**
      * The persona this runs as instead of the happy path's. Null means it inherits.
      */