@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
47 lines • 1.82 kB
TypeScript
import * as z from "zod";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
/**
* A party is a person, group, or organization that is involved in a contract and has legally binding obligations and responsibilities. They also seek to benefit from the agreement.
*
* @remarks
*/
export type Party = {
/**
* Unique identifier for the party, mapped to the party entity reference.
*/
id: string;
/**
* Name of the party as it appears in the agreement.
*/
nameInAgreement?: string | null | undefined;
/**
* Formal name of the party.
*/
preferredName?: string | null | undefined;
};
/** @internal */
export declare const Party$inboundSchema: z.ZodType<Party, z.ZodTypeDef, unknown>;
/** @internal */
export type Party$Outbound = {
id: string;
name_in_agreement?: string | null | undefined;
preferred_name?: string | null | undefined;
};
/** @internal */
export declare const Party$outboundSchema: z.ZodType<Party$Outbound, z.ZodTypeDef, Party>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace Party$ {
/** @deprecated use `Party$inboundSchema` instead. */
const inboundSchema: z.ZodType<Party, z.ZodTypeDef, unknown>;
/** @deprecated use `Party$outboundSchema` instead. */
const outboundSchema: z.ZodType<Party$Outbound, z.ZodTypeDef, Party>;
/** @deprecated use `Party$Outbound` instead. */
type Outbound = Party$Outbound;
}
export declare function partyToJSON(party: Party): string;
export declare function partyFromJSON(jsonString: string): SafeParseResult<Party, SDKValidationError>;
//# sourceMappingURL=party.d.ts.map