@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
30 lines • 1.19 kB
TypeScript
import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import { Agreement } from "./agreement.js";
import { PageLinks } from "./pagelinks.js";
import { ResponseMetadata } from "./responsemetadata.js";
/**
* A collection of agreements.
*/
export type AgreementsResponse = {
/**
* A list of agreements
*/
data?: Array<Agreement> | undefined;
/**
* Control information and metadata for the response.
*/
responseMetadata?: ResponseMetadata | undefined;
/**
* 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.
*/
links?: PageLinks | null | undefined;
};
/** @internal */
export declare const AgreementsResponse$inboundSchema: z.ZodType<AgreementsResponse, z.ZodTypeDef, unknown>;
export declare function agreementsResponseFromJSON(jsonString: string): SafeParseResult<AgreementsResponse, SDKValidationError>;
//# sourceMappingURL=agreementsresponse.d.ts.map