@roarkanalytics/sdk 2.21.0 → 2.21.2

package/src/core/README.md

@@ -0,0 +1,3 @@
+# `core`
+
+This directory holds public modules implementing non-resource-specific SDK functionality.

package/src/core/api-promise.ts

@@ -0,0 +1,92 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { type Roark } from '../client';
+
+import { type PromiseOrValue } from '../internal/types';
+import { APIResponseProps, defaultParseResponse } from '../internal/parse';
+
+/**
+ * A subclass of `Promise` providing additional helper methods
+ * for interacting with the SDK.
+ */
+export class APIPromise<T> extends Promise<T> {
+  private parsedPromise: Promise<T> | undefined;
+  #client: Roark;
+
+  constructor(
+    client: Roark,
+    private responsePromise: Promise<APIResponseProps>,
+    private parseResponse: (
+      client: Roark,
+      props: APIResponseProps,
+    ) => PromiseOrValue<T> = defaultParseResponse,
+  ) {
+    super((resolve) => {
+      // this is maybe a bit weird but this has to be a no-op to not implicitly
+      // parse the response body; instead .then, .catch, .finally are overridden
+      // to parse the response
+      resolve(null as any);
+    });
+    this.#client = client;
+  }
+
+  _thenUnwrap<U>(transform: (data: T, props: APIResponseProps) => U): APIPromise<U> {
+    return new APIPromise(this.#client, this.responsePromise, async (client, props) =>
+      transform(await this.parseResponse(client, props), props),
+    );
+  }
+
+  /**
+   * Gets the raw `Response` instance instead of parsing the response
+   * data.
+   *
+   * If you want to parse the response body but still get the `Response`
+   * instance, you can use {@link withResponse()}.
+   *
+   * 👋 Getting the wrong TypeScript type for `Response`?
+   * Try setting `"moduleResolution": "NodeNext"` or add `"lib": ["DOM"]`
+   * to your `tsconfig.json`.
+   */
+  asResponse(): Promise<Response> {
+    return this.responsePromise.then((p) => p.response);
+  }
+
+  /**
+   * Gets the parsed response data and the raw `Response` instance.
+   *
+   * If you just want to get the raw `Response` instance without parsing it,
+   * you can use {@link asResponse()}.
+   *
+   * 👋 Getting the wrong TypeScript type for `Response`?
+   * Try setting `"moduleResolution": "NodeNext"` or add `"lib": ["DOM"]`
+   * to your `tsconfig.json`.
+   */
+  async withResponse(): Promise<{ data: T; response: Response }> {
+    const [data, response] = await Promise.all([this.parse(), this.asResponse()]);
+    return { data, response };
+  }
+
+  private parse(): Promise<T> {
+    if (!this.parsedPromise) {
+      this.parsedPromise = this.responsePromise.then((data) => this.parseResponse(this.#client, data));
+    }
+    return this.parsedPromise;
+  }
+
+  override then<TResult1 = T, TResult2 = never>(
+    onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null,
+    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null,
+  ): Promise<TResult1 | TResult2> {
+    return this.parse().then(onfulfilled, onrejected);
+  }
+
+  override catch<TResult = never>(
+    onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null,
+  ): Promise<T | TResult> {
+    return this.parse().catch(onrejected);
+  }
+
+  override finally(onfinally?: (() => void) | undefined | null): Promise<T> {
+    return this.parse().finally(onfinally);
+  }
+}

package/src/core/error.ts

@@ -0,0 +1,130 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { castToError } from '../internal/errors';
+
+export class RoarkError extends Error {}
+
+export class APIError<
+  TStatus extends number | undefined = number | undefined,
+  THeaders extends Headers | undefined = Headers | undefined,
+  TError extends Object | undefined = Object | undefined,
+> extends RoarkError {
+  /** HTTP status for the response that caused the error */
+  readonly status: TStatus;
+  /** HTTP headers for the response that caused the error */
+  readonly headers: THeaders;
+  /** JSON body of the response that caused the error */
+  readonly error: TError;
+
+  constructor(status: TStatus, error: TError, message: string | undefined, headers: THeaders) {
+    super(`${APIError.makeMessage(status, error, message)}`);
+    this.status = status;
+    this.headers = headers;
+    this.error = error;
+  }
+
+  private static makeMessage(status: number | undefined, error: any, message: string | undefined) {
+    const msg =
+      error?.message ?
+        typeof error.message === 'string' ?
+          error.message
+        : JSON.stringify(error.message)
+      : error ? JSON.stringify(error)
+      : message;
+
+    if (status && msg) {
+      return `${status} ${msg}`;
+    }
+    if (status) {
+      return `${status} status code (no body)`;
+    }
+    if (msg) {
+      return msg;
+    }
+    return '(no status code or body)';
+  }
+
+  static generate(
+    status: number | undefined,
+    errorResponse: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  ): APIError {
+    if (!status || !headers) {
+      return new APIConnectionError({ message, cause: castToError(errorResponse) });
+    }
+
+    const error = errorResponse as Record<string, any>;
+
+    if (status === 400) {
+      return new BadRequestError(status, error, message, headers);
+    }
+
+    if (status === 401) {
+      return new AuthenticationError(status, error, message, headers);
+    }
+
+    if (status === 403) {
+      return new PermissionDeniedError(status, error, message, headers);
+    }
+
+    if (status === 404) {
+      return new NotFoundError(status, error, message, headers);
+    }
+
+    if (status === 409) {
+      return new ConflictError(status, error, message, headers);
+    }
+
+    if (status === 422) {
+      return new UnprocessableEntityError(status, error, message, headers);
+    }
+
+    if (status === 429) {
+      return new RateLimitError(status, error, message, headers);
+    }
+
+    if (status >= 500) {
+      return new InternalServerError(status, error, message, headers);
+    }
+
+    return new APIError(status, error, message, headers);
+  }
+}
+
+export class APIUserAbortError extends APIError<undefined, undefined, undefined> {
+  constructor({ message }: { message?: string } = {}) {
+    super(undefined, undefined, message || 'Request was aborted.', undefined);
+  }
+}
+
+export class APIConnectionError extends APIError<undefined, undefined, undefined> {
+  constructor({ message, cause }: { message?: string | undefined; cause?: Error | undefined }) {
+    super(undefined, undefined, message || 'Connection error.', undefined);
+    // in some environments the 'cause' property is already declared
+    // @ts-ignore
+    if (cause) this.cause = cause;
+  }
+}
+
+export class APIConnectionTimeoutError extends APIConnectionError {
+  constructor({ message }: { message?: string } = {}) {
+    super({ message: message ?? 'Request timed out.' });
+  }
+}
+
+export class BadRequestError extends APIError<400, Headers> {}
+
+export class AuthenticationError extends APIError<401, Headers> {}
+
+export class PermissionDeniedError extends APIError<403, Headers> {}
+
+export class NotFoundError extends APIError<404, Headers> {}
+
+export class ConflictError extends APIError<409, Headers> {}
+
+export class UnprocessableEntityError extends APIError<422, Headers> {}
+
+export class RateLimitError extends APIError<429, Headers> {}
+
+export class InternalServerError extends APIError<number, Headers> {}

package/src/core/resource.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import type { Roark } from '../client';
+
+export abstract class APIResource {
+  protected _client: Roark;
+
+  constructor(client: Roark) {
+    this._client = client;
+  }
+}

package/src/core/uploads.ts

@@ -0,0 +1,2 @@
+export { type Uploadable } from '../internal/uploads';
+export { toFile, type ToFileInput } from '../internal/to-file';

package/src/error.ts

@@ -1,130 +1,2 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { castToError, Headers } from './core';
-
-export class RoarkError extends Error {}
-
-export class APIError<
-  TStatus extends number | undefined = number | undefined,
-  THeaders extends Headers | undefined = Headers | undefined,
-  TError extends Object | undefined = Object | undefined,
-> extends RoarkError {
-  /** HTTP status for the response that caused the error */
-  readonly status: TStatus;
-  /** HTTP headers for the response that caused the error */
-  readonly headers: THeaders;
-  /** JSON body of the response that caused the error */
-  readonly error: TError;
-
-  constructor(status: TStatus, error: TError, message: string | undefined, headers: THeaders) {
-    super(`${APIError.makeMessage(status, error, message)}`);
-    this.status = status;
-    this.headers = headers;
-    this.error = error;
-  }
-
-  private static makeMessage(status: number | undefined, error: any, message: string | undefined) {
-    const msg =
-      error?.message ?
-        typeof error.message === 'string' ?
-          error.message
-        : JSON.stringify(error.message)
-      : error ? JSON.stringify(error)
-      : message;
-
-    if (status && msg) {
-      return `${status} ${msg}`;
-    }
-    if (status) {
-      return `${status} status code (no body)`;
-    }
-    if (msg) {
-      return msg;
-    }
-    return '(no status code or body)';
-  }
-
-  static generate(
-    status: number | undefined,
-    errorResponse: Object | undefined,
-    message: string | undefined,
-    headers: Headers | undefined,
-  ): APIError {
-    if (!status || !headers) {
-      return new APIConnectionError({ message, cause: castToError(errorResponse) });
-    }
-
-    const error = errorResponse as Record<string, any>;
-
-    if (status === 400) {
-      return new BadRequestError(status, error, message, headers);
-    }
-
-    if (status === 401) {
-      return new AuthenticationError(status, error, message, headers);
-    }
-
-    if (status === 403) {
-      return new PermissionDeniedError(status, error, message, headers);
-    }
-
-    if (status === 404) {
-      return new NotFoundError(status, error, message, headers);
-    }
-
-    if (status === 409) {
-      return new ConflictError(status, error, message, headers);
-    }
-
-    if (status === 422) {
-      return new UnprocessableEntityError(status, error, message, headers);
-    }
-
-    if (status === 429) {
-      return new RateLimitError(status, error, message, headers);
-    }
-
-    if (status >= 500) {
-      return new InternalServerError(status, error, message, headers);
-    }
-
-    return new APIError(status, error, message, headers);
-  }
-}
-
-export class APIUserAbortError extends APIError<undefined, undefined, undefined> {
-  constructor({ message }: { message?: string } = {}) {
-    super(undefined, undefined, message || 'Request was aborted.', undefined);
-  }
-}
-
-export class APIConnectionError extends APIError<undefined, undefined, undefined> {
-  constructor({ message, cause }: { message?: string | undefined; cause?: Error | undefined }) {
-    super(undefined, undefined, message || 'Connection error.', undefined);
-    // in some environments the 'cause' property is already declared
-    // @ts-ignore
-    if (cause) this.cause = cause;
-  }
-}
-
-export class APIConnectionTimeoutError extends APIConnectionError {
-  constructor({ message }: { message?: string } = {}) {
-    super({ message: message ?? 'Request timed out.' });
-  }
-}
-
-export class BadRequestError extends APIError<400, Headers> {}
-
-export class AuthenticationError extends APIError<401, Headers> {}
-
-export class PermissionDeniedError extends APIError<403, Headers> {}
-
-export class NotFoundError extends APIError<404, Headers> {}
-
-export class ConflictError extends APIError<409, Headers> {}
-
-export class UnprocessableEntityError extends APIError<422, Headers> {}
-
-export class RateLimitError extends APIError<429, Headers> {}
-
-export class InternalServerError extends APIError<number, Headers> {}
+/** @deprecated Import from ./core/error instead */
+export * from './core/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 './core/uploads';
+export { APIPromise } from './core/api-promise';
+export { Roark, type ClientOptions } from './client';
 export {
   RoarkError,
   APIError,
@@ -320,6 +19,4 @@ export {
   InternalServerError,
   PermissionDeniedError,
   UnprocessableEntityError,
-} from './error';
-
-export default Roark;
+} from './core/error';