import { FinalRequestOptions } from "../internal/request-options.js"; import { type OzAPI } from "../client.js"; import { APIPromise } from "./api-promise.js"; import { type APIResponseProps } from "../internal/parse.js"; export type PageRequestOptions = Pick; export declare abstract class AbstractPage implements AsyncIterable { #private; protected options: FinalRequestOptions; protected response: Response; protected body: unknown; constructor(client: OzAPI, response: Response, body: unknown, options: FinalRequestOptions); abstract nextPageRequestOptions(): PageRequestOptions | null; abstract getPaginatedItems(): Item[]; hasNextPage(): boolean; getNextPage(): Promise; iterPages(): AsyncGenerator; [Symbol.asyncIterator](): AsyncGenerator; } /** * 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 declare class PagePromise, Item = ReturnType[number]> extends APIPromise implements AsyncIterable { constructor(client: OzAPI, request: Promise, Page: new (...args: ConstructorParameters) => PageClass); /** * Allow auto-paginating iteration on an unawaited list call, eg: * * for await (const item of client.items.list()) { * console.log(item) * } */ [Symbol.asyncIterator](): AsyncGenerator; } export interface RunsCursorPageResponse { runs: Array; page_info: RunsCursorPageResponse.PageInfo; } export declare namespace RunsCursorPageResponse { interface PageInfo { has_next_page?: boolean; next_cursor?: string; } } export interface RunsCursorPageParams { cursor?: string; limit?: number; } export declare class RunsCursorPage extends AbstractPage implements RunsCursorPageResponse { runs: Array; page_info: RunsCursorPageResponse.PageInfo; constructor(client: OzAPI, response: Response, body: RunsCursorPageResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; hasNextPage(): boolean; nextPageRequestOptions(): PageRequestOptions | null; } //# sourceMappingURL=pagination.d.ts.map