import { FinalRequestOptions } from "../internal/request-options.js"; import { type Pylon } 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: Pylon, 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: Pylon, 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 PylonCursorPageResponse { data: Array; pagination: PylonCursorPageResponse.Pagination; request_id: string; } export declare namespace PylonCursorPageResponse { interface Pagination { cursor?: string; has_next_page?: boolean; } } export interface PylonCursorPageParams { cursor?: string; limit?: number; } export declare class PylonCursorPage extends AbstractPage implements PylonCursorPageResponse { data: Array; pagination: PylonCursorPageResponse.Pagination; request_id: string; constructor(client: Pylon, response: Response, body: PylonCursorPageResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; nextPageRequestOptions(): PageRequestOptions | null; } export interface PylonSearchPageResponse { data: Array; pagination: PylonSearchPageResponse.Pagination; request_id: string; } export declare namespace PylonSearchPageResponse { interface Pagination { cursor?: string; has_next_page?: boolean; } } export interface PylonSearchPageParams { cursor?: string; limit?: number; /** * Search filter criteria */ filter?: PylonSearchPageParams.Filter; } export declare namespace PylonSearchPageParams { /** * Search filter criteria */ interface Filter { field?: string; operator?: string; subfilters?: Array; value?: string; values?: Array; } } export declare class PylonSearchPage extends AbstractPage implements PylonSearchPageResponse { data: Array; pagination: PylonSearchPageResponse.Pagination; request_id: string; constructor(client: Pylon, response: Response, body: PylonSearchPageResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; nextPageRequestOptions(): PageRequestOptions | null; } //# sourceMappingURL=pagination.d.ts.map