feat: add verification_method field to Sign Request signer schemas (box/box-openapi#626)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "0068c55", "specHash": "74452eb", "version": "10.18.0" }
+{ "engineHash": "0068c55", "specHash": "33e4656", "version": "10.18.0" }

box_sdk_gen/schemas/__init__.py

@@ -306,14 +306,10 @@
 
 from box_sdk_gen.schemas.sign_request_cancel_request import *
 
-from box_sdk_gen.schemas.sign_request_create_signer import *
-
 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 *
@@ -344,20 +340,26 @@
 
 from box_sdk_gen.schemas.template_signer_input import *
 
-from box_sdk_gen.schemas.template_signer import *
+from box_sdk_gen.schemas.sign_request_signer_input import *
 
-from box_sdk_gen.schemas.sign_template import *
+from box_sdk_gen.schemas.sign_request_signer_verification_method_cac_piv import *
 
-from box_sdk_gen.schemas.sign_templates import *
+from box_sdk_gen.schemas.sign_request_signer_verification_method_login import *
 
-from box_sdk_gen.schemas.sign_request_signer_input import *
+from box_sdk_gen.schemas.sign_request_signer_verification_method_phone_sms import *
+
+from box_sdk_gen.schemas.sign_request_signer_verification_method import *
+
+from box_sdk_gen.schemas.sign_request_create_signer import *
 
 from box_sdk_gen.schemas.sign_request_signer import *
 
 from box_sdk_gen.schemas.sign_request import *
 
 from box_sdk_gen.schemas.sign_requests import *
 
+from box_sdk_gen.schemas.sign_request_create_request import *
+
 from box_sdk_gen.schemas.status_skill_card import *
 
 from box_sdk_gen.schemas.storage_policy_mini import *
@@ -370,6 +372,20 @@
 
 from box_sdk_gen.schemas.storage_policies import *
 
+from box_sdk_gen.schemas.template_signer_verification_method_cac_piv import *
+
+from box_sdk_gen.schemas.template_signer_verification_method_login import *
+
+from box_sdk_gen.schemas.template_signer_verification_method_phone_sms import *
+
+from box_sdk_gen.schemas.template_signer_verification_method import *
+
+from box_sdk_gen.schemas.template_signer import *
+
+from box_sdk_gen.schemas.sign_template import *
+
+from box_sdk_gen.schemas.sign_templates import *
+
 from box_sdk_gen.schemas.terms_of_service_base import *
 
 from box_sdk_gen.schemas.terms_of_service import *

box_sdk_gen/schemas/sign_request_create_signer.py

@@ -4,6 +4,22 @@
 
 from box_sdk_gen.internal.base_object import BaseObject
 
+from box_sdk_gen.schemas.sign_request_signer_verification_method_login import (
+    SignRequestSignerVerificationMethodLogin,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_verification_method_phone_sms import (
+    SignRequestSignerVerificationMethodPhoneSms,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_verification_method_cac_piv import (
+    SignRequestSignerVerificationMethodCacPiv,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_verification_method import (
+    SignRequestSignerVerificationMethod,
+)
+
 from box_sdk_gen.box.errors import BoxSDKError
 
 
@@ -30,6 +46,7 @@ def __init__(
         signer_group_id: Optional[str] = None,
         suppress_notifications: Optional[bool] = None,
         language: Optional[str] = None,
+        verification_method: Optional[SignRequestSignerVerificationMethod] = None,
         **kwargs
     ):
         """
@@ -88,6 +105,8 @@ def __init__(
                 :param language: The language of the user, formatted in modified version of the
         [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format., defaults to None
                 :type language: Optional[str], optional
+                :param verification_method: The verification method for the signer., defaults to None
+                :type verification_method: Optional[SignRequestSignerVerificationMethod], optional
         """
         super().__init__(**kwargs)
         self.email = email
@@ -103,3 +122,4 @@ def __init__(
         self.signer_group_id = signer_group_id
         self.suppress_notifications = suppress_notifications
         self.language = language
+        self.verification_method = verification_method

box_sdk_gen/schemas/sign_request_signer.py

@@ -10,6 +10,22 @@
     SignRequestCreateSignerRoleField,
 )
 
+from box_sdk_gen.schemas.sign_request_signer_verification_method_login import (
+    SignRequestSignerVerificationMethodLogin,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_verification_method_phone_sms import (
+    SignRequestSignerVerificationMethodPhoneSms,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_verification_method_cac_piv import (
+    SignRequestSignerVerificationMethodCacPiv,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_verification_method import (
+    SignRequestSignerVerificationMethod,
+)
+
 from box_sdk_gen.schemas.sign_request_create_signer import SignRequestCreateSigner
 
 from box_sdk_gen.schemas.sign_request_signer_input import SignRequestSignerInput
@@ -76,6 +92,7 @@ def __init__(
         signer_group_id: Optional[str] = None,
         suppress_notifications: Optional[bool] = None,
         language: Optional[str] = None,
+        verification_method: Optional[SignRequestSignerVerificationMethod] = None,
         **kwargs
     ):
         """
@@ -149,6 +166,8 @@ def __init__(
                 :param language: The language of the user, formatted in modified version of the
         [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format., defaults to None
                 :type language: Optional[str], optional
+                :param verification_method: The verification method for the signer., defaults to None
+                :type verification_method: Optional[SignRequestSignerVerificationMethod], optional
         """
         super().__init__(
             email=email,
@@ -164,6 +183,7 @@ def __init__(
             signer_group_id=signer_group_id,
             suppress_notifications=suppress_notifications,
             language=language,
+            verification_method=verification_method,
             **kwargs
         )
         self.has_viewed_document = has_viewed_document

box_sdk_gen/schemas/sign_request_signer_verification_method.py

@@ -0,0 +1,21 @@
+from typing import Union
+
+from box_sdk_gen.schemas.sign_request_signer_verification_method_login import (
+    SignRequestSignerVerificationMethodLogin,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_verification_method_phone_sms import (
+    SignRequestSignerVerificationMethodPhoneSms,
+)
+
+from box_sdk_gen.schemas.sign_request_signer_verification_method_cac_piv import (
+    SignRequestSignerVerificationMethodCacPiv,
+)
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+SignRequestSignerVerificationMethod = Union[
+    SignRequestSignerVerificationMethodLogin,
+    SignRequestSignerVerificationMethodPhoneSms,
+    SignRequestSignerVerificationMethodCacPiv,
+]

box_sdk_gen/schemas/sign_request_signer_verification_method_cac_piv.py

@@ -0,0 +1,26 @@
+from enum import Enum
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class SignRequestSignerVerificationMethodCacPivTypeField(str, Enum):
+    CAC_PIV = 'cac_piv'
+
+
+class SignRequestSignerVerificationMethodCacPiv(BaseObject):
+    _discriminator = 'type', {'cac_piv'}
+
+    def __init__(
+        self,
+        *,
+        type: SignRequestSignerVerificationMethodCacPivTypeField = SignRequestSignerVerificationMethodCacPivTypeField.CAC_PIV,
+        **kwargs
+    ):
+        """
+        :param type: The type of verification method., defaults to SignRequestSignerVerificationMethodCacPivTypeField.CAC_PIV
+        :type type: SignRequestSignerVerificationMethodCacPivTypeField, optional
+        """
+        super().__init__(**kwargs)
+        self.type = type

box_sdk_gen/schemas/sign_request_signer_verification_method_login.py

@@ -0,0 +1,26 @@
+from enum import Enum
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class SignRequestSignerVerificationMethodLoginTypeField(str, Enum):
+    LOGIN = 'login'
+
+
+class SignRequestSignerVerificationMethodLogin(BaseObject):
+    _discriminator = 'type', {'login'}
+
+    def __init__(
+        self,
+        *,
+        type: SignRequestSignerVerificationMethodLoginTypeField = SignRequestSignerVerificationMethodLoginTypeField.LOGIN,
+        **kwargs
+    ):
+        """
+        :param type: The type of verification method., defaults to SignRequestSignerVerificationMethodLoginTypeField.LOGIN
+        :type type: SignRequestSignerVerificationMethodLoginTypeField, optional
+        """
+        super().__init__(**kwargs)
+        self.type = type

box_sdk_gen/schemas/sign_request_signer_verification_method_phone_sms.py

@@ -0,0 +1,30 @@
+from enum import Enum
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class SignRequestSignerVerificationMethodPhoneSmsTypeField(str, Enum):
+    PHONE = 'phone'
+
+
+class SignRequestSignerVerificationMethodPhoneSms(BaseObject):
+    _discriminator = 'type', {'phone'}
+
+    def __init__(
+        self,
+        phone_number: str,
+        *,
+        type: SignRequestSignerVerificationMethodPhoneSmsTypeField = SignRequestSignerVerificationMethodPhoneSmsTypeField.PHONE,
+        **kwargs
+    ):
+        """
+        :param phone_number: The phone number to where the message will be sent.
+        :type phone_number: str
+        :param type: The type of verification method., defaults to SignRequestSignerVerificationMethodPhoneSmsTypeField.PHONE
+        :type type: SignRequestSignerVerificationMethodPhoneSmsTypeField, optional
+        """
+        super().__init__(**kwargs)
+        self.phone_number = phone_number
+        self.type = type

box_sdk_gen/schemas/template_signer.py

@@ -6,8 +6,24 @@
 
 from box_sdk_gen.internal.base_object import BaseObject
 
+from box_sdk_gen.schemas.template_signer_verification_method_login import (
+    TemplateSignerVerificationMethodLogin,
+)
+
+from box_sdk_gen.schemas.template_signer_verification_method_phone_sms import (
+    TemplateSignerVerificationMethodPhoneSms,
+)
+
+from box_sdk_gen.schemas.template_signer_verification_method_cac_piv import (
+    TemplateSignerVerificationMethodCacPiv,
+)
+
 from box_sdk_gen.schemas.template_signer_input import TemplateSignerInput
 
+from box_sdk_gen.schemas.template_signer_verification_method import (
+    TemplateSignerVerificationMethod,
+)
+
 from box_sdk_gen.box.errors import BoxSDKError
 
 
@@ -32,6 +48,7 @@ def __init__(
         is_password_required: Optional[bool] = None,
         is_phone_number_required: Optional[bool] = None,
         login_required: Optional[bool] = None,
+        verification_method: Optional[TemplateSignerVerificationMethod] = None,
         **kwargs
     ):
         """
@@ -65,6 +82,8 @@ def __init__(
                 :type is_phone_number_required: Optional[bool], optional
                 :param login_required: If true, the signer is required to login to access the document., defaults to None
                 :type login_required: Optional[bool], optional
+                :param verification_method: The verification method for the signer., defaults to None
+                :type verification_method: Optional[TemplateSignerVerificationMethod], optional
         """
         super().__init__(**kwargs)
         self.inputs = inputs
@@ -78,3 +97,4 @@ def __init__(
         self.is_password_required = is_password_required
         self.is_phone_number_required = is_phone_number_required
         self.login_required = login_required
+        self.verification_method = verification_method

box_sdk_gen/schemas/template_signer_verification_method.py

@@ -0,0 +1,21 @@
+from typing import Union
+
+from box_sdk_gen.schemas.template_signer_verification_method_login import (
+    TemplateSignerVerificationMethodLogin,
+)
+
+from box_sdk_gen.schemas.template_signer_verification_method_phone_sms import (
+    TemplateSignerVerificationMethodPhoneSms,
+)
+
+from box_sdk_gen.schemas.template_signer_verification_method_cac_piv import (
+    TemplateSignerVerificationMethodCacPiv,
+)
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+TemplateSignerVerificationMethod = Union[
+    TemplateSignerVerificationMethodLogin,
+    TemplateSignerVerificationMethodPhoneSms,
+    TemplateSignerVerificationMethodCacPiv,
+]