increase 0.377.0 → 0.378.0

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 Increase } 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: Increase;
+
+  constructor(
+    client: Increase,
+    private responsePromise: Promise<APIResponseProps>,
+    private parseResponse: (
+      client: Increase,
+      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,443 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { castToError } from '../internal/errors';
+
+export class IncreaseError extends Error {}
+
+export class APIError<
+  TStatus extends number | undefined = number | undefined,
+  THeaders extends Headers | undefined = Headers | undefined,
+  TError extends Object | undefined = Object | undefined,
+> extends IncreaseError {
+  /** 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>;
+
+    const type = error?.['type'];
+
+    if (type === 'invalid_parameters_error' && status === 400) {
+      return new InvalidParametersError(status, error, message, headers);
+    }
+
+    if (type === 'malformed_request_error' && status === 400) {
+      return new MalformedRequestError(status, error, message, headers);
+    }
+
+    if (type === 'invalid_api_key_error' && status === 401) {
+      return new InvalidAPIKeyError(status, error, message, headers);
+    }
+
+    if (type === 'environment_mismatch_error' && status === 403) {
+      return new EnvironmentMismatchError(status, error, message, headers);
+    }
+
+    if (type === 'insufficient_permissions_error' && status === 403) {
+      return new InsufficientPermissionsError(status, error, message, headers);
+    }
+
+    if (type === 'private_feature_error' && status === 403) {
+      return new PrivateFeatureError(status, error, message, headers);
+    }
+
+    if (type === 'api_method_not_found_error' && status === 404) {
+      return new APIMethodNotFoundError(status, error, message, headers);
+    }
+
+    if (type === 'object_not_found_error' && status === 404) {
+      return new ObjectNotFoundError(status, error, message, headers);
+    }
+
+    if (type === 'idempotency_key_already_used_error' && status === 409) {
+      return new IdempotencyKeyAlreadyUsedError(status, error, message, headers);
+    }
+
+    if (type === 'invalid_operation_error' && status === 409) {
+      return new InvalidOperationError(status, error, message, headers);
+    }
+
+    if (type === 'rate_limited_error' && status === 429) {
+      return new RateLimitedError(status, error, message, headers);
+    }
+
+    if (type === 'internal_server_error' && status === 500) {
+      return new InternalServerError(status, error, message, headers);
+    }
+
+    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);
+    }
+
+    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 InvalidParametersError extends BadRequestError {
+  detail: string | null;
+
+  /**
+   * All errors related to parsing the request parameters.
+   */
+  errors: Array<{ [key: string]: unknown }>;
+
+  override status: 400;
+
+  title: string;
+
+  type: 'invalid_parameters_error';
+
+  constructor(status: 400, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.errors = data?.['errors'] ?? [];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+  }
+}
+
+export class MalformedRequestError extends BadRequestError {
+  detail: string | null;
+
+  override status: 400;
+
+  title: string;
+
+  type: 'malformed_request_error';
+
+  constructor(status: 400, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+  }
+}
+
+export class InvalidAPIKeyError extends AuthenticationError {
+  detail: string | null;
+
+  /**
+   * - `deleted_credential` - deleted_credential
+   * - `expired_credential` - expired_credential
+   * - `no_credential` - no_credential
+   * - `no_header` - no_header
+   * - `no_api_access` - no_api_access
+   * - `wrong_environment` - wrong_environment
+   */
+  reason:
+    | 'deleted_credential'
+    | 'expired_credential'
+    | 'no_credential'
+    | 'no_header'
+    | 'no_api_access'
+    | 'wrong_environment';
+
+  override status: 401;
+
+  title: string;
+
+  type: 'invalid_api_key_error';
+
+  constructor(status: 401, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.reason = data?.['reason'];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+  }
+}
+
+export class EnvironmentMismatchError extends PermissionDeniedError {
+  detail: string | null;
+
+  override status: 403;
+
+  title: string;
+
+  type: 'environment_mismatch_error';
+
+  constructor(status: 403, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+  }
+}
+
+export class InsufficientPermissionsError extends PermissionDeniedError {
+  detail: string | null;
+
+  override status: 403;
+
+  title: string;
+
+  type: 'insufficient_permissions_error';
+
+  constructor(status: 403, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+  }
+}
+
+export class PrivateFeatureError extends PermissionDeniedError {
+  detail: string | null;
+
+  override status: 403;
+
+  title: string;
+
+  type: 'private_feature_error';
+
+  constructor(status: 403, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+  }
+}
+
+export class APIMethodNotFoundError extends NotFoundError {
+  detail: string | null;
+
+  override status: 404;
+
+  title: string;
+
+  type: 'api_method_not_found_error';
+
+  constructor(status: 404, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+  }
+}
+
+export class ObjectNotFoundError extends NotFoundError {
+  detail: string | null;
+
+  override status: 404;
+
+  title: string;
+
+  type: 'object_not_found_error';
+
+  constructor(status: 404, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+  }
+}
+
+export class IdempotencyKeyAlreadyUsedError extends ConflictError {
+  detail: string | null;
+
+  resource_id: string;
+
+  override status: 409;
+
+  title: string;
+
+  type: 'idempotency_key_already_used_error';
+
+  constructor(status: 409, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.resource_id = data?.['resource_id'];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+  }
+}
+
+export class InvalidOperationError extends ConflictError {
+  detail: string | null;
+
+  override status: 409;
+
+  title: string;
+
+  type: 'invalid_operation_error';
+
+  constructor(status: 409, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+  }
+}
+
+export class RateLimitedError extends RateLimitError {
+  detail: string | null;
+
+  override status: 429;
+
+  title: string;
+
+  type: 'rate_limited_error';
+
+  retry_after?: number | null;
+
+  constructor(status: 429, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+    this.retry_after = data?.['retry_after'];
+  }
+}
+
+export class InternalServerError extends APIError<number, Headers> {
+  detail: string | null;
+
+  override status: 500;
+
+  title: string;
+
+  type: 'internal_server_error';
+
+  constructor(status: 500, error: Object, message: string | undefined, headers: Headers) {
+    const data = error as Record<string, any>;
+    super(status, error, data?.['title'] || message, headers);
+
+    this.detail = data?.['detail'];
+    this.status = data?.['status'];
+    this.title = data?.['title'];
+    this.type = data?.['type'];
+  }
+}

package/src/core/pagination.ts

@@ -0,0 +1,165 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { IncreaseError } from './error';
+import { FinalRequestOptions } from '../internal/request-options';
+import { defaultParseResponse } from '../internal/parse';
+import { type Increase } from '../client';
+import { APIPromise } from './api-promise';
+import { type APIResponseProps } from '../internal/parse';
+import { maybeObj } from '../internal/utils/values';
+
+export type PageRequestOptions = Pick<FinalRequestOptions, 'query' | 'headers' | 'body' | 'path' | 'method'>;
+
+export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
+  #client: Increase;
+  protected options: FinalRequestOptions;
+
+  protected response: Response;
+  protected body: unknown;
+
+  constructor(client: Increase, response: Response, body: unknown, options: FinalRequestOptions) {
+    this.#client = client;
+    this.options = options;
+    this.response = response;
+    this.body = body;
+  }
+
+  abstract nextPageRequestOptions(): PageRequestOptions | null;
+
+  abstract getPaginatedItems(): Item[];
+
+  hasNextPage(): boolean {
+    const items = this.getPaginatedItems();
+    if (!items.length) return false;
+    return this.nextPageRequestOptions() != null;
+  }
+
+  async getNextPage(): Promise<this> {
+    const nextOptions = this.nextPageRequestOptions();
+    if (!nextOptions) {
+      throw new IncreaseError(
+        'No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.',
+      );
+    }
+
+    return await this.#client.requestAPIList(this.constructor as any, nextOptions);
+  }
+
+  async *iterPages(): AsyncGenerator<this> {
+    let page: this = this;
+    yield page;
+    while (page.hasNextPage()) {
+      page = await page.getNextPage();
+      yield page;
+    }
+  }
+
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
+    for await (const page of this.iterPages()) {
+      for (const item of page.getPaginatedItems()) {
+        yield item;
+      }
+    }
+  }
+}
+
+/**
+ * This subclass of Promise will resolve to an instantiated Page once the request completes.
+ *
+ * It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg:
+ *
+ *    for await (const item of client.items.list()) {
+ *      console.log(item)
+ *    }
+ */
+export class PagePromise<
+    PageClass extends AbstractPage<Item>,
+    Item = ReturnType<PageClass['getPaginatedItems']>[number],
+  >
+  extends APIPromise<PageClass>
+  implements AsyncIterable<Item>
+{
+  constructor(
+    client: Increase,
+    request: Promise<APIResponseProps>,
+    Page: new (...args: ConstructorParameters<typeof AbstractPage>) => PageClass,
+  ) {
+    super(
+      client,
+      request,
+      async (client, props) =>
+        new Page(client, props.response, await defaultParseResponse(client, props), props.options),
+    );
+  }
+
+  /**
+   * Allow auto-paginating iteration on an unawaited list call, eg:
+   *
+   *    for await (const item of client.items.list()) {
+   *      console.log(item)
+   *    }
+   */
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
+    const page = await this;
+    for await (const item of page) {
+      yield item;
+    }
+  }
+}
+
+export interface PageResponse<Item> {
+  data: Array<Item>;
+
+  /**
+   * A pointer to a place in the list.
+   */
+  next_cursor: string | null;
+}
+
+export interface PageParams {
+  /**
+   * Return the page of entries after this one.
+   */
+  cursor?: string;
+
+  /**
+   * Limit the size of the list that is returned. The default (and maximum) is 100
+   * objects.
+   */
+  limit?: number;
+}
+
+export class Page<Item> extends AbstractPage<Item> implements PageResponse<Item> {
+  data: Array<Item>;
+
+  /**
+   * A pointer to a place in the list.
+   */
+  next_cursor: string | null;
+
+  constructor(client: Increase, response: Response, body: PageResponse<Item>, options: FinalRequestOptions) {
+    super(client, response, body, options);
+
+    this.data = body.data || [];
+    this.next_cursor = body.next_cursor || null;
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data ?? [];
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.next_cursor;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        cursor,
+      },
+    };
+  }
+}

package/src/core/resource.ts

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