cloudflare/src/resources/durable-objects/namespaces/objects.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../../core/resource';
import {
  CursorPaginationAfter,
  type CursorPaginationAfterParams,
  PagePromise,
} from '../../../core/pagination';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';

export class BaseObjects extends APIResource {
  static override readonly _key: readonly ['durableObjects', 'namespaces', 'objects'] = Object.freeze([
    'durableObjects',
    'namespaces',
    'objects',
  ] as const);

  /**
   * Returns the Durable Objects in a given Durable Object namespace.
   */
  list(
    id: string,
    params: ObjectListParams,
    options?: RequestOptions,
  ): PagePromise<DurableObjectsCursorPaginationAfter, DurableObject> {
    const { account_id, ...query } = params;
    return this._client.getAPIList(
      path`/accounts/${account_id}/workers/durable_objects/namespaces/${id}/objects`,
      CursorPaginationAfter<DurableObject>,
      { query, ...options },
    );
  }
}
export class Objects extends BaseObjects {}

export type DurableObjectsCursorPaginationAfter = CursorPaginationAfter<DurableObject>;

export interface DurableObject {
  /**
   * ID of the Durable Object.
   */
  id?: string;

  /**
   * Whether the Durable Object has stored data.
   */
  hasStoredData?: boolean;
}

export interface ObjectListParams extends CursorPaginationAfterParams {
  /**
   * Path param: Identifier.
   */
  account_id: string;

  /**
   * Query param: The number of objects to return. The cursor attribute may be used
   * to iterate over the next batch of objects if there are more than the limit.
   */
  limit?: number;
}

export declare namespace Objects {
  export {
    type DurableObject as DurableObject,
    type DurableObjectsCursorPaginationAfter as DurableObjectsCursorPaginationAfter,
    type ObjectListParams as ObjectListParams,
  };
}