Add edit&resend to OpenAPI docs, and note that it uses quota

Author: jtreminio-dropbox

bin/check-clean-git-status

@@ -7,7 +7,6 @@ if [[ $(git status --porcelain) != '' ]]; then
   printf "\t./run-build\n"
 
   git status
-  git diff
 
   exit 1
 else

docs/SignatureRequestApi.md

@@ -613,7 +613,7 @@ Edit Signature Request
 
 Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
 
-**NOTE:** Edit and resend will not deduct your signature request quota.
+**NOTE:** Edit and resend *will* deduct your signature request quota.
 
 ### Example
 
@@ -738,6 +738,8 @@ Edit Embedded Signature Request
 
 Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
 
+**NOTE:** Edit and resend *will* deduct your signature request quota.
+
 ### Example
 
 * Basic Authentication (api_key):
@@ -849,6 +851,8 @@ Edit Embedded Signature Request with Template
 
 Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
 
+**NOTE:** Edit and resend *will* deduct your signature request quota.
+
 ### Example
 
 * Basic Authentication (api_key):
@@ -952,7 +956,7 @@ Edit Signature Request With Template
 
 Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.
 
-**NOTE:** Edit and resend will not deduct your signature request quota.
+**NOTE:** Edit and resend *will* deduct your signature request quota.
 
 ### Example
 

dropbox_sign/api/signature_request_api.py

@@ -1476,7 +1476,7 @@ def signature_request_edit(
     ) -> SignatureRequestGetResponse:
         """Edit Signature Request
 
-        Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.  **NOTE:** Edit and resend will not deduct your signature request quota.
+        Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str
@@ -1547,7 +1547,7 @@ def signature_request_edit_with_http_info(
     ) -> ApiResponse[SignatureRequestGetResponse]:
         """Edit Signature Request
 
-        Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.  **NOTE:** Edit and resend will not deduct your signature request quota.
+        Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str
@@ -1618,7 +1618,7 @@ def signature_request_edit_without_preload_content(
     ) -> RESTResponseType:
         """Edit Signature Request
 
-        Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.  **NOTE:** Edit and resend will not deduct your signature request quota.
+        Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str
@@ -1774,7 +1774,7 @@ def signature_request_edit_embedded(
     ) -> SignatureRequestGetResponse:
         """Edit Embedded Signature Request
 
-        Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+        Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str
@@ -1845,7 +1845,7 @@ def signature_request_edit_embedded_with_http_info(
     ) -> ApiResponse[SignatureRequestGetResponse]:
         """Edit Embedded Signature Request
 
-        Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+        Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str
@@ -1916,7 +1916,7 @@ def signature_request_edit_embedded_without_preload_content(
     ) -> RESTResponseType:
         """Edit Embedded Signature Request
 
-        Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+        Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str
@@ -2072,7 +2072,7 @@ def signature_request_edit_embedded_with_template(
     ) -> SignatureRequestGetResponse:
         """Edit Embedded Signature Request with Template
 
-        Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+        Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str
@@ -2143,7 +2143,7 @@ def signature_request_edit_embedded_with_template_with_http_info(
     ) -> ApiResponse[SignatureRequestGetResponse]:
         """Edit Embedded Signature Request with Template
 
-        Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+        Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str
@@ -2214,7 +2214,7 @@ def signature_request_edit_embedded_with_template_without_preload_content(
     ) -> RESTResponseType:
         """Edit Embedded Signature Request with Template
 
-        Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+        Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str
@@ -2373,7 +2373,7 @@ def signature_request_edit_with_template(
     ) -> SignatureRequestGetResponse:
         """Edit Signature Request With Template
 
-        Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.  **NOTE:** Edit and resend will not deduct your signature request quota.
+        Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str
@@ -2444,7 +2444,7 @@ def signature_request_edit_with_template_with_http_info(
     ) -> ApiResponse[SignatureRequestGetResponse]:
         """Edit Signature Request With Template
 
-        Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.  **NOTE:** Edit and resend will not deduct your signature request quota.
+        Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str
@@ -2515,7 +2515,7 @@ def signature_request_edit_with_template_without_preload_content(
     ) -> RESTResponseType:
         """Edit Signature Request With Template
 
