@unkey/api
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
28 lines • 1.16 kB
TypeScript
import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
/**
* Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
*/
export type Pagination = {
/**
* Opaque pagination token for retrieving the next page of results.
*
* @remarks
* Include this exact value in the cursor field of subsequent requests.
* Cursors are temporary and may expire after extended periods.
*/
cursor?: string | undefined;
/**
* Indicates whether additional results exist beyond this page.
*
* @remarks
* When true, use the cursor to fetch the next page.
* When false, you have reached the end of the result set.
*/
hasMore: boolean;
};
/** @internal */
export declare const Pagination$inboundSchema: z.ZodType<Pagination, z.ZodTypeDef, unknown>;
export declare function paginationFromJSON(jsonString: string): SafeParseResult<Pagination, SDKValidationError>;
//# sourceMappingURL=pagination.d.ts.map