@docusign/iam-sdk/dist/commonjs/models/components/agreementlinks.d.ts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.

import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import { Link, Link$Outbound } from "./link.js";
/**
 * Link to the collection of configured agreement types for the account. Always present.
 */
export type AgreementLinksAgreementTypes = {
    /**
     * The URL for the referenced page.
     */
    href: string;
};
/**
 * Hypermedia controls (HATEOAS) for agreement specific links to resources.
 *
 * @remarks
 */
export type AgreementLinks = {
    /**
     * A URL that references a specific resource.
     *
     * @remarks
     */
    document?: Link | null | undefined;
    /**
     * Link to the collection of configured agreement types for the account. Always present.
     */
    agreementTypes?: AgreementLinksAgreementTypes | null | undefined;
};
/** @internal */
export declare const AgreementLinksAgreementTypes$inboundSchema: z.ZodType<AgreementLinksAgreementTypes, z.ZodTypeDef, unknown>;
/** @internal */
export type AgreementLinksAgreementTypes$Outbound = {
    href: string;
};
/** @internal */
export declare const AgreementLinksAgreementTypes$outboundSchema: z.ZodType<AgreementLinksAgreementTypes$Outbound, z.ZodTypeDef, AgreementLinksAgreementTypes>;
export declare function agreementLinksAgreementTypesToJSON(agreementLinksAgreementTypes: AgreementLinksAgreementTypes): string;
export declare function agreementLinksAgreementTypesFromJSON(jsonString: string): SafeParseResult<AgreementLinksAgreementTypes, SDKValidationError>;
/** @internal */
export declare const AgreementLinks$inboundSchema: z.ZodType<AgreementLinks, z.ZodTypeDef, unknown>;
/** @internal */
export type AgreementLinks$Outbound = {
    document?: Link$Outbound | null | undefined;
    agreement_types?: AgreementLinksAgreementTypes$Outbound | null | undefined;
};
/** @internal */
export declare const AgreementLinks$outboundSchema: z.ZodType<AgreementLinks$Outbound, z.ZodTypeDef, AgreementLinks>;
export declare function agreementLinksToJSON(agreementLinks: AgreementLinks): string;
export declare function agreementLinksFromJSON(jsonString: string): SafeParseResult<AgreementLinks, SDKValidationError>;
//# sourceMappingURL=agreementlinks.d.ts.map