-        Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.  **NOTE:** Edit and resend will not deduct your signature request quota.
+        Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.  **NOTE:** Edit and resend *will* deduct your signature request quota.
 
         :param signature_request_id: The id of the SignatureRequest to edit. (required)
         :type signature_request_id: str

dropbox_sign/configuration.py

@@ -546,7 +546,9 @@ def to_debug_report(self) -> str:
             "OS: {env}\n"
             "Python Version: {pyversion}\n"
             "Version of the API: 3.0.0\n"
-            "SDK Package Version: 1.9.0".format(env=sys.platform, pyversion=sys.version)
+            "SDK Package Version: 1.9.0".format(
+                env=sys.platform, pyversion=sys.version
+            )
         )
 
     def get_host_settings(self) -> List[HostSetting]:

dropbox_sign/models/api_app_create_request.py

@@ -45,7 +45,9 @@ class ApiAppCreateRequest(BaseModel):
         description="The URL at which the ApiApp should receive event callbacks.",
     )
     custom_logo_file: Optional[
-        Union[StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]]
+        Union[
+            StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]
+        ]
     ] = Field(
         default=None,
         description="An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)",

dropbox_sign/models/api_app_update_request.py

@@ -41,7 +41,9 @@ class ApiAppUpdateRequest(BaseModel):
         description="The URL at which the API App should receive event callbacks.",
     )
     custom_logo_file: Optional[
-        Union[StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]]
+        Union[
+            StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]
+        ]
     ] = Field(
         default=None,
         description="An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)",

dropbox_sign/models/fax_send_request.py

@@ -39,7 +39,14 @@ class FaxSendRequest(BaseModel):
         default=None, description="Fax Send From Sender (used only with fax number)"
     )
     files: Optional[
-        List[Union[StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]]]
+        List[
+            Union[
+                StrictBytes,
+                StrictStr,
+                io.IOBase,
+                Tuple[StrictStr, StrictBytes, io.IOBase],
+            ]
+        ]
     ] = Field(
         default=None,
         description="Use `files[]` to indicate the uploaded file(s) to fax  This endpoint requires either **files** or **file_urls[]**, but not both.",

dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py

@@ -43,7 +43,9 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest(BaseModel):
         description="Client id of the app you're using to create this embedded signature request. Used for security purposes."
     )
     signer_file: Optional[
-        Union[StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]]
+        Union[
+            StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]
+        ]
     ] = Field(
         default=None,
         description="`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:  - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)      By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).      **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)      You may only specify field values here, any other options should be set in the custom_fields request parameter.  Example CSV:  ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```",

dropbox_sign/models/signature_request_bulk_send_with_template_request.py

@@ -40,7 +40,9 @@ class SignatureRequestBulkSendWithTemplateRequest(BaseModel):
         description="Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."
     )
     signer_file: Optional[
-        Union[StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]]
+        Union[
+            StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]
+        ]
     ] = Field(
         default=None,
         description="`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:  - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)      By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).      **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)      You may only specify field values here, any other options should be set in the custom_fields request parameter.  Example CSV:  ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```",

dropbox_sign/models/signature_request_create_embedded_request.py

@@ -58,7 +58,14 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel):
         description="Client id of the app you're using to create this embedded signature request. Used for security purposes."
     )
     files: Optional[
-        List[Union[StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]]]
+        List[
+            Union[
+                StrictBytes,
+                StrictStr,
+                io.IOBase,
+                Tuple[StrictStr, StrictBytes, io.IOBase],
+            ]
+        ]
     ] = Field(
         default=None,
         description="Use `files[]` to indicate the uploaded file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both.",