@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
37 lines • 1.39 kB
TypeScript
import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import { PageLink } from "./pagelink.js";
/**
* Hypermedia controls (HATEOAS) for navigating between pages in a paginated collection of results.
*
* @remarks
* Links for the current page, next page, and previous page, with optional first and last page links.
*/
export type PageLinks = {
/**
* A URL that references a specific page in the pagination process. This is typically used for navigation
*
* @remarks
* between paginated results.
*/
first?: PageLink | null | undefined;
/**
* A URL that references a specific page in the pagination process. This is typically used for navigation
*
* @remarks
* between paginated results.
*/
self?: PageLink | null | undefined;
/**
* A URL that references a specific page in the pagination process. This is typically used for navigation
*
* @remarks
* between paginated results.
*/
next?: PageLink | null | undefined;
};
/** @internal */
export declare const PageLinks$inboundSchema: z.ZodType<PageLinks, z.ZodTypeDef, unknown>;
export declare function pageLinksFromJSON(jsonString: string): SafeParseResult<PageLinks, SDKValidationError>;
//# sourceMappingURL=pagelinks.d.ts.map