import { FinalRequestOptions } from "../internal/request-options.js"; import { type SGPClient } 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: SGPClient, 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: SGPClient, 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 CursorPageResponse { has_more: boolean; items: Array; } export interface CursorPageParams { starting_after?: string; ending_before?: string; limit?: number; } export declare class CursorPage extends AbstractPage implements CursorPageResponse { has_more: boolean; items: Array; constructor(client: SGPClient, response: Response, body: CursorPageResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; hasNextPage(): boolean; nextPageRequestOptions(): PageRequestOptions | null; } export interface CursorPageVectorsResponse { has_more: boolean; vectors: Array; } export interface CursorPageVectorsParams { starting_after?: string; ending_before?: string; limit?: number; } export declare class CursorPageVectors extends AbstractPage implements CursorPageVectorsResponse { has_more: boolean; vectors: Array; constructor(client: SGPClient, response: Response, body: CursorPageVectorsResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; hasNextPage(): boolean; nextPageRequestOptions(): PageRequestOptions | null; } export interface CursorPageByNameResponse { has_more: boolean; items: Array; } export interface CursorPageByNameParams { starting_after?: string; ending_before?: string; limit?: number; } export declare class CursorPageByName extends AbstractPage implements CursorPageByNameResponse { has_more: boolean; items: Array; constructor(client: SGPClient, response: Response, body: CursorPageByNameResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; hasNextPage(): boolean; nextPageRequestOptions(): PageRequestOptions | null; } export interface APIListPageResponse { items: Array; } export declare class APIListPage extends AbstractPage implements APIListPageResponse { items: Array; constructor(client: SGPClient, response: Response, body: APIListPageResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; nextPageRequestOptions(): PageRequestOptions | null; } //# sourceMappingURL=pagination.d.ts.map