fix: improve wording for box sign (box/box-openapi#424) (#163)

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "3eadef2", "specHash": "98bca8f", "version": "0.6.5" }
+{ "engineHash": "3eadef2", "specHash": "f26f46d", "version": "0.6.5" }

box_sdk_gen/managers/sign_requests.py

@@ -75,7 +75,7 @@ def cancel_sign_request(
     ) -> SignRequest:
         """
                 Cancels a sign request.
-                :param sign_request_id: The ID of the sign request
+                :param sign_request_id: The ID of the signature request
         Example: "33243242"
                 :type sign_request_id: str
                 :param extra_headers: Extra headers that will be included in the HTTP request., defaults to None
@@ -110,8 +110,8 @@ def resend_sign_request(
         extra_headers: Optional[Dict[str, Optional[str]]] = None
     ) -> None:
         """
-                Resends a sign request email to all outstanding signers.
-                :param sign_request_id: The ID of the sign request
+                Resends a signature request email to all outstanding signers.
+                :param sign_request_id: The ID of the signature request
         Example: "33243242"
                 :type sign_request_id: str
                 :param extra_headers: Extra headers that will be included in the HTTP request., defaults to None
@@ -147,7 +147,7 @@ def get_sign_request_by_id(
     ) -> SignRequest:
         """
                 Gets a sign request by ID.
-                :param sign_request_id: The ID of the sign request
+                :param sign_request_id: The ID of the signature request
         Example: "33243242"
                 :type sign_request_id: str
                 :param extra_headers: Extra headers that will be included in the HTTP request., defaults to None
@@ -182,9 +182,9 @@ def get_sign_requests(
         extra_headers: Optional[Dict[str, Optional[str]]] = None
     ) -> SignRequests:
         """
-                Gets sign requests created by a user. If the `sign_files` and/or
+                Gets signature requests created by a user. If the `sign_files` and/or
 
-                `parent_folder` are deleted, the sign request will not return in the list.
+                `parent_folder` are deleted, the signature request will not return in the list.
 
                 :param marker: Defines the position marker at which to begin returning results. This is
         used when paginating using marker-based pagination.
