@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
311 lines • 16.3 kB
JavaScript
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import * as z from "zod/v3";
import { remap as remap$ } from "../../lib/primitives.js";
import { safeParse } from "../../lib/schemas.js";
import * as types from "../../types/primitives.js";
import { AgreementActions$inboundSchema, AgreementActions$outboundSchema, } from "./agreementactions.js";
import { AgreementLinks$inboundSchema, AgreementLinks$outboundSchema, } from "./agreementlinks.js";
import { CurrencyCode$inboundSchema, CurrencyCode$outboundSchema, } from "./currencycode.js";
import { CustomProperty$inboundSchema, CustomProperty$outboundSchema, } from "./customproperty.js";
import { LinkedData$inboundSchema, LinkedData$outboundSchema, } from "./linkeddata.js";
import { Party$inboundSchema, Party$outboundSchema, } from "./party.js";
import { ResourceMetadata$inboundSchema, ResourceMetadata$outboundSchema, } from "./resourcemetadata.js";
/**
* Terms specifying the payment due date, based on a defined number of days or other conditions.
*/
export const PaymentTermsDueDate = {
UnderSevenDays: "UNDER_SEVEN_DAYS",
SevenDays: "SEVEN_DAYS",
FifteenDays: "FIFTEEN_DAYS",
ThirtyDays: "THIRTY_DAYS",
FortyFiveDays: "FORTY_FIVE_DAYS",
SixtyDays: "SIXTY_DAYS",
NinetyDays: "NINETY_DAYS",
OverNinetyDays: "OVER_NINETY_DAYS",
OnReceipt: "ON_RECEIPT",
Other: "OTHER",
Silent: "SILENT",
};
/** @internal */
export const PaymentTermsDueDate$inboundSchema = z.nativeEnum(PaymentTermsDueDate);
/** @internal */
export const PaymentTermsDueDate$outboundSchema = PaymentTermsDueDate$inboundSchema;
/** @internal */
export const Provisions$inboundSchema = z.object({
assignment_type: z.nullable(types.string()).optional(),
assignment_change_of_control: z.nullable(types.string()).optional(),
assignment_termination_rights: z.nullable(types.string()).optional(),
confidentiality_obligation_period: z.nullable(types.string()).optional(),
governing_law: z.nullable(types.string()).optional(),
jurisdiction: z.nullable(types.string()).optional(),
nda_type: z.nullable(types.string()).optional(),
annual_agreement_value: z.nullable(types.number()).optional(),
annual_agreement_value_currency_code: z.nullable(CurrencyCode$inboundSchema)
.optional(),
total_agreement_value: z.nullable(types.number()).optional(),
total_agreement_value_currency_code: z.nullable(CurrencyCode$inboundSchema)
.optional(),
payment_terms_due_date: PaymentTermsDueDate$inboundSchema.default("OTHER"),
can_charge_late_payment_fees: z.nullable(types.boolean()).optional(),
late_payment_fee_percent: z.nullable(types.number()).optional(),
liability_cap_fixed_amount: z.nullable(types.number()).optional(),
liability_cap_currency_code: z.nullable(CurrencyCode$inboundSchema)
.optional(),
liability_cap_multiplier: z.nullable(types.number()).optional(),
liability_cap_duration: z.nullable(types.string()).optional(),
price_cap_percent_increase: z.nullable(types.number()).optional(),
renewal_type: z.nullable(types.string()).optional(),
renewal_notice_period: z.nullable(types.string()).optional(),
renewal_notice_date: types.optional(types.string()),
auto_renewal_term_length: z.nullable(types.string()).optional(),
renewal_extension_period: z.nullable(types.string()).optional(),
renewal_process_owner: types.optional(types.string()),
renewal_additional_info: z.nullable(types.string()).optional(),
termination_period_for_cause: z.nullable(types.string()).optional(),
termination_period_for_convenience: z.nullable(types.string()).optional(),
effective_date: types.optional(types.string()),
expiration_date: types.optional(types.string()),
execution_date: types.optional(types.string()),
term_length: z.nullable(types.string()).optional(),
}).transform((v) => {
return remap$(v, {
"assignment_type": "assignmentType",
"assignment_change_of_control": "assignmentChangeOfControl",
"assignment_termination_rights": "assignmentTerminationRights",
"confidentiality_obligation_period": "confidentialityObligationPeriod",
"governing_law": "governingLaw",
"nda_type": "ndaType",
"annual_agreement_value": "annualAgreementValue",
"annual_agreement_value_currency_code": "annualAgreementValueCurrencyCode",
"total_agreement_value": "totalAgreementValue",
"total_agreement_value_currency_code": "totalAgreementValueCurrencyCode",
"payment_terms_due_date": "paymentTermsDueDate",
"can_charge_late_payment_fees": "canChargeLatePaymentFees",
"late_payment_fee_percent": "latePaymentFeePercent",
"liability_cap_fixed_amount": "liabilityCapFixedAmount",
"liability_cap_currency_code": "liabilityCapCurrencyCode",
"liability_cap_multiplier": "liabilityCapMultiplier",
"liability_cap_duration": "liabilityCapDuration",
"price_cap_percent_increase": "priceCapPercentIncrease",
"renewal_type": "renewalType",
"renewal_notice_period": "renewalNoticePeriod",
"renewal_notice_date": "renewalNoticeDate",
"auto_renewal_term_length": "autoRenewalTermLength",
"renewal_extension_period": "renewalExtensionPeriod",
"renewal_process_owner": "renewalProcessOwner",
"renewal_additional_info": "renewalAdditionalInfo",
"termination_period_for_cause": "terminationPeriodForCause",
"termination_period_for_convenience": "terminationPeriodForConvenience",
"effective_date": "effectiveDate",
"expiration_date": "expirationDate",
"execution_date": "executionDate",
"term_length": "termLength",
});
});
/** @internal */
export const Provisions$outboundSchema = z.object({
assignmentType: z.nullable(z.string()).optional(),
assignmentChangeOfControl: z.nullable(z.string()).optional(),
assignmentTerminationRights: z.nullable(z.string()).optional(),
confidentialityObligationPeriod: z.nullable(z.string()).optional(),
governingLaw: z.nullable(z.string()).optional(),
jurisdiction: z.nullable(z.string()).optional(),
ndaType: z.nullable(z.string()).optional(),
annualAgreementValue: z.nullable(z.number()).optional(),
annualAgreementValueCurrencyCode: z.nullable(CurrencyCode$outboundSchema)
.optional(),
totalAgreementValue: z.nullable(z.number()).optional(),
totalAgreementValueCurrencyCode: z.nullable(CurrencyCode$outboundSchema)
.optional(),
paymentTermsDueDate: PaymentTermsDueDate$outboundSchema.default("OTHER"),
canChargeLatePaymentFees: z.nullable(z.boolean()).optional(),
latePaymentFeePercent: z.nullable(z.number()).optional(),
liabilityCapFixedAmount: z.nullable(z.number()).optional(),
liabilityCapCurrencyCode: z.nullable(CurrencyCode$outboundSchema).optional(),
liabilityCapMultiplier: z.nullable(z.number()).optional(),
liabilityCapDuration: z.nullable(z.string()).optional(),
priceCapPercentIncrease: z.nullable(z.number()).optional(),
renewalType: z.nullable(z.string()).optional(),
renewalNoticePeriod: z.nullable(z.string()).optional(),
renewalNoticeDate: z.string().optional(),
autoRenewalTermLength: z.nullable(z.string()).optional(),
renewalExtensionPeriod: z.nullable(z.string()).optional(),
renewalProcessOwner: z.string().optional(),
renewalAdditionalInfo: z.nullable(z.string()).optional(),
terminationPeriodForCause: z.nullable(z.string()).optional(),
terminationPeriodForConvenience: z.nullable(z.string()).optional(),
effectiveDate: z.string().optional(),
expirationDate: z.string().optional(),
executionDate: z.string().optional(),
termLength: z.nullable(z.string()).optional(),
}).transform((v) => {
return remap$(v, {
assignmentType: "assignment_type",
assignmentChangeOfControl: "assignment_change_of_control",
assignmentTerminationRights: "assignment_termination_rights",
confidentialityObligationPeriod: "confidentiality_obligation_period",
governingLaw: "governing_law",
ndaType: "nda_type",
annualAgreementValue: "annual_agreement_value",
annualAgreementValueCurrencyCode: "annual_agreement_value_currency_code",
totalAgreementValue: "total_agreement_value",
totalAgreementValueCurrencyCode: "total_agreement_value_currency_code",
paymentTermsDueDate: "payment_terms_due_date",
canChargeLatePaymentFees: "can_charge_late_payment_fees",
latePaymentFeePercent: "late_payment_fee_percent",
liabilityCapFixedAmount: "liability_cap_fixed_amount",
liabilityCapCurrencyCode: "liability_cap_currency_code",
liabilityCapMultiplier: "liability_cap_multiplier",
liabilityCapDuration: "liability_cap_duration",
priceCapPercentIncrease: "price_cap_percent_increase",
renewalType: "renewal_type",
renewalNoticePeriod: "renewal_notice_period",
renewalNoticeDate: "renewal_notice_date",
autoRenewalTermLength: "auto_renewal_term_length",
renewalExtensionPeriod: "renewal_extension_period",
renewalProcessOwner: "renewal_process_owner",
renewalAdditionalInfo: "renewal_additional_info",
terminationPeriodForCause: "termination_period_for_cause",
terminationPeriodForConvenience: "termination_period_for_convenience",
effectiveDate: "effective_date",
expirationDate: "expiration_date",
executionDate: "execution_date",
termLength: "term_length",
});
});
export function provisionsToJSON(provisions) {
return JSON.stringify(Provisions$outboundSchema.parse(provisions));
}
export function provisionsFromJSON(jsonString) {
return safeParse(jsonString, (x) => Provisions$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Provisions' from JSON`);
}
/** @internal */
export const RelatedAgreementDocuments$inboundSchema = z.object({
parent_agreement_document_id: types.string().default("00000000-0000-0000-0000-000000000000"),
}).transform((v) => {
return remap$(v, {
"parent_agreement_document_id": "parentAgreementDocumentId",
});
});
/** @internal */
export const RelatedAgreementDocuments$outboundSchema = z.object({
parentAgreementDocumentId: z.string().default("00000000-0000-0000-0000-000000000000"),
}).transform((v) => {
return remap$(v, {
parentAgreementDocumentId: "parent_agreement_document_id",
});
});
export function relatedAgreementDocumentsToJSON(relatedAgreementDocuments) {
return JSON.stringify(RelatedAgreementDocuments$outboundSchema.parse(relatedAgreementDocuments));
}
export function relatedAgreementDocumentsFromJSON(jsonString) {
return safeParse(jsonString, (x) => RelatedAgreementDocuments$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'RelatedAgreementDocuments' from JSON`);
}
/** @internal */
export const Agreement$inboundSchema = z.object({
id: types.string().default("00000000-0000-0000-0000-000000000000"),
title: z.nullable(types.string()).optional(),
file_name: z.nullable(types.string()).optional(),
document_id: z.nullable(types.string()).optional(),
type: z.nullable(types.string()).optional(),
category: z.nullable(types.string()).optional(),
summary: z.nullable(types.string()).optional(),
status: z.nullable(types.string()).optional(),
review_status: z.nullable(types.string()).optional(),
review_completed_at: z.nullable(types.date()).optional(),
parties: z.nullable(z.array(Party$inboundSchema)).optional(),
provisions: z.nullable(z.lazy(() => Provisions$inboundSchema)).optional(),
custom_provisions: z.nullable(z.record(CustomProperty$inboundSchema))
.optional(),
additional_user_defined_data: z.nullable(z.record(CustomProperty$inboundSchema)).optional(),
additional_custom_clm_data: z.nullable(z.record(CustomProperty$inboundSchema))
.optional(),
additional_custom_esign_data: z.nullable(z.record(CustomProperty$inboundSchema)).optional(),
related_agreement_documents: types.optional(z.lazy(() => RelatedAgreementDocuments$inboundSchema)),
languages: z.nullable(z.array(types.nullable(types.string()))).optional(),
source_name: z.nullable(types.string()).optional(),
source_id: z.nullable(types.string()).optional(),
source_account_id: z.nullable(types.string()).optional(),
linked_data: types.optional(z.array(LinkedData$inboundSchema)),
metadata: types.optional(ResourceMetadata$inboundSchema),
_links: z.nullable(AgreementLinks$inboundSchema).optional(),
_actions: z.nullable(AgreementActions$inboundSchema).optional(),
}).transform((v) => {
return remap$(v, {
"file_name": "fileName",
"document_id": "documentId",
"review_status": "reviewStatus",
"review_completed_at": "reviewCompletedAt",
"custom_provisions": "customProvisions",
"additional_user_defined_data": "additionalUserDefinedData",
"additional_custom_clm_data": "additionalCustomClmData",
"additional_custom_esign_data": "additionalCustomEsignData",
"related_agreement_documents": "relatedAgreementDocuments",
"source_name": "sourceName",
"source_id": "sourceId",
"source_account_id": "sourceAccountId",
"linked_data": "linkedData",
"_links": "links",
"_actions": "actions",
});
});
/** @internal */
export const Agreement$outboundSchema = z.object({
id: z.string().default("00000000-0000-0000-0000-000000000000"),
title: z.nullable(z.string()).optional(),
fileName: z.nullable(z.string()).optional(),
documentId: z.nullable(z.string()).optional(),
type: z.nullable(z.string()).optional(),
category: z.nullable(z.string()).optional(),
summary: z.nullable(z.string()).optional(),
status: z.nullable(z.string()).optional(),
reviewStatus: z.nullable(z.string()).optional(),
reviewCompletedAt: z.nullable(z.date().transform(v => v.toISOString()))
.optional(),
parties: z.nullable(z.array(Party$outboundSchema)).optional(),
provisions: z.nullable(z.lazy(() => Provisions$outboundSchema)).optional(),
customProvisions: z.nullable(z.record(CustomProperty$outboundSchema))
.optional(),
additionalUserDefinedData: z.nullable(z.record(CustomProperty$outboundSchema))
.optional(),
additionalCustomClmData: z.nullable(z.record(CustomProperty$outboundSchema))
.optional(),
additionalCustomEsignData: z.nullable(z.record(CustomProperty$outboundSchema))
.optional(),
relatedAgreementDocuments: z.lazy(() => RelatedAgreementDocuments$outboundSchema).optional(),
languages: z.nullable(z.array(z.nullable(z.string()))).optional(),
sourceName: z.nullable(z.string()).optional(),
sourceId: z.nullable(z.string()).optional(),
sourceAccountId: z.nullable(z.string()).optional(),
linkedData: z.array(LinkedData$outboundSchema).optional(),
metadata: ResourceMetadata$outboundSchema.optional(),
links: z.nullable(AgreementLinks$outboundSchema).optional(),
actions: z.nullable(AgreementActions$outboundSchema).optional(),
}).transform((v) => {
return remap$(v, {
fileName: "file_name",
documentId: "document_id",
reviewStatus: "review_status",
reviewCompletedAt: "review_completed_at",
customProvisions: "custom_provisions",
additionalUserDefinedData: "additional_user_defined_data",
additionalCustomClmData: "additional_custom_clm_data",
additionalCustomEsignData: "additional_custom_esign_data",
relatedAgreementDocuments: "related_agreement_documents",
sourceName: "source_name",
sourceId: "source_id",
sourceAccountId: "source_account_id",
linkedData: "linked_data",
links: "_links",
actions: "_actions",
});
});
export function agreementToJSON(agreement) {
return JSON.stringify(Agreement$outboundSchema.parse(agreement));
}
export function agreementFromJSON(jsonString) {
return safeParse(jsonString, (x) => Agreement$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Agreement' from JSON`);
}
//# sourceMappingURL=agreement.js.map