diff --git a/README.md b/README.md index 4b21611..2ebcf87 100644 --- a/README.md +++ b/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 @@ apisupport@hellosign.com 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 diff --git a/VERSION b/VERSION index bd8bf88..27f9cd3 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.7.0 +1.8.0 diff --git a/docs/BulkSendJobGetResponseSignatureRequests.md b/docs/BulkSendJobGetResponseSignatureRequests.md index d213ed9..9314ae4 100644 --- a/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/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. | | diff --git a/docs/FaxResponse.md b/docs/FaxResponse.md index d531f5d..f8bc78c 100644 --- a/docs/FaxResponse.md +++ b/docs/FaxResponse.md @@ -8,13 +8,14 @@ Name | Type | Description | Notes | `fax_id`*_required_ | ```str``` | Fax ID | | | `title`*_required_ | ```str``` | Fax Title | | | `original_title`*_required_ | ```str``` | Fax Original Title | | -| `subject`*_required_ | ```str``` | Fax Subject | | -| `message`*_required_ | ```str``` | Fax Message | | | `metadata`*_required_ | ```Dict[str, object]``` | Fax Metadata | | | `created_at`*_required_ | ```int``` | Fax Created At Timestamp | | | `sender`*_required_ | ```str``` | Fax Sender Email | | -| `transmissions`*_required_ | [```List[FaxResponseTransmission]```](FaxResponseTransmission.md) | Fax Transmissions List | | | `files_url`*_required_ | ```str``` | Fax Files URL | | +| `transmissions`*_required_ | [```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) diff --git a/docs/FaxResponseTransmission.md b/docs/FaxResponseTransmission.md index 9ba09c1..fb60d8b 100644 --- a/docs/FaxResponseTransmission.md +++ b/docs/FaxResponseTransmission.md @@ -6,7 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `recipient`*_required_ | ```str``` | Fax Transmission Recipient | | -| `sender`*_required_ | ```str``` | Fax Transmission Sender | | | `status_code`*_required_ | ```str``` | Fax Transmission Status Code | | | `sent_at` | ```int``` | Fax Transmission Sent Timestamp | | diff --git a/docs/SignatureRequestResponse.md b/docs/SignatureRequestResponse.md index a8af74c..552f80e 100644 --- a/docs/SignatureRequestResponse.md +++ b/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. | | diff --git a/docs/SignatureRequestResponseDataValueInitials.md b/docs/SignatureRequestResponseDataValueInitials.md index 33a6013..425498b 100644 --- a/docs/SignatureRequestResponseDataValueInitials.md +++ b/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) diff --git a/docs/SignatureRequestResponseDataValueSignature.md b/docs/SignatureRequestResponseDataValueSignature.md index cd15128..a50bcc5 100644 --- a/docs/SignatureRequestResponseDataValueSignature.md +++ b/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) diff --git a/docs/TemplateResponse.md b/docs/TemplateResponse.md index 315cf71..01220c9 100644 --- a/docs/TemplateResponse.md +++ b/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. | | diff --git a/dropbox_sign/__init__.py b/dropbox_sign/__init__.py index 9aa6a40..c94e664 100644 --- a/dropbox_sign/__init__.py +++ b/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 * diff --git a/dropbox_sign/api_client.py b/dropbox_sign/api_client.py index bf8122b..7d2eae2 100644 --- a/dropbox_sign/api_client.py +++ b/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): diff --git a/dropbox_sign/configuration.py b/dropbox_sign/configuration.py index 6a812ba..39da268 100644 --- a/dropbox_sign/configuration.py +++ b/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): diff --git a/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py b/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py index 748c75c..de4b9a2 100644 --- a/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py +++ b/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,)", diff --git a/dropbox_sign/models/fax_response.py b/dropbox_sign/models/fax_response.py index 035993f..976606e 100644 --- a/dropbox_sign/models/fax_response.py +++ b/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 diff --git a/dropbox_sign/models/fax_response_transmission.py b/dropbox_sign/models/fax_response_transmission.py index c34d2e9..28cf397 100644 --- a/dropbox_sign/models/fax_response_transmission.py +++ b/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,)", } diff --git a/dropbox_sign/models/signature_request_response.py b/dropbox_sign/models/signature_request_response.py index 5c8efc0..e367012 100644 --- a/dropbox_sign/models/signature_request_response.py +++ b/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,)", diff --git a/dropbox_sign/models/signature_request_response_data_value_initials.py b/dropbox_sign/models/signature_request_response_data_value_initials.py index db4e028..f5a493c 100644 --- a/dropbox_sign/models/signature_request_response_data_value_initials.py +++ b/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,6 +41,10 @@ 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", @@ -48,6 +52,7 @@ class SignatureRequestResponseDataValueInitials(SignatureRequestResponseDataBase "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,)", diff --git a/dropbox_sign/models/signature_request_response_data_value_signature.py b/dropbox_sign/models/signature_request_response_data_value_signature.py index 795ab9b..86461b3 100644 --- a/dropbox_sign/models/signature_request_response_data_value_signature.py +++ b/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,6 +41,10 @@ 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", @@ -48,6 +52,7 @@ class SignatureRequestResponseDataValueSignature(SignatureRequestResponseDataBas "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,)", diff --git a/dropbox_sign/models/template_response.py b/dropbox_sign/models/template_response.py index da77294..01f36b3 100644 --- a/dropbox_sign/models/template_response.py +++ b/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],)", diff --git a/openapi-config.yaml b/openapi-config.yaml index 95bd53b..fb119ff 100644 --- a/openapi-config.yaml +++ b/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 diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index fe81aca..608b57d 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -11173,6 +11173,10 @@ components: bulk_send_job_id: description: 'The id of the BulkSendJob.' type: string + metadata: + description: 'The metadata attached to the signature request.' + type: object + additionalProperties: {} x-internal-class: true EmbeddedEditUrlResponseEmbedded: description: 'An embedded template object.' @@ -11217,13 +11221,11 @@ components: - fax_id - title - original_title - - subject - - message - metadata - created_at - sender - - transmissions - files_url + - transmissions properties: fax_id: description: 'Fax ID' @@ -11237,9 +11239,11 @@ components: subject: description: 'Fax Subject' type: string + nullable: true message: description: 'Fax Message' type: string + nullable: true metadata: description: 'Fax Metadata' type: object @@ -11250,14 +11254,18 @@ components: sender: description: 'Fax Sender Email' type: string + files_url: + description: 'Fax Files URL' + type: string + final_copy_uri: + description: 'The path where the completed document can be downloaded' + type: string + nullable: true transmissions: description: 'Fax Transmissions List' type: array items: $ref: '#/components/schemas/FaxResponseTransmission' - files_url: - description: 'Fax Files URL' - type: string type: object x-internal-class: true FaxLineResponseFaxLine: @@ -11280,15 +11288,11 @@ components: FaxResponseTransmission: required: - recipient - - sender - status_code properties: recipient: description: 'Fax Transmission Recipient' type: string - sender: - description: 'Fax Transmission Sender' - type: string status_code: description: 'Fax Transmission Status Code' type: string @@ -11352,13 +11356,13 @@ components: description: 'Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.' type: boolean default: false - nullable: true signature_request_id: description: 'The id of the SignatureRequest.' type: string requester_email_address: description: 'The email address of the initiator of the SignatureRequest.' type: string + nullable: true title: description: 'The title the specified Account uses for the SignatureRequest.' type: string @@ -11376,12 +11380,14 @@ components: metadata: description: 'The metadata attached to the signature request.' type: object + additionalProperties: {} created_at: description: 'Time the signature request was created.' type: integer expires_at: description: '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.' type: integer + nullable: true is_complete: description: 'Whether or not the SignatureRequest has been fully executed by all signers.' type: boolean @@ -11509,6 +11515,7 @@ components: editor: description: 'The name of the Role that is able to edit this field.' type: string + nullable: true type: object discriminator: propertyName: type @@ -11519,13 +11526,12 @@ components: x-base-class: true SignatureRequestResponseCustomFieldCheckbox: description: 'This class extends `SignatureRequestResponseCustomFieldBase`.' + required: + - type allOf: - $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' - - required: - - name - - type properties: type: description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.' @@ -11537,13 +11543,12 @@ components: type: object SignatureRequestResponseCustomFieldText: description: 'This class extends `SignatureRequestResponseCustomFieldBase`.' + required: + - type allOf: - $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' - - required: - - name - - type properties: type: description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.' @@ -11671,6 +11676,10 @@ components: value: description: 'The value of the form field.' type: string + is_signed: + description: 'This field contains the boolean true if the field is signed.' + type: boolean + nullable: true type: object SignatureRequestResponseDataValueRadio: allOf: @@ -11699,6 +11708,10 @@ components: value: description: 'The value of the form field.' type: string + is_signed: + description: 'This field contains the boolean true if the field is signed.' + type: boolean + nullable: true type: object SignatureRequestResponseDataValueText: allOf: @@ -11936,6 +11949,7 @@ components: metadata: description: 'The metadata attached to the template.' type: object + additionalProperties: {} signer_roles: description: 'An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.' type: array diff --git a/pyproject.toml b/pyproject.toml index 6b765e6..9e4a325 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "dropbox_sign" -version = "1.7.0" +version = "1.8.0" description = "Dropbox Sign API" authors = ["Official Python SDK for the Dropbox Sign API "] license = "MIT" diff --git a/setup.py b/setup.py index 73b4f58..15a2f1c 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "dropbox-sign" -VERSION = "1.7.0" +VERSION = "1.8.0" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0", diff --git a/test_fixtures/BulkSendJobGetResponse.json b/test_fixtures/BulkSendJobGetResponse.json index e3e3bb2..e428a30 100644 --- a/test_fixtures/BulkSendJobGetResponse.json +++ b/test_fixtures/BulkSendJobGetResponse.json @@ -24,6 +24,15 @@ "custom_fields": [], "created_at": 0, "expires_at": 0, + "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" + }, "response_data": [ { "api_id": "80c678_1", diff --git a/test_fixtures/FaxGetResponse.json b/test_fixtures/FaxGetResponse.json index 5892719..2eda936 100644 --- a/test_fixtures/FaxGetResponse.json +++ b/test_fixtures/FaxGetResponse.json @@ -6,7 +6,15 @@ "original_title": "example original title", "subject": "example subject", "message": "example message", - "metadata": [], + "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" + }, "created_at": 1726774555, "sender": "me@dropboxsign.com", "transmissions": [ diff --git a/test_fixtures/FaxListResponse.json b/test_fixtures/FaxListResponse.json index bfa69cd..a9ebf63 100644 --- a/test_fixtures/FaxListResponse.json +++ b/test_fixtures/FaxListResponse.json @@ -13,7 +13,15 @@ "original_title": "example original title", "subject": "example subject", "message": "example message", - "metadata": [], + "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" + }, "created_at": 1726774555, "sender": "me@dropboxsign.com", "transmissions": [ diff --git a/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json b/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json index 01b4d40..c155d43 100644 --- a/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json +++ b/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json @@ -18,7 +18,13 @@ ], "message": "Glad we could come to an agreement.", "metadata": { - "field1": "value1" + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" }, "signer_list": [ { diff --git a/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json b/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json index 68fe824..e08221f 100644 --- a/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json +++ b/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json @@ -17,7 +17,13 @@ ], "message": "Glad we could come to an agreement.", "metadata": { - "field1": "value1" + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" }, "signer_list": [ { diff --git a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json index cb5d374..16e8037 100644 --- a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json @@ -90,7 +90,13 @@ "hide_text_tags": false, "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", "metadata": { - "field1": "value1" + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" }, "populate_auto_fill_fields": false, "signers": [ diff --git a/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json b/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json index 3f0047e..a9597ea 100644 --- a/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +++ b/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json @@ -21,7 +21,13 @@ ], "message": "Glad we could come to an agreement.", "metadata": { - "field1": "value1" + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" }, "populate_auto_fill_fields": false, "signers": [ diff --git a/test_fixtures/SignatureRequestGetResponse.json b/test_fixtures/SignatureRequestGetResponse.json index e9d9a37..f0fda3c 100644 --- a/test_fixtures/SignatureRequestGetResponse.json +++ b/test_fixtures/SignatureRequestGetResponse.json @@ -6,7 +6,15 @@ "original_title": "The NDA we talked about", "subject": "The NDA we talked about", "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": {}, + "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" + }, "created_at": 1570471067, "is_complete": false, "is_declined": false, @@ -91,6 +99,7 @@ "required": true, "api_id": "initial__1", "value": "YM", + "is_signed": true, "signature_id": "a9f4825edef25f47e7b4c14ce8100d81d1693160" }, { @@ -107,6 +116,7 @@ "required": true, "api_id": "signature__1", "value": "John Doe", + "is_signed": true, "signature_id": "a9f4825edef25f47e7b4c14ce8100d81d1693160" } ], diff --git a/test_fixtures/SignatureRequestListResponse.json b/test_fixtures/SignatureRequestListResponse.json index f6560be..fd70a82 100644 --- a/test_fixtures/SignatureRequestListResponse.json +++ b/test_fixtures/SignatureRequestListResponse.json @@ -13,7 +13,15 @@ "original_title": "FHA", "subject": "FHA", "message": "Let me know if you two have any questions.", - "metadata": {}, + "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" + }, "created_at": 1570471067, "expires_at": 0, "is_complete": false, diff --git a/test_fixtures/SignatureRequestSendRequest.json b/test_fixtures/SignatureRequestSendRequest.json index 6a33979..98d12db 100644 --- a/test_fixtures/SignatureRequestSendRequest.json +++ b/test_fixtures/SignatureRequestSendRequest.json @@ -192,6 +192,11 @@ "is_eid": false, "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", "custom_id": 1234, "custom_text": "NDA #9" }, @@ -472,4 +477,3 @@ "use_text_tags": true } } - diff --git a/test_fixtures/SignatureRequestSendWithTemplateRequest.json b/test_fixtures/SignatureRequestSendWithTemplateRequest.json index 7b8ce3d..4d1cc86 100644 --- a/test_fixtures/SignatureRequestSendWithTemplateRequest.json +++ b/test_fixtures/SignatureRequestSendWithTemplateRequest.json @@ -20,7 +20,13 @@ "is_eid": false, "message": "Glad we could come to an agreement.", "metadata": { - "field1": "value1" + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" }, "signers": [ { diff --git a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json index e31c5da..b293945 100644 --- a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +++ b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json @@ -96,6 +96,11 @@ ], "message": "For your approval", "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", "custom_id": 1234, "custom_text": "NDA #9" }, diff --git a/test_fixtures/TemplateCreateRequest.json b/test_fixtures/TemplateCreateRequest.json index e31c5da..b293945 100644 --- a/test_fixtures/TemplateCreateRequest.json +++ b/test_fixtures/TemplateCreateRequest.json @@ -96,6 +96,11 @@ ], "message": "For your approval", "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", "custom_id": 1234, "custom_text": "NDA #9" }, diff --git a/test_fixtures/TemplateGetResponse.json b/test_fixtures/TemplateGetResponse.json index b025913..0961c0e 100644 --- a/test_fixtures/TemplateGetResponse.json +++ b/test_fixtures/TemplateGetResponse.json @@ -9,7 +9,15 @@ "is_creator": true, "is_embedded": false, "is_locked": false, - "metadata": {}, + "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" + }, "signer_roles": [ { "name": "Outside Vendor", diff --git a/test_fixtures/TemplateListResponse.json b/test_fixtures/TemplateListResponse.json index caa5e6d..a4a144c 100644 --- a/test_fixtures/TemplateListResponse.json +++ b/test_fixtures/TemplateListResponse.json @@ -16,7 +16,15 @@ "is_creator": true, "is_embedded": false, "is_locked": false, - "metadata": {}, + "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", + "custom_id": 1234, + "custom_text": "NDA #9" + }, "signer_roles": [ { "name": "Client", diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json index d72f562..e18890b 100644 --- a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +++ b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json @@ -99,6 +99,11 @@ "is_for_embedded_signing": true, "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", "custom_id": 1234, "custom_text": "NDA #9" }, diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json index 4a1aafb..7c72649 100644 --- a/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +++ b/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json @@ -33,6 +33,11 @@ "is_for_embedded_signing": true, "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", "custom_id": 1234, "custom_text": "NDA #9" }, diff --git a/test_fixtures/UnclaimedDraftCreateRequest.json b/test_fixtures/UnclaimedDraftCreateRequest.json index 817ded5..b74d377 100644 --- a/test_fixtures/UnclaimedDraftCreateRequest.json +++ b/test_fixtures/UnclaimedDraftCreateRequest.json @@ -88,6 +88,11 @@ "hide_text_tags": true, "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", "metadata": { + "metadata_name_1": "metadata_value_1", + "metadata_name_2": { + "metadata_name_2_a": "metadata_value_2_a" + }, + "metadata_name_3": "metadata_value_3", "custom_id": 1234, "custom_text": "NDA #9" },