@roarkanalytics/sdk 2.33.2 → 3.0.0

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

@@ -12,6 +12,15 @@ export class CustomerFlowEdgeCase extends APIResource {
    * expectations. Omitted fields are left alone; `additionalExpectations` replaces
    * the set wholesale rather than appending. Promoting it to the happy path is a
    * separate call, since that also demotes the incumbent.
+   *
+   * @example
+   * ```ts
+   * const customerFlowEdgeCase =
+   *   await client.customerFlowEdgeCase.update(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { flowId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *   );
+   * ```
    */
   update(
     edgeCaseID: string,
@@ -30,6 +39,14 @@ export class CustomerFlowEdgeCase extends APIResource {
    * /v1/customer-flow/{flowId}/graph rather than here.
    *
    * Leave personaOverrideId or environmentId unset to inherit the happy path's.
+   *
+   * @example
+   * ```ts
+   * const response = await client.customerFlowEdgeCase.add(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { title: 'x' },
+   * );
+   * ```
    */
   add(
     flowID: string,
@@ -43,6 +60,14 @@ export class CustomerFlowEdgeCase extends APIResource {
    * Makes this edge case the flow's happy path, and the outgoing happy path an edge
    * case. Its persona and environment are baked into it first, so edge cases that
    * were inheriting keep the configuration they had.
+   *
+   * @example
+   * ```ts
+   * const response = await client.customerFlowEdgeCase.promote(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { flowId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   * );
+   * ```
    */
   promote(
     edgeCaseID: string,
@@ -57,6 +82,15 @@ export class CustomerFlowEdgeCase extends APIResource {
    * Soft-deletes a variant. On a scripted flow the path engine re-creates a variant
    * for any path still in the graph, so remove the path through PUT /graph instead
    * if that is what you meant.
+   *
+   * @example
+   * ```ts
+   * const customerFlowEdgeCase =
+   *   await client.customerFlowEdgeCase.remove(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { flowId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *   );
+   * ```
    */
   remove(
     edgeCaseID: string,
@@ -214,6 +248,12 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
         | '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
        */
@@ -512,6 +552,12 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
         | '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
        */
@@ -805,6 +851,12 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
         | '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
        */
@@ -1117,6 +1169,12 @@ export namespace CustomerFlowEdgeCaseAddResponse {
         | '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
        */
@@ -1415,6 +1473,12 @@ export namespace CustomerFlowEdgeCaseAddResponse {
         | '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
        */
@@ -1708,6 +1772,12 @@ export namespace CustomerFlowEdgeCaseAddResponse {
         | '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
        */
@@ -2020,6 +2090,12 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
         | '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
        */
@@ -2318,6 +2394,12 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
         | '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
        */
@@ -2611,6 +2693,12 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
         | '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
        */