@docusign/iam-sdk/dist/esm/models/components/changeagreementtyperesponse.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 { ResourceMetadata } from "./resourcemetadata.js";
export type Self = {
    href?: string | undefined;
};
export type Collection = {
    href?: string | undefined;
};
export type ChangeAgreementTypeResponseAgreementTypes = {
    href?: string | undefined;
};
/**
 * Hypermedia links for the agreement.
 */
export type ChangeAgreementTypeResponseLinks = {
    self?: Self | undefined;
    collection?: Collection | undefined;
    agreementTypes?: ChangeAgreementTypeResponseAgreementTypes | undefined;
};
export type ChangeAgreementTypeResponseChangeType = {
    href?: string | undefined;
    method?: string | undefined;
    description?: string | undefined;
};
/**
 * Available actions on the agreement.
 */
export type Actions = {
    changeType?: ChangeAgreementTypeResponseChangeType | undefined;
};
/**
 * The updated agreement after a type change.
 */
export type ChangeAgreementTypeResponse = {
    /**
     * Unique identifier of the agreement.
     */
    id?: string | undefined;
    /**
     * Title of the agreement.
     */
    title?: string | undefined;
    /**
     * The updated agreement type.
     */
    type?: string | undefined;
    /**
     * Server-recomputed category based on new type.
     */
    category?: string | undefined;
    /**
     * Current status of the agreement.
     */
    status?: string | undefined;
    metadata?: ResourceMetadata | undefined;
    /**
     * Hypermedia links for the agreement.
     */
    links?: ChangeAgreementTypeResponseLinks | undefined;
    /**
     * Available actions on the agreement.
     */
    actions?: Actions | undefined;
};
/** @internal */
export declare const Self$inboundSchema: z.ZodType<Self, z.ZodTypeDef, unknown>;
export declare function selfFromJSON(jsonString: string): SafeParseResult<Self, SDKValidationError>;
/** @internal */
export declare const Collection$inboundSchema: z.ZodType<Collection, z.ZodTypeDef, unknown>;
export declare function collectionFromJSON(jsonString: string): SafeParseResult<Collection, SDKValidationError>;
/** @internal */
export declare const ChangeAgreementTypeResponseAgreementTypes$inboundSchema: z.ZodType<ChangeAgreementTypeResponseAgreementTypes, z.ZodTypeDef, unknown>;
export declare function changeAgreementTypeResponseAgreementTypesFromJSON(jsonString: string): SafeParseResult<ChangeAgreementTypeResponseAgreementTypes, SDKValidationError>;
/** @internal */
export declare const ChangeAgreementTypeResponseLinks$inboundSchema: z.ZodType<ChangeAgreementTypeResponseLinks, z.ZodTypeDef, unknown>;
export declare function changeAgreementTypeResponseLinksFromJSON(jsonString: string): SafeParseResult<ChangeAgreementTypeResponseLinks, SDKValidationError>;
/** @internal */
export declare const ChangeAgreementTypeResponseChangeType$inboundSchema: z.ZodType<ChangeAgreementTypeResponseChangeType, z.ZodTypeDef, unknown>;
export declare function changeAgreementTypeResponseChangeTypeFromJSON(jsonString: string): SafeParseResult<ChangeAgreementTypeResponseChangeType, SDKValidationError>;
/** @internal */
export declare const Actions$inboundSchema: z.ZodType<Actions, z.ZodTypeDef, unknown>;
export declare function actionsFromJSON(jsonString: string): SafeParseResult<Actions, SDKValidationError>;
/** @internal */
export declare const ChangeAgreementTypeResponse$inboundSchema: z.ZodType<ChangeAgreementTypeResponse, z.ZodTypeDef, unknown>;
export declare function changeAgreementTypeResponseFromJSON(jsonString: string): SafeParseResult<ChangeAgreementTypeResponse, SDKValidationError>;
//# sourceMappingURL=changeagreementtyperesponse.d.ts.map