diff --git a/.codegen.json b/.codegen.json index c3bebf116..d142675ba 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "f97463c", "specHash": "31c41d5", "version": "4.2.0" } +{ "engineHash": "f97463c", "specHash": "b7abe0d", "version": "4.2.0" } diff --git a/src/sdk-gen/schemas/index.ts b/src/sdk-gen/schemas/index.ts index 0ad6933fd..41f3b5c21 100644 --- a/src/sdk-gen/schemas/index.ts +++ b/src/sdk-gen/schemas/index.ts @@ -133,14 +133,26 @@ export * from './shieldInformationBarrierSegmentRestrictionBase'; export * from './shieldInformationBarrierSegmentRestrictionMini'; export * from './signRequestCreateSigner'; export * from './signRequestPrefillTag'; +export * from './signRequestBase'; +export * from './signRequestCreateRequest'; +export * from './signRequestSignerAttachment'; +export * from './signRequestSignerInputCustomValidation'; +export * from './signRequestSignerInputDateAsiaValidation'; +export * from './signRequestSignerInputDateEuValidation'; +export * from './signRequestSignerInputDateIsoValidation'; +export * from './signRequestSignerInputDateUsValidation'; +export * from './signRequestSignerInputEmailValidation'; +export * from './signRequestSignerInputNumberWithCommaValidation'; +export * from './signRequestSignerInputNumberWithPeriodValidation'; +export * from './signRequestSignerInputSsnValidation'; +export * from './signRequestSignerInputZip4Validation'; +export * from './signRequestSignerInputZipValidation'; +export * from './signRequestSignerInputValidation'; export * from './templateSignerInput'; export * from './templateSigner'; export * from './signTemplate'; export * from './signTemplates'; export * from './signRequestSignerInput'; -export * from './signRequestBase'; -export * from './signRequestCreateRequest'; -export * from './signRequestSignerAttachment'; export * from './signRequestSigner'; export * from './signRequest'; export * from './signRequests'; diff --git a/src/sdk-gen/schemas/signRequestSignerInput.ts b/src/sdk-gen/schemas/signRequestSignerInput.ts index c5af00b6e..82f13c51b 100644 --- a/src/sdk-gen/schemas/signRequestSignerInput.ts +++ b/src/sdk-gen/schemas/signRequestSignerInput.ts @@ -1,9 +1,45 @@ import { serializeDate } from '../internal/utils'; import { deserializeDate } from '../internal/utils'; +import { serializeSignRequestSignerInputEmailValidation } from './signRequestSignerInputEmailValidation'; +import { deserializeSignRequestSignerInputEmailValidation } from './signRequestSignerInputEmailValidation'; +import { serializeSignRequestSignerInputCustomValidation } from './signRequestSignerInputCustomValidation'; +import { deserializeSignRequestSignerInputCustomValidation } from './signRequestSignerInputCustomValidation'; +import { serializeSignRequestSignerInputZipValidation } from './signRequestSignerInputZipValidation'; +import { deserializeSignRequestSignerInputZipValidation } from './signRequestSignerInputZipValidation'; +import { serializeSignRequestSignerInputZip4Validation } from './signRequestSignerInputZip4Validation'; +import { deserializeSignRequestSignerInputZip4Validation } from './signRequestSignerInputZip4Validation'; +import { serializeSignRequestSignerInputSsnValidation } from './signRequestSignerInputSsnValidation'; +import { deserializeSignRequestSignerInputSsnValidation } from './signRequestSignerInputSsnValidation'; +import { serializeSignRequestSignerInputNumberWithPeriodValidation } from './signRequestSignerInputNumberWithPeriodValidation'; +import { deserializeSignRequestSignerInputNumberWithPeriodValidation } from './signRequestSignerInputNumberWithPeriodValidation'; +import { serializeSignRequestSignerInputNumberWithCommaValidation } from './signRequestSignerInputNumberWithCommaValidation'; +import { deserializeSignRequestSignerInputNumberWithCommaValidation } from './signRequestSignerInputNumberWithCommaValidation'; +import { serializeSignRequestSignerInputDateIsoValidation } from './signRequestSignerInputDateIsoValidation'; +import { deserializeSignRequestSignerInputDateIsoValidation } from './signRequestSignerInputDateIsoValidation'; +import { serializeSignRequestSignerInputDateUsValidation } from './signRequestSignerInputDateUsValidation'; +import { deserializeSignRequestSignerInputDateUsValidation } from './signRequestSignerInputDateUsValidation'; +import { serializeSignRequestSignerInputDateEuValidation } from './signRequestSignerInputDateEuValidation'; +import { deserializeSignRequestSignerInputDateEuValidation } from './signRequestSignerInputDateEuValidation'; +import { serializeSignRequestSignerInputDateAsiaValidation } from './signRequestSignerInputDateAsiaValidation'; +import { deserializeSignRequestSignerInputDateAsiaValidation } from './signRequestSignerInputDateAsiaValidation'; import { serializeSignRequestPrefillTag } from './signRequestPrefillTag'; import { deserializeSignRequestPrefillTag } from './signRequestPrefillTag'; +import { serializeSignRequestSignerInputValidation } from './signRequestSignerInputValidation'; +import { deserializeSignRequestSignerInputValidation } from './signRequestSignerInputValidation'; import { Date } from '../internal/utils'; +import { SignRequestSignerInputEmailValidation } from './signRequestSignerInputEmailValidation'; +import { SignRequestSignerInputCustomValidation } from './signRequestSignerInputCustomValidation'; +import { SignRequestSignerInputZipValidation } from './signRequestSignerInputZipValidation'; +import { SignRequestSignerInputZip4Validation } from './signRequestSignerInputZip4Validation'; +import { SignRequestSignerInputSsnValidation } from './signRequestSignerInputSsnValidation'; +import { SignRequestSignerInputNumberWithPeriodValidation } from './signRequestSignerInputNumberWithPeriodValidation'; +import { SignRequestSignerInputNumberWithCommaValidation } from './signRequestSignerInputNumberWithCommaValidation'; +import { SignRequestSignerInputDateIsoValidation } from './signRequestSignerInputDateIsoValidation'; +import { SignRequestSignerInputDateUsValidation } from './signRequestSignerInputDateUsValidation'; +import { SignRequestSignerInputDateEuValidation } from './signRequestSignerInputDateEuValidation'; +import { SignRequestSignerInputDateAsiaValidation } from './signRequestSignerInputDateAsiaValidation'; import { SignRequestPrefillTag } from './signRequestPrefillTag'; +import { SignRequestSignerInputValidation } from './signRequestSignerInputValidation'; import { BoxSdkError } from '../box/errors'; import { SerializedData } from '../serialization/json'; import { sdIsEmpty } from '../serialization/json'; @@ -47,8 +83,12 @@ export type SignRequestSignerInput = SignRequestPrefillTag & { * Index of page that the input is on. */ readonly pageIndex: number; /** - * Whether this input was defined as read-only(immutable by signers) or not. */ + * Indicates whether this input is read-only (cannot be modified by signers). */ readonly readOnly?: boolean; + /** + * Specifies the formatting rules that signers must follow for text field inputs. + * If set, this validation is mandatory. */ + readonly validation?: SignRequestSignerInputValidation; }; export function serializeSignRequestSignerInputTypeField( val: SignRequestSignerInputTypeField @@ -162,6 +202,10 @@ export function serializeSignRequestSignerInput( : serializeSignRequestSignerInputContentTypeField(val.contentType), ['page_index']: val.pageIndex, ['read_only']: val.readOnly, + ['validation']: + val.validation == void 0 + ? val.validation + : serializeSignRequestSignerInputValidation(val.validation), }, }; } @@ -202,6 +246,10 @@ export function deserializeSignRequestSignerInput( } const readOnly: undefined | boolean = val.read_only == void 0 ? void 0 : val.read_only; + const validation: SignRequestSignerInputValidation | undefined = + val.validation == void 0 + ? void 0 + : deserializeSignRequestSignerInputValidation(val.validation); if (!(val.document_tag_id == void 0) && !sdIsString(val.document_tag_id)) { throw new BoxSdkError({ message: @@ -239,6 +287,7 @@ export function deserializeSignRequestSignerInput( contentType: contentType, pageIndex: pageIndex, readOnly: readOnly, + validation: validation, documentTagId: documentTagId, textValue: textValue, checkboxValue: checkboxValue, diff --git a/src/sdk-gen/schemas/signRequestSignerInputCustomValidation.ts b/src/sdk-gen/schemas/signRequestSignerInputCustomValidation.ts new file mode 100644 index 000000000..fbb05e06d --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputCustomValidation.ts @@ -0,0 +1,199 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputCustomValidationValidationTypeField = + | 'custom' + | string; +export class SignRequestSignerInputCustomValidation { + /** + * Defines the validation format for the text input as custom. + * A custom regular expression is used for validation. */ + readonly validationType: SignRequestSignerInputCustomValidationValidationTypeField = + 'custom' as SignRequestSignerInputCustomValidationValidationTypeField; + /** + * Regular expression used for validation. */ + readonly customRegex!: string | null; + /** + * Error message shown if input fails custom regular expression validation. */ + readonly customErrorMessage!: string | null; + readonly rawData?: SerializedData; + constructor( + fields: Omit & + Partial> + ) { + if (fields.validationType !== undefined) { + this.validationType = fields.validationType; + } + if (fields.customRegex !== undefined) { + this.customRegex = fields.customRegex; + } + if (fields.customErrorMessage !== undefined) { + this.customErrorMessage = fields.customErrorMessage; + } + if (fields.rawData !== undefined) { + this.rawData = fields.rawData; + } + } +} +export interface SignRequestSignerInputCustomValidationInput { + /** + * Defines the validation format for the text input as custom. + * A custom regular expression is used for validation. */ + readonly validationType?: SignRequestSignerInputCustomValidationValidationTypeField; + /** + * Regular expression used for validation. */ + readonly customRegex: string | null; + /** + * Error message shown if input fails custom regular expression validation. */ + readonly customErrorMessage: string | null; + readonly rawData?: SerializedData; +} +export function serializeSignRequestSignerInputCustomValidationValidationTypeField( + val: SignRequestSignerInputCustomValidationValidationTypeField +): SerializedData { + return val; +} +export function deserializeSignRequestSignerInputCustomValidationValidationTypeField( + val: SerializedData +): SignRequestSignerInputCustomValidationValidationTypeField { + if (val == 'custom') { + return val; + } + if (sdIsString(val)) { + return val; + } + throw new BoxSdkError({ + message: + "Can't deserialize SignRequestSignerInputCustomValidationValidationTypeField", + }); +} +export function serializeSignRequestSignerInputCustomValidation( + val: SignRequestSignerInputCustomValidation +): SerializedData { + return { + ['validation_type']: + serializeSignRequestSignerInputCustomValidationValidationTypeField( + val.validationType + ), + ['custom_regex']: val.customRegex, + ['custom_error_message']: val.customErrorMessage, + }; +} +export function deserializeSignRequestSignerInputCustomValidation( + val: SerializedData +): SignRequestSignerInputCustomValidation { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestSignerInputCustomValidation"', + }); + } + if (val.validation_type == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "validation_type" of type "SignRequestSignerInputCustomValidation" to be defined', + }); + } + const validationType: SignRequestSignerInputCustomValidationValidationTypeField = + deserializeSignRequestSignerInputCustomValidationValidationTypeField( + val.validation_type + ); + if (val.custom_regex == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "custom_regex" of type "SignRequestSignerInputCustomValidation" to be defined', + }); + } + if (!sdIsString(val.custom_regex)) { + throw new BoxSdkError({ + message: + 'Expecting string for "custom_regex" of type "SignRequestSignerInputCustomValidation"', + }); + } + const customRegex: string = val.custom_regex; + if (val.custom_error_message == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "custom_error_message" of type "SignRequestSignerInputCustomValidation" to be defined', + }); + } + if (!sdIsString(val.custom_error_message)) { + throw new BoxSdkError({ + message: + 'Expecting string for "custom_error_message" of type "SignRequestSignerInputCustomValidation"', + }); + } + const customErrorMessage: string = val.custom_error_message; + return { + validationType: validationType, + customRegex: customRegex, + customErrorMessage: customErrorMessage, + } satisfies SignRequestSignerInputCustomValidation; +} +export function serializeSignRequestSignerInputCustomValidationInput( + val: SignRequestSignerInputCustomValidationInput +): SerializedData { + return { + ['validationType']: + val.validationType == void 0 + ? val.validationType + : serializeSignRequestSignerInputCustomValidationValidationTypeField( + val.validationType + ), + ['custom_regex']: val.customRegex, + ['custom_error_message']: val.customErrorMessage, + }; +} +export function deserializeSignRequestSignerInputCustomValidationInput( + val: SerializedData +): SignRequestSignerInputCustomValidationInput { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: + 'Expecting a map for "SignRequestSignerInputCustomValidationInput"', + }); + } + const validationType: + | undefined + | SignRequestSignerInputCustomValidationValidationTypeField = + val.validationType == void 0 + ? void 0 + : deserializeSignRequestSignerInputCustomValidationValidationTypeField( + val.validationType + ); + if (val.custom_regex == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "custom_regex" of type "SignRequestSignerInputCustomValidationInput" to be defined', + }); + } + if (!sdIsString(val.custom_regex)) { + throw new BoxSdkError({ + message: + 'Expecting string for "custom_regex" of type "SignRequestSignerInputCustomValidationInput"', + }); + } + const customRegex: string = val.custom_regex; + if (val.custom_error_message == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "custom_error_message" of type "SignRequestSignerInputCustomValidationInput" to be defined', + }); + } + if (!sdIsString(val.custom_error_message)) { + throw new BoxSdkError({ + message: + 'Expecting string for "custom_error_message" of type "SignRequestSignerInputCustomValidationInput"', + }); + } + const customErrorMessage: string = val.custom_error_message; + return { + validationType: validationType, + customRegex: customRegex, + customErrorMessage: customErrorMessage, + } satisfies SignRequestSignerInputCustomValidationInput; +} diff --git a/src/sdk-gen/schemas/signRequestSignerInputDateAsiaValidation.ts b/src/sdk-gen/schemas/signRequestSignerInputDateAsiaValidation.ts new file mode 100644 index 000000000..d1987d624 --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputDateAsiaValidation.ts @@ -0,0 +1,68 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputDateAsiaValidationValidationTypeField = + | 'date_asia' + | string; +export interface SignRequestSignerInputDateAsiaValidation { + /** + * Validates that the text input uses the Asian date format `YYYY/MM/DD`. */ + readonly validationType?: SignRequestSignerInputDateAsiaValidationValidationTypeField; + readonly rawData?: SerializedData; +} +export function serializeSignRequestSignerInputDateAsiaValidationValidationTypeField( + val: SignRequestSignerInputDateAsiaValidationValidationTypeField +): SerializedData { + return val; +} +export function deserializeSignRequestSignerInputDateAsiaValidationValidationTypeField( + val: SerializedData +): SignRequestSignerInputDateAsiaValidationValidationTypeField { + if (val == 'date_asia') { + return val; + } + if (sdIsString(val)) { + return val; + } + throw new BoxSdkError({ + message: + "Can't deserialize SignRequestSignerInputDateAsiaValidationValidationTypeField", + }); +} +export function serializeSignRequestSignerInputDateAsiaValidation( + val: SignRequestSignerInputDateAsiaValidation +): SerializedData { + return { + ['validation_type']: + val.validationType == void 0 + ? val.validationType + : serializeSignRequestSignerInputDateAsiaValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputDateAsiaValidation( + val: SerializedData +): SignRequestSignerInputDateAsiaValidation { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestSignerInputDateAsiaValidation"', + }); + } + const validationType: + | undefined + | SignRequestSignerInputDateAsiaValidationValidationTypeField = + val.validation_type == void 0 + ? void 0 + : deserializeSignRequestSignerInputDateAsiaValidationValidationTypeField( + val.validation_type + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputDateAsiaValidation; +} diff --git a/src/sdk-gen/schemas/signRequestSignerInputDateEuValidation.ts b/src/sdk-gen/schemas/signRequestSignerInputDateEuValidation.ts new file mode 100644 index 000000000..6f72207a8 --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputDateEuValidation.ts @@ -0,0 +1,68 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputDateEuValidationValidationTypeField = + | 'date_eu' + | string; +export interface SignRequestSignerInputDateEuValidation { + /** + * Validates that the text input uses the European date format `DD/MM/YYYY`. */ + readonly validationType?: SignRequestSignerInputDateEuValidationValidationTypeField; + readonly rawData?: SerializedData; +} +export function serializeSignRequestSignerInputDateEuValidationValidationTypeField( + val: SignRequestSignerInputDateEuValidationValidationTypeField +): SerializedData { + return val; +} +export function deserializeSignRequestSignerInputDateEuValidationValidationTypeField( + val: SerializedData +): SignRequestSignerInputDateEuValidationValidationTypeField { + if (val == 'date_eu') { + return val; + } + if (sdIsString(val)) { + return val; + } + throw new BoxSdkError({ + message: + "Can't deserialize SignRequestSignerInputDateEuValidationValidationTypeField", + }); +} +export function serializeSignRequestSignerInputDateEuValidation( + val: SignRequestSignerInputDateEuValidation +): SerializedData { + return { + ['validation_type']: + val.validationType == void 0 + ? val.validationType + : serializeSignRequestSignerInputDateEuValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputDateEuValidation( + val: SerializedData +): SignRequestSignerInputDateEuValidation { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestSignerInputDateEuValidation"', + }); + } + const validationType: + | undefined + | SignRequestSignerInputDateEuValidationValidationTypeField = + val.validation_type == void 0 + ? void 0 + : deserializeSignRequestSignerInputDateEuValidationValidationTypeField( + val.validation_type + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputDateEuValidation; +} diff --git a/src/sdk-gen/schemas/signRequestSignerInputDateIsoValidation.ts b/src/sdk-gen/schemas/signRequestSignerInputDateIsoValidation.ts new file mode 100644 index 000000000..a2f7ea239 --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputDateIsoValidation.ts @@ -0,0 +1,68 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputDateIsoValidationValidationTypeField = + | 'date_iso' + | string; +export interface SignRequestSignerInputDateIsoValidation { + /** + * Validates that the text input uses the ISO date format `YYYY-MM-DD`. */ + readonly validationType?: SignRequestSignerInputDateIsoValidationValidationTypeField; + readonly rawData?: SerializedData; +} +export function serializeSignRequestSignerInputDateIsoValidationValidationTypeField( + val: SignRequestSignerInputDateIsoValidationValidationTypeField +): SerializedData { + return val; +} +export function deserializeSignRequestSignerInputDateIsoValidationValidationTypeField( + val: SerializedData +): SignRequestSignerInputDateIsoValidationValidationTypeField { + if (val == 'date_iso') { + return val; + } + if (sdIsString(val)) { + return val; + } + throw new BoxSdkError({ + message: + "Can't deserialize SignRequestSignerInputDateIsoValidationValidationTypeField", + }); +} +export function serializeSignRequestSignerInputDateIsoValidation( + val: SignRequestSignerInputDateIsoValidation +): SerializedData { + return { + ['validation_type']: + val.validationType == void 0 + ? val.validationType + : serializeSignRequestSignerInputDateIsoValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputDateIsoValidation( + val: SerializedData +): SignRequestSignerInputDateIsoValidation { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestSignerInputDateIsoValidation"', + }); + } + const validationType: + | undefined + | SignRequestSignerInputDateIsoValidationValidationTypeField = + val.validation_type == void 0 + ? void 0 + : deserializeSignRequestSignerInputDateIsoValidationValidationTypeField( + val.validation_type + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputDateIsoValidation; +} diff --git a/src/sdk-gen/schemas/signRequestSignerInputDateUsValidation.ts b/src/sdk-gen/schemas/signRequestSignerInputDateUsValidation.ts new file mode 100644 index 000000000..d737a3ae0 --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputDateUsValidation.ts @@ -0,0 +1,68 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputDateUsValidationValidationTypeField = + | 'date_us' + | string; +export interface SignRequestSignerInputDateUsValidation { + /** + * Validates that the text input uses the US date format `MM/DD/YYYY`. */ + readonly validationType?: SignRequestSignerInputDateUsValidationValidationTypeField; + readonly rawData?: SerializedData; +} +export function serializeSignRequestSignerInputDateUsValidationValidationTypeField( + val: SignRequestSignerInputDateUsValidationValidationTypeField +): SerializedData { + return val; +} +export function deserializeSignRequestSignerInputDateUsValidationValidationTypeField( + val: SerializedData +): SignRequestSignerInputDateUsValidationValidationTypeField { + if (val == 'date_us') { + return val; + } + if (sdIsString(val)) { + return val; + } + throw new BoxSdkError({ + message: + "Can't deserialize SignRequestSignerInputDateUsValidationValidationTypeField", + }); +} +export function serializeSignRequestSignerInputDateUsValidation( + val: SignRequestSignerInputDateUsValidation +): SerializedData { + return { + ['validation_type']: + val.validationType == void 0 + ? val.validationType + : serializeSignRequestSignerInputDateUsValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputDateUsValidation( + val: SerializedData +): SignRequestSignerInputDateUsValidation { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestSignerInputDateUsValidation"', + }); + } + const validationType: + | undefined + | SignRequestSignerInputDateUsValidationValidationTypeField = + val.validation_type == void 0 + ? void 0 + : deserializeSignRequestSignerInputDateUsValidationValidationTypeField( + val.validation_type + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputDateUsValidation; +} diff --git a/src/sdk-gen/schemas/signRequestSignerInputEmailValidation.ts b/src/sdk-gen/schemas/signRequestSignerInputEmailValidation.ts new file mode 100644 index 000000000..b0fa88ed6 --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputEmailValidation.ts @@ -0,0 +1,119 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputEmailValidationValidationTypeField = + | 'email' + | string; +export class SignRequestSignerInputEmailValidation { + /** + * Validates that the text input is an email address. */ + readonly validationType: SignRequestSignerInputEmailValidationValidationTypeField = + 'email' as SignRequestSignerInputEmailValidationValidationTypeField; + readonly rawData?: SerializedData; + constructor( + fields: Omit & + Partial> + ) { + if (fields.validationType !== undefined) { + this.validationType = fields.validationType; + } + if (fields.rawData !== undefined) { + this.rawData = fields.rawData; + } + } +} +export interface SignRequestSignerInputEmailValidationInput { + /** + * Validates that the text input is an email address. */ + readonly validationType?: SignRequestSignerInputEmailValidationValidationTypeField; + readonly rawData?: SerializedData; +} +export function serializeSignRequestSignerInputEmailValidationValidationTypeField( + val: SignRequestSignerInputEmailValidationValidationTypeField +): SerializedData { + return val; +} +export function deserializeSignRequestSignerInputEmailValidationValidationTypeField( + val: SerializedData +): SignRequestSignerInputEmailValidationValidationTypeField { + if (val == 'email') { + return val; + } + if (sdIsString(val)) { + return val; + } + throw new BoxSdkError({ + message: + "Can't deserialize SignRequestSignerInputEmailValidationValidationTypeField", + }); +} +export function serializeSignRequestSignerInputEmailValidation( + val: SignRequestSignerInputEmailValidation +): SerializedData { + return { + ['validation_type']: + serializeSignRequestSignerInputEmailValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputEmailValidation( + val: SerializedData +): SignRequestSignerInputEmailValidation { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestSignerInputEmailValidation"', + }); + } + if (val.validation_type == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "validation_type" of type "SignRequestSignerInputEmailValidation" to be defined', + }); + } + const validationType: SignRequestSignerInputEmailValidationValidationTypeField = + deserializeSignRequestSignerInputEmailValidationValidationTypeField( + val.validation_type + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputEmailValidation; +} +export function serializeSignRequestSignerInputEmailValidationInput( + val: SignRequestSignerInputEmailValidationInput +): SerializedData { + return { + ['validationType']: + val.validationType == void 0 + ? val.validationType + : serializeSignRequestSignerInputEmailValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputEmailValidationInput( + val: SerializedData +): SignRequestSignerInputEmailValidationInput { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: + 'Expecting a map for "SignRequestSignerInputEmailValidationInput"', + }); + } + const validationType: + | undefined + | SignRequestSignerInputEmailValidationValidationTypeField = + val.validationType == void 0 + ? void 0 + : deserializeSignRequestSignerInputEmailValidationValidationTypeField( + val.validationType + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputEmailValidationInput; +} diff --git a/src/sdk-gen/schemas/signRequestSignerInputNumberWithCommaValidation.ts b/src/sdk-gen/schemas/signRequestSignerInputNumberWithCommaValidation.ts new file mode 100644 index 000000000..b7d4e7195 --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputNumberWithCommaValidation.ts @@ -0,0 +1,69 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputNumberWithCommaValidationValidationTypeField = + | 'number_with_comma' + | string; +export interface SignRequestSignerInputNumberWithCommaValidation { + /** + * Validates that the text input uses a number format with a comma as the decimal separator (for example, 1,23). */ + readonly validationType?: SignRequestSignerInputNumberWithCommaValidationValidationTypeField; + readonly rawData?: SerializedData; +} +export function serializeSignRequestSignerInputNumberWithCommaValidationValidationTypeField( + val: SignRequestSignerInputNumberWithCommaValidationValidationTypeField +): SerializedData { + return val; +} +export function deserializeSignRequestSignerInputNumberWithCommaValidationValidationTypeField( + val: SerializedData +): SignRequestSignerInputNumberWithCommaValidationValidationTypeField { + if (val == 'number_with_comma') { + return val; + } + if (sdIsString(val)) { + return val; + } + throw new BoxSdkError({ + message: + "Can't deserialize SignRequestSignerInputNumberWithCommaValidationValidationTypeField", + }); +} +export function serializeSignRequestSignerInputNumberWithCommaValidation( + val: SignRequestSignerInputNumberWithCommaValidation +): SerializedData { + return { + ['validation_type']: + val.validationType == void 0 + ? val.validationType + : serializeSignRequestSignerInputNumberWithCommaValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputNumberWithCommaValidation( + val: SerializedData +): SignRequestSignerInputNumberWithCommaValidation { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: + 'Expecting a map for "SignRequestSignerInputNumberWithCommaValidation"', + }); + } + const validationType: + | undefined + | SignRequestSignerInputNumberWithCommaValidationValidationTypeField = + val.validation_type == void 0 + ? void 0 + : deserializeSignRequestSignerInputNumberWithCommaValidationValidationTypeField( + val.validation_type + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputNumberWithCommaValidation; +} diff --git a/src/sdk-gen/schemas/signRequestSignerInputNumberWithPeriodValidation.ts b/src/sdk-gen/schemas/signRequestSignerInputNumberWithPeriodValidation.ts new file mode 100644 index 000000000..2a3664fc5 --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputNumberWithPeriodValidation.ts @@ -0,0 +1,68 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputNumberWithPeriodValidationValidationTypeField = + 'number_with_period' | string; +export interface SignRequestSignerInputNumberWithPeriodValidation { + /** + * Validates that the text input uses a number format with a period as the decimal separator (for example, 1.23). */ + readonly validationType?: SignRequestSignerInputNumberWithPeriodValidationValidationTypeField; + readonly rawData?: SerializedData; +} +export function serializeSignRequestSignerInputNumberWithPeriodValidationValidationTypeField( + val: SignRequestSignerInputNumberWithPeriodValidationValidationTypeField +): SerializedData { + return val; +} +export function deserializeSignRequestSignerInputNumberWithPeriodValidationValidationTypeField( + val: SerializedData +): SignRequestSignerInputNumberWithPeriodValidationValidationTypeField { + if (val == 'number_with_period') { + return val; + } + if (sdIsString(val)) { + return val; + } + throw new BoxSdkError({ + message: + "Can't deserialize SignRequestSignerInputNumberWithPeriodValidationValidationTypeField", + }); +} +export function serializeSignRequestSignerInputNumberWithPeriodValidation( + val: SignRequestSignerInputNumberWithPeriodValidation +): SerializedData { + return { + ['validation_type']: + val.validationType == void 0 + ? val.validationType + : serializeSignRequestSignerInputNumberWithPeriodValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputNumberWithPeriodValidation( + val: SerializedData +): SignRequestSignerInputNumberWithPeriodValidation { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: + 'Expecting a map for "SignRequestSignerInputNumberWithPeriodValidation"', + }); + } + const validationType: + | undefined + | SignRequestSignerInputNumberWithPeriodValidationValidationTypeField = + val.validation_type == void 0 + ? void 0 + : deserializeSignRequestSignerInputNumberWithPeriodValidationValidationTypeField( + val.validation_type + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputNumberWithPeriodValidation; +} diff --git a/src/sdk-gen/schemas/signRequestSignerInputSsnValidation.ts b/src/sdk-gen/schemas/signRequestSignerInputSsnValidation.ts new file mode 100644 index 000000000..5174dced0 --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputSsnValidation.ts @@ -0,0 +1,118 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputSsnValidationValidationTypeField = + | 'ssn' + | string; +export class SignRequestSignerInputSsnValidation { + /** + * Validates that the text input is a Social Security Number (SSN). */ + readonly validationType: SignRequestSignerInputSsnValidationValidationTypeField = + 'ssn' as SignRequestSignerInputSsnValidationValidationTypeField; + readonly rawData?: SerializedData; + constructor( + fields: Omit & + Partial> + ) { + if (fields.validationType !== undefined) { + this.validationType = fields.validationType; + } + if (fields.rawData !== undefined) { + this.rawData = fields.rawData; + } + } +} +export interface SignRequestSignerInputSsnValidationInput { + /** + * Validates that the text input is a Social Security Number (SSN). */ + readonly validationType?: SignRequestSignerInputSsnValidationValidationTypeField; + readonly rawData?: SerializedData; +} +export function serializeSignRequestSignerInputSsnValidationValidationTypeField( + val: SignRequestSignerInputSsnValidationValidationTypeField +): SerializedData { + return val; +} +export function deserializeSignRequestSignerInputSsnValidationValidationTypeField( + val: SerializedData +): SignRequestSignerInputSsnValidationValidationTypeField { + if (val == 'ssn') { + return val; + } + if (sdIsString(val)) { + return val; + } + throw new BoxSdkError({ + message: + "Can't deserialize SignRequestSignerInputSsnValidationValidationTypeField", + }); +} +export function serializeSignRequestSignerInputSsnValidation( + val: SignRequestSignerInputSsnValidation +): SerializedData { + return { + ['validation_type']: + serializeSignRequestSignerInputSsnValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputSsnValidation( + val: SerializedData +): SignRequestSignerInputSsnValidation { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestSignerInputSsnValidation"', + }); + } + if (val.validation_type == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "validation_type" of type "SignRequestSignerInputSsnValidation" to be defined', + }); + } + const validationType: SignRequestSignerInputSsnValidationValidationTypeField = + deserializeSignRequestSignerInputSsnValidationValidationTypeField( + val.validation_type + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputSsnValidation; +} +export function serializeSignRequestSignerInputSsnValidationInput( + val: SignRequestSignerInputSsnValidationInput +): SerializedData { + return { + ['validationType']: + val.validationType == void 0 + ? val.validationType + : serializeSignRequestSignerInputSsnValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputSsnValidationInput( + val: SerializedData +): SignRequestSignerInputSsnValidationInput { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestSignerInputSsnValidationInput"', + }); + } + const validationType: + | undefined + | SignRequestSignerInputSsnValidationValidationTypeField = + val.validationType == void 0 + ? void 0 + : deserializeSignRequestSignerInputSsnValidationValidationTypeField( + val.validationType + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputSsnValidationInput; +} diff --git a/src/sdk-gen/schemas/signRequestSignerInputValidation.ts b/src/sdk-gen/schemas/signRequestSignerInputValidation.ts new file mode 100644 index 000000000..1e5cda012 --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputValidation.ts @@ -0,0 +1,253 @@ +import { serializeSignRequestSignerInputEmailValidation } from './signRequestSignerInputEmailValidation'; +import { deserializeSignRequestSignerInputEmailValidation } from './signRequestSignerInputEmailValidation'; +import { serializeSignRequestSignerInputCustomValidation } from './signRequestSignerInputCustomValidation'; +import { deserializeSignRequestSignerInputCustomValidation } from './signRequestSignerInputCustomValidation'; +import { serializeSignRequestSignerInputZipValidation } from './signRequestSignerInputZipValidation'; +import { deserializeSignRequestSignerInputZipValidation } from './signRequestSignerInputZipValidation'; +import { serializeSignRequestSignerInputZip4Validation } from './signRequestSignerInputZip4Validation'; +import { deserializeSignRequestSignerInputZip4Validation } from './signRequestSignerInputZip4Validation'; +import { serializeSignRequestSignerInputSsnValidation } from './signRequestSignerInputSsnValidation'; +import { deserializeSignRequestSignerInputSsnValidation } from './signRequestSignerInputSsnValidation'; +import { serializeSignRequestSignerInputNumberWithPeriodValidation } from './signRequestSignerInputNumberWithPeriodValidation'; +import { deserializeSignRequestSignerInputNumberWithPeriodValidation } from './signRequestSignerInputNumberWithPeriodValidation'; +import { serializeSignRequestSignerInputNumberWithCommaValidation } from './signRequestSignerInputNumberWithCommaValidation'; +import { deserializeSignRequestSignerInputNumberWithCommaValidation } from './signRequestSignerInputNumberWithCommaValidation'; +import { serializeSignRequestSignerInputDateIsoValidation } from './signRequestSignerInputDateIsoValidation'; +import { deserializeSignRequestSignerInputDateIsoValidation } from './signRequestSignerInputDateIsoValidation'; +import { serializeSignRequestSignerInputDateUsValidation } from './signRequestSignerInputDateUsValidation'; +import { deserializeSignRequestSignerInputDateUsValidation } from './signRequestSignerInputDateUsValidation'; +import { serializeSignRequestSignerInputDateEuValidation } from './signRequestSignerInputDateEuValidation'; +import { deserializeSignRequestSignerInputDateEuValidation } from './signRequestSignerInputDateEuValidation'; +import { serializeSignRequestSignerInputDateAsiaValidation } from './signRequestSignerInputDateAsiaValidation'; +import { deserializeSignRequestSignerInputDateAsiaValidation } from './signRequestSignerInputDateAsiaValidation'; +import { SignRequestSignerInputEmailValidation } from './signRequestSignerInputEmailValidation'; +import { SignRequestSignerInputCustomValidation } from './signRequestSignerInputCustomValidation'; +import { SignRequestSignerInputZipValidation } from './signRequestSignerInputZipValidation'; +import { SignRequestSignerInputZip4Validation } from './signRequestSignerInputZip4Validation'; +import { SignRequestSignerInputSsnValidation } from './signRequestSignerInputSsnValidation'; +import { SignRequestSignerInputNumberWithPeriodValidation } from './signRequestSignerInputNumberWithPeriodValidation'; +import { SignRequestSignerInputNumberWithCommaValidation } from './signRequestSignerInputNumberWithCommaValidation'; +import { SignRequestSignerInputDateIsoValidation } from './signRequestSignerInputDateIsoValidation'; +import { SignRequestSignerInputDateUsValidation } from './signRequestSignerInputDateUsValidation'; +import { SignRequestSignerInputDateEuValidation } from './signRequestSignerInputDateEuValidation'; +import { SignRequestSignerInputDateAsiaValidation } from './signRequestSignerInputDateAsiaValidation'; +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputValidation = + | SignRequestSignerInputEmailValidation + | SignRequestSignerInputCustomValidation + | SignRequestSignerInputZipValidation + | SignRequestSignerInputZip4Validation + | SignRequestSignerInputSsnValidation + | SignRequestSignerInputNumberWithPeriodValidation + | SignRequestSignerInputNumberWithCommaValidation + | SignRequestSignerInputDateIsoValidation + | SignRequestSignerInputDateUsValidation + | SignRequestSignerInputDateEuValidation + | SignRequestSignerInputDateAsiaValidation; +export function serializeSignRequestSignerInputValidation( + val: any +): SerializedData { + try { + if (val.validationType == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "validationType" of type "SignRequestSignerInputEmailValidation" to be defined', + }); + } + return serializeSignRequestSignerInputEmailValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + if (val.validationType == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "validationType" of type "SignRequestSignerInputCustomValidation" to be defined', + }); + } + if (val.customRegex == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "customRegex" of type "SignRequestSignerInputCustomValidation" to be defined', + }); + } + if (!sdIsString(val.customRegex)) { + throw new BoxSdkError({ + message: + 'Expecting string for "customRegex" of type "SignRequestSignerInputCustomValidation"', + }); + } + if (val.customErrorMessage == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "customErrorMessage" of type "SignRequestSignerInputCustomValidation" to be defined', + }); + } + if (!sdIsString(val.customErrorMessage)) { + throw new BoxSdkError({ + message: + 'Expecting string for "customErrorMessage" of type "SignRequestSignerInputCustomValidation"', + }); + } + return serializeSignRequestSignerInputCustomValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + if (val.validationType == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "validationType" of type "SignRequestSignerInputZipValidation" to be defined', + }); + } + return serializeSignRequestSignerInputZipValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + if (val.validationType == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "validationType" of type "SignRequestSignerInputZip4Validation" to be defined', + }); + } + return serializeSignRequestSignerInputZip4Validation(val); + } catch (error) { + void 0; + } finally { + } + try { + if (val.validationType == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "validationType" of type "SignRequestSignerInputSsnValidation" to be defined', + }); + } + return serializeSignRequestSignerInputSsnValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return serializeSignRequestSignerInputNumberWithPeriodValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return serializeSignRequestSignerInputNumberWithCommaValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return serializeSignRequestSignerInputDateIsoValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return serializeSignRequestSignerInputDateUsValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return serializeSignRequestSignerInputDateEuValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return serializeSignRequestSignerInputDateAsiaValidation(val); + } catch (error) { + void 0; + } finally { + } + throw new BoxSdkError({ + message: "Can't serialize SignRequestSignerInputValidation", + }); +} +export function deserializeSignRequestSignerInputValidation( + val: SerializedData +): SignRequestSignerInputValidation { + try { + return deserializeSignRequestSignerInputEmailValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return deserializeSignRequestSignerInputCustomValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return deserializeSignRequestSignerInputZipValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return deserializeSignRequestSignerInputZip4Validation(val); + } catch (error) { + void 0; + } finally { + } + try { + return deserializeSignRequestSignerInputSsnValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return deserializeSignRequestSignerInputNumberWithPeriodValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return deserializeSignRequestSignerInputNumberWithCommaValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return deserializeSignRequestSignerInputDateIsoValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return deserializeSignRequestSignerInputDateUsValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return deserializeSignRequestSignerInputDateEuValidation(val); + } catch (error) { + void 0; + } finally { + } + try { + return deserializeSignRequestSignerInputDateAsiaValidation(val); + } catch (error) { + void 0; + } finally { + } + throw new BoxSdkError({ + message: "Can't deserialize SignRequestSignerInputValidation", + }); +} diff --git a/src/sdk-gen/schemas/signRequestSignerInputZip4Validation.ts b/src/sdk-gen/schemas/signRequestSignerInputZip4Validation.ts new file mode 100644 index 000000000..cdda86651 --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputZip4Validation.ts @@ -0,0 +1,119 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputZip4ValidationValidationTypeField = + | 'zip_4' + | string; +export class SignRequestSignerInputZip4Validation { + /** + * Validates that the text input is a ZIP+4 code. */ + readonly validationType: SignRequestSignerInputZip4ValidationValidationTypeField = + 'zip_4' as SignRequestSignerInputZip4ValidationValidationTypeField; + readonly rawData?: SerializedData; + constructor( + fields: Omit & + Partial> + ) { + if (fields.validationType !== undefined) { + this.validationType = fields.validationType; + } + if (fields.rawData !== undefined) { + this.rawData = fields.rawData; + } + } +} +export interface SignRequestSignerInputZip4ValidationInput { + /** + * Validates that the text input is a ZIP+4 code. */ + readonly validationType?: SignRequestSignerInputZip4ValidationValidationTypeField; + readonly rawData?: SerializedData; +} +export function serializeSignRequestSignerInputZip4ValidationValidationTypeField( + val: SignRequestSignerInputZip4ValidationValidationTypeField +): SerializedData { + return val; +} +export function deserializeSignRequestSignerInputZip4ValidationValidationTypeField( + val: SerializedData +): SignRequestSignerInputZip4ValidationValidationTypeField { + if (val == 'zip_4') { + return val; + } + if (sdIsString(val)) { + return val; + } + throw new BoxSdkError({ + message: + "Can't deserialize SignRequestSignerInputZip4ValidationValidationTypeField", + }); +} +export function serializeSignRequestSignerInputZip4Validation( + val: SignRequestSignerInputZip4Validation +): SerializedData { + return { + ['validation_type']: + serializeSignRequestSignerInputZip4ValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputZip4Validation( + val: SerializedData +): SignRequestSignerInputZip4Validation { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestSignerInputZip4Validation"', + }); + } + if (val.validation_type == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "validation_type" of type "SignRequestSignerInputZip4Validation" to be defined', + }); + } + const validationType: SignRequestSignerInputZip4ValidationValidationTypeField = + deserializeSignRequestSignerInputZip4ValidationValidationTypeField( + val.validation_type + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputZip4Validation; +} +export function serializeSignRequestSignerInputZip4ValidationInput( + val: SignRequestSignerInputZip4ValidationInput +): SerializedData { + return { + ['validationType']: + val.validationType == void 0 + ? val.validationType + : serializeSignRequestSignerInputZip4ValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputZip4ValidationInput( + val: SerializedData +): SignRequestSignerInputZip4ValidationInput { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: + 'Expecting a map for "SignRequestSignerInputZip4ValidationInput"', + }); + } + const validationType: + | undefined + | SignRequestSignerInputZip4ValidationValidationTypeField = + val.validationType == void 0 + ? void 0 + : deserializeSignRequestSignerInputZip4ValidationValidationTypeField( + val.validationType + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputZip4ValidationInput; +} diff --git a/src/sdk-gen/schemas/signRequestSignerInputZipValidation.ts b/src/sdk-gen/schemas/signRequestSignerInputZipValidation.ts new file mode 100644 index 000000000..2913536a4 --- /dev/null +++ b/src/sdk-gen/schemas/signRequestSignerInputZipValidation.ts @@ -0,0 +1,118 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export type SignRequestSignerInputZipValidationValidationTypeField = + | 'zip' + | string; +export class SignRequestSignerInputZipValidation { + /** + * Validates that the text input is a ZIP code. */ + readonly validationType: SignRequestSignerInputZipValidationValidationTypeField = + 'zip' as SignRequestSignerInputZipValidationValidationTypeField; + readonly rawData?: SerializedData; + constructor( + fields: Omit & + Partial> + ) { + if (fields.validationType !== undefined) { + this.validationType = fields.validationType; + } + if (fields.rawData !== undefined) { + this.rawData = fields.rawData; + } + } +} +export interface SignRequestSignerInputZipValidationInput { + /** + * Validates that the text input is a ZIP code. */ + readonly validationType?: SignRequestSignerInputZipValidationValidationTypeField; + readonly rawData?: SerializedData; +} +export function serializeSignRequestSignerInputZipValidationValidationTypeField( + val: SignRequestSignerInputZipValidationValidationTypeField +): SerializedData { + return val; +} +export function deserializeSignRequestSignerInputZipValidationValidationTypeField( + val: SerializedData +): SignRequestSignerInputZipValidationValidationTypeField { + if (val == 'zip') { + return val; + } + if (sdIsString(val)) { + return val; + } + throw new BoxSdkError({ + message: + "Can't deserialize SignRequestSignerInputZipValidationValidationTypeField", + }); +} +export function serializeSignRequestSignerInputZipValidation( + val: SignRequestSignerInputZipValidation +): SerializedData { + return { + ['validation_type']: + serializeSignRequestSignerInputZipValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputZipValidation( + val: SerializedData +): SignRequestSignerInputZipValidation { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestSignerInputZipValidation"', + }); + } + if (val.validation_type == void 0) { + throw new BoxSdkError({ + message: + 'Expecting "validation_type" of type "SignRequestSignerInputZipValidation" to be defined', + }); + } + const validationType: SignRequestSignerInputZipValidationValidationTypeField = + deserializeSignRequestSignerInputZipValidationValidationTypeField( + val.validation_type + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputZipValidation; +} +export function serializeSignRequestSignerInputZipValidationInput( + val: SignRequestSignerInputZipValidationInput +): SerializedData { + return { + ['validationType']: + val.validationType == void 0 + ? val.validationType + : serializeSignRequestSignerInputZipValidationValidationTypeField( + val.validationType + ), + }; +} +export function deserializeSignRequestSignerInputZipValidationInput( + val: SerializedData +): SignRequestSignerInputZipValidationInput { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestSignerInputZipValidationInput"', + }); + } + const validationType: + | undefined + | SignRequestSignerInputZipValidationValidationTypeField = + val.validationType == void 0 + ? void 0 + : deserializeSignRequestSignerInputZipValidationValidationTypeField( + val.validationType + ); + return { + validationType: validationType, + } satisfies SignRequestSignerInputZipValidationInput; +} diff --git a/src/sdk-gen/schemas/templateSignerInput.ts b/src/sdk-gen/schemas/templateSignerInput.ts index b039a8330..92b871623 100644 --- a/src/sdk-gen/schemas/templateSignerInput.ts +++ b/src/sdk-gen/schemas/templateSignerInput.ts @@ -1,9 +1,45 @@ import { serializeDate } from '../internal/utils'; import { deserializeDate } from '../internal/utils'; +import { serializeSignRequestSignerInputEmailValidation } from './signRequestSignerInputEmailValidation'; +import { deserializeSignRequestSignerInputEmailValidation } from './signRequestSignerInputEmailValidation'; +import { serializeSignRequestSignerInputCustomValidation } from './signRequestSignerInputCustomValidation'; +import { deserializeSignRequestSignerInputCustomValidation } from './signRequestSignerInputCustomValidation'; +import { serializeSignRequestSignerInputZipValidation } from './signRequestSignerInputZipValidation'; +import { deserializeSignRequestSignerInputZipValidation } from './signRequestSignerInputZipValidation'; +import { serializeSignRequestSignerInputZip4Validation } from './signRequestSignerInputZip4Validation'; +import { deserializeSignRequestSignerInputZip4Validation } from './signRequestSignerInputZip4Validation'; +import { serializeSignRequestSignerInputSsnValidation } from './signRequestSignerInputSsnValidation'; +import { deserializeSignRequestSignerInputSsnValidation } from './signRequestSignerInputSsnValidation'; +import { serializeSignRequestSignerInputNumberWithPeriodValidation } from './signRequestSignerInputNumberWithPeriodValidation'; +import { deserializeSignRequestSignerInputNumberWithPeriodValidation } from './signRequestSignerInputNumberWithPeriodValidation'; +import { serializeSignRequestSignerInputNumberWithCommaValidation } from './signRequestSignerInputNumberWithCommaValidation'; +import { deserializeSignRequestSignerInputNumberWithCommaValidation } from './signRequestSignerInputNumberWithCommaValidation'; +import { serializeSignRequestSignerInputDateIsoValidation } from './signRequestSignerInputDateIsoValidation'; +import { deserializeSignRequestSignerInputDateIsoValidation } from './signRequestSignerInputDateIsoValidation'; +import { serializeSignRequestSignerInputDateUsValidation } from './signRequestSignerInputDateUsValidation'; +import { deserializeSignRequestSignerInputDateUsValidation } from './signRequestSignerInputDateUsValidation'; +import { serializeSignRequestSignerInputDateEuValidation } from './signRequestSignerInputDateEuValidation'; +import { deserializeSignRequestSignerInputDateEuValidation } from './signRequestSignerInputDateEuValidation'; +import { serializeSignRequestSignerInputDateAsiaValidation } from './signRequestSignerInputDateAsiaValidation'; +import { deserializeSignRequestSignerInputDateAsiaValidation } from './signRequestSignerInputDateAsiaValidation'; import { serializeSignRequestPrefillTag } from './signRequestPrefillTag'; import { deserializeSignRequestPrefillTag } from './signRequestPrefillTag'; +import { serializeSignRequestSignerInputValidation } from './signRequestSignerInputValidation'; +import { deserializeSignRequestSignerInputValidation } from './signRequestSignerInputValidation'; import { Date } from '../internal/utils'; +import { SignRequestSignerInputEmailValidation } from './signRequestSignerInputEmailValidation'; +import { SignRequestSignerInputCustomValidation } from './signRequestSignerInputCustomValidation'; +import { SignRequestSignerInputZipValidation } from './signRequestSignerInputZipValidation'; +import { SignRequestSignerInputZip4Validation } from './signRequestSignerInputZip4Validation'; +import { SignRequestSignerInputSsnValidation } from './signRequestSignerInputSsnValidation'; +import { SignRequestSignerInputNumberWithPeriodValidation } from './signRequestSignerInputNumberWithPeriodValidation'; +import { SignRequestSignerInputNumberWithCommaValidation } from './signRequestSignerInputNumberWithCommaValidation'; +import { SignRequestSignerInputDateIsoValidation } from './signRequestSignerInputDateIsoValidation'; +import { SignRequestSignerInputDateUsValidation } from './signRequestSignerInputDateUsValidation'; +import { SignRequestSignerInputDateEuValidation } from './signRequestSignerInputDateEuValidation'; +import { SignRequestSignerInputDateAsiaValidation } from './signRequestSignerInputDateAsiaValidation'; import { SignRequestPrefillTag } from './signRequestPrefillTag'; +import { SignRequestSignerInputValidation } from './signRequestSignerInputValidation'; import { BoxSdkError } from '../box/errors'; import { SerializedData } from '../serialization/json'; import { sdIsEmpty } from '../serialization/json'; @@ -90,8 +126,12 @@ export type TemplateSignerInput = SignRequestPrefillTag & { * The label field is used especially for text, attachment, radio, and checkbox type inputs. */ readonly label?: string | null; /** - * Whether this input was defined as read-only(immutable by signers) or not. */ + * Indicates whether this input is read-only (cannot be modified by signers). */ readonly readOnly?: boolean; + /** + * Specifies the formatting rules that signers must follow for text field inputs. + * If set, this validation is mandatory. */ + readonly validation?: SignRequestSignerInputValidation; }; export function serializeTemplateSignerInputTypeField( val: TemplateSignerInputTypeField @@ -287,6 +327,10 @@ export function serializeTemplateSignerInput( : serializeTemplateSignerInputDimensionsField(val.dimensions), ['label']: val.label, ['read_only']: val.readOnly, + ['validation']: + val.validation == void 0 + ? val.validation + : serializeSignRequestSignerInputValidation(val.validation), }, }; } @@ -383,6 +427,10 @@ export function deserializeTemplateSignerInput( } const readOnly: undefined | boolean = val.read_only == void 0 ? void 0 : val.read_only; + const validation: SignRequestSignerInputValidation | undefined = + val.validation == void 0 + ? void 0 + : deserializeSignRequestSignerInputValidation(val.validation); if (!(val.document_tag_id == void 0) && !sdIsString(val.document_tag_id)) { throw new BoxSdkError({ message: @@ -427,6 +475,7 @@ export function deserializeTemplateSignerInput( dimensions: dimensions, label: label, readOnly: readOnly, + validation: validation, documentTagId: documentTagId, textValue: textValue, checkboxValue: checkboxValue,