diff --git a/.codegen.json b/.codegen.json index c173bd7..edf1b3f 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "3eadef2", "specHash": "f26f46d", "version": "0.6.5" } +{ "engineHash": "3eadef2", "specHash": "6c3dd22", "version": "0.6.5" } diff --git a/box_sdk_gen/managers/sign_requests.py b/box_sdk_gen/managers/sign_requests.py index d2616c3..03f4b7b 100644 --- a/box_sdk_gen/managers/sign_requests.py +++ b/box_sdk_gen/managers/sign_requests.py @@ -235,6 +235,7 @@ def create_sign_request( 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, extra_headers: Optional[Dict[str, Optional[str]]] = None ) -> SignRequest: """ @@ -274,6 +275,8 @@ def create_sign_request( :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 an `embed_url_external_id`, defaults to None + :type external_system_name: Optional[str], optional :param extra_headers: Extra headers that will be included in the HTTP request., defaults to None :type extra_headers: Optional[Dict[str, Optional[str]]], optional """ @@ -297,6 +300,7 @@ def create_sign_request( '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, } headers_map: Dict[str, str] = prepare_params({**extra_headers}) response: FetchResponse = fetch( diff --git a/box_sdk_gen/schemas/sign_request.py b/box_sdk_gen/schemas/sign_request.py index db7f4ad..19773a7 100644 --- a/box_sdk_gen/schemas/sign_request.py +++ b/box_sdk_gen/schemas/sign_request.py @@ -89,6 +89,7 @@ def __init__( 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 ): """ @@ -141,6 +142,8 @@ def __init__( :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 an `embed_url_external_id`, defaults to None + :type external_system_name: Optional[str], optional """ super().__init__( is_document_preparation_needed=is_document_preparation_needed, @@ -156,6 +159,7 @@ def __init__( 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 ) self.type = type diff --git a/box_sdk_gen/schemas/sign_request_base.py b/box_sdk_gen/schemas/sign_request_base.py index 252599c..c3791e0 100644 --- a/box_sdk_gen/schemas/sign_request_base.py +++ b/box_sdk_gen/schemas/sign_request_base.py @@ -24,6 +24,7 @@ def __init__( 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 ): """ @@ -53,6 +54,8 @@ def __init__( :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 an `embed_url_external_id`, defaults to None + :type external_system_name: Optional[str], optional """ super().__init__(**kwargs) self.is_document_preparation_needed = is_document_preparation_needed @@ -70,3 +73,4 @@ def __init__( 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 index 6e55bac..6818e05 100644 --- a/box_sdk_gen/schemas/sign_request_create_request.py +++ b/box_sdk_gen/schemas/sign_request_create_request.py @@ -42,6 +42,7 @@ def __init__( 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 ): """ @@ -77,6 +78,8 @@ def __init__( :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 an `embed_url_external_id`, defaults to None + :type external_system_name: Optional[str], optional """ super().__init__( is_document_preparation_needed=is_document_preparation_needed, @@ -92,6 +95,7 @@ def __init__( 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 ) self.signers = signers diff --git a/box_sdk_gen/schemas/sign_request_create_signer.py b/box_sdk_gen/schemas/sign_request_create_signer.py index 6d2474c..2431ea2 100644 --- a/box_sdk_gen/schemas/sign_request_create_signer.py +++ b/box_sdk_gen/schemas/sign_request_create_signer.py @@ -26,6 +26,7 @@ def __init__( verification_phone_number: Optional[str] = None, password: Optional[str] = None, signer_group_id: Optional[str] = None, + suppress_notifications: Optional[bool] = None, **kwargs ): """ @@ -76,6 +77,8 @@ def __init__( determine which signers belongs to same group. A successful response will provide a generated UUID value instead for signers in the same signer group., defaults to None :type signer_group_id: Optional[str], optional + :param suppress_notifications: If true, no emails about the sign request will be sent, defaults to None + :type suppress_notifications: Optional[bool], optional """ super().__init__(**kwargs) self.email = email @@ -89,3 +92,4 @@ def __init__( 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 index f6e184e..9615f31 100644 --- a/box_sdk_gen/schemas/sign_request_signer.py +++ b/box_sdk_gen/schemas/sign_request_signer.py @@ -67,6 +67,7 @@ def __init__( verification_phone_number: Optional[str] = None, password: Optional[str] = None, signer_group_id: Optional[str] = None, + suppress_notifications: Optional[bool] = None, **kwargs ): """ @@ -130,6 +131,8 @@ def __init__( determine which signers belongs to same group. A successful response will provide a generated UUID value instead for signers in the same signer group., defaults to None :type signer_group_id: Optional[str], optional + :param suppress_notifications: If true, no emails about the sign request will be sent, defaults to None + :type suppress_notifications: Optional[bool], optional """ super().__init__( email=email, @@ -143,6 +146,7 @@ def __init__( verification_phone_number=verification_phone_number, password=password, signer_group_id=signer_group_id, + suppress_notifications=suppress_notifications, **kwargs ) self.has_viewed_document = has_viewed_document diff --git a/docs/sign_requests.md b/docs/sign_requests.md index 5c14967..01f6978 100644 --- a/docs/sign_requests.md +++ b/docs/sign_requests.md @@ -170,6 +170,8 @@ client.sign_requests.create_sign_request([SignRequestCreateSigner(email=signer_1 - 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]` + - Used as an optional system name to appear in the signature log next to the signers who have been assigned an `embed_url_external_id` - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request.