orb-billing 5.76.0 → 6.0.0

package/src/core/pagination.ts

@@ -0,0 +1,167 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { OrbError } from './error';
+import { FinalRequestOptions } from '../internal/request-options';
+import { defaultParseResponse } from '../internal/parse';
+import { type BaseOrb } 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: BaseOrb;
+  protected options: FinalRequestOptions;
+
+  protected response: Response;
+  protected body: unknown;
+
+  constructor(client: BaseOrb, 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 OrbError(
+        '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: BaseOrb,
+    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>;
+
+  pagination_metadata: PageResponse.PaginationMetadata;
+}
+
+export namespace PageResponse {
+  export interface PaginationMetadata {
+    has_more: boolean;
+
+    next_cursor: string | null;
+  }
+}
+
+export interface PageParams {
+  /**
+   * Cursor for pagination. This can be populated by the `next_cursor` value returned
+   * from the initial request.
+   */
+  cursor?: string | null;
+
+  /**
+   * The number of items to fetch. Defaults to 20.
+   */
+  limit?: number;
+}
+
+export class Page<Item> extends AbstractPage<Item> implements PageResponse<Item> {
+  data: Array<Item>;
+
+  pagination_metadata: PageResponse.PaginationMetadata;
+
+  constructor(client: BaseOrb, response: Response, body: PageResponse<Item>, options: FinalRequestOptions) {
+    super(client, response, body, options);
+
+    this.data = body.data || [];
+    this.pagination_metadata = body.pagination_metadata;
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data ?? [];
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.pagination_metadata.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 { BaseOrb } from '../client';
+
+export abstract class APIResource {
+  protected _client: BaseOrb;
+
+  constructor(client: BaseOrb) {
+    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,456 +1,2 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { castToError, Headers } from './core';
-
-export class OrbError extends Error {}
-
-export class APIError<
-  TStatus extends number | undefined = number | undefined,
-  THeaders extends Headers | undefined = Headers | undefined,
-  TError extends Object | undefined = Object | undefined,
-> extends OrbError {
-  /** 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 === 'https://docs.withorb.com/reference/error-responses#400-constraint-violation' &&
-      status === 400
-    ) {
-      return new ConstraintViolation(status, error, message, headers);
-    }
-
-    if (
-      type === 'https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation' &&
-      status === 400
-    ) {
-      return new DuplicateResourceCreation(status, error, message, headers);
-    }
-
-    if (
-      type === 'https://docs.withorb.com/reference/error-responses#404-feature-not-available' &&
-      status === 400
-    ) {
-      return new FeatureNotAvailable(status, error, message, headers);
-    }
-
-    if (
-      type === 'https://docs.withorb.com/reference/error-responses#400-request-validation-errors' &&
-      status === 400
-    ) {
-      return new RequestValidationError(status, error, message, headers);
-    }
-
-    if (
-      type === 'https://docs.withorb.com/reference/error-responses#401-authentication-error' &&
-      status === 401
-    ) {
-      return new OrbAuthenticationError(status, error, message, headers);
-    }
-
-    if (
-      type === 'https://docs.withorb.com/reference/error-responses#404-resource-not-found' &&
-      status === 404
-    ) {
-      return new ResourceNotFound(status, error, message, headers);
-    }
-
-    if (type === 'https://docs.withorb.com/reference/error-responses#404-url-not-found' && status === 404) {
-      return new URLNotFound(status, error, message, headers);
-    }
-
-    if (
-      type === 'https://docs.withorb.com/reference/error-responses#409-resource-conflict' &&
-      status === 409
-    ) {
-      return new ResourceConflict(status, error, message, headers);
-    }
-
-    if (
-      type === 'https://docs.withorb.com/reference/error-responses#413-request-too-large' &&
-      status === 413
-    ) {
-      return new RequestTooLarge(status, error, message, headers);
-    }
-
-    if (
-      type === 'https://docs.withorb.com/reference/error-responses#413-resource-too-large' &&
-      status === 413
-    ) {
-      return new ResourceTooLarge(status, error, message, headers);
-    }
-
-    if (
-      type === 'https://docs.withorb.com/reference/error-responses#429-too-many-requests' &&
-      status === 429
-    ) {
-      return new TooManyRequests(status, error, message, headers);
-    }
-
-    if (
-      type === 'https://docs.withorb.com/reference/error-responses#500-internal-server-error' &&
-      status === 500
-    ) {
-      return new OrbInternalServerError(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);
-    }
-
-    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> {}
-
-export class ConstraintViolation extends BadRequestError {
-  override status: 400;
-
-  type: 'https://docs.withorb.com/reference/error-responses#400-constraint-violation';
-
-  detail?: string | null;
-
-  title?: string | null;
-
-  constructor(status: 400, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.type = data?.['type'];
-    this.detail = data?.['detail'];
-    this.title = data?.['title'];
-  }
-}
-
-export class DuplicateResourceCreation extends BadRequestError {
-  override status: 400;
-
-  type: 'https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation';
-
-  detail?: string | null;
-
-  title?: string | null;
-
-  constructor(status: 400, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.type = data?.['type'];
-    this.detail = data?.['detail'];
-    this.title = data?.['title'];
-  }
-}
-
-export class FeatureNotAvailable extends BadRequestError {
-  override status: 400;
-
-  type: 'https://docs.withorb.com/reference/error-responses#404-feature-not-available';
-
-  detail?: string | null;
-
-  title?: string | null;
-
-  constructor(status: 400, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.type = data?.['type'];
-    this.detail = data?.['detail'];
-    this.title = data?.['title'];
-  }
-}
-
-export class RequestValidationError extends BadRequestError {
-  override status: 400;
-
-  type: 'https://docs.withorb.com/reference/error-responses#400-request-validation-errors';
-
-  validation_errors: Array<unknown>;
-
-  detail?: string | null;
-
-  title?: string | null;
-
-  constructor(status: 400, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.type = data?.['type'];
-    this.validation_errors = data?.['validation_errors'] ?? [];
-    this.detail = data?.['detail'];
-    this.title = data?.['title'];
-  }
-}
-
-export class OrbAuthenticationError extends AuthenticationError {
-  override status: 401;
-
-  type: 'https://docs.withorb.com/reference/error-responses#401-authentication-error';
-
-  detail?: string | null;
-
-  title?: string | null;
-
-  constructor(status: 401, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.type = data?.['type'];
-    this.detail = data?.['detail'];
-    this.title = data?.['title'];
-  }
-}
-
-export class ResourceNotFound extends NotFoundError {
-  override status: 404;
-
-  title: string;
-
-  type: 'https://docs.withorb.com/reference/error-responses#404-resource-not-found';
-
-  detail?: string | null;
-
-  constructor(status: 404, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.title = data?.['title'];
-    this.type = data?.['type'];
-    this.detail = data?.['detail'];
-  }
-}
-
-export class URLNotFound extends NotFoundError {
-  override status: 404;
-
-  type: 'https://docs.withorb.com/reference/error-responses#404-url-not-found';
-
-  detail?: string | null;
-
-  title?: string | null;
-
-  constructor(status: 404, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.type = data?.['type'];
-    this.detail = data?.['detail'];
-    this.title = data?.['title'];
-  }
-}
-
-export class ResourceConflict extends ConflictError {
-  override status: 409;
-
-  type: 'https://docs.withorb.com/reference/error-responses#409-resource-conflict';
-
-  detail?: string | null;
-
-  title?: string | null;
-
-  constructor(status: 409, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.type = data?.['type'];
-    this.detail = data?.['detail'];
-    this.title = data?.['title'];
-  }
-}
-
-export class RequestTooLarge extends APIError {
-  override status: 413;
-
-  type: 'https://docs.withorb.com/reference/error-responses#413-request-too-large';
-
-  detail?: string | null;
-
-  title?: string | null;
-
-  constructor(status: 413, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.type = data?.['type'];
-    this.detail = data?.['detail'];
-    this.title = data?.['title'];
-  }
-}
-
-export class ResourceTooLarge extends APIError {
-  override status: 413;
-
-  type: 'https://docs.withorb.com/reference/error-responses#413-resource-too-large';
-
-  detail?: string | null;
-
-  title?: string | null;
-
-  constructor(status: 413, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.type = data?.['type'];
-    this.detail = data?.['detail'];
-    this.title = data?.['title'];
-  }
-}
-
-export class TooManyRequests extends RateLimitError {
-  override status: 429;
-
-  type: 'https://docs.withorb.com/reference/error-responses#429-too-many-requests';
-
-  detail?: string | null;
-
-  title?: string | null;
-
-  constructor(status: 429, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.type = data?.['type'];
-    this.detail = data?.['detail'];
-    this.title = data?.['title'];
-  }
-}
-
-export class OrbInternalServerError extends InternalServerError {
-  override status: 500;
-
-  type: 'https://docs.withorb.com/reference/error-responses#500-internal-server-error';
-
-  detail?: string | null;
-
-  title?: string | null;
-
-  constructor(status: 500, error: Object, message: string | undefined, headers: Headers) {
-    const data = error as Record<string, any>;
-    super(status, error, message, headers);
-
-    this.status = data?.['status'];
-    this.type = data?.['type'];
-    this.detail = data?.['detail'];
-    this.title = data?.['title'];
-  }
-}
+/** @deprecated Import from ./core/error instead */
+export * from './core/error';