Skip to content

Commit 974e9b3

Browse files
box-sdk-buildbox-sdk-build
box-sdk-build
and
box-sdk-build
authored
feat(boxsdkgen): text input validation for Box Sign (box/box-openapi#568) (#1245)
Co-authored-by: box-sdk-build <box-sdk-build@box.com>
1 parent 4371cf3 commit 974e9b3

16 files changed

Lines changed: 512 additions & 24 deletions

‎.codegen.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "f97463c", "specHash": "31c41d5", "version": "4.2.0" }
1+
{ "engineHash": "f97463c", "specHash": "b7abe0d", "version": "4.2.0" }

‎box_sdk_gen/schemas/__init__.py‎

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,36 @@
264264

265265
from box_sdk_gen.schemas.sign_request_prefill_tag import *
266266

267+
from box_sdk_gen.schemas.sign_request_base import *
268+
269+
from box_sdk_gen.schemas.sign_request_create_request import *
270+
271+
from box_sdk_gen.schemas.sign_request_signer_attachment import *
272+
273+
from box_sdk_gen.schemas.sign_request_signer_input_custom_validation import *
274+
275+
from box_sdk_gen.schemas.sign_request_signer_input_date_asia_validation import *
276+
277+
from box_sdk_gen.schemas.sign_request_signer_input_date_eu_validation import *
278+
279+
from box_sdk_gen.schemas.sign_request_signer_input_date_iso_validation import *
280+
281+
from box_sdk_gen.schemas.sign_request_signer_input_date_us_validation import *
282+
283+
from box_sdk_gen.schemas.sign_request_signer_input_email_validation import *
284+
285+
from box_sdk_gen.schemas.sign_request_signer_input_number_with_comma_validation import *
286+
287+
from box_sdk_gen.schemas.sign_request_signer_input_number_with_period_validation import *
288+
289+
from box_sdk_gen.schemas.sign_request_signer_input_ssn_validation import *
290+
291+
from box_sdk_gen.schemas.sign_request_signer_input_zip_4_validation import *
292+
293+
from box_sdk_gen.schemas.sign_request_signer_input_zip_validation import *
294+
295+
from box_sdk_gen.schemas.sign_request_signer_input_validation import *
296+
267297
from box_sdk_gen.schemas.template_signer_input import *
268298

269299
from box_sdk_gen.schemas.template_signer import *
@@ -274,12 +304,6 @@
274304

275305
from box_sdk_gen.schemas.sign_request_signer_input import *
276306

277-
from box_sdk_gen.schemas.sign_request_base import *
278-
279-
from box_sdk_gen.schemas.sign_request_create_request import *
280-
281-
from box_sdk_gen.schemas.sign_request_signer_attachment import *
282-
283307
from box_sdk_gen.schemas.sign_request_signer import *
284308

285309
from box_sdk_gen.schemas.sign_request import *

‎box_sdk_gen/schemas/sign_request_signer_input.py‎

Lines changed: 69 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,56 @@
44

55
from box_sdk_gen.internal.utils import Date
66

7+
from box_sdk_gen.schemas.sign_request_signer_input_email_validation import (
8+
SignRequestSignerInputEmailValidation,
9+
)
10+
11+
from box_sdk_gen.schemas.sign_request_signer_input_custom_validation import (
12+
SignRequestSignerInputCustomValidation,
13+
)
14+
15+
from box_sdk_gen.schemas.sign_request_signer_input_zip_validation import (
16+
SignRequestSignerInputZipValidation,
17+
)
18+
19+
from box_sdk_gen.schemas.sign_request_signer_input_zip_4_validation import (
20+
SignRequestSignerInputZip4Validation,
21+
)
22+
23+
from box_sdk_gen.schemas.sign_request_signer_input_ssn_validation import (
24+
SignRequestSignerInputSsnValidation,
25+
)
26+
27+
from box_sdk_gen.schemas.sign_request_signer_input_number_with_period_validation import (
28+
SignRequestSignerInputNumberWithPeriodValidation,
29+
)
30+
31+
from box_sdk_gen.schemas.sign_request_signer_input_number_with_comma_validation import (
32+
SignRequestSignerInputNumberWithCommaValidation,
33+
)
34+
35+
from box_sdk_gen.schemas.sign_request_signer_input_date_iso_validation import (
36+
SignRequestSignerInputDateIsoValidation,
37+
)
38+
39+
from box_sdk_gen.schemas.sign_request_signer_input_date_us_validation import (
40+
SignRequestSignerInputDateUsValidation,
41+
)
42+
43+
from box_sdk_gen.schemas.sign_request_signer_input_date_eu_validation import (
44+
SignRequestSignerInputDateEuValidation,
45+
)
46+
47+
from box_sdk_gen.schemas.sign_request_signer_input_date_asia_validation import (
48+
SignRequestSignerInputDateAsiaValidation,
49+
)
50+
751
from box_sdk_gen.schemas.sign_request_prefill_tag import SignRequestPrefillTag
852

