@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
60 lines • 2.43 kB
TypeScript
import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
/**
* Change the agreement type to a different configured type.
*
* @remarks
* Only present when the agreement type is mutable.
*/
export type AgreementActionsChangeType = {
/**
* The URL for the change-type action.
*/
href?: string | undefined;
/**
* The HTTP method for the action.
*/
method?: string | undefined;
/**
* Human-readable description of the action.
*/
description?: string | undefined;
};
/**
* Available actions on the agreement. Actions are conditionally present based on the current state of the resource.
*
* @remarks
*/
export type AgreementActions = {
/**
* Change the agreement type to a different configured type.
*
* @remarks
* Only present when the agreement type is mutable.
*/
changeType?: AgreementActionsChangeType | undefined;
};
/** @internal */
export declare const AgreementActionsChangeType$inboundSchema: z.ZodType<AgreementActionsChangeType, z.ZodTypeDef, unknown>;
/** @internal */
export type AgreementActionsChangeType$Outbound = {
href?: string | undefined;
method?: string | undefined;
description?: string | undefined;
};
/** @internal */
export declare const AgreementActionsChangeType$outboundSchema: z.ZodType<AgreementActionsChangeType$Outbound, z.ZodTypeDef, AgreementActionsChangeType>;
export declare function agreementActionsChangeTypeToJSON(agreementActionsChangeType: AgreementActionsChangeType): string;
export declare function agreementActionsChangeTypeFromJSON(jsonString: string): SafeParseResult<AgreementActionsChangeType, SDKValidationError>;
/** @internal */
export declare const AgreementActions$inboundSchema: z.ZodType<AgreementActions, z.ZodTypeDef, unknown>;
/** @internal */
export type AgreementActions$Outbound = {
change_type?: AgreementActionsChangeType$Outbound | undefined;
};
/** @internal */
export declare const AgreementActions$outboundSchema: z.ZodType<AgreementActions$Outbound, z.ZodTypeDef, AgreementActions>;
export declare function agreementActionsToJSON(agreementActions: AgreementActions): string;
export declare function agreementActionsFromJSON(jsonString: string): SafeParseResult<AgreementActions, SDKValidationError>;
//# sourceMappingURL=agreementactions.d.ts.map