Release 1.8.0

README.md

@@ -49,7 +49,7 @@ Python 3.7+
 Install using `pip`:
 
 ```shell
-python3 -m pip install dropbox-sign==1.7.0
+python3 -m pip install dropbox-sign==1.8.0
 ```
 
 Alternatively:
@@ -391,6 +391,6 @@ [email protected]
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 3.0.0
-- Package version: 1.7.0
+- Package version: 1.8.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 

VERSION

@@ -1 +1 @@
-1.7.0
+1.8.0

docs/BulkSendJobGetResponseSignatureRequests.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 | `original_title` | ```str``` |  Default Label for account.  |  |
 | `subject` | ```str``` |  The subject in the email that was initially sent to the signers.  |  |
 | `message` | ```str``` |  The custom message in the email that was initially sent to the signers.  |  |
-| `metadata` | ```object``` |  The metadata attached to the signature request.  |  |
+| `metadata` | ```Dict[str, object]``` |  The metadata attached to the signature request.  |  |
 | `created_at` | ```int``` |  Time the signature request was created.  |  |
 | `expires_at` | ```int``` |  The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.  |  |
 | `is_complete` | ```bool``` |  Whether or not the SignatureRequest has been fully executed by all signers.  |  |

docs/FaxResponse.md

@@ -8,13 +8,14 @@ Name | Type | Description | Notes
 | `fax_id`<sup>*_required_</sup> | ```str``` |  Fax ID  |  |
 | `title`<sup>*_required_</sup> | ```str``` |  Fax Title  |  |
 | `original_title`<sup>*_required_</sup> | ```str``` |  Fax Original Title  |  |
-| `subject`<sup>*_required_</sup> | ```str``` |  Fax Subject  |  |
-| `message`<sup>*_required_</sup> | ```str``` |  Fax Message  |  |
 | `metadata`<sup>*_required_</sup> | ```Dict[str, object]``` |  Fax Metadata  |  |
 | `created_at`<sup>*_required_</sup> | ```int``` |  Fax Created At Timestamp  |  |
 | `sender`<sup>*_required_</sup> | ```str``` |  Fax Sender Email  |  |
-| `transmissions`<sup>*_required_</sup> | [```List[FaxResponseTransmission]```](FaxResponseTransmission.md) |  Fax Transmissions List  |  |
 | `files_url`<sup>*_required_</sup> | ```str``` |  Fax Files URL  |  |
+| `transmissions`<sup>*_required_</sup> | [```List[FaxResponseTransmission]```](FaxResponseTransmission.md) |  Fax Transmissions List  |  |
+| `subject` | ```str``` |  Fax Subject  |  |
+| `message` | ```str``` |  Fax Message  |  |
+| `final_copy_uri` | ```str``` |  The path where the completed document can be downloaded  |  |
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/FaxResponseTransmission.md

@@ -6,7 +6,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 | `recipient`<sup>*_required_</sup> | ```str``` |  Fax Transmission Recipient  |  |
-| `sender`<sup>*_required_</sup> | ```str``` |  Fax Transmission Sender  |  |
 | `status_code`<sup>*_required_</sup> | ```str``` |  Fax Transmission Status Code  |  |
 | `sent_at` | ```int``` |  Fax Transmission Sent Timestamp  |  |
 

docs/SignatureRequestResponse.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 | `original_title` | ```str``` |  Default Label for account.  |  |
 | `subject` | ```str``` |  The subject in the email that was initially sent to the signers.  |  |
 | `message` | ```str``` |  The custom message in the email that was initially sent to the signers.  |  |
-| `metadata` | ```object``` |  The metadata attached to the signature request.  |  |
+| `metadata` | ```Dict[str, object]``` |  The metadata attached to the signature request.  |  |
 | `created_at` | ```int``` |  Time the signature request was created.  |  |
 | `expires_at` | ```int``` |  The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.  |  |
 | `is_complete` | ```bool``` |  Whether or not the SignatureRequest has been fully executed by all signers.  |  |

