@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
38 lines • 1.74 kB
TypeScript
import * as z from "zod";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
/**
* A high-level, AI-generated summary of an agreement document.
*/
export type AgreementSummary = {
/**
* An AI-generated summary of the agreement. This summary is provided for convenience
*
* @remarks
* and may not capture every detail of the original agreement.
*/
summary?: string | undefined;
};
/** @internal */
export declare const AgreementSummary$inboundSchema: z.ZodType<AgreementSummary, z.ZodTypeDef, unknown>;
/** @internal */
export type AgreementSummary$Outbound = {
summary?: string | undefined;
};
/** @internal */
export declare const AgreementSummary$outboundSchema: z.ZodType<AgreementSummary$Outbound, z.ZodTypeDef, AgreementSummary>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace AgreementSummary$ {
/** @deprecated use `AgreementSummary$inboundSchema` instead. */
const inboundSchema: z.ZodType<AgreementSummary, z.ZodTypeDef, unknown>;
/** @deprecated use `AgreementSummary$outboundSchema` instead. */
const outboundSchema: z.ZodType<AgreementSummary$Outbound, z.ZodTypeDef, AgreementSummary>;
/** @deprecated use `AgreementSummary$Outbound` instead. */
type Outbound = AgreementSummary$Outbound;
}
export declare function agreementSummaryToJSON(agreementSummary: AgreementSummary): string;
export declare function agreementSummaryFromJSON(jsonString: string): SafeParseResult<AgreementSummary, SDKValidationError>;
//# sourceMappingURL=agreementsummary.d.ts.map