fix: remove unused parameter from SignRequest (box/box-openapi#489) (#411)

box-sdk-build · web-flow · commit 578d9b48da7e · 2024-12-20T14:57:03.000+01:00
diff --git a/.codegen.json b/.codegen.json
@@ -1 +1 @@
-{ "engineHash": "5604447", "specHash": "c9d7bb5", "version": "1.8.0" }
+{ "engineHash": "264bdc9", "specHash": "6886603", "version": "1.8.0" }
diff --git a/box_sdk_gen/managers/sign_requests.py b/box_sdk_gen/managers/sign_requests.py
@@ -245,7 +245,6 @@ def create_sign_request(
         prefill_tags: Optional[List[SignRequestPrefillTag]] = None,
         days_valid: Union[Optional[int], NullValue] = None,
         external_id: Union[Optional[str], NullValue] = None,
-        is_phone_verification_required_to_view: Union[Optional[bool], NullValue] = None,
         template_id: Union[Optional[str], NullValue] = None,
         external_system_name: Union[Optional[str], NullValue] = None,
         extra_headers: Optional[Dict[str, Optional[str]]] = None
@@ -290,8 +289,6 @@ def create_sign_request(
                 :type days_valid: Union[Optional[int], NullValue], optional
                 :param external_id: This can be used to reference an ID in an external system that the sign request is related to., defaults to None
                 :type external_id: Union[Optional[str], NullValue], optional
-                :param is_phone_verification_required_to_view: Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them., defaults to None
-                :type is_phone_verification_required_to_view: Union[Optional[bool], NullValue], optional
                 :param template_id: When a signature request is created from a template this field will indicate the id of that template., defaults to None
                 :type template_id: Union[Optional[str], NullValue], optional
                 :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None
@@ -317,7 +314,6 @@ def create_sign_request(
             'prefill_tags': prefill_tags,
             'days_valid': days_valid,
             'external_id': external_id,
-            'is_phone_verification_required_to_view': is_phone_verification_required_to_view,
             'template_id': template_id,
             'external_system_name': external_system_name,
         }
diff --git a/box_sdk_gen/schemas/event.py b/box_sdk_gen/schemas/event.py
@@ -69,6 +69,14 @@ class EventEventTypeField(str, Enum):
     DOWNLOAD = 'DOWNLOAD'
     EDIT = 'EDIT'
     EDIT_USER = 'EDIT_USER'
+    EDR_CROWDSTRIKE_DEVICE_DETECTED = 'EDR_CROWDSTRIKE_DEVICE_DETECTED'
+    EDR_CROWDSTRIKE_NO_BOX_TOOLS = 'EDR_CROWDSTRIKE_NO_BOX_TOOLS'
+    EDR_CROWDSTRIKE_BOX_TOOLS_OUTDATED = 'EDR_CROWDSTRIKE_BOX_TOOLS_OUTDATED'
+    EDR_CROWDSTRIKE_DRIVE_OUTDATED = 'EDR_CROWDSTRIKE_DRIVE_OUTDATED'
+    EDR_CROWDSTRIKE_ACCESS_ALLOWED_NO_CROWDSTRIKE_DEVICE = (
+        'EDR_CROWDSTRIKE_ACCESS_ALLOWED_NO_CROWDSTRIKE_DEVICE'
+    )
+    EDR_CROWDSTRIKE_ACCESS_REVOKED = 'EDR_CROWDSTRIKE_ACCESS_REVOKED'
     EMAIL_ALIAS_CONFIRM = 'EMAIL_ALIAS_CONFIRM'
     EMAIL_ALIAS_REMOVE = 'EMAIL_ALIAS_REMOVE'
     ENABLE_TWO_FACTOR_AUTH = 'ENABLE_TWO_FACTOR_AUTH'
diff --git a/box_sdk_gen/schemas/sign_request.py b/box_sdk_gen/schemas/sign_request.py
@@ -89,7 +89,6 @@ def __init__(
         prefill_tags: Optional[List[SignRequestPrefillTag]] = None,
         days_valid: Optional[int] = None,
         external_id: Optional[str] = None,
-        is_phone_verification_required_to_view: Optional[bool] = None,
         template_id: Optional[str] = None,
         external_system_name: Optional[str] = None,
         **kwargs
@@ -142,8 +141,6 @@ def __init__(
                 :type days_valid: Optional[int], optional
                 :param external_id: This can be used to reference an ID in an external system that the sign request is related to., defaults to None
                 :type external_id: Optional[str], optional
-                :param is_phone_verification_required_to_view: Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them., defaults to None
-                :type is_phone_verification_required_to_view: Optional[bool], optional
                 :param template_id: When a signature request is created from a template this field will indicate the id of that template., defaults to None
                 :type template_id: Optional[str], optional
                 :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None
@@ -161,7 +158,6 @@ def __init__(
             prefill_tags=prefill_tags,
             days_valid=days_valid,
             external_id=external_id,
-            is_phone_verification_required_to_view=is_phone_verification_required_to_view,
             template_id=template_id,
             external_system_name=external_system_name,
             **kwargs
diff --git a/box_sdk_gen/schemas/sign_request_base.py b/box_sdk_gen/schemas/sign_request_base.py
@@ -24,7 +24,6 @@ def __init__(
         prefill_tags: Optional[List[SignRequestPrefillTag]] = None,
         days_valid: Optional[int] = None,
         external_id: Optional[str] = None,
-        is_phone_verification_required_to_view: Optional[bool] = None,
         template_id: Optional[str] = None,
         external_system_name: Optional[str] = None,
         **kwargs
@@ -52,8 +51,6 @@ def __init__(
         :type days_valid: Optional[int], optional
         :param external_id: This can be used to reference an ID in an external system that the sign request is related to., defaults to None
         :type external_id: Optional[str], optional
-        :param is_phone_verification_required_to_view: Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them., defaults to None
-        :type is_phone_verification_required_to_view: Optional[bool], optional
         :param template_id: When a signature request is created from a template this field will indicate the id of that template., defaults to None
         :type template_id: Optional[str], optional
         :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None
@@ -71,8 +68,5 @@ def __init__(
         self.prefill_tags = prefill_tags
         self.days_valid = days_valid
         self.external_id = external_id
-        self.is_phone_verification_required_to_view = (
-            is_phone_verification_required_to_view
-        )
         self.template_id = template_id
         self.external_system_name = external_system_name
diff --git a/box_sdk_gen/schemas/sign_request_create_request.py b/box_sdk_gen/schemas/sign_request_create_request.py
@@ -42,7 +42,6 @@ def __init__(
         prefill_tags: Optional[List[SignRequestPrefillTag]] = None,
         days_valid: Optional[int] = None,
         external_id: Optional[str] = None,
-        is_phone_verification_required_to_view: Optional[bool] = None,
         template_id: Optional[str] = None,
         external_system_name: Optional[str] = None,
         **kwargs
@@ -83,8 +82,6 @@ def __init__(
                 :type days_valid: Optional[int], optional
                 :param external_id: This can be used to reference an ID in an external system that the sign request is related to., defaults to None
                 :type external_id: Optional[str], optional
-                :param is_phone_verification_required_to_view: Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them., defaults to None
-                :type is_phone_verification_required_to_view: Optional[bool], optional
                 :param template_id: When a signature request is created from a template this field will indicate the id of that template., defaults to None
                 :type template_id: Optional[str], optional
                 :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None
@@ -102,7 +99,6 @@ def __init__(
             prefill_tags=prefill_tags,
             days_valid=days_valid,
             external_id=external_id,
-            is_phone_verification_required_to_view=is_phone_verification_required_to_view,
             template_id=template_id,
             external_system_name=external_system_name,
             **kwargs
diff --git a/box_sdk_gen/schemas/sign_request_create_signer.py b/box_sdk_gen/schemas/sign_request_create_signer.py
@@ -25,7 +25,6 @@ def __init__(
         redirect_url: Optional[str] = None,
         declined_redirect_url: Optional[str] = None,
         login_required: Optional[bool] = None,
-        verification_phone_number: Optional[str] = None,
         password: Optional[str] = None,
         signer_group_id: Optional[str] = None,
         suppress_notifications: Optional[bool] = None,
@@ -63,13 +62,8 @@ def __init__(
                 :param login_required: If set to true, the signer will need to log in to a Box account
         before signing the request. If the signer does not have
         an existing account, they will have the option to create
-        a free Box account. Cannot be selected in combination with
-        `verification_phone_number`., defaults to None
+        a free Box account., defaults to None
                 :type login_required: Optional[bool], optional
-                :param verification_phone_number: If set, this phone number will be used to verify the signer
-        via two-factor authentication before they are able to sign the document.
-        Cannot be selected in combination with `login_required`., defaults to None
-                :type verification_phone_number: Optional[str], optional
                 :param password: If set, the signer is required to enter the password before they are able
         to sign a document. This field is write only., defaults to None
                 :type password: Optional[str], optional
@@ -93,7 +87,6 @@ def __init__(
         self.redirect_url = redirect_url
         self.declined_redirect_url = declined_redirect_url
         self.login_required = login_required
-        self.verification_phone_number = verification_phone_number
         self.password = password
         self.signer_group_id = signer_group_id
         self.suppress_notifications = suppress_notifications
diff --git a/box_sdk_gen/schemas/sign_request_signer.py b/box_sdk_gen/schemas/sign_request_signer.py
@@ -66,7 +66,6 @@ def __init__(
         redirect_url: Optional[str] = None,
         declined_redirect_url: Optional[str] = None,
         login_required: Optional[bool] = None,
-        verification_phone_number: Optional[str] = None,
         password: Optional[str] = None,
         signer_group_id: Optional[str] = None,
         suppress_notifications: Optional[bool] = None,
@@ -117,13 +116,8 @@ def __init__(
                 :param login_required: If set to true, the signer will need to log in to a Box account
         before signing the request. If the signer does not have
         an existing account, they will have the option to create
-        a free Box account. Cannot be selected in combination with
-        `verification_phone_number`., defaults to None
+        a free Box account., defaults to None
                 :type login_required: Optional[bool], optional
-                :param verification_phone_number: If set, this phone number will be used to verify the signer
-        via two-factor authentication before they are able to sign the document.
-        Cannot be selected in combination with `login_required`., defaults to None
-                :type verification_phone_number: Optional[str], optional
                 :param password: If set, the signer is required to enter the password before they are able
         to sign a document. This field is write only., defaults to None
                 :type password: Optional[str], optional
@@ -147,7 +141,6 @@ def __init__(
             redirect_url=redirect_url,
             declined_redirect_url=declined_redirect_url,
             login_required=login_required,
-            verification_phone_number=verification_phone_number,
             password=password,
             signer_group_id=signer_group_id,
             suppress_notifications=suppress_notifications,
diff --git a/docs/sign_requests.md b/docs/sign_requests.md
@@ -173,8 +173,6 @@ client.sign_requests.create_sign_request(
   - Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.
 - external_id `Optional[str]`
   - This can be used to reference an ID in an external system that the sign request is related to.
-- is_phone_verification_required_to_view `Optional[bool]`
-  - Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them.
 - template_id `Optional[str]`
   - When a signature request is created from a template this field will indicate the id of that template.
 - external_system_name `Optional[str]`
diff --git a/test/sign_requests.py b/test/sign_requests.py
@@ -71,7 +71,6 @@ def testCreateGetCancelAndListSignRequest():
         ],
         days_valid=30,
         external_id='123',
-        is_phone_verification_required_to_view=False,
         external_system_name='BoxSignIntegration',
     )
     assert created_sign_request.are_reminders_enabled == True
@@ -83,7 +82,6 @@ def testCreateGetCancelAndListSignRequest():
     assert created_sign_request.external_id == '123'
     assert created_sign_request.external_system_name == 'BoxSignIntegration'
     assert created_sign_request.is_document_preparation_needed == False
-    assert created_sign_request.is_phone_verification_required_to_view == False
     assert created_sign_request.name == 'Sign Request'
     assert created_sign_request.redirect_url == 'https://www.box.com'
     assert created_sign_request.sign_files.files[0].name == file_to_sign.name

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{ "engineHash": "5604447", "specHash": "c9d7bb5", "version": "1.8.0" }`
	`1`	`+{ "engineHash": "264bdc9", "specHash": "6886603", "version": "1.8.0" }`