@roarkanalytics/sdk 2.21.0 → 2.21.1

package/src/error.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { castToError, Headers } from './core';
+import { castToError } from './internal/errors';
 
 export class RoarkError extends Error {}
 

package/src/index.ts

@@ -1,311 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { type Agent } from './_shims/index';
-import * as qs from './internal/qs';
-import * as Core from './core';
-import * as Errors from './error';
-import * as Uploads from './uploads';
-import * as API from './resources/index';
-import {
-  Call,
-  CallCreateParams,
-  CallCreateResponse,
-  CallGetByIDResponse,
-  CallListEvaluationRunsResponse,
-  CallListMetricsParams,
-  CallListMetricsResponse,
-  CallListParams,
-  CallListResponse,
-  CallListSentimentRunsResponse,
-} from './resources/call';
-import {
-  Evaluation,
-  EvaluationCreateJobParams,
-  EvaluationCreateJobResponse,
-  EvaluationGetEvaluatorByIDResponse,
-  EvaluationGetJobResponse,
-  EvaluationListEvaluatorsParams,
-  EvaluationListEvaluatorsResponse,
-  EvaluationListJobRunsParams,
-  EvaluationListJobRunsResponse,
-} from './resources/evaluation';
-import { Health, HealthGetResponse } from './resources/health';
-import {
-  IntegrationCreateRetellCallParams,
-  IntegrationCreateRetellCallResponse,
-  IntegrationCreateVapiCallParams,
-  IntegrationCreateVapiCallResponse,
-  Integrations,
-} from './resources/integrations';
-import { Metric, MetricListDefinitionsResponse } from './resources/metric';
-import {
-  Persona,
-  PersonaCreateParams,
-  PersonaCreateResponse,
-  PersonaGetByIDResponse,
-  PersonaListParams,
-  PersonaListResponse,
-  PersonaUpdateParams,
-  PersonaUpdateResponse,
-} from './resources/persona';
-import {
-  Simulation,
-  SimulationGetRunPlanJobResponse,
-  SimulationGetSimulationJobByIDResponse,
-  SimulationListRunPlanJobsParams,
-  SimulationListRunPlanJobsResponse,
-  SimulationListScenariosParams,
-  SimulationListScenariosResponse,
-  SimulationLookupSimulationJobParams,
-  SimulationLookupSimulationJobResponse,
-  SimulationStartRunPlanJobResponse,
-} from './resources/simulation';
+export { Roark as default } from './client';
 
