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

.codegen.json

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

box_sdk_gen/schemas/__init__.py

@@ -264,6 +264,36 @@
 
 from box_sdk_gen.schemas.sign_request_prefill_tag import *
 
+from box_sdk_gen.schemas.sign_request_base import *
+
+from box_sdk_gen.schemas.sign_request_create_request import *
+
+from box_sdk_gen.schemas.sign_request_signer_attachment import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_custom_validation import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_date_asia_validation import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_date_eu_validation import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_date_iso_validation import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_date_us_validation import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_email_validation import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_number_with_comma_validation import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_number_with_period_validation import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_ssn_validation import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_zip_4_validation import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_zip_validation import *
+
+from box_sdk_gen.schemas.sign_request_signer_input_validation import *
+
 from box_sdk_gen.schemas.template_signer_input import *
 
 from box_sdk_gen.schemas.template_signer import *
@@ -274,12 +304,6 @@
 
 from box_sdk_gen.schemas.sign_request_signer_input import *
 
-from box_sdk_gen.schemas.sign_request_base import *
-
-from box_sdk_gen.schemas.sign_request_create_request import *
-
-from box_sdk_gen.schemas.sign_request_signer_attachment import *
-
 from box_sdk_gen.schemas.sign_request_signer import *
 
 from box_sdk_gen.schemas.sign_request import *

box_sdk_gen/schemas/sign_request_signer_input.py

@@ -4,8 +4,56 @@
 
 from box_sdk_gen.internal.utils import Date
 