@@ -238,19 +238,19 @@ def create_sign_request(
         extra_headers: Optional[Dict[str, Optional[str]]] = None
     ) -> SignRequest:
         """
-        Creates a sign request. This involves preparing a document for signing and
+        Creates a signature request. This involves preparing a document for signing and
 
-        sending the sign request to signers.
+        sending the signature request to signers.
 
-        :param signers: Array of signers for the sign request. 35 is the max number of signers permitted.
+        :param signers: Array of signers for the signature request. 35 is the max number of signers permitted.
         :type signers: List[SignRequestCreateSigner]
         :param source_files: List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file., defaults to None
         :type source_files: Optional[List[FileBase]], optional
         :param signature_color: Force a specific color for the signature (blue, black, or red), defaults to None
         :type signature_color: Optional[CreateSignRequestSignatureColor], optional
-        :param is_document_preparation_needed: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation via UI., defaults to None
+        :param is_document_preparation_needed: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI., defaults to None
         :type is_document_preparation_needed: Optional[bool], optional
-        :param redirect_url: When specified, signature request will be redirected to this url when a document is signed., defaults to None
+        :param redirect_url: When specified, the signature request will be redirected to this url when a document is signed., defaults to None
         :type redirect_url: Optional[str], optional
         :param declined_redirect_url: The uri that a signer will be redirected to after declining to sign a document., defaults to None
         :type declined_redirect_url: Optional[str], optional
@@ -262,9 +262,9 @@ def create_sign_request(
         :type email_message: Optional[str], optional
         :param are_reminders_enabled: Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers., defaults to None
         :type are_reminders_enabled: Optional[bool], optional
-        :param name: Name of the sign request., defaults to None
+        :param name: Name of the signature request., defaults to None
         :type name: Optional[str], optional
-        :param prefill_tags: When a document contains sign related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag., defaults to None
+        :param prefill_tags: When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag., defaults to None
         :type prefill_tags: Optional[List[SignRequestPrefillTag]], optional
         :param days_valid: 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., defaults to None
         :type days_valid: Optional[int], optional

box_sdk_gen/schemas/sign_request.py

@@ -96,27 +96,28 @@ def __init__(
                 :type type: Optional[SignRequestTypeField], optional
                 :param source_files: List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file., defaults to None
                 :type source_files: Optional[List[FileBase]], optional
-                :param signers: Array of signers for the sign request, defaults to None
+                :param signers: Array of signers for the signature request., defaults to None
                 :type signers: Optional[List[SignRequestSigner]], optional
                 :param signature_color: Force a specific color for the signature (blue, black, or red)., defaults to None
                 :type signature_color: Optional[str], optional
-                :param id: Sign request ID, defaults to None
+                :param id: Box Sign request ID., defaults to None
                 :type id: Optional[str], optional
                 :param prepare_url: This URL is returned if `is_document_preparation_needed` is
-        set to `true` in the request. It is used to prepare the sign request
-        via UI. The sign request is not sent until preparation is complete., defaults to None
+        set to `true` for Box Sign request. It is used to prepare a signature request
+        using the UI. The signature request is not sent until the preparation
+        phase is complete., defaults to None
                 :type prepare_url: Optional[str], optional
-                :param status: Describes the status of the sign request, defaults to None
+                :param status: Describes the status of the signature request., defaults to None
                 :type status: Optional[SignRequestStatusField], optional
                 :param sign_files: List of files that will be signed, which are copies of the original
         source files. A new version of these files are created as signers sign
         and can be downloaded at any point in the signing process., defaults to None
                 :type sign_files: Optional[SignRequestSignFilesField], optional
                 :param auto_expire_at: Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned., defaults to None
                 :type auto_expire_at: Optional[DateTime], optional
-                :param is_document_preparation_needed: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation via UI., defaults to None
+                :param is_document_preparation_needed: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI., defaults to None
                 :type is_document_preparation_needed: Optional[bool], optional
-                :param redirect_url: When specified, signature request will be redirected to this url when a document is signed., defaults to None
+                :param redirect_url: When specified, the signature request will be redirected to this url when a document is signed., defaults to None
                 :type redirect_url: Optional[str], optional
                 :param declined_redirect_url: The uri that a signer will be redirected to after declining to sign a document., defaults to None
                 :type declined_redirect_url: Optional[str], optional
@@ -128,9 +129,9 @@ def __init__(
                 :type email_message: Optional[str], optional
                 :param are_reminders_enabled: Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers., defaults to None
                 :type are_reminders_enabled: Optional[bool], optional
-                :param name: Name of the sign request., defaults to None
+                :param name: Name of the signature request., defaults to None
                 :type name: Optional[str], optional
-                :param prefill_tags: When a document contains sign related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag., defaults to None
+                :param prefill_tags: When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag., defaults to None
                 :type prefill_tags: Optional[List[SignRequestPrefillTag]], optional
                 :param days_valid: 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., defaults to None
                 :type days_valid: Optional[int], optional

box_sdk_gen/schemas/sign_request_base.py

@@ -27,9 +27,9 @@ def __init__(
         **kwargs
     ):
         """
-        :param is_document_preparation_needed: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation via UI., defaults to None
+        :param is_document_preparation_needed: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI., defaults to None
         :type is_document_preparation_needed: Optional[bool], optional
-        :param redirect_url: When specified, signature request will be redirected to this url when a document is signed., defaults to None
+        :param redirect_url: When specified, the signature request will be redirected to this url when a document is signed., defaults to None
         :type redirect_url: Optional[str], optional
         :param declined_redirect_url: The uri that a signer will be redirected to after declining to sign a document., defaults to None
         :type declined_redirect_url: Optional[str], optional