docs/SignatureRequestResponseDataValueInitials.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 | `type` | ```str``` |  An input field for initials  |  [default to 'initials'] |
 | `value` | ```str``` |  The value of the form field.  |  |
+| `is_signed` | ```bool``` |  This field contains the boolean true if the field is signed.  |  |
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/SignatureRequestResponseDataValueSignature.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 | `type` | ```str``` |  A signature input field  |  [default to 'signature'] |
 | `value` | ```str``` |  The value of the form field.  |  |
+| `is_signed` | ```bool``` |  This field contains the boolean true if the field is signed.  |  |
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/TemplateResponse.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 | `is_creator` | ```bool``` |  `true` if you are the owner of this template, `false` if it's been shared with you by a team member.  |  |
 | `can_edit` | ```bool``` |  Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).  |  |
 | `is_locked` | ```bool``` |  Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.  |  |
-| `metadata` | ```object``` |  The metadata attached to the template.  |  |
+| `metadata` | ```Dict[str, object]``` |  The metadata attached to the template.  |  |
 | `signer_roles` | [```List[TemplateResponseSignerRole]```](TemplateResponseSignerRole.md) |  An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.  |  |
 | `cc_roles` | [```List[TemplateResponseCCRole]```](TemplateResponseCCRole.md) |  An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.  |  |
 | `documents` | [```List[TemplateResponseDocument]```](TemplateResponseDocument.md) |  An array describing each document associated with this Template. Includes form field data for each document.  |  |

dropbox_sign/__init__.py

@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.7.0"
+__version__ = "1.8.0"
 
 # import apis into sdk package
 from dropbox_sign.apis import *

dropbox_sign/api_client.py

@@ -89,7 +89,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = "OpenAPI-Generator/1.7.0/python"
+        self.user_agent = "OpenAPI-Generator/1.8.0/python"
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

dropbox_sign/configuration.py

@@ -432,7 +432,7 @@ def to_debug_report(self):
             "OS: {env}\n"
             "Python Version: {pyversion}\n"
             "Version of the API: 3.0.0\n"
-            "SDK Version: 1.7.0".format(env=sys.platform, pyversion=sys.version)
+            "SDK Version: 1.8.0".format(env=sys.platform, pyversion=sys.version)
         )
 
     def get_host_settings(self):

dropbox_sign/models/bulk_send_job_get_response_signature_requests.py

@@ -335,7 +335,7 @@ def openapi_types(cls) -> Dict[str, str]:
             "original_title": "(str,)",
             "subject": "(str,)",
             "message": "(str,)",
-            "metadata": "(object,)",
+            "metadata": "(Dict[str, object],)",
             "created_at": "(int,)",
             "expires_at": "(int,)",
             "is_complete": "(bool,)",

dropbox_sign/models/fax_response.py

@@ -19,7 +19,7 @@
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
 from dropbox_sign.models.fax_response_transmission import FaxResponseTransmission
 from typing import Optional, Set, Tuple
 from typing_extensions import Self
@@ -36,26 +36,31 @@ class FaxResponse(BaseModel):
     fax_id: StrictStr = Field(description="Fax ID")
     title: StrictStr = Field(description="Fax Title")
     original_title: StrictStr = Field(description="Fax Original Title")
-    subject: StrictStr = Field(description="Fax Subject")
-    message: StrictStr = Field(description="Fax Message")
     metadata: Dict[str, Any] = Field(description="Fax Metadata")
     created_at: StrictInt = Field(description="Fax Created At Timestamp")
     sender: StrictStr = Field(description="Fax Sender Email")
+    files_url: StrictStr = Field(description="Fax Files URL")
     transmissions: List[FaxResponseTransmission] = Field(
         description="Fax Transmissions List"
     )