+from box_sdk_gen.schemas.sign_request_signer_input_email_validation import (
+    SignRequestSignerInputEmailValidation,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_input_custom_validation import (
+    SignRequestSignerInputCustomValidation,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_input_zip_validation import (
+    SignRequestSignerInputZipValidation,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_input_zip_4_validation import (
+    SignRequestSignerInputZip4Validation,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_input_ssn_validation import (
+    SignRequestSignerInputSsnValidation,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_input_number_with_period_validation import (
+    SignRequestSignerInputNumberWithPeriodValidation,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_input_number_with_comma_validation import (
+    SignRequestSignerInputNumberWithCommaValidation,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_input_date_iso_validation import (
+    SignRequestSignerInputDateIsoValidation,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_input_date_us_validation import (
+    SignRequestSignerInputDateUsValidation,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_input_date_eu_validation import (
+    SignRequestSignerInputDateEuValidation,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_input_date_asia_validation import (
+    SignRequestSignerInputDateAsiaValidation,
+)
+
 from box_sdk_gen.schemas.sign_request_prefill_tag import SignRequestPrefillTag
 
+from box_sdk_gen.schemas.sign_request_signer_input_validation import (
+    SignRequestSignerInputValidation,
+)
+
 from box_sdk_gen.box.errors import BoxSDKError
 
 
@@ -44,29 +92,33 @@ def __init__(
         type: Optional[SignRequestSignerInputTypeField] = None,
         content_type: Optional[SignRequestSignerInputContentTypeField] = None,
         read_only: Optional[bool] = None,
+        validation: Optional[SignRequestSignerInputValidation] = None,
         document_tag_id: Optional[str] = None,
         text_value: Optional[str] = None,
         checkbox_value: Optional[bool] = None,
         date_value: Optional[Date] = None,
         **kwargs
     ):
         """
-        :param page_index: Index of page that the input is on.
-        :type page_index: int
-        :param type: Type of input., defaults to None
-        :type type: Optional[SignRequestSignerInputTypeField], optional
-        :param content_type: Content type of input., defaults to None
-        :type content_type: Optional[SignRequestSignerInputContentTypeField], optional
-        :param read_only: Whether this input was defined as read-only(immutable by signers) or not., defaults to None
-        :type read_only: Optional[bool], optional
-        :param document_tag_id: This references the ID of a specific tag contained in a file of the signature request., defaults to None
-        :type document_tag_id: Optional[str], optional
-        :param text_value: Text prefill value., defaults to None
-        :type text_value: Optional[str], optional
-        :param checkbox_value: Checkbox prefill value., defaults to None
-        :type checkbox_value: Optional[bool], optional
-        :param date_value: Date prefill value., defaults to None
-        :type date_value: Optional[Date], optional
+                :param page_index: Index of page that the input is on.
+                :type page_index: int
+                :param type: Type of input., defaults to None
+                :type type: Optional[SignRequestSignerInputTypeField], optional
+                :param content_type: Content type of input., defaults to None
+                :type content_type: Optional[SignRequestSignerInputContentTypeField], optional
+                :param read_only: Indicates whether this input is read-only (cannot be modified by signers)., defaults to None
+                :type read_only: Optional[bool], optional
+                :param validation: Specifies the formatting rules that signers must follow for text field inputs.
+        If set, this validation is mandatory., defaults to None
+                :type validation: Optional[SignRequestSignerInputValidation], optional
+                :param document_tag_id: This references the ID of a specific tag contained in a file of the signature request., defaults to None
+                :type document_tag_id: Optional[str], optional
+                :param text_value: Text prefill value., defaults to None
+                :type text_value: Optional[str], optional
+                :param checkbox_value: Checkbox prefill value., defaults to None
+                :type checkbox_value: Optional[bool], optional
+                :param date_value: Date prefill value., defaults to None
+                :type date_value: Optional[Date], optional
         """
         super().__init__(
             document_tag_id=document_tag_id,
@@ -79,3 +131,4 @@ def __init__(
         self.type = type
         self.content_type = content_type
         self.read_only = read_only
+        self.validation = validation

box_sdk_gen/schemas/sign_request_signer_input_custom_validation.py

@@ -0,0 +1,33 @@
+from enum import Enum
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class SignRequestSignerInputCustomValidationValidationTypeField(str, Enum):
+    CUSTOM = 'custom'
+
+
+class SignRequestSignerInputCustomValidation(BaseObject):
+    def __init__(
+        self,
+        custom_regex: str,
+        custom_error_message: str,
+        *,
+        validation_type: SignRequestSignerInputCustomValidationValidationTypeField = SignRequestSignerInputCustomValidationValidationTypeField.CUSTOM,
+        **kwargs
+    ):
+        """
+                :param custom_regex: Regular expression used for validation.
+                :type custom_regex: str
+                :param custom_error_message: Error message shown if input fails custom regular expression validation.
+                :type custom_error_message: str
+                :param validation_type: Defines the validation format for the text input as custom.
+        A custom regular expression is used for validation., defaults to SignRequestSignerInputCustomValidationValidationTypeField.CUSTOM
+                :type validation_type: SignRequestSignerInputCustomValidationValidationTypeField, optional
+        """
+        super().__init__(**kwargs)
+        self.custom_regex = custom_regex
+        self.custom_error_message = custom_error_message
+        self.validation_type = validation_type

box_sdk_gen/schemas/sign_request_signer_input_date_asia_validation.py

@@ -0,0 +1,28 @@
+from enum import Enum
+
+from typing import Optional
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class SignRequestSignerInputDateAsiaValidationValidationTypeField(str, Enum):
+    DATE_ASIA = 'date_asia'
+
+
+class SignRequestSignerInputDateAsiaValidation(BaseObject):
+    def __init__(
+        self,
+        *,
+        validation_type: Optional[
+            SignRequestSignerInputDateAsiaValidationValidationTypeField
+        ] = None,
+        **kwargs
+    ):
+        """
+        :param validation_type: Validates that the text input uses the Asian date format `YYYY/MM/DD`., defaults to None
+        :type validation_type: Optional[SignRequestSignerInputDateAsiaValidationValidationTypeField], optional
+        """
+        super().__init__(**kwargs)
+        self.validation_type = validation_type

box_sdk_gen/schemas/sign_request_signer_input_date_eu_validation.py

@@ -0,0 +1,28 @@
+from enum import Enum
+
+from typing import Optional
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class SignRequestSignerInputDateEuValidationValidationTypeField(str, Enum):
+    DATE_EU = 'date_eu'
+
+
+class SignRequestSignerInputDateEuValidation(BaseObject):
+    def __init__(
+        self,
+        *,
+        validation_type: Optional[
+            SignRequestSignerInputDateEuValidationValidationTypeField
+        ] = None,
+        **kwargs
+    ):
+        """
+        :param validation_type: Validates that the text input uses the European date format `DD/MM/YYYY`., defaults to None
+        :type validation_type: Optional[SignRequestSignerInputDateEuValidationValidationTypeField], optional
+        """
+        super().__init__(**kwargs)
+        self.validation_type = validation_type

box_sdk_gen/schemas/sign_request_signer_input_date_iso_validation.py

@@ -0,0 +1,28 @@
+from enum import Enum
+
+from typing import Optional
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class SignRequestSignerInputDateIsoValidationValidationTypeField(str, Enum):
+    DATE_ISO = 'date_iso'
+
+
+class SignRequestSignerInputDateIsoValidation(BaseObject):
+    def __init__(
+        self,
+        *,
+        validation_type: Optional[
+            SignRequestSignerInputDateIsoValidationValidationTypeField
+        ] = None,
+        **kwargs
+    ):
+        """
+        :param validation_type: Validates that the text input uses the ISO date format `YYYY-MM-DD`., defaults to None
+        :type validation_type: Optional[SignRequestSignerInputDateIsoValidationValidationTypeField], optional
+        """
+        super().__init__(**kwargs)
+        self.validation_type = validation_type

box_sdk_gen/schemas/sign_request_signer_input_date_us_validation.py

@@ -0,0 +1,28 @@
+from enum import Enum
+
+from typing import Optional
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class SignRequestSignerInputDateUsValidationValidationTypeField(str, Enum):
+    DATE_US = 'date_us'
+
+
+class SignRequestSignerInputDateUsValidation(BaseObject):
+    def __init__(
+        self,
+        *,
+        validation_type: Optional[
+            SignRequestSignerInputDateUsValidationValidationTypeField
+        ] = None,
+        **kwargs
+    ):
+        """
+        :param validation_type: Validates that the text input uses the US date format `MM/DD/YYYY`., defaults to None
+        :type validation_type: Optional[SignRequestSignerInputDateUsValidationValidationTypeField], optional
+        """
+        super().__init__(**kwargs)
+        self.validation_type = validation_type

box_sdk_gen/schemas/sign_request_signer_input_email_validation.py

@@ -0,0 +1,24 @@
+from enum import Enum
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class SignRequestSignerInputEmailValidationValidationTypeField(str, Enum):
+    EMAIL = 'email'
+
+
+class SignRequestSignerInputEmailValidation(BaseObject):
+    def __init__(
+        self,
+        *,
+        validation_type: SignRequestSignerInputEmailValidationValidationTypeField = SignRequestSignerInputEmailValidationValidationTypeField.EMAIL,
+        **kwargs
+    ):
+        """
+        :param validation_type: Validates that the text input is an email address., defaults to SignRequestSignerInputEmailValidationValidationTypeField.EMAIL
+        :type validation_type: SignRequestSignerInputEmailValidationValidationTypeField, optional
+        """
+        super().__init__(**kwargs)
+        self.validation_type = validation_type

box_sdk_gen/schemas/sign_request_signer_input_number_with_comma_validation.py

@@ -0,0 +1,28 @@
+from enum import Enum
+
+from typing import Optional
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class SignRequestSignerInputNumberWithCommaValidationValidationTypeField(str, Enum):
+    NUMBER_WITH_COMMA = 'number_with_comma'
+
+
+class SignRequestSignerInputNumberWithCommaValidation(BaseObject):
+    def __init__(
+        self,
+        *,
+        validation_type: Optional[
+            SignRequestSignerInputNumberWithCommaValidationValidationTypeField
+        ] = None,
+        **kwargs
+    ):
+        """
+        :param validation_type: Validates that the text input uses a number format with a comma as the decimal separator (for example, 1,23)., defaults to None
+        :type validation_type: Optional[SignRequestSignerInputNumberWithCommaValidationValidationTypeField], optional
+        """
+        super().__init__(**kwargs)
+        self.validation_type = validation_type

box_sdk_gen/schemas/sign_request_signer_input_number_with_period_validation.py

@@ -0,0 +1,28 @@
+from enum import Enum
+
+from typing import Optional
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class SignRequestSignerInputNumberWithPeriodValidationValidationTypeField(str, Enum):
+    NUMBER_WITH_PERIOD = 'number_with_period'
+
+
+class SignRequestSignerInputNumberWithPeriodValidation(BaseObject):
+    def __init__(
+        self,
+        *,
+        validation_type: Optional[
+            SignRequestSignerInputNumberWithPeriodValidationValidationTypeField
+        ] = None,
+        **kwargs
+    ):
+        """
+        :param validation_type: Validates that the text input uses a number format with a period as the decimal separator (for example, 1.23)., defaults to None
+        :type validation_type: Optional[SignRequestSignerInputNumberWithPeriodValidationValidationTypeField], optional
+        """
+        super().__init__(**kwargs)
+        self.validation_type = validation_type