53+
from box_sdk_gen.schemas.sign_request_signer_input_validation import (
54+
SignRequestSignerInputValidation,
55+
)
56+
957
from box_sdk_gen.box.errors import BoxSDKError
1058

1159

@@ -44,29 +92,33 @@ def __init__(
4492
type: Optional[SignRequestSignerInputTypeField] = None,
4593
content_type: Optional[SignRequestSignerInputContentTypeField] = None,
4694
read_only: Optional[bool] = None,
95+
validation: Optional[SignRequestSignerInputValidation] = None,
4796
document_tag_id: Optional[str] = None,
4897
text_value: Optional[str] = None,
4998
checkbox_value: Optional[bool] = None,
5099
date_value: Optional[Date] = None,
51100
**kwargs
52101
):
53102
"""
54-
:param page_index: Index of page that the input is on.
55-
:type page_index: int
56-
:param type: Type of input., defaults to None
57-
:type type: Optional[SignRequestSignerInputTypeField], optional
58-
:param content_type: Content type of input., defaults to None
59-
:type content_type: Optional[SignRequestSignerInputContentTypeField], optional
60-
:param read_only: Whether this input was defined as read-only(immutable by signers) or not., defaults to None
61-
:type read_only: Optional[bool], optional
62-
:param document_tag_id: This references the ID of a specific tag contained in a file of the signature request., defaults to None
63-
:type document_tag_id: Optional[str], optional
64-
:param text_value: Text prefill value., defaults to None
65-
:type text_value: Optional[str], optional
66-
:param checkbox_value: Checkbox prefill value., defaults to None
67-
:type checkbox_value: Optional[bool], optional
68-
:param date_value: Date prefill value., defaults to None
69-
:type date_value: Optional[Date], optional
103+
:param page_index: Index of page that the input is on.
104+
:type page_index: int
105+
:param type: Type of input., defaults to None
106+
:type type: Optional[SignRequestSignerInputTypeField], optional
107+
:param content_type: Content type of input., defaults to None
108+
:type content_type: Optional[SignRequestSignerInputContentTypeField], optional
109+
:param read_only: Indicates whether this input is read-only (cannot be modified by signers)., defaults to None
110+
:type read_only: Optional[bool], optional
111+
:param validation: Specifies the formatting rules that signers must follow for text field inputs.
112+
If set, this validation is mandatory., defaults to None
113+
:type validation: Optional[SignRequestSignerInputValidation], optional
114+
:param document_tag_id: This references the ID of a specific tag contained in a file of the signature request., defaults to None
115+
:type document_tag_id: Optional[str], optional
116+
:param text_value: Text prefill value., defaults to None
117+
:type text_value: Optional[str], optional
118+
:param checkbox_value: Checkbox prefill value., defaults to None
119+
:type checkbox_value: Optional[bool], optional
120+
:param date_value: Date prefill value., defaults to None
121+
:type date_value: Optional[Date], optional
70122
"""
71123
super().__init__(
72124
document_tag_id=document_tag_id,
@@ -79,3 +131,4 @@ def __init__(
79131
self.type = type
80132
self.content_type = content_type
81133
self.read_only = read_only
134+
self.validation = validation

‎box_sdk_gen/schemas/sign_request_signer_input_custom_validation.py‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
from enum import Enum
2+
3+
from box_sdk_gen.internal.base_object import BaseObject
4+
5+
from box_sdk_gen.box.errors import BoxSDKError
6+
7+
8+
class SignRequestSignerInputCustomValidationValidationTypeField(str, Enum):
9+
CUSTOM = 'custom'
10+
11+
12+
class SignRequestSignerInputCustomValidation(BaseObject):
13+
def __init__(
14+
self,
15+
custom_regex: str,
16+
custom_error_message: str,
17+
*,
18+
validation_type: SignRequestSignerInputCustomValidationValidationTypeField = SignRequestSignerInputCustomValidationValidationTypeField.CUSTOM,
19+
**kwargs
20+
):
21+
"""
22+
:param custom_regex: Regular expression used for validation.
23+
:type custom_regex: str
24+
:param custom_error_message: Error message shown if input fails custom regular expression validation.
25+
:type custom_error_message: str
26+
:param validation_type: Defines the validation format for the text input as custom.
27+
A custom regular expression is used for validation., defaults to SignRequestSignerInputCustomValidationValidationTypeField.CUSTOM
28+
:type validation_type: SignRequestSignerInputCustomValidationValidationTypeField, optional
29+
"""
30+
super().__init__(**kwargs)
31+
self.custom_regex = custom_regex
32+
self.custom_error_message = custom_error_message
33+
self.validation_type = validation_type

‎box_sdk_gen/schemas/sign_request_signer_input_date_asia_validation.py‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
from enum import Enum
2+
3+
from typing import Optional
4+
5+
from box_sdk_gen.internal.base_object import BaseObject
6+
7+
from box_sdk_gen.box.errors import BoxSDKError
8+
9+
10+
class SignRequestSignerInputDateAsiaValidationValidationTypeField(str, Enum):
11+
DATE_ASIA = 'date_asia'
12+
13+
14+
class SignRequestSignerInputDateAsiaValidation(BaseObject):
15+
def __init__(
16+
self,
17+
*,
18+
validation_type: Optional[
19+
SignRequestSignerInputDateAsiaValidationValidationTypeField
20+
] = None,
21+
**kwargs
22+
):
23+
"""
24+
:param validation_type: Validates that the text input uses the Asian date format `YYYY/MM/DD`., defaults to None
25+
:type validation_type: Optional[SignRequestSignerInputDateAsiaValidationValidationTypeField], optional
26+
"""
27+
super().__init__(**kwargs)
28+
self.validation_type = validation_type

‎box_sdk_gen/schemas/sign_request_signer_input_date_eu_validation.py‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
from enum import Enum
2+
3+
from typing import Optional
4+
5+
from box_sdk_gen.internal.base_object import BaseObject
6+
7+
from box_sdk_gen.box.errors import BoxSDKError
8+
9+
10+
class SignRequestSignerInputDateEuValidationValidationTypeField(str, Enum):
11+
DATE_EU = 'date_eu'
12+
13+
14+
class SignRequestSignerInputDateEuValidation(BaseObject):
15+
def __init__(
16+
self,
17+
*,
18+
validation_type: Optional[
19+
SignRequestSignerInputDateEuValidationValidationTypeField
20+
] = None,
21+
**kwargs
22+
):
23+
"""
24+
:param validation_type: Validates that the text input uses the European date format `DD/MM/YYYY`., defaults to None
25+
:type validation_type: Optional[SignRequestSignerInputDateEuValidationValidationTypeField], optional
26+
"""
27+
super().__init__(**kwargs)
28+
self.validation_type = validation_type

‎box_sdk_gen/schemas/sign_request_signer_input_date_iso_validation.py‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
from enum import Enum
2+
3+
from typing import Optional
4+
5+
from box_sdk_gen.internal.base_object import BaseObject
6+
7+
from box_sdk_gen.box.errors import BoxSDKError
8+
9+
10+
class SignRequestSignerInputDateIsoValidationValidationTypeField(str, Enum):
11+
DATE_ISO = 'date_iso'
12+
13+
14+
class SignRequestSignerInputDateIsoValidation(BaseObject):
15+
def __init__(
16+
self,
17+
*,
18+
validation_type: Optional[
19+
SignRequestSignerInputDateIsoValidationValidationTypeField
20+
] = None,
21+
**kwargs
22+
):
23+
"""
24+
:param validation_type: Validates that the text input uses the ISO date format `YYYY-MM-DD`., defaults to None
25+
:type validation_type: Optional[SignRequestSignerInputDateIsoValidationValidationTypeField], optional
26+
"""
27+
super().__init__(**kwargs)
28+
self.validation_type = validation_type

‎box_sdk_gen/schemas/sign_request_signer_input_date_us_validation.py‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
from enum import Enum
2+
3+
from typing import Optional
4+
5+
from box_sdk_gen.internal.base_object import BaseObject
6+
7+
from box_sdk_gen.box.errors import BoxSDKError
8+
9+
10+
class SignRequestSignerInputDateUsValidationValidationTypeField(str, Enum):
11+
DATE_US = 'date_us'
12+
13+
14+
class SignRequestSignerInputDateUsValidation(BaseObject):
15+
def __init__(
16+
self,
17+
*,
18+
validation_type: Optional[
19+
SignRequestSignerInputDateUsValidationValidationTypeField
20+
] = None,
21+
**kwargs
22+
):
23+
"""
24+
:param validation_type: Validates that the text input uses the US date format `MM/DD/YYYY`., defaults to None
25+
:type validation_type: Optional[SignRequestSignerInputDateUsValidationValidationTypeField], optional
26+
"""
27+
super().__init__(**kwargs)
28+
self.validation_type = validation_type

‎box_sdk_gen/schemas/sign_request_signer_input_email_validation.py‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
from enum import Enum
2+
3+
from box_sdk_gen.internal.base_object import BaseObject
4+
5+
from box_sdk_gen.box.errors import BoxSDKError
6+
7+
8+
class SignRequestSignerInputEmailValidationValidationTypeField(str, Enum):
9+
EMAIL = 'email'
10+
11+
12+
class SignRequestSignerInputEmailValidation(BaseObject):
13+
def __init__(
14+
self,
15+
*,
16+
validation_type: SignRequestSignerInputEmailValidationValidationTypeField = SignRequestSignerInputEmailValidationValidationTypeField.EMAIL,
17+
**kwargs
18+
):
19+
"""
20+
:param validation_type: Validates that the text input is an email address., defaults to SignRequestSignerInputEmailValidationValidationTypeField.EMAIL
21+
:type validation_type: SignRequestSignerInputEmailValidationValidationTypeField, optional
22+
"""
23+
super().__init__(**kwargs)
24+
self.validation_type = validation_type

‎box_sdk_gen/schemas/sign_request_signer_input_number_with_comma_validation.py‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
from enum import Enum
2+
3+
from typing import Optional
4+
5+
from box_sdk_gen.internal.base_object import BaseObject
6+
7+
from box_sdk_gen.box.errors import BoxSDKError
8+
9+
10+
class SignRequestSignerInputNumberWithCommaValidationValidationTypeField(str, Enum):
11+
NUMBER_WITH_COMMA = 'number_with_comma'
12+
13+
14+
class SignRequestSignerInputNumberWithCommaValidation(BaseObject):
15+
def __init__(
16+
self,
17+
*,
18+
validation_type: Optional[
19+
SignRequestSignerInputNumberWithCommaValidationValidationTypeField
20+
] = None,
21+
**kwargs
22+
):
23+
"""
24+
: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
25+
:type validation_type: Optional[SignRequestSignerInputNumberWithCommaValidationValidationTypeField], optional
26+
"""
27+
super().__init__(**kwargs)
28+
self.validation_type = validation_type

0 commit comments

Comments
 (0)