import { FinalRequestOptions } from "../internal/request-options.mjs";
import { type Mixedbread } from "../client.mjs";
import { APIPromise } from "./api-promise.mjs";
import { type APIResponseProps } from "../internal/parse.mjs";
export type PageRequestOptions = Pick<FinalRequestOptions, 'query' | 'headers' | 'body' | 'path' | 'method'>;
export declare abstract class AbstractPage<Item> implements AsyncIterable<Item> {
    #private;
    protected options: FinalRequestOptions;
    protected response: Response;
    protected body: unknown;
    constructor(client: Mixedbread, response: Response, body: unknown, options: FinalRequestOptions);
    abstract nextPageRequestOptions(): PageRequestOptions | null;
    abstract getPaginatedItems(): Item[];
    hasNextPage(): boolean;
    getNextPage(): Promise<this>;
    iterPages(): AsyncGenerator<this>;
    [Symbol.asyncIterator](): AsyncGenerator<Item>;
}
/**
 * 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<PageClass extends AbstractPage<Item>, Item = ReturnType<PageClass['getPaginatedItems']>[number]> extends APIPromise<PageClass> implements AsyncIterable<Item> {
    constructor(client: Mixedbread, request: Promise<APIResponseProps>, Page: new (...args: ConstructorParameters<typeof AbstractPage>) => 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<Item>;
}
export interface LimitOffsetResponse<Item> {
    data: Array<Item>;
    pagination: LimitOffsetResponse.Pagination;
}
export declare namespace LimitOffsetResponse {
    interface Pagination {
        total?: number;
        offset?: number;
    }
}
export interface LimitOffsetParams {
    /**
     * The number of elements to skip.
     */
    offset?: number;
    /**
     * The maximum number of elements to fetch.
     */
    limit?: number;
}
export declare class LimitOffset<Item> extends AbstractPage<Item> implements LimitOffsetResponse<Item> {
    data: Array<Item>;
    pagination: LimitOffsetResponse.Pagination;
    constructor(client: Mixedbread, response: Response, body: LimitOffsetResponse<Item>, options: FinalRequestOptions);
    getPaginatedItems(): Item[];
    nextPageRequestOptions(): PageRequestOptions | null;
}
export interface CursorResponse<Item> {
    data: Array<Item>;
    pagination: CursorResponse.Pagination;
}
export declare namespace CursorResponse {
    interface Pagination {
        first_cursor?: string;
        last_cursor?: string;
        has_more?: boolean;
        total?: number;
    }
}
export interface CursorParams {
    /**
     * The cursor to base the request on for the next elements.
     */
    after?: string;
    /**
     * The cursor to base the request on for the previous elements.
     */
    before?: string;
    limit?: number;
    include_total?: boolean;
}
export declare class Cursor<Item> extends AbstractPage<Item> implements CursorResponse<Item> {
    data: Array<Item>;
    pagination: CursorResponse.Pagination;
    constructor(client: Mixedbread, response: Response, body: CursorResponse<Item>, options: FinalRequestOptions);
    getPaginatedItems(): Item[];
    hasNextPage(): boolean;
    nextPageRequestOptions(): PageRequestOptions | null;
}
//# sourceMappingURL=pagination.d.mts.map