feat: text input validation for Box Sign (box/box-openapi#568)

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "f97463c", "specHash": "31c41d5", "version": "10.2.0" }
+{ "engineHash": "f97463c", "specHash": "b7abe0d", "version": "10.2.0" }

src/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';

src/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,

src/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<SignRequestSignerInputCustomValidation, 'validationType'> &
+      Partial<Pick<SignRequestSignerInputCustomValidation, 'validationType'>>,
+  ) {
+    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;
+}

src/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;
+}