@roarkanalytics/sdk 2.26.0 → 2.27.0

package/src/client.ts

@@ -11,7 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
-import * as qs from './internal/qs';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
@@ -337,8 +337,8 @@ export class Roark {
     return buildHeaders([{ Authorization: `Bearer ${this.bearerToken}` }]);
   }
 
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'comma' });
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -370,12 +370,13 @@ export class Roark {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -680,9 +681,9 @@ export class Roark {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -814,7 +815,7 @@ export class Roark {
     ) {
       return {
         bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
-        body: this.stringifyQuery(body as Record<string, unknown>),
+        body: this.stringifyQuery(body),
       };
     } else {
       return this.#encoder({ body, headers });

package/src/internal/utils/query.ts

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as qs from '../qs/stringify';
+
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return qs.stringify(query, { arrayFormat: 'comma' });
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/call.ts

@@ -217,6 +217,11 @@ export namespace CallListResponse {
       | 'UNKNOWN'
       | null;
 
+    /**
+     * IDs of metric policies that have been applied to this call
+     */
+    policyIds?: Array<string> | null;
+
     /**
      * Custom properties associated with the call
      */
@@ -382,6 +387,11 @@ export namespace CallGetByIDResponse {
       | 'UNKNOWN'
       | null;
 
+    /**
+     * IDs of metric policies that have been applied to this call
+     */
+    policyIds?: Array<string> | null;
+
     /**
      * Custom properties associated with the call
      */
@@ -850,6 +860,11 @@ export namespace CallListMetricsResponse {
        */
       participantRole?: 'agent' | 'customer';
 
+      /**
+       * IDs of metric policies that triggered this metric computation
+       */
+      policyIds?: Array<string>;
+
       /**
        * Segment information (for SEGMENT context metrics)
        */
@@ -1550,8 +1565,14 @@ export namespace CallCreateParams {
      * the agents array this tool invocation belongs to
      */
     export interface Agent {
+      /**
+       * The custom ID set on the agent
+       */
       customId?: string;
 
+      /**
+       * The Roark ID of the agent
+       */
       roarkId?: string;
     }
   }
@@ -1565,15 +1586,29 @@ export namespace CallCreateParams {
 
     text: string;
 
+    /**
+     * Metadata about the agent that spoke this turn - used to match which agent from
+     * the `agents` array this transcript entry belongs to
+     */
     agent?: TranscriptEntryAgent.Agent;
 
     languageCode?: string;
   }
 
   export namespace TranscriptEntryAgent {
+    /**
+     * Metadata about the agent that spoke this turn - used to match which agent from
+     * the `agents` array this transcript entry belongs to
+     */
     export interface Agent {
+      /**
+       * The custom ID set on the agent
+       */
       customId?: string;
 
+      /**
+       * The Roark ID of the agent
+       */
       roarkId?: string;
     }
   }

package/src/resources/metric-collection-job.ts

@@ -77,6 +77,11 @@ export namespace MetricCollectionJobCreateResponse {
      */
     failedItems: number;
 
+    /**
+     * IDs of the metric policies that triggered this job
+     */
+    policyIds: Array<string>;
+
     /**
      * When the job started processing
      */
@@ -148,6 +153,11 @@ export namespace MetricCollectionJobListResponse {
      */
     failedItems: number;
 
+    /**
+     * IDs of the metric policies that triggered this job
+     */
+    policyIds: Array<string>;
+
     /**
      * When the job started processing
      */
@@ -234,6 +244,11 @@ export namespace MetricCollectionJobGetByIDResponse {
      */
     failedItems: number;
 
+    /**
+     * IDs of the metric policies that triggered this job
+     */
+    policyIds: Array<string>;
+
     /**
      * When the job started processing
      */

package/src/resources/metric-policy.ts

@@ -169,7 +169,7 @@ export namespace MetricPolicyCreateResponse {
          * Type of condition: AGENT (match by agent ID), CALL_SOURCE (match by source e.g.
          * VAPI, RETELL), CALL_PROPERTY (match by call property key/value)
          */
-        conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY';
+        conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY' | 'INTEGRATION';
 
         /**
          * Value to compare against. Required for CALL_PROPERTY conditions.
@@ -268,7 +268,7 @@ export namespace MetricPolicyUpdateResponse {
          * Type of condition: AGENT (match by agent ID), CALL_SOURCE (match by source e.g.
          * VAPI, RETELL), CALL_PROPERTY (match by call property key/value)
          */
-        conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY';
+        conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY' | 'INTEGRATION';
 
         /**
          * Value to compare against. Required for CALL_PROPERTY conditions.
@@ -369,7 +369,7 @@ export namespace MetricPolicyListResponse {
          * Type of condition: AGENT (match by agent ID), CALL_SOURCE (match by source e.g.
          * VAPI, RETELL), CALL_PROPERTY (match by call property key/value)
          */
-        conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY';
+        conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY' | 'INTEGRATION';
 
         /**
          * Value to compare against. Required for CALL_PROPERTY conditions.
@@ -498,7 +498,7 @@ export namespace MetricPolicyGetByIDResponse {
          * Type of condition: AGENT (match by agent ID), CALL_SOURCE (match by source e.g.
          * VAPI, RETELL), CALL_PROPERTY (match by call property key/value)
          */
-        conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY';
+        conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY' | 'INTEGRATION';
 
         /**
          * Value to compare against. Required for CALL_PROPERTY conditions.
@@ -556,7 +556,7 @@ export namespace MetricPolicyCreateParams {
        * Type of condition: AGENT (match by agent ID), CALL_SOURCE (match by source e.g.
        * VAPI, RETELL), CALL_PROPERTY (match by call property key/value)
        */
-      conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY';
+      conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY' | 'INTEGRATION';
 
       /**
        * Comparison operator. Required for CALL_PROPERTY conditions.
@@ -620,7 +620,7 @@ export namespace MetricPolicyUpdateParams {
        * Type of condition: AGENT (match by agent ID), CALL_SOURCE (match by source e.g.
        * VAPI, RETELL), CALL_PROPERTY (match by call property key/value)
        */
-      conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY';
+      conditionType: 'AGENT' | 'CALL_SOURCE' | 'CALL_PROPERTY' | 'INTEGRATION';
 
       /**
        * Comparison operator. Required for CALL_PROPERTY conditions.

package/src/resources/simulation-job.ts

@@ -158,7 +158,14 @@ export namespace SimulationJobGetByIDResponse {
         | 'IT'
         | 'ID'
         | 'TH'
-        | 'JP';
+        | 'JP'
+        | 'NZ'
+        | 'PH'
+        | 'SG'
+        | 'MY'
+        | 'HK'
+        | 'TR'
+        | 'PT';
 
       /**
        * Background noise setting
@@ -176,7 +183,7 @@ export namespace SimulationJobGetByIDResponse {
       /**
        * Base emotional state of the persona
        */
-      baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
+      baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
 
       /**
        * How the persona confirms information
@@ -226,7 +233,24 @@ export namespace SimulationJobGetByIDResponse {
       /**
        * Primary language ISO 639-1 code for the persona
        */
-      language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
+      language:
+        | 'EN'
+        | 'ES'
+        | 'DE'
+        | 'HI'
+        | 'FR'
+        | 'NL'
+        | 'AR'
+        | 'EL'
+        | 'IT'
+        | 'ID'
+        | 'TH'
+        | 'JA'
+        | 'TL'
+        | 'MS'
+        | 'ZH'
+        | 'TR'
+        | 'PT';
 
       /**
        * How reliable the persona's memory is
@@ -415,7 +439,14 @@ export namespace SimulationJobLookupResponse {
         | 'IT'
         | 'ID'
         | 'TH'
-        | 'JP';
+        | 'JP'
+        | 'NZ'
+        | 'PH'
+        | 'SG'
+        | 'MY'
+        | 'HK'
+        | 'TR'
+        | 'PT';
 
       /**
        * Background noise setting
@@ -433,7 +464,7 @@ export namespace SimulationJobLookupResponse {
       /**
        * Base emotional state of the persona
        */
-      baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
+      baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
 
       /**
        * How the persona confirms information
@@ -483,7 +514,24 @@ export namespace SimulationJobLookupResponse {
       /**
        * Primary language ISO 639-1 code for the persona
        */
-      language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
+      language:
+        | 'EN'
+        | 'ES'
+        | 'DE'
+        | 'HI'
+        | 'FR'
+        | 'NL'
+        | 'AR'
+        | 'EL'
+        | 'IT'
+        | 'ID'
+        | 'TH'
+        | 'JA'
+        | 'TL'
+        | 'MS'
+        | 'ZH'
+        | 'TR'
+        | 'PT';
 
       /**
        * How reliable the persona's memory is

package/src/resources/simulation-persona.ts

@@ -105,7 +105,14 @@ export namespace SimulationPersonaCreateResponse {
       | 'IT'
       | 'ID'
       | 'TH'
-      | 'JP';
+      | 'JP'
+      | 'NZ'
+      | 'PH'
+      | 'SG'
+      | 'MY'
+      | 'HK'
+      | 'TR'
+      | 'PT';
 
     /**
      * Background noise setting
@@ -123,7 +130,7 @@ export namespace SimulationPersonaCreateResponse {
     /**
      * Base emotional state of the persona
      */
-    baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
+    baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
 
     /**
      * How the persona confirms information
@@ -173,7 +180,24 @@ export namespace SimulationPersonaCreateResponse {
     /**
      * Primary language ISO 639-1 code for the persona
      */
-    language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
+    language:
+      | 'EN'
+      | 'ES'
+      | 'DE'
+      | 'HI'
+      | 'FR'
+      | 'NL'
+      | 'AR'
+      | 'EL'
+      | 'IT'
+      | 'ID'
+      | 'TH'
+      | 'JA'
+      | 'TL'
+      | 'MS'
+      | 'ZH'
+      | 'TR'
+      | 'PT';
 
     /**
      * How reliable the persona's memory is
@@ -258,7 +282,14 @@ export namespace SimulationPersonaUpdateResponse {
       | 'IT'
       | 'ID'
       | 'TH'
-      | 'JP';
+      | 'JP'
+      | 'NZ'
+      | 'PH'
+      | 'SG'
+      | 'MY'
+      | 'HK'
+      | 'TR'
+      | 'PT';
 
     /**
      * Background noise setting
@@ -276,7 +307,7 @@ export namespace SimulationPersonaUpdateResponse {
     /**
      * Base emotional state of the persona
      */
-    baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
+    baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
 
     /**
      * How the persona confirms information
@@ -326,7 +357,24 @@ export namespace SimulationPersonaUpdateResponse {
     /**
      * Primary language ISO 639-1 code for the persona
      */
-    language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
+    language:
+      | 'EN'
+      | 'ES'
+      | 'DE'
+      | 'HI'
+      | 'FR'
+      | 'NL'
+      | 'AR'
+      | 'EL'
+      | 'IT'
+      | 'ID'
+      | 'TH'
+      | 'JA'
+      | 'TL'
+      | 'MS'
+      | 'ZH'
+      | 'TR'
+      | 'PT';
 
     /**
      * How reliable the persona's memory is
@@ -413,7 +461,14 @@ export namespace SimulationPersonaListResponse {
       | 'IT'
       | 'ID'
       | 'TH'
-      | 'JP';
+      | 'JP'
+      | 'NZ'
+      | 'PH'
+      | 'SG'
+      | 'MY'
+      | 'HK'
+      | 'TR'
+      | 'PT';
 
     /**
      * Background noise setting
@@ -431,7 +486,7 @@ export namespace SimulationPersonaListResponse {
     /**
      * Base emotional state of the persona
      */
-    baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
+    baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
 
     /**
      * How the persona confirms information
@@ -481,7 +536,24 @@ export namespace SimulationPersonaListResponse {
     /**
      * Primary language ISO 639-1 code for the persona
      */
-    language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
+    language:
+      | 'EN'
+      | 'ES'
+      | 'DE'
+      | 'HI'
+      | 'FR'
+      | 'NL'
+      | 'AR'
+      | 'EL'
+      | 'IT'
+      | 'ID'
+      | 'TH'
+      | 'JA'
+      | 'TL'
+      | 'MS'
+      | 'ZH'
+      | 'TR'
+      | 'PT';
 
     /**
      * How reliable the persona's memory is
@@ -583,7 +655,14 @@ export namespace SimulationPersonaGetByIDResponse {
       | 'IT'
       | 'ID'
       | 'TH'
-      | 'JP';
+      | 'JP'
+      | 'NZ'
+      | 'PH'
+      | 'SG'
+      | 'MY'
+      | 'HK'
+      | 'TR'
+      | 'PT';
 
     /**
      * Background noise setting
@@ -601,7 +680,7 @@ export namespace SimulationPersonaGetByIDResponse {
     /**
      * Base emotional state of the persona
      */
-    baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
+    baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
 
     /**
      * How the persona confirms information
@@ -651,7 +730,24 @@ export namespace SimulationPersonaGetByIDResponse {
     /**
      * Primary language ISO 639-1 code for the persona
      */
-    language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
+    language:
+      | 'EN'
+      | 'ES'
+      | 'DE'
+      | 'HI'
+      | 'FR'
+      | 'NL'
+      | 'AR'
+      | 'EL'
+      | 'IT'
+      | 'ID'
+      | 'TH'
+      | 'JA'
+      | 'TL'
+      | 'MS'
+      | 'ZH'
+      | 'TR'
+      | 'PT';
 
     /**
      * How reliable the persona's memory is
@@ -726,7 +822,14 @@ export interface SimulationPersonaCreateParams {
     | 'IT'
     | 'ID'
     | 'TH'
-    | 'JP';
+    | 'JP'
+    | 'NZ'
+    | 'PH'
+    | 'SG'
+    | 'MY'
+    | 'HK'
+    | 'TR'
+    | 'PT';
 
   /**
    * Gender of the persona
@@ -736,7 +839,24 @@ export interface SimulationPersonaCreateParams {
   /**
    * Primary language ISO 639-1 code for the persona
    */
-  language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
+  language:
+    | 'EN'
+    | 'ES'
+    | 'DE'
+    | 'HI'
+    | 'FR'
+    | 'NL'
+    | 'AR'
+    | 'EL'
+    | 'IT'
+    | 'ID'
+    | 'TH'
+    | 'JA'
+    | 'TL'
+    | 'MS'
+    | 'ZH'
+    | 'TR'
+    | 'PT';
 
   /**
    * The name the agent will identify as during conversations
@@ -764,7 +884,7 @@ export interface SimulationPersonaCreateParams {
   /**
    * Base emotional state of the persona
    */
-  baseEmotion?: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
+  baseEmotion?: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
 
   /**
    * How the persona confirms information
@@ -858,7 +978,14 @@ export interface SimulationPersonaUpdateParams {
     | 'IT'
     | 'ID'
     | 'TH'
-    | 'JP';
+    | 'JP'
+    | 'NZ'
+    | 'PH'
+    | 'SG'
+    | 'MY'
+    | 'HK'
+    | 'TR'
+    | 'PT';
 
   /**
    * Background noise setting
@@ -881,7 +1008,7 @@ export interface SimulationPersonaUpdateParams {
   /**
    * Base emotional state of the persona
    */
-  baseEmotion?: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED';
+  baseEmotion?: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
 
   /**
    * How the persona confirms information
@@ -931,7 +1058,24 @@ export interface SimulationPersonaUpdateParams {
   /**
    * Primary language ISO 639-1 code for the persona
    */
-  language?: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
+  language?:
+    | 'EN'
+    | 'ES'
+    | 'DE'
+    | 'HI'
+    | 'FR'
+    | 'NL'
+    | 'AR'
+    | 'EL'
+    | 'IT'
+    | 'ID'
+    | 'TH'
+    | 'JA'
+    | 'TL'
+    | 'MS'
+    | 'ZH'
+    | 'TR'
+    | 'PT';
 
   /**
    * How reliable the persona's memory is