@@ -41,9 +41,9 @@ def __init__(
         :type email_message: Optional[str], optional
         :param are_reminders_enabled: Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers., defaults to None
         :type are_reminders_enabled: Optional[bool], optional
-        :param name: Name of the sign request., defaults to None
+        :param name: Name of the signature request., defaults to None
         :type name: Optional[str], optional
-        :param prefill_tags: When a document contains sign related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag., defaults to None
+        :param prefill_tags: When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag., defaults to None
         :type prefill_tags: Optional[List[SignRequestPrefillTag]], optional
         :param days_valid: 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., defaults to None
         :type days_valid: Optional[int], optional

box_sdk_gen/schemas/sign_request_create_request.py

@@ -45,15 +45,15 @@ def __init__(
         **kwargs
     ):
         """
-        :param signers: Array of signers for the sign request. 35 is the max number of signers permitted.
+        :param signers: Array of signers for the signature request. 35 is the max number of signers permitted.
         :type signers: List[SignRequestCreateSigner]
         :param source_files: List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file., defaults to None
         :type source_files: Optional[List[FileBase]], optional
         :param signature_color: Force a specific color for the signature (blue, black, or red), defaults to None
         :type signature_color: Optional[SignRequestCreateRequestSignatureColorField], optional
-        :param is_document_preparation_needed: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation via UI., defaults to None
+        :param is_document_preparation_needed: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI., defaults to None
         :type is_document_preparation_needed: Optional[bool], optional
-        :param redirect_url: When specified, signature request will be redirected to this url when a document is signed., defaults to None
+        :param redirect_url: When specified, the signature request will be redirected to this url when a document is signed., defaults to None
         :type redirect_url: Optional[str], optional
         :param declined_redirect_url: The uri that a signer will be redirected to after declining to sign a document., defaults to None
         :type declined_redirect_url: Optional[str], optional
@@ -65,9 +65,9 @@ def __init__(
         :type email_message: Optional[str], optional
         :param are_reminders_enabled: Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers., defaults to None
         :type are_reminders_enabled: Optional[bool], optional
-        :param name: Name of the sign request., defaults to None
+        :param name: Name of the signature request., defaults to None
         :type name: Optional[str], optional
-        :param prefill_tags: When a document contains sign related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag., defaults to None
+        :param prefill_tags: When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag., defaults to None
         :type prefill_tags: Optional[List[SignRequestPrefillTag]], optional
         :param days_valid: 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., defaults to None
         :type days_valid: Optional[int], optional

box_sdk_gen/schemas/sign_request_create_signer.py

@@ -32,7 +32,7 @@ def __init__(
                 :param email: Email address of the signer.
         The email address of the signer is required when making signature requests, except when using templates that are configured to include emails., defaults to None
                 :type email: Optional[str], optional
-                :param role: Defines the role of the signer in the sign request. A `signer`
+                :param role: Defines the role of the signer in the signature request. A `signer`
         must sign the document and an `approver` must approve the document. A
         `final_copy_reader` only receives the final signed document and signing
         log., defaults to None

box_sdk_gen/schemas/sign_request_prefill_tag.py

@@ -16,7 +16,7 @@ def __init__(
         **kwargs
     ):
         """
-        :param document_tag_id: This references the ID of a specific tag contained in a file of the sign request., defaults to None
+        :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

box_sdk_gen/schemas/sign_request_signer.py

@@ -34,11 +34,11 @@ def __init__(
         **kwargs
     ):
         """
-        :param type: Type of decision made by the signer, defaults to None
+        :param type: Type of decision made by the signer., defaults to None
         :type type: Optional[SignRequestSignerSignerDecisionTypeField], optional
-        :param finalized_at: Date and Time that the decision was made, defaults to None
+        :param finalized_at: Date and Time that the decision was made., defaults to None
         :type finalized_at: Optional[DateTime], optional
-        :param additional_info: Additional info about the decision, such as the decline reason from the signer, defaults to None
+        :param additional_info: Additional info about the decision, such as the decline reason from the signer., defaults to None
         :type additional_info: Optional[str], optional
         """
         super().__init__(**kwargs)
@@ -72,7 +72,7 @@ def __init__(
         """
                 :param has_viewed_document: Set to `true` if the signer views the document, defaults to None
                 :type has_viewed_document: Optional[bool], optional
-                :param signer_decision: Final decision made by the signer, defaults to None
+                :param signer_decision: Final decision made by the signer., defaults to None
                 :type signer_decision: Optional[SignRequestSignerSignerDecisionField], optional
                 :param embed_url: URL to direct a signer to for signing, defaults to None
                 :type embed_url: Optional[str], optional
@@ -81,12 +81,12 @@ def __init__(
         It will be returned in the response
         only if the `embed_url_external_user_id`
         parameter was passed in the
-        `create sign request` call., defaults to None
+        `create Box Sign request` call., defaults to None
                 :type iframeable_embed_url: Optional[str], optional
                 :param email: Email address of the signer.
         The email address of the signer is required when making signature requests, except when using templates that are configured to include emails., defaults to None
                 :type email: Optional[str], optional
-                :param role: Defines the role of the signer in the sign request. A `signer`
+                :param role: Defines the role of the signer in the signature request. A `signer`
         must sign the document and an `approver` must approve the document. A
         `final_copy_reader` only receives the final signed document and signing
         log., defaults to None