-    files_url: StrictStr = Field(description="Fax Files URL")
+    subject: Optional[StrictStr] = Field(default=None, description="Fax Subject")
+    message: Optional[StrictStr] = Field(default=None, description="Fax Message")
+    final_copy_uri: Optional[StrictStr] = Field(
+        default=None,
+        description="The path where the completed document can be downloaded",
+    )
     __properties: ClassVar[List[str]] = [
         "fax_id",
         "title",
         "original_title",
-        "subject",
-        "message",
         "metadata",
         "created_at",
         "sender",
-        "transmissions",
         "files_url",
+        "transmissions",
+        "subject",
+        "message",
+        "final_copy_uri",
     ]
 
     model_config = ConfigDict(
@@ -131,11 +136,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
                 "fax_id": obj.get("fax_id"),
                 "title": obj.get("title"),
                 "original_title": obj.get("original_title"),
-                "subject": obj.get("subject"),
-                "message": obj.get("message"),
                 "metadata": obj.get("metadata"),
                 "created_at": obj.get("created_at"),
                 "sender": obj.get("sender"),
+                "files_url": obj.get("files_url"),
                 "transmissions": (
                     [
                         FaxResponseTransmission.from_dict(_item)
@@ -144,7 +148,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
                     if obj.get("transmissions") is not None
                     else None
                 ),
-                "files_url": obj.get("files_url"),
+                "subject": obj.get("subject"),
+                "message": obj.get("message"),
+                "final_copy_uri": obj.get("final_copy_uri"),
             }
         )
         return _obj
@@ -165,13 +171,14 @@ def openapi_types(cls) -> Dict[str, str]:
             "fax_id": "(str,)",
             "title": "(str,)",
             "original_title": "(str,)",
-            "subject": "(str,)",
-            "message": "(str,)",
             "metadata": "(Dict[str, object],)",
             "created_at": "(int,)",
             "sender": "(str,)",
-            "transmissions": "(List[FaxResponseTransmission],)",
             "files_url": "(str,)",
+            "transmissions": "(List[FaxResponseTransmission],)",
+            "subject": "(str,)",
+            "message": "(str,)",
+            "final_copy_uri": "(str,)",
         }
 
     @classmethod

dropbox_sign/models/fax_response_transmission.py