-export interface ClientOptions {
-  /**
-   * JWT token for authentication
-   */
-  bearerToken?: string | undefined;
-
-  /**
-   * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
-   *
-   * Defaults to process.env['ROARK_BASE_URL'].
-   */
-  baseURL?: string | null | undefined;
-
-  /**
-   * The maximum amount of time (in milliseconds) that the client should wait for a response
-   * from the server before timing out a single request.
-   *
-   * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
-   * much longer than this timeout before the promise succeeds or fails.
-   *
-   * @unit milliseconds
-   */
-  timeout?: number | undefined;
-
-  /**
-   * An HTTP agent used to manage HTTP(S) connections.
-   *
-   * If not provided, an agent will be constructed by default in the Node.js environment,
-   * otherwise no agent is used.
-   */
-  httpAgent?: Agent | undefined;
-
-  /**
-   * Specify a custom `fetch` function implementation.
-   *
-   * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
-   * defined globally.
-   */
-  fetch?: Core.Fetch | undefined;
-
-  /**
-   * The maximum number of times that the client will retry a request in case of a
-   * temporary failure, like a network error or a 5XX error from the server.
-   *
-   * @default 2
-   */
-  maxRetries?: number | undefined;
-
-  /**
-   * Default headers to include with every request to the API.
-   *
-   * These can be removed in individual requests by explicitly setting the
-   * header to `undefined` or `null` in request options.
-   */
-  defaultHeaders?: Core.Headers | undefined;
-
-  /**
-   * Default query parameters to include with every request to the API.
-   *
-   * These can be removed in individual requests by explicitly setting the
-   * param to `undefined` in request options.
-   */
-  defaultQuery?: Core.DefaultQuery | undefined;
-}
-
-/**
- * API Client for interfacing with the Roark API.
- */
-export class Roark extends Core.APIClient {
-  bearerToken: string;
-
-  private _options: ClientOptions;
-
-  /**
-   * API Client for interfacing with the Roark API.
-   *
-   * @param {string | undefined} [opts.bearerToken=process.env['ROARK_API_BEARER_TOKEN'] ?? undefined]
-   * @param {string} [opts.baseURL=process.env['ROARK_BASE_URL'] ?? https://api.roark.ai] - Override the default base URL for the API.
-   * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
-   * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
-   * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
-   * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
-   * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
-   * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
-   */
-  constructor({
-    baseURL = Core.readEnv('ROARK_BASE_URL'),
-    bearerToken = Core.readEnv('ROARK_API_BEARER_TOKEN'),
-    ...opts
-  }: ClientOptions = {}) {
-    if (bearerToken === undefined) {
-      throw new Errors.RoarkError(
-        "The ROARK_API_BEARER_TOKEN environment variable is missing or empty; either provide it, or instantiate the Roark client with an bearerToken option, like new Roark({ bearerToken: 'My Bearer Token' }).",
-      );
-    }
-
-    const options: ClientOptions = {
-      bearerToken,
-      ...opts,
-      baseURL: baseURL || `https://api.roark.ai`,
-    };
-
-    super({
-      baseURL: options.baseURL!,
-      baseURLOverridden: baseURL ? baseURL !== 'https://api.roark.ai' : false,
-      timeout: options.timeout ?? 60000 /* 1 minute */,
-      httpAgent: options.httpAgent,
-      maxRetries: options.maxRetries,
-      fetch: options.fetch,
-    });
-
-    this._options = options;
-
-    this.bearerToken = bearerToken;
-  }
-
-  health: API.Health = new API.Health(this);
-  evaluation: API.Evaluation = new API.Evaluation(this);
-  call: API.Call = new API.Call(this);
-  metric: API.Metric = new API.Metric(this);
-  integrations: API.Integrations = new API.Integrations(this);
-  simulation: API.Simulation = new API.Simulation(this);
-  persona: API.Persona = new API.Persona(this);
-
-  /**
-   * Check whether the base URL is set to its default.
-   */
-  #baseURLOverridden(): boolean {
-    return this.baseURL !== 'https://api.roark.ai';
-  }
-
-  protected override defaultQuery(): Core.DefaultQuery | undefined {
-    return this._options.defaultQuery;
-  }
-
-  protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
-    return {
-      ...super.defaultHeaders(opts),
-      ...this._options.defaultHeaders,
-    };
-  }
-
-  protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
-    return { Authorization: `Bearer ${this.bearerToken}` };
-  }
-
-  protected override stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'comma' });
-  }
-
-  static Roark = this;
-  static DEFAULT_TIMEOUT = 60000; // 1 minute
-
-  static RoarkError = Errors.RoarkError;
-  static APIError = Errors.APIError;
-  static APIConnectionError = Errors.APIConnectionError;
-  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
-  static APIUserAbortError = Errors.APIUserAbortError;
-  static NotFoundError = Errors.NotFoundError;
-  static ConflictError = Errors.ConflictError;
-  static RateLimitError = Errors.RateLimitError;
-  static BadRequestError = Errors.BadRequestError;
-  static AuthenticationError = Errors.AuthenticationError;
-  static InternalServerError = Errors.InternalServerError;
-  static PermissionDeniedError = Errors.PermissionDeniedError;
-  static UnprocessableEntityError = Errors.UnprocessableEntityError;
-
-  static toFile = Uploads.toFile;
-  static fileFromPath = Uploads.fileFromPath;
-}
-
-Roark.Health = Health;
-Roark.Evaluation = Evaluation;
-Roark.Call = Call;
-Roark.Metric = Metric;
-Roark.Integrations = Integrations;
-Roark.Simulation = Simulation;
-Roark.Persona = Persona;
-
-export declare namespace Roark {
-  export type RequestOptions = Core.RequestOptions;
-
-  export { Health as Health, type HealthGetResponse as HealthGetResponse };
-
-  export {
-    Evaluation as Evaluation,
-    type EvaluationCreateJobResponse as EvaluationCreateJobResponse,
-    type EvaluationGetEvaluatorByIDResponse as EvaluationGetEvaluatorByIDResponse,
-    type EvaluationGetJobResponse as EvaluationGetJobResponse,
-    type EvaluationListEvaluatorsResponse as EvaluationListEvaluatorsResponse,
-    type EvaluationListJobRunsResponse as EvaluationListJobRunsResponse,
-    type EvaluationCreateJobParams as EvaluationCreateJobParams,
-    type EvaluationListEvaluatorsParams as EvaluationListEvaluatorsParams,
-    type EvaluationListJobRunsParams as EvaluationListJobRunsParams,
-  };
-
-  export {
-    Call as Call,
-    type CallCreateResponse as CallCreateResponse,
-    type CallListResponse as CallListResponse,
-    type CallGetByIDResponse as CallGetByIDResponse,
-    type CallListEvaluationRunsResponse as CallListEvaluationRunsResponse,
-    type CallListMetricsResponse as CallListMetricsResponse,
-    type CallListSentimentRunsResponse as CallListSentimentRunsResponse,
-    type CallCreateParams as CallCreateParams,
-    type CallListParams as CallListParams,
-    type CallListMetricsParams as CallListMetricsParams,
-  };
-
-  export { Metric as Metric, type MetricListDefinitionsResponse as MetricListDefinitionsResponse };
-
-  export {
-    Integrations as Integrations,
-    type IntegrationCreateRetellCallResponse as IntegrationCreateRetellCallResponse,
-    type IntegrationCreateVapiCallResponse as IntegrationCreateVapiCallResponse,
-    type IntegrationCreateRetellCallParams as IntegrationCreateRetellCallParams,
-    type IntegrationCreateVapiCallParams as IntegrationCreateVapiCallParams,
-  };
-
-  export {
-    Simulation as Simulation,
-    type SimulationGetRunPlanJobResponse as SimulationGetRunPlanJobResponse,
-    type SimulationGetSimulationJobByIDResponse as SimulationGetSimulationJobByIDResponse,
-    type SimulationListRunPlanJobsResponse as SimulationListRunPlanJobsResponse,
-    type SimulationListScenariosResponse as SimulationListScenariosResponse,
-    type SimulationLookupSimulationJobResponse as SimulationLookupSimulationJobResponse,
-    type SimulationStartRunPlanJobResponse as SimulationStartRunPlanJobResponse,
-    type SimulationListRunPlanJobsParams as SimulationListRunPlanJobsParams,
-    type SimulationListScenariosParams as SimulationListScenariosParams,
-    type SimulationLookupSimulationJobParams as SimulationLookupSimulationJobParams,
-  };
-
-  export {
-    Persona as Persona,
-    type PersonaCreateResponse as PersonaCreateResponse,
-    type PersonaUpdateResponse as PersonaUpdateResponse,
-    type PersonaListResponse as PersonaListResponse,
-    type PersonaGetByIDResponse as PersonaGetByIDResponse,
-    type PersonaCreateParams as PersonaCreateParams,
-    type PersonaUpdateParams as PersonaUpdateParams,
-    type PersonaListParams as PersonaListParams,
-  };
-}
-
-export { toFile, fileFromPath } from './uploads';
+export { type Uploadable, toFile } from './uploads';
+export { APIPromise } from './api-promise';
+export { Roark, type ClientOptions } from './client';
 export {
   RoarkError,
   APIError,
@@ -321,5 +20,3 @@ export {
   PermissionDeniedError,
   UnprocessableEntityError,
 } from './error';
-
-export default Roark;

package/src/internal/builtin-types.ts

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export type Fetch = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
+
+/**
+ * An alias to the builtin `RequestInit` type so we can
+ * easily alias it in import statements if there are name clashes.
+ *
+ * https://developer.mozilla.org/docs/Web/API/RequestInit
+ */
+type _RequestInit = RequestInit;
+
+/**
+ * An alias to the builtin `Response` type so we can
+ * easily alias it in import statements if there are name clashes.
+ *
+ * https://developer.mozilla.org/docs/Web/API/Response
+ */
+type _Response = Response;
+
+/**
+ * The type for the first argument to `fetch`.
+ *
+ * https://developer.mozilla.org/docs/Web/API/Window/fetch#resource
+ */
+type _RequestInfo = Request | URL | string;
+
+/**
+ * The type for constructing `RequestInit` Headers.
+ *
+ * https://developer.mozilla.org/docs/Web/API/RequestInit#setting_headers
+ */
+type _HeadersInit = RequestInit['headers'];
+
+/**
+ * The type for constructing `RequestInit` body.
+ *
+ * https://developer.mozilla.org/docs/Web/API/RequestInit#body
+ */
+type _BodyInit = RequestInit['body'];
+
+export type {
+  _BodyInit as BodyInit,
+  _HeadersInit as HeadersInit,
+  _RequestInfo as RequestInfo,
+  _RequestInit as RequestInit,
+  _Response as Response,
+};
+
+/**
+ * A copy of the builtin `EndingType` type as it isn't fully supported in certain
+ * environments and attempting to reference the global version will error.
+ *
+ * https://github.com/microsoft/TypeScript/blob/49ad1a3917a0ea57f5ff248159256e12bb1cb705/src/lib/dom.generated.d.ts#L27941
+ */
+type EndingType = 'native' | 'transparent';
+
+/**
+ * A copy of the builtin `BlobPropertyBag` type as it isn't fully supported in certain
+ * environments and attempting to reference the global version will error.
+ *
+ * https://github.com/microsoft/TypeScript/blob/49ad1a3917a0ea57f5ff248159256e12bb1cb705/src/lib/dom.generated.d.ts#L154
+ * https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob#options
+ */
+export interface BlobPropertyBag {
+  endings?: EndingType;
+  type?: string;
+}
+
+/**
+ * A copy of the builtin `FilePropertyBag` type as it isn't fully supported in certain
+ * environments and attempting to reference the global version will error.
+ *
+ * https://github.com/microsoft/TypeScript/blob/49ad1a3917a0ea57f5ff248159256e12bb1cb705/src/lib/dom.generated.d.ts#L503
+ * https://developer.mozilla.org/en-US/docs/Web/API/File/File#options
+ */
+export interface FilePropertyBag extends BlobPropertyBag {
+  lastModified?: number;
+}

package/src/internal/detect-platform.ts

@@ -0,0 +1,196 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { VERSION } from '../version';
+
+export const isRunningInBrowser = () => {
+  return (
+    // @ts-ignore
+    typeof window !== 'undefined' &&
+    // @ts-ignore
+    typeof window.document !== 'undefined' &&
+    // @ts-ignore
+    typeof navigator !== 'undefined'
+  );
+};
+
+type DetectedPlatform = 'deno' | 'node' | 'edge' | 'unknown';
+
+/**
+ * Note this does not detect 'browser'; for that, use getBrowserInfo().
+ */
+function getDetectedPlatform(): DetectedPlatform {
+  if (typeof Deno !== 'undefined' && Deno.build != null) {
+    return 'deno';
+  }
+  if (typeof EdgeRuntime !== 'undefined') {
+    return 'edge';
+  }
+  if (
+    Object.prototype.toString.call(
+      typeof (globalThis as any).process !== 'undefined' ? (globalThis as any).process : 0,
+    ) === '[object process]'
+  ) {
+    return 'node';
+  }
+  return 'unknown';
+}
+
+declare const Deno: any;
+declare const EdgeRuntime: any;
+type Arch = 'x32' | 'x64' | 'arm' | 'arm64' | `other:${string}` | 'unknown';
+type PlatformName =
+  | 'MacOS'
+  | 'Linux'
+  | 'Windows'
+  | 'FreeBSD'
+  | 'OpenBSD'
+  | 'iOS'
+  | 'Android'
+  | `Other:${string}`
+  | 'Unknown';
+type Browser = 'ie' | 'edge' | 'chrome' | 'firefox' | 'safari';
+type PlatformProperties = {
+  'X-Stainless-Lang': 'js';
+  'X-Stainless-Package-Version': string;
+  'X-Stainless-OS': PlatformName;
+  'X-Stainless-Arch': Arch;
+  'X-Stainless-Runtime': 'node' | 'deno' | 'edge' | `browser:${Browser}` | 'unknown';
+  'X-Stainless-Runtime-Version': string;
+};
+const getPlatformProperties = (): PlatformProperties => {
+  const detectedPlatform = getDetectedPlatform();
+  if (detectedPlatform === 'deno') {
+    return {
+      'X-Stainless-Lang': 'js',
+      'X-Stainless-Package-Version': VERSION,
+      'X-Stainless-OS': normalizePlatform(Deno.build.os),
+      'X-Stainless-Arch': normalizeArch(Deno.build.arch),
+      'X-Stainless-Runtime': 'deno',
+      'X-Stainless-Runtime-Version':
+        typeof Deno.version === 'string' ? Deno.version : Deno.version?.deno ?? 'unknown',
+    };
+  }
+  if (typeof EdgeRuntime !== 'undefined') {
+    return {
+      'X-Stainless-Lang': 'js',
+      'X-Stainless-Package-Version': VERSION,
+      'X-Stainless-OS': 'Unknown',
+      'X-Stainless-Arch': `other:${EdgeRuntime}`,
+      'X-Stainless-Runtime': 'edge',
+      'X-Stainless-Runtime-Version': (globalThis as any).process.version,
+    };
+  }
+  // Check if Node.js
+  if (detectedPlatform === 'node') {
+    return {
+      'X-Stainless-Lang': 'js',
+      'X-Stainless-Package-Version': VERSION,
+      'X-Stainless-OS': normalizePlatform((globalThis as any).process.platform),
+      'X-Stainless-Arch': normalizeArch((globalThis as any).process.arch),
+      'X-Stainless-Runtime': 'node',
+      'X-Stainless-Runtime-Version': (globalThis as any).process.version,
+    };
+  }
+
+  const browserInfo = getBrowserInfo();
+  if (browserInfo) {
+    return {
+      'X-Stainless-Lang': 'js',
+      'X-Stainless-Package-Version': VERSION,
+      'X-Stainless-OS': 'Unknown',
+      'X-Stainless-Arch': 'unknown',
+      'X-Stainless-Runtime': `browser:${browserInfo.browser}`,
+      'X-Stainless-Runtime-Version': browserInfo.version,
+    };
+  }
+
+  // TODO add support for Cloudflare workers, etc.
+  return {
+    'X-Stainless-Lang': 'js',
+    'X-Stainless-Package-Version': VERSION,
+    'X-Stainless-OS': 'Unknown',
+    'X-Stainless-Arch': 'unknown',
+    'X-Stainless-Runtime': 'unknown',
+    'X-Stainless-Runtime-Version': 'unknown',
+  };
+};
+
+type BrowserInfo = {
+  browser: Browser;
+  version: string;
+};
+
+declare const navigator: { userAgent: string } | undefined;
+
+// Note: modified from https://github.com/JS-DevTools/host-environment/blob/b1ab79ecde37db5d6e163c050e54fe7d287d7c92/src/isomorphic.browser.ts
+function getBrowserInfo(): BrowserInfo | null {
+  if (typeof navigator === 'undefined' || !navigator) {
+    return null;
+  }
+
+  // NOTE: The order matters here!
+  const browserPatterns = [
+    { key: 'edge' as const, pattern: /Edge(?:\W+(\d+)\.(\d+)(?:\.(\d+))?)?/ },
+    { key: 'ie' as const, pattern: /MSIE(?:\W+(\d+)\.(\d+)(?:\.(\d+))?)?/ },
+    { key: 'ie' as const, pattern: /Trident(?:.*rv\:(\d+)\.(\d+)(?:\.(\d+))?)?/ },
+    { key: 'chrome' as const, pattern: /Chrome(?:\W+(\d+)\.(\d+)(?:\.(\d+))?)?/ },
+    { key: 'firefox' as const, pattern: /Firefox(?:\W+(\d+)\.(\d+)(?:\.(\d+))?)?/ },
+    { key: 'safari' as const, pattern: /(?:Version\W+(\d+)\.(\d+)(?:\.(\d+))?)?(?:\W+Mobile\S*)?\W+Safari/ },
+  ];
+
+  // Find the FIRST matching browser
+  for (const { key, pattern } of browserPatterns) {
+    const match = pattern.exec(navigator.userAgent);
+    if (match) {
+      const major = match[1] || 0;
+      const minor = match[2] || 0;
+      const patch = match[3] || 0;
+
+      return { browser: key, version: `${major}.${minor}.${patch}` };
+    }
+  }
+
+  return null;
+}
+
+const normalizeArch = (arch: string): Arch => {
+  // Node docs:
+  // - https://nodejs.org/api/process.html#processarch
+  // Deno docs:
+  // - https://doc.deno.land/deno/stable/~/Deno.build
+  if (arch === 'x32') return 'x32';
+  if (arch === 'x86_64' || arch === 'x64') return 'x64';
+  if (arch === 'arm') return 'arm';
+  if (arch === 'aarch64' || arch === 'arm64') return 'arm64';
+  if (arch) return `other:${arch}`;
+  return 'unknown';
+};
+
+const normalizePlatform = (platform: string): PlatformName => {
+  // Node platforms:
+  // - https://nodejs.org/api/process.html#processplatform
+  // Deno platforms:
+  // - https://doc.deno.land/deno/stable/~/Deno.build
+  // - https://github.com/denoland/deno/issues/14799
+
+  platform = platform.toLowerCase();
+
+  // NOTE: this iOS check is untested and may not work
+  // Node does not work natively on IOS, there is a fork at
+  // https://github.com/nodejs-mobile/nodejs-mobile
+  // however it is unknown at the time of writing how to detect if it is running
+  if (platform.includes('ios')) return 'iOS';
+  if (platform === 'android') return 'Android';
+  if (platform === 'darwin') return 'MacOS';
+  if (platform === 'win32') return 'Windows';
+  if (platform === 'freebsd') return 'FreeBSD';
+  if (platform === 'openbsd') return 'OpenBSD';
+  if (platform === 'linux') return 'Linux';
+  if (platform) return `Other:${platform}`;
+  return 'Unknown';
+};
+
+let _platformHeaders: PlatformProperties;
+export const getPlatformHeaders = () => {
+  return (_platformHeaders ??= getPlatformProperties());
+};

package/src/internal/errors.ts

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export function isAbortError(err: unknown) {
+  return (
+    typeof err === 'object' &&
+    err !== null &&
+    // Spec-compliant fetch implementations
+    (('name' in err && (err as any).name === 'AbortError') ||
+      // Expo fetch
+      ('message' in err && String((err as any).message).includes('FetchRequestCanceledException')))
+  );
+}
+
+export const castToError = (err: any): Error => {
+  if (err instanceof Error) return err;
+  if (typeof err === 'object' && err !== null) {
+    try {
+      return new Error(JSON.stringify(err));
+    } catch {}
+  }
+  return new Error(err);
+};