import { FinalRequestOptions } from "../internal/request-options.mjs"; import { type BaseCloudflare } from "../client.mjs"; import { APIPromise } from "./api-promise.mjs"; import { type APIResponseProps } from "../internal/parse.mjs"; export type PageRequestOptions = Pick; export declare abstract class AbstractPage implements AsyncIterable { #private; protected options: FinalRequestOptions; protected response: Response; protected body: unknown; constructor(client: BaseCloudflare, 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: BaseCloudflare, 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 V4PagePaginationResponse { result: V4PagePaginationResponse.Result; result_info: V4PagePaginationResponse.ResultInfo; } export declare namespace V4PagePaginationResponse { interface Result { items?: Array; } interface ResultInfo { page?: number; per_page?: number; } } export interface V4PagePaginationParams { page?: number; per_page?: number; } export declare class V4PagePagination extends AbstractPage implements V4PagePaginationResponse { result: V4PagePaginationResponse.Result; result_info: V4PagePaginationResponse.ResultInfo; constructor(client: BaseCloudflare, response: Response, body: V4PagePaginationResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; nextPageRequestOptions(): PageRequestOptions | null; } export interface V4PagePaginationArrayResponse { result: Array; result_info: V4PagePaginationArrayResponse.ResultInfo; } export declare namespace V4PagePaginationArrayResponse { interface ResultInfo { page?: number; per_page?: number; } } export interface V4PagePaginationArrayParams { page?: number; per_page?: number; } export declare class V4PagePaginationArray extends AbstractPage implements V4PagePaginationArrayResponse { result: Array; result_info: V4PagePaginationArrayResponse.ResultInfo; constructor(client: BaseCloudflare, response: Response, body: V4PagePaginationArrayResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; nextPageRequestOptions(): PageRequestOptions | null; } export interface CursorPaginationResponse { result: Array; result_info: CursorPaginationResponse.ResultInfo; } export declare namespace CursorPaginationResponse { interface ResultInfo { count?: number; cursor?: string; per_page?: number; } } export interface CursorPaginationParams { per_page?: number; cursor?: string; } export declare class CursorPagination extends AbstractPage implements CursorPaginationResponse { result: Array; result_info: CursorPaginationResponse.ResultInfo; constructor(client: BaseCloudflare, response: Response, body: CursorPaginationResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; nextPageRequestOptions(): PageRequestOptions | null; } export interface CursorPaginationAfterResponse { result: Array; result_info: CursorPaginationAfterResponse.ResultInfo; } export declare namespace CursorPaginationAfterResponse { interface ResultInfo { cursors?: ResultInfo.Cursors; } namespace ResultInfo { interface Cursors { after?: string; } } } export interface CursorPaginationAfterParams { cursor?: string; } export declare class CursorPaginationAfter extends AbstractPage implements CursorPaginationAfterResponse { result: Array; result_info: CursorPaginationAfterResponse.ResultInfo; constructor(client: BaseCloudflare, response: Response, body: CursorPaginationAfterResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; nextPageRequestOptions(): PageRequestOptions | null; } export interface CursorLimitPaginationResponse { result: Array; result_info: CursorLimitPaginationResponse.ResultInfo; } export declare namespace CursorLimitPaginationResponse { interface ResultInfo { count?: number; cursor?: string; per_page?: number; } } export interface CursorLimitPaginationParams { limit?: number; cursor?: string; } export declare class CursorLimitPagination extends AbstractPage implements CursorLimitPaginationResponse { result: Array; result_info: CursorLimitPaginationResponse.ResultInfo; constructor(client: BaseCloudflare, response: Response, body: CursorLimitPaginationResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; nextPageRequestOptions(): PageRequestOptions | null; } export interface SinglePageResponse { result: Array; } export declare class SinglePage extends AbstractPage implements SinglePageResponse { result: Array; constructor(client: BaseCloudflare, response: Response, body: SinglePageResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; nextPageRequestOptions(): PageRequestOptions | null; } //# sourceMappingURL=pagination.d.mts.map