@@ -33,17 +33,11 @@ class FaxResponseTransmission(BaseModel):
     """  # noqa: E501
 
     recipient: StrictStr = Field(description="Fax Transmission Recipient")
-    sender: StrictStr = Field(description="Fax Transmission Sender")
     status_code: StrictStr = Field(description="Fax Transmission Status Code")
     sent_at: Optional[StrictInt] = Field(
         default=None, description="Fax Transmission Sent Timestamp"
     )
-    __properties: ClassVar[List[str]] = [
-        "recipient",
-        "sender",
-        "status_code",
-        "sent_at",
-    ]
+    __properties: ClassVar[List[str]] = ["recipient", "status_code", "sent_at"]
 
     @field_validator("status_code")
     def status_code_validate_enum(cls, value):
@@ -129,7 +123,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         _obj = cls.model_validate(
             {
                 "recipient": obj.get("recipient"),
-                "sender": obj.get("sender"),
                 "status_code": obj.get("status_code"),
                 "sent_at": obj.get("sent_at"),
             }
@@ -150,7 +143,6 @@ def init(cls, data: Any) -> Self:
     def openapi_types(cls) -> Dict[str, str]:
         return {
             "recipient": "(str,)",
-            "sender": "(str,)",
             "status_code": "(str,)",
             "sent_at": "(int,)",
         }

dropbox_sign/models/signature_request_response.py

@@ -336,7 +336,7 @@ def openapi_types(cls) -> Dict[str, str]:
             "original_title": "(str,)",
             "subject": "(str,)",
             "message": "(str,)",
-            "metadata": "(object,)",
+            "metadata": "(Dict[str, object],)",
             "created_at": "(int,)",
             "expires_at": "(int,)",
             "is_complete": "(bool,)",

dropbox_sign/models/signature_request_response_data_value_initials.py

@@ -18,7 +18,7 @@
 import re  # noqa: F401
 import json
 
-from pydantic import ConfigDict, Field, StrictStr
+from pydantic import ConfigDict, Field, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from dropbox_sign.models.signature_request_response_data_base import (
     SignatureRequestResponseDataBase,
@@ -41,13 +41,18 @@ class SignatureRequestResponseDataValueInitials(SignatureRequestResponseDataBase
     value: Optional[StrictStr] = Field(
         default=None, description="The value of the form field."
     )
+    is_signed: Optional[StrictBool] = Field(
+        default=None,
+        description="This field contains the boolean true if the field is signed.",
+    )
     __properties: ClassVar[List[str]] = [
         "api_id",
         "signature_id",
         "name",
         "required",
         "type",
         "value",
+        "is_signed",
     ]
 
     model_config = ConfigDict(
@@ -119,6 +124,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
                 "required": obj.get("required"),
                 "type": obj.get("type") if obj.get("type") is not None else "initials",
                 "value": obj.get("value"),
+                "is_signed": obj.get("is_signed"),
             }
         )
         return _obj
@@ -138,6 +144,7 @@ def openapi_types(cls) -> Dict[str, str]:
         return {
             "type": "(str,)",
             "value": "(str,)",
+            "is_signed": "(bool,)",
             "api_id": "(str,)",
             "signature_id": "(str,)",
             "name": "(str,)",

dropbox_sign/models/signature_request_response_data_value_signature.py

@@ -18,7 +18,7 @@
 import re  # noqa: F401
 import json
 
-from pydantic import ConfigDict, Field, StrictStr
+from pydantic import ConfigDict, Field, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from dropbox_sign.models.signature_request_response_data_base import (
     SignatureRequestResponseDataBase,
@@ -41,13 +41,18 @@ class SignatureRequestResponseDataValueSignature(SignatureRequestResponseDataBas
     value: Optional[StrictStr] = Field(
         default=None, description="The value of the form field."
     )
+    is_signed: Optional[StrictBool] = Field(
+        default=None,
+        description="This field contains the boolean true if the field is signed.",
+    )
     __properties: ClassVar[List[str]] = [
         "api_id",
         "signature_id",
         "name",
         "required",
         "type",
         "value",
+        "is_signed",
     ]
 
     model_config = ConfigDict(
@@ -119,6 +124,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
                 "required": obj.get("required"),
                 "type": obj.get("type") if obj.get("type") is not None else "signature",
                 "value": obj.get("value"),
+                "is_signed": obj.get("is_signed"),
             }
         )
         return _obj
@@ -138,6 +144,7 @@ def openapi_types(cls) -> Dict[str, str]:
         return {
             "type": "(str,)",
             "value": "(str,)",
+            "is_signed": "(bool,)",
             "api_id": "(str,)",
             "signature_id": "(str,)",
             "name": "(str,)",

dropbox_sign/models/template_response.py

@@ -325,7 +325,7 @@ def openapi_types(cls) -> Dict[str, str]:
             "is_creator": "(bool,)",
             "can_edit": "(bool,)",
             "is_locked": "(bool,)",
-            "metadata": "(object,)",
+            "metadata": "(Dict[str, object],)",
             "signer_roles": "(List[TemplateResponseSignerRole],)",
             "cc_roles": "(List[TemplateResponseCCRole],)",
             "documents": "(List[TemplateResponseDocument],)",

openapi-config.yaml

@@ -5,7 +5,7 @@ additionalProperties:
   generatorLanguageVersion: ">=3.7"
   packageName: dropbox_sign
   projectName: dropbox-sign
-  packageVersion: 1.7.0
+  packageVersion: 1.8.0
   sortModelPropertiesByRequiredFlag: true
   legacyDiscriminatorBehavior: true
   packageAuthor: Dropbox Sign API Team