@roarkanalytics/sdk 2.4.1 → 2.6.0

package/src/internal/qs/utils.ts

@@ -0,0 +1,265 @@
+import { RFC1738 } from './formats';
+import type { DefaultEncoder, Format } from './types';
+
+const has = Object.prototype.hasOwnProperty;
+const is_array = Array.isArray;
+
+const hex_table = (() => {
+  const array = [];
+  for (let i = 0; i < 256; ++i) {
+    array.push('%' + ((i < 16 ? '0' : '') + i.toString(16)).toUpperCase());
+  }
+
+  return array;
+})();
+
+function compact_queue<T extends Record<string, any>>(queue: Array<{ obj: T; prop: string }>) {
+  while (queue.length > 1) {
+    const item = queue.pop();
+    if (!item) continue;
+
+    const obj = item.obj[item.prop];
+
+    if (is_array(obj)) {
+      const compacted: unknown[] = [];
+
+      for (let j = 0; j < obj.length; ++j) {
+        if (typeof obj[j] !== 'undefined') {
+          compacted.push(obj[j]);
+        }
+      }
+
+      // @ts-ignore
+      item.obj[item.prop] = compacted;
+    }
+  }
+}
+
+function array_to_object(source: any[], options: { plainObjects: boolean }) {
+  const obj = options && options.plainObjects ? Object.create(null) : {};
+  for (let i = 0; i < source.length; ++i) {
+    if (typeof source[i] !== 'undefined') {
+      obj[i] = source[i];
+    }
+  }
+
+  return obj;
+}
+
+export function merge(
+  target: any,
+  source: any,
+  options: { plainObjects?: boolean; allowPrototypes?: boolean } = {},
+) {
+  if (!source) {
+    return target;
+  }
+
+  if (typeof source !== 'object') {
+    if (is_array(target)) {
+      target.push(source);
+    } else if (target && typeof target === 'object') {
+      if (
+        (options && (options.plainObjects || options.allowPrototypes)) ||
+        !has.call(Object.prototype, source)
+      ) {
+        target[source] = true;
+      }
+    } else {
+      return [target, source];
+    }
+
+    return target;
+  }
+
+  if (!target || typeof target !== 'object') {
+    return [target].concat(source);
+  }
+
+  let mergeTarget = target;
+  if (is_array(target) && !is_array(source)) {
+    // @ts-ignore
+    mergeTarget = array_to_object(target, options);
+  }
+
+  if (is_array(target) && is_array(source)) {
+    source.forEach(function (item, i) {
+      if (has.call(target, i)) {
+        const targetItem = target[i];
+        if (targetItem && typeof targetItem === 'object' && item && typeof item === 'object') {
+          target[i] = merge(targetItem, item, options);
+        } else {
+          target.push(item);
+        }
+      } else {
+        target[i] = item;
+      }
+    });
+    return target;
+  }
+
+  return Object.keys(source).reduce(function (acc, key) {
+    const value = source[key];
+
+    if (has.call(acc, key)) {
+      acc[key] = merge(acc[key], value, options);
+    } else {
+      acc[key] = value;
+    }
+    return acc;
+  }, mergeTarget);
+}
+
+export function assign_single_source(target: any, source: any) {
+  return Object.keys(source).reduce(function (acc, key) {
+    acc[key] = source[key];
+    return acc;
+  }, target);
+}
+
+export function decode(str: string, _: any, charset: string) {
+  const strWithoutPlus = str.replace(/\+/g, ' ');
+  if (charset === 'iso-8859-1') {
+    // unescape never throws, no try...catch needed:
+    return strWithoutPlus.replace(/%[0-9a-f]{2}/gi, unescape);
+  }
+  // utf-8
+  try {
+    return decodeURIComponent(strWithoutPlus);
+  } catch (e) {
+    return strWithoutPlus;
+  }
+}
+
+const limit = 1024;
+
+export const encode: (
+  str: any,
+  defaultEncoder: DefaultEncoder,
+  charset: string,
+  type: 'key' | 'value',
+  format: Format,
+) => string = (str, _defaultEncoder, charset, _kind, format: Format) => {
+  // This code was originally written by Brian White for the io.js core querystring library.
+  // It has been adapted here for stricter adherence to RFC 3986
+  if (str.length === 0) {
+    return str;
+  }
+
+  let string = str;
+  if (typeof str === 'symbol') {
+    string = Symbol.prototype.toString.call(str);
+  } else if (typeof str !== 'string') {
+    string = String(str);
+  }
+
+  if (charset === 'iso-8859-1') {
+    return escape(string).replace(/%u[0-9a-f]{4}/gi, function ($0) {
+      return '%26%23' + parseInt($0.slice(2), 16) + '%3B';
+    });
+  }
+
+  let out = '';
+  for (let j = 0; j < string.length; j += limit) {
+    const segment = string.length >= limit ? string.slice(j, j + limit) : string;
+    const arr = [];
+
+    for (let i = 0; i < segment.length; ++i) {
+      let c = segment.charCodeAt(i);
+      if (
+        c === 0x2d || // -
+        c === 0x2e || // .
+        c === 0x5f || // _
+        c === 0x7e || // ~
+        (c >= 0x30 && c <= 0x39) || // 0-9
+        (c >= 0x41 && c <= 0x5a) || // a-z
+        (c >= 0x61 && c <= 0x7a) || // A-Z
+        (format === RFC1738 && (c === 0x28 || c === 0x29)) // ( )
+      ) {
+        arr[arr.length] = segment.charAt(i);
+        continue;
+      }
+
+      if (c < 0x80) {
+        arr[arr.length] = hex_table[c];
+        continue;
+      }
+
+      if (c < 0x800) {
+        arr[arr.length] = hex_table[0xc0 | (c >> 6)]! + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      if (c < 0xd800 || c >= 0xe000) {
+        arr[arr.length] =
+          hex_table[0xe0 | (c >> 12)]! + hex_table[0x80 | ((c >> 6) & 0x3f)] + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      i += 1;
+      c = 0x10000 + (((c & 0x3ff) << 10) | (segment.charCodeAt(i) & 0x3ff));
+
+      arr[arr.length] =
+        hex_table[0xf0 | (c >> 18)]! +
+        hex_table[0x80 | ((c >> 12) & 0x3f)] +
+        hex_table[0x80 | ((c >> 6) & 0x3f)] +
+        hex_table[0x80 | (c & 0x3f)];
+    }
+
+    out += arr.join('');
+  }
+
+  return out;
+};
+
+export function compact(value: any) {
+  const queue = [{ obj: { o: value }, prop: 'o' }];
+  const refs = [];
+
+  for (let i = 0; i < queue.length; ++i) {
+    const item = queue[i];
+    // @ts-ignore
+    const obj = item.obj[item.prop];
+
+    const keys = Object.keys(obj);
+    for (let j = 0; j < keys.length; ++j) {
+      const key = keys[j]!;
+      const val = obj[key];
+      if (typeof val === 'object' && val !== null && refs.indexOf(val) === -1) {
+        queue.push({ obj: obj, prop: key });
+        refs.push(val);
+      }
+    }
+  }
+
+  compact_queue(queue);
+
+  return value;
+}
+
+export function is_regexp(obj: any) {
+  return Object.prototype.toString.call(obj) === '[object RegExp]';
+}
+
+export function is_buffer(obj: any) {
+  if (!obj || typeof obj !== 'object') {
+    return false;
+  }
+
+  return !!(obj.constructor && obj.constructor.isBuffer && obj.constructor.isBuffer(obj));
+}
+
+export function combine(a: any, b: any) {
+  return [].concat(a, b);
+}
+
+export function maybe_map<T>(val: T[], fn: (v: T) => T) {
+  if (is_array(val)) {
+    const mapped = [];
+    for (let i = 0; i < val.length; i += 1) {
+      mapped.push(fn(val[i]!));
+    }
+    return mapped;
+  }
+  return fn(val);
+}

package/src/resources/index.ts

@@ -20,3 +20,9 @@ export {
   type IntegrationCreateRetellCallParams,
   type IntegrationCreateVapiCallParams,
 } from './integrations';
+export {
+  Simulation,
+  type SimulationGetJobByIDResponse,
+  type SimulationLookupJobResponse,
+  type SimulationLookupJobParams,
+} from './simulation';

package/src/resources/simulation.ts

@@ -0,0 +1,403 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+
+export class Simulation extends APIResource {
+  /**
+   * Find a simulation job directly by its ID
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulation.getJobById(
+   *   '7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f',
+   * );
+   * ```
+   */
+  getJobById(jobId: unknown, options?: Core.RequestOptions): Core.APIPromise<SimulationGetJobByIDResponse> {
+    return this._client.get(`/v1/simulation/job/${jobId}`, options);
+  }
+
+  /**
+   * Find a simulation job by looking up the active lease for the given phone numbers
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulation.lookupJob({
+   *   roarkPhoneNumber: {},
+   * });
+   * ```
+   */
+  lookupJob(
+    query: SimulationLookupJobParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SimulationLookupJobResponse> {
+    return this._client.get('/v1/simulation/job/lookup', { query, ...options });
+  }
+}
+
+export interface SimulationGetJobByIDResponse {
+  /**
+   * Simulation job with related entities
+   */
+  data: SimulationGetJobByIDResponse.Data;
+}
+
+export namespace SimulationGetJobByIDResponse {
+  /**
+   * Simulation job with related entities
+   */
+  export interface Data {
+    /**
+     * Agent endpoint used in the simulation
+     */
+    agentEndpoint: Data.AgentEndpoint;
+
+    /**
+     * When the job was created
+     */
+    createdAt: string;
+
+    /**
+     * Persona used in the simulation
+     */
+    persona: Data.Persona;
+
+    /**
+     * Processing status
+     */
+    processingStatus: string;
+
+    /**
+     * Scenario used in the simulation
+     */
+    scenario: Data.Scenario;
+
+    /**
+     * Simulation job ID
+     */
+    simulationJobId: string;
+
+    /**
+     * Job status
+     */
+    status: string;
+
+    /**
+     * When the job completed
+     */
+    completedAt?: string | null;
+
+    /**
+     * When the job started
+     */
+    startedAt?: string | null;
+  }
+
+  export namespace Data {
+    /**
+     * Agent endpoint used in the simulation
+     */
+    export interface AgentEndpoint {
+      /**
+       * Agent endpoint ID
+       */
+      id: string;
+
+      /**
+       * Agent endpoint type
+       */
+      endpointType: string;
+
+      /**
+       * Agent endpoint name
+       */
+      name: string;
+
+      /**
+       * Agent endpoint phone number
+       */
+      phoneNumber: string | null;
+    }
+
+    /**
+     * Persona used in the simulation
+     */
+    export interface Persona {
+      /**
+       * Persona ID
+       */
+      id: string;
+
+      /**
+       * Accent of the persona
+       */
+      accent: string;
+
+      /**
+       * Background noise setting
+       */
+      backgroundNoise: string;
+
+      /**
+       * Base emotion of the persona
+       */
+      baseEmotion: string;
+
+      /**
+       * How the persona confirms information
+       */
+      confirmationStyle: string;
+
+      /**
+       * Whether persona has speech disfluencies
+       */
+      disfluencies: boolean;
+
+      /**
+       * Gender of the persona
+       */
+      gender: string;
+
+      /**
+       * How clearly the persona expresses intent
+       */
+      intentClarity: string;
+
+      /**
+       * Language of the persona
+       */
+      language: string;
+
+      /**
+       * Reliability of persona memory
+       */
+      memoryReliability: string;
+
+      /**
+       * Persona name
+       */
+      name: string;
+
+      /**
+       * Speech clarity
+       */
+      speechClarity: string;
+
+      /**
+       * Speech pace
+       */
+      speechPace: string;
+    }
+
+    /**
+     * Scenario used in the simulation
+     */
+    export interface Scenario {
+      /**
+       * Scenario ID
+       */
+      id: string;
+
+      /**
+       * Scenario description
+       */
+      description?: string | null;
+    }
+  }
+}
+
+export interface SimulationLookupJobResponse {
+  /**
+   * Simulation job with related entities
+   */
+  data: SimulationLookupJobResponse.Data;
+}
+
+export namespace SimulationLookupJobResponse {
+  /**
+   * Simulation job with related entities
+   */
+  export interface Data {
+    /**
+     * Agent endpoint used in the simulation
+     */
+    agentEndpoint: Data.AgentEndpoint;
+
+    /**
+     * When the job was created
+     */
+    createdAt: string;
+
+    /**
+     * Persona used in the simulation
+     */
+    persona: Data.Persona;
+
+    /**
+     * Processing status
+     */
+    processingStatus: string;
+
+    /**
+     * Scenario used in the simulation
+     */
+    scenario: Data.Scenario;
+
+    /**
+     * Simulation job ID
+     */
+    simulationJobId: string;
+
+    /**
+     * Job status
+     */
+    status: string;
+
+    /**
+     * When the job completed
+     */
+    completedAt?: string | null;
+
+    /**
+     * When the job started
+     */
+    startedAt?: string | null;
+  }
+
+  export namespace Data {
+    /**
+     * Agent endpoint used in the simulation
+     */
+    export interface AgentEndpoint {
+      /**
+       * Agent endpoint ID
+       */
+      id: string;
+
+      /**
+       * Agent endpoint type
+       */
+      endpointType: string;
+
+      /**
+       * Agent endpoint name
+       */
+      name: string;
+
+      /**
+       * Agent endpoint phone number
+       */
+      phoneNumber: string | null;
+    }
+
+    /**
+     * Persona used in the simulation
+     */
+    export interface Persona {
+      /**
+       * Persona ID
+       */
+      id: string;
+
+      /**
+       * Accent of the persona
+       */
+      accent: string;
+
+      /**
+       * Background noise setting
+       */
+      backgroundNoise: string;
+
+      /**
+       * Base emotion of the persona
+       */
+      baseEmotion: string;
+
+      /**
+       * How the persona confirms information
+       */
+      confirmationStyle: string;
+
+      /**
+       * Whether persona has speech disfluencies
+       */
+      disfluencies: boolean;
+
+      /**
+       * Gender of the persona
+       */
+      gender: string;
+
+      /**
+       * How clearly the persona expresses intent
+       */
+      intentClarity: string;
+
+      /**
+       * Language of the persona
+       */
+      language: string;
+
+      /**
+       * Reliability of persona memory
+       */
+      memoryReliability: string;
+
+      /**
+       * Persona name
+       */
+      name: string;
+
+      /**
+       * Speech clarity
+       */
+      speechClarity: string;
+
+      /**
+       * Speech pace
+       */
+      speechPace: string;
+    }
+
+    /**
+     * Scenario used in the simulation
+     */
+    export interface Scenario {
+      /**
+       * Scenario ID
+       */
+      id: string;
+
+      /**
+       * Scenario description
+       */
+      description?: string | null;
+    }
+  }
+}
+
+export interface SimulationLookupJobParams {
+  /**
+   * Phone number provisioned by Roark for the simulation job in E.164 format. In the
+   * case of an inbound simulation, this is the number that calls your agent; in the
+   * case of an outbound simulation, this is the number you call from your agent.
+   */
+  roarkPhoneNumber: unknown;
+
+  /**
+   * ISO 8601 timestamp of when the call was received. Alternatively, any time
+   * between the start and end of the call is valid. Defaults to the current time,
+   * which fetches any jobs that are currently ongoing.
+   */
+  callReceivedAt?: unknown;
+}
+
+export declare namespace Simulation {
+  export {
+    type SimulationGetJobByIDResponse as SimulationGetJobByIDResponse,
+    type SimulationLookupJobResponse as SimulationLookupJobResponse,
+    type SimulationLookupJobParams as SimulationLookupJobParams,
+  };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.4.1'; // x-release-please-version
+export const VERSION = '2.6.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.4.1";
+export declare const VERSION = "2.6.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.4.1'; // x-release-please-version
+exports.VERSION = '2.6.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.4.1'; // x-release-please-version
+export const VERSION = '2.6.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map