diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e038c25..ccd6d9b 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -14,9 +14,6 @@ stages: - pip install -r test-requirements.txt - pytest --cov=dropbox_sign -pytest-3.7: - extends: .pytest - image: python:3.7-alpine pytest-3.8: extends: .pytest image: python:3.8-alpine @@ -29,3 +26,6 @@ pytest-3.10: pytest-3.11: extends: .pytest image: python:3.11-alpine +pytest-3.12: + extends: .pytest + image: python:3.12-alpine diff --git a/.travis.yml b/.travis.yml index 6b47ff2..757c4ee 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,13 +1,13 @@ # ref: https://docs.travis-ci.com/user/languages/python language: python python: - - "3.7" - "3.8" - "3.9" - "3.10" - "3.11" + - "3.12" # uncomment the following if needed - #- "3.11-dev" # 3.11 development branch + #- "3.12-dev" # 3.12 development branch #- "nightly" # nightly build # command to install dependencies install: diff --git a/README.md b/README.md index 2ebcf87..fe3fd13 100644 --- a/README.md +++ b/README.md @@ -42,14 +42,14 @@ this command. ### Requirements. -Python 3.7+ +Python 3.8+ ### pip Install using `pip`: ```shell -python3 -m pip install dropbox-sign==1.8.0 +python3 -m pip install dropbox-sign==1.9.0 ``` Alternatively: @@ -69,29 +69,30 @@ Please follow the [installation procedure](#installation--usage) and then run th ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountCreateRequest( + account_create_request = models.AccountCreateRequest( email_address="newuser@dropboxsign.com", ) try: - response = account_api.account_create(data) + response = api.AccountApi(api_client).account_create( + account_create_request=account_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_create: %s\n" % e) ``` @@ -116,7 +117,7 @@ Class | Method | HTTP request | Description |```EmbeddedApi``` | [```embedded_edit_url```](docs/EmbeddedApi.md#embedded_edit_url) | ```POST /embedded/edit_url/{template_id}``` | Get Embedded Template Edit URL| ```EmbeddedApi``` | [```embedded_sign_url```](docs/EmbeddedApi.md#embedded_sign_url) | ```GET /embedded/sign_url/{signature_id}``` | Get Embedded Sign URL| |```FaxApi``` | [```fax_delete```](docs/FaxApi.md#fax_delete) | ```DELETE /fax/{fax_id}``` | Delete Fax| -```FaxApi``` | [```fax_files```](docs/FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | List Fax Files| +```FaxApi``` | [```fax_files```](docs/FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | Download Fax Files| ```FaxApi``` | [```fax_get```](docs/FaxApi.md#fax_get) | ```GET /fax/{fax_id}``` | Get Fax| ```FaxApi``` | [```fax_list```](docs/FaxApi.md#fax_list) | ```GET /fax/list``` | Lists Faxes| ```FaxApi``` | [```fax_send```](docs/FaxApi.md#fax_send) | ```POST /fax/send``` | Send Fax| @@ -135,6 +136,10 @@ Class | Method | HTTP request | Description ```SignatureRequestApi``` | [```signature_request_cancel```](docs/SignatureRequestApi.md#signature_request_cancel) | ```POST /signature_request/cancel/{signature_request_id}``` | Cancel Incomplete Signature Request| ```SignatureRequestApi``` | [```signature_request_create_embedded```](docs/SignatureRequestApi.md#signature_request_create_embedded) | ```POST /signature_request/create_embedded``` | Create Embedded Signature Request| ```SignatureRequestApi``` | [```signature_request_create_embedded_with_template```](docs/SignatureRequestApi.md#signature_request_create_embedded_with_template) | ```POST /signature_request/create_embedded_with_template``` | Create Embedded Signature Request with Template| +```SignatureRequestApi``` | [```signature_request_edit```](docs/SignatureRequestApi.md#signature_request_edit) | ```PUT /signature_request/edit/{signature_request_id}``` | Edit Signature Request| +```SignatureRequestApi``` | [```signature_request_edit_embedded```](docs/SignatureRequestApi.md#signature_request_edit_embedded) | ```PUT /signature_request/edit_embedded/{signature_request_id}``` | Edit Embedded Signature Request| +```SignatureRequestApi``` | [```signature_request_edit_embedded_with_template```](docs/SignatureRequestApi.md#signature_request_edit_embedded_with_template) | ```PUT /signature_request/edit_embedded_with_template/{signature_request_id}``` | Edit Embedded Signature Request with Template| +```SignatureRequestApi``` | [```signature_request_edit_with_template```](docs/SignatureRequestApi.md#signature_request_edit_with_template) | ```PUT /signature_request/edit_with_template/{signature_request_id}``` | Edit Signature Request With Template| ```SignatureRequestApi``` | [```signature_request_files```](docs/SignatureRequestApi.md#signature_request_files) | ```GET /signature_request/files/{signature_request_id}``` | Download Files| ```SignatureRequestApi``` | [```signature_request_files_as_data_uri```](docs/SignatureRequestApi.md#signature_request_files_as_data_uri) | ```GET /signature_request/files_as_data_uri/{signature_request_id}``` | Download Files as Data Uri| ```SignatureRequestApi``` | [```signature_request_files_as_file_url```](docs/SignatureRequestApi.md#signature_request_files_as_file_url) | ```GET /signature_request/files_as_file_url/{signature_request_id}``` | Download Files as File Url| @@ -238,6 +243,10 @@ Class | Method | HTTP request | Description - [SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md) - [SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md) - [SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md) + - [SignatureRequestEditEmbeddedRequest](docs/SignatureRequestEditEmbeddedRequest.md) + - [SignatureRequestEditEmbeddedWithTemplateRequest](docs/SignatureRequestEditEmbeddedWithTemplateRequest.md) + - [SignatureRequestEditRequest](docs/SignatureRequestEditRequest.md) + - [SignatureRequestEditWithTemplateRequest](docs/SignatureRequestEditWithTemplateRequest.md) - [SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md) - [SignatureRequestListResponse](docs/SignatureRequestListResponse.md) - [SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md) @@ -391,6 +400,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.8.0 +- Package version: 1.9.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen diff --git a/VERSION b/VERSION index 27f9cd3..f8e233b 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.8.0 +1.9.0 diff --git a/bin/check-clean-git-status b/bin/check-clean-git-status index a2131c2..debcd48 100755 --- a/bin/check-clean-git-status +++ b/bin/check-clean-git-status @@ -7,6 +7,7 @@ if [[ $(git status --porcelain) != '' ]]; then printf "\t./run-build\n" git status + git diff exit 1 else diff --git a/bin/generate-examples.php b/bin/generate-examples.php index ff3b6d3..dc872e5 100755 --- a/bin/generate-examples.php +++ b/bin/generate-examples.php @@ -271,4 +271,3 @@ protected function getReplaceCodeString( $generate->setUseSnakeCase(true); $generate->run(); - diff --git a/bin/replace b/bin/replace index a9ebab9..1199c95 100755 --- a/bin/replace +++ b/bin/replace @@ -23,6 +23,6 @@ rep () { done } -rep 'Union\[StrictBytes, StrictStr\]' 'Union[StrictBytes, StrictStr, io.IOBase]' +rep 'Union\[StrictBytes, StrictStr, Tuple\[StrictStr, StrictBytes\]\]' 'Union[StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]]' printf "\n" diff --git a/docs/AccountApi.md b/docs/AccountApi.md index ce6cc0f..baf60a9 100644 --- a/docs/AccountApi.md +++ b/docs/AccountApi.md @@ -23,29 +23,30 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountCreateRequest( + account_create_request = models.AccountCreateRequest( email_address="newuser@dropboxsign.com", ) try: - response = account_api.account_create(data) + response = api.AccountApi(api_client).account_create( + account_create_request=account_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_create: %s\n" % e) ``` ``` @@ -90,25 +91,24 @@ Returns the properties and settings of your Account. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - try: - response = account_api.account_get(email_address="jack@example.com") + response = api.AccountApi(api_client).account_get() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_get: %s\n" % e) ``` ``` @@ -154,29 +154,31 @@ Updates the properties and settings of your Account. Currently only allows for u * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountUpdateRequest( + account_update_request = models.AccountUpdateRequest( callback_url="https://www.example.com/callback", + locale="en-US", ) try: - response = account_api.account_update(data) + response = api.AccountApi(api_client).account_update( + account_update_request=account_update_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_update: %s\n" % e) ``` ``` @@ -221,29 +223,30 @@ Verifies whether an Dropbox Sign Account exists for the given email address. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountVerifyRequest( + account_verify_request = models.AccountVerifyRequest( email_address="some_user@dropboxsign.com", ) try: - response = account_api.account_verify(data) + response = api.AccountApi(api_client).account_verify( + account_verify_request=account_verify_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_verify: %s\n" % e) ``` ``` diff --git a/docs/AccountCreateRequest.md b/docs/AccountCreateRequest.md index a804661..6801084 100644 --- a/docs/AccountCreateRequest.md +++ b/docs/AccountCreateRequest.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/AccountCreateResponse.md b/docs/AccountCreateResponse.md index 9b1be12..4e24e96 100644 --- a/docs/AccountCreateResponse.md +++ b/docs/AccountCreateResponse.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/AccountGetResponse.md b/docs/AccountGetResponse.md index 0c12540..05c7654 100644 --- a/docs/AccountGetResponse.md +++ b/docs/AccountGetResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/AccountResponse.md b/docs/AccountResponse.md index 26ce76b..fe7f8da 100644 --- a/docs/AccountResponse.md +++ b/docs/AccountResponse.md @@ -19,3 +19,4 @@ Name | Type | Description | Notes [[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/AccountResponseQuotas.md b/docs/AccountResponseQuotas.md index 1894473..c487703 100644 --- a/docs/AccountResponseQuotas.md +++ b/docs/AccountResponseQuotas.md @@ -14,3 +14,4 @@ Name | Type | Description | Notes [[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/AccountResponseUsage.md b/docs/AccountResponseUsage.md index dd99429..62eba4d 100644 --- a/docs/AccountResponseUsage.md +++ b/docs/AccountResponseUsage.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/AccountUpdateRequest.md b/docs/AccountUpdateRequest.md index 5ef47eb..cddccf4 100644 --- a/docs/AccountUpdateRequest.md +++ b/docs/AccountUpdateRequest.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/AccountVerifyRequest.md b/docs/AccountVerifyRequest.md index 9dc6f46..477b47f 100644 --- a/docs/AccountVerifyRequest.md +++ b/docs/AccountVerifyRequest.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/AccountVerifyResponse.md b/docs/AccountVerifyResponse.md index 2f0c541..46194d7 100644 --- a/docs/AccountVerifyResponse.md +++ b/docs/AccountVerifyResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/AccountVerifyResponseAccount.md b/docs/AccountVerifyResponseAccount.md index 9c4abee..b2f7d71 100644 --- a/docs/AccountVerifyResponseAccount.md +++ b/docs/AccountVerifyResponseAccount.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/ApiAppApi.md b/docs/ApiAppApi.md index 9b982da..2ee0a39 100644 --- a/docs/ApiAppApi.md +++ b/docs/ApiAppApi.md @@ -24,23 +24,24 @@ Creates a new API App. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - oauth = models.SubOAuth( callback_url="https://example.com/oauth", - scopes=["basic_account_info" "request_signature"], + scopes=[ + "basic_account_info", + "request_signature", + ], ) white_labeling_options = models.SubWhiteLabelingOptions( @@ -48,21 +49,24 @@ with ApiClient(configuration) as api_client: primary_button_text_color="#ffffff", ) - custom_logo_file = open("./CustomLogoFile.png", "rb") - - data = models.ApiAppCreateRequest( + api_app_create_request = models.ApiAppCreateRequest( name="My Production App", - domains=["example.com"], + domains=[ + "example.com", + ], + custom_logo_file=open("CustomLogoFile.png", "rb").read(), oauth=oauth, white_labeling_options=white_labeling_options, - custom_logo_file=custom_logo_file, ) try: - response = api_app_api.api_app_create(data) + response = api.ApiAppApi(api_client).api_app_create( + api_app_create_request=api_app_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_create: %s\n" % e) ``` ``` @@ -107,24 +111,24 @@ Deletes an API App. Can only be invoked for apps you own. * Bearer (JWT) Authentication (oauth2): ```python -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - try: - api_app_api.api_app_delete(client_id) + api.ApiAppApi(api_client).api_app_delete( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + ) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_delete: %s\n" % e) ``` ``` @@ -169,27 +173,26 @@ Returns an object with information about an API App. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - try: - response = api_app_api.api_app_get(client_id) + response = api.ApiAppApi(api_client).api_app_get( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_get: %s\n" % e) ``` ``` @@ -234,31 +237,27 @@ Returns a list of API Apps that are accessible by you. If you are on a team with * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - page = 1 - page_size = 2 - try: - response = api_app_api.api_app_list( - page=page, - page_size=page_size, + response = api.ApiAppApi(api_client).api_app_list( + page=1, + page_size=20, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_list: %s\n" % e) ``` ``` @@ -304,41 +303,51 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) + oauth = models.SubOAuth( + callback_url="https://example.com/oauth", + scopes=[ + "basic_account_info", + "request_signature", + ], + ) white_labeling_options = models.SubWhiteLabelingOptions( primary_button_color="#00b3e6", primary_button_text_color="#ffffff", ) - custom_logo_file = open("./CustomLogoFile.png", "rb") - - data = models.ApiAppUpdateRequest( + api_app_update_request = models.ApiAppUpdateRequest( + callback_url="https://example.com/dropboxsign", name="New Name", - callback_url="http://example.com/dropboxsign", + domains=[ + "example.com", + ], + custom_logo_file=open("CustomLogoFile.png", "rb").read(), + oauth=oauth, white_labeling_options=white_labeling_options, - custom_logo_file=custom_logo_file, ) - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - try: - response = api_app_api.api_app_update(client_id, data) + response = api.ApiAppApi(api_client).api_app_update( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + api_app_update_request=api_app_update_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_update: %s\n" % e) ``` ``` diff --git a/docs/ApiAppCreateRequest.md b/docs/ApiAppCreateRequest.md index 9cac62a..206b753 100644 --- a/docs/ApiAppCreateRequest.md +++ b/docs/ApiAppCreateRequest.md @@ -15,3 +15,4 @@ Name | Type | Description | Notes [[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/ApiAppGetResponse.md b/docs/ApiAppGetResponse.md index 7d45c86..d94e9df 100644 --- a/docs/ApiAppGetResponse.md +++ b/docs/ApiAppGetResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/ApiAppListResponse.md b/docs/ApiAppListResponse.md index b41af4e..71bdba5 100644 --- a/docs/ApiAppListResponse.md +++ b/docs/ApiAppListResponse.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/ApiAppResponse.md b/docs/ApiAppResponse.md index ae25a38..88660ac 100644 --- a/docs/ApiAppResponse.md +++ b/docs/ApiAppResponse.md @@ -18,3 +18,4 @@ Name | Type | Description | Notes [[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/ApiAppResponseOAuth.md b/docs/ApiAppResponseOAuth.md index 0c18e5f..58a6a1e 100644 --- a/docs/ApiAppResponseOAuth.md +++ b/docs/ApiAppResponseOAuth.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/ApiAppResponseOptions.md b/docs/ApiAppResponseOptions.md index 42f8144..a96d6de 100644 --- a/docs/ApiAppResponseOptions.md +++ b/docs/ApiAppResponseOptions.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/ApiAppResponseOwnerAccount.md b/docs/ApiAppResponseOwnerAccount.md index 9b8e22f..b1cd337 100644 --- a/docs/ApiAppResponseOwnerAccount.md +++ b/docs/ApiAppResponseOwnerAccount.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/ApiAppResponseWhiteLabelingOptions.md b/docs/ApiAppResponseWhiteLabelingOptions.md index 375c8f2..ae742c2 100644 --- a/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/docs/ApiAppResponseWhiteLabelingOptions.md @@ -22,3 +22,4 @@ Name | Type | Description | Notes [[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/ApiAppUpdateRequest.md b/docs/ApiAppUpdateRequest.md index 6e3238a..58a3f8a 100644 --- a/docs/ApiAppUpdateRequest.md +++ b/docs/ApiAppUpdateRequest.md @@ -15,3 +15,4 @@ Name | Type | Description | Notes [[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/BulkSendJobApi.md b/docs/BulkSendJobApi.md index cfff86e..0e045f5 100644 --- a/docs/BulkSendJobApi.md +++ b/docs/BulkSendJobApi.md @@ -21,27 +21,28 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - bulk_send_job_api = apis.BulkSendJobApi(api_client) - - bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174" - try: - response = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id) + response = api.BulkSendJobApi(api_client).bulk_send_job_get( + bulk_send_job_id="6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page=1, + page_size=20, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling BulkSendJobApi#bulk_send_job_get: %s\n" % e) ``` ``` @@ -88,31 +89,27 @@ Returns a list of BulkSendJob that you can access. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - bulk_send_job_api = apis.BulkSendJobApi(api_client) - - page = 1 - page_size = 20 - try: - response = bulk_send_job_api.bulk_send_job_list( - page=page, - page_size=page_size, + response = api.BulkSendJobApi(api_client).bulk_send_job_list( + page=1, + page_size=20, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling BulkSendJobApi#bulk_send_job_list: %s\n" % e) ``` ``` diff --git a/docs/BulkSendJobGetResponse.md b/docs/BulkSendJobGetResponse.md index a39bcb8..8f141cb 100644 --- a/docs/BulkSendJobGetResponse.md +++ b/docs/BulkSendJobGetResponse.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/BulkSendJobGetResponseSignatureRequests.md b/docs/BulkSendJobGetResponseSignatureRequests.md index 9314ae4..b697653 100644 --- a/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/docs/BulkSendJobGetResponseSignatureRequests.md @@ -33,3 +33,4 @@ Name | Type | Description | Notes [[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/BulkSendJobListResponse.md b/docs/BulkSendJobListResponse.md index 24c7abc..2767d71 100644 --- a/docs/BulkSendJobListResponse.md +++ b/docs/BulkSendJobListResponse.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/BulkSendJobResponse.md b/docs/BulkSendJobResponse.md index 19e770f..11a6322 100644 --- a/docs/BulkSendJobResponse.md +++ b/docs/BulkSendJobResponse.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/BulkSendJobSendResponse.md b/docs/BulkSendJobSendResponse.md index cf31a57..a408454 100644 --- a/docs/BulkSendJobSendResponse.md +++ b/docs/BulkSendJobSendResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/EmbeddedApi.md b/docs/EmbeddedApi.md index 9de8a57..9bf1d9d 100644 --- a/docs/EmbeddedApi.md +++ b/docs/EmbeddedApi.md @@ -21,32 +21,36 @@ Retrieves an embedded object containing a template url that can be opened in an * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - embedded_api = apis.EmbeddedApi(api_client) + merge_fields = [] - data = models.EmbeddedEditUrlRequest( - cc_roles=[""], - merge_fields=[], + embedded_edit_url_request = models.EmbeddedEditUrlRequest( + cc_roles=[ + "", + ], + merge_fields=merge_fields, ) - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - response = embedded_api.embedded_edit_url(template_id, data) + response = api.EmbeddedApi(api_client).embedded_edit_url( + template_id="f57db65d3f933b5316d398057a36176831451a35", + embedded_edit_url_request=embedded_edit_url_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling EmbeddedApi#embedded_edit_url: %s\n" % e) ``` ``` @@ -92,27 +96,26 @@ Retrieves an embedded object containing a signature url that can be opened in an * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - embedded_api = apis.EmbeddedApi(api_client) - - signature_id = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" - try: - response = embedded_api.embedded_sign_url(signature_id) + response = api.EmbeddedApi(api_client).embedded_sign_url( + signature_id="50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling EmbeddedApi#embedded_sign_url: %s\n" % e) ``` ``` diff --git a/docs/EmbeddedEditUrlRequest.md b/docs/EmbeddedEditUrlRequest.md index 6382a52..603d65b 100644 --- a/docs/EmbeddedEditUrlRequest.md +++ b/docs/EmbeddedEditUrlRequest.md @@ -18,3 +18,4 @@ Name | Type | Description | Notes [[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/EmbeddedEditUrlResponse.md b/docs/EmbeddedEditUrlResponse.md index e1f5781..7cf3c1b 100644 --- a/docs/EmbeddedEditUrlResponse.md +++ b/docs/EmbeddedEditUrlResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/EmbeddedEditUrlResponseEmbedded.md b/docs/EmbeddedEditUrlResponseEmbedded.md index ae39687..f5e819a 100644 --- a/docs/EmbeddedEditUrlResponseEmbedded.md +++ b/docs/EmbeddedEditUrlResponseEmbedded.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/EmbeddedSignUrlResponse.md b/docs/EmbeddedSignUrlResponse.md index af38fc7..e91d075 100644 --- a/docs/EmbeddedSignUrlResponse.md +++ b/docs/EmbeddedSignUrlResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/EmbeddedSignUrlResponseEmbedded.md b/docs/EmbeddedSignUrlResponseEmbedded.md index 71373c8..bf6fdbd 100644 --- a/docs/EmbeddedSignUrlResponseEmbedded.md +++ b/docs/EmbeddedSignUrlResponseEmbedded.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/ErrorResponse.md b/docs/ErrorResponse.md index dc83b8f..2f15b49 100644 --- a/docs/ErrorResponse.md +++ b/docs/ErrorResponse.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/ErrorResponseError.md b/docs/ErrorResponseError.md index 9b05890..f6052d6 100644 --- a/docs/ErrorResponseError.md +++ b/docs/ErrorResponseError.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/EventCallbackRequest.md b/docs/EventCallbackRequest.md index 857fac5..dd9655b 100644 --- a/docs/EventCallbackRequest.md +++ b/docs/EventCallbackRequest.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/EventCallbackRequestEvent.md b/docs/EventCallbackRequestEvent.md index 6eadfcd..2675bbf 100644 --- a/docs/EventCallbackRequestEvent.md +++ b/docs/EventCallbackRequestEvent.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/EventCallbackRequestEventMetadata.md b/docs/EventCallbackRequestEventMetadata.md index d510eae..35f31bb 100644 --- a/docs/EventCallbackRequestEventMetadata.md +++ b/docs/EventCallbackRequestEventMetadata.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/FaxApi.md b/docs/FaxApi.md index a0b2cbd..431d0ca 100644 --- a/docs/FaxApi.md +++ b/docs/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- |[```fax_delete```](FaxApi.md#fax_delete) | ```DELETE /fax/{fax_id}``` | Delete Fax| -|[```fax_files```](FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | List Fax Files| +|[```fax_files```](FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | Download Fax Files| |[```fax_get```](FaxApi.md#fax_get) | ```GET /fax/{fax_id}``` | Get Fax| |[```fax_list```](FaxApi.md#fax_list) | ```GET /fax/list``` | Lists Faxes| |[```fax_send```](FaxApi.md#fax_send) | ```POST /fax/send``` | Send Fax| @@ -16,29 +16,30 @@ Method | HTTP request | Description Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - try: - fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") + api.FaxApi(api_client).fax_delete( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_delete: %s\n" % e) ``` ``` @@ -73,34 +74,34 @@ void (empty response body) # ```fax_files``` > ```io.IOBase fax_files(fax_id)``` -List Fax Files +Download Fax Files -Returns list of fax files +Downloads files associated with a Fax ### Example * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = fax_api.fax_files(fax_id) - open("file_response.pdf", "wb").write(response.read()) + response = api.FaxApi(api_client).fax_files( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + open("./file_response", "wb").write(response.read()) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_files: %s\n" % e) ``` ``` @@ -137,32 +138,32 @@ with ApiClient(configuration) as api_client: Get Fax -Returns information about fax +Returns information about a Fax ### Example * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = fax_api.fax_get(fax_id) + response = api.FaxApi(api_client).fax_get( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_get: %s\n" % e) ``` ``` @@ -199,36 +200,33 @@ with ApiClient(configuration) as api_client: Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - page = 1 - page_size = 2 - try: - response = fax_api.fax_list( - page=page, - page_size=page_size, + response = api.FaxApi(api_client).fax_list( + page=1, + page_size=20, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_list: %s\n" % e) ``` ``` @@ -236,8 +234,8 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `page` | **int** | Page | [optional][default to 1] | -| `page_size` | **int** | Page size | [optional][default to 20] | +| `page` | **int** | Which page number of the Fax List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **int** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | ### Return type @@ -266,41 +264,45 @@ with ApiClient(configuration) as api_client: Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - data = models.FaxSendRequest( - files=[open("example_signature_request.pdf", "rb")], - test_mode=True, + fax_send_request = models.FaxSendRequest( recipient="16690000001", sender="16690000000", + test_mode=True, cover_page_to="Jill Fax", - cover_page_message="I'm sending you a fax!", cover_page_from="Faxer Faxerson", + cover_page_message="I'm sending you a fax!", title="This is what the fax is about!", + files=[ + open("./example_fax.pdf", "rb").read(), + ], ) try: - response = fax_api.fax_send(data) + response = api.FaxApi(api_client).fax_send( + fax_send_request=fax_send_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_send: %s\n" % e) ``` ``` diff --git a/docs/FaxGetResponse.md b/docs/FaxGetResponse.md index 02b92d6..094dc61 100644 --- a/docs/FaxGetResponse.md +++ b/docs/FaxGetResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/FaxLineAddUserRequest.md b/docs/FaxLineAddUserRequest.md index 9d2c5e1..71ba11c 100644 --- a/docs/FaxLineAddUserRequest.md +++ b/docs/FaxLineAddUserRequest.md @@ -5,9 +5,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | +| `number`*_required_ | ```str``` | The Fax Line number | | | `account_id` | ```str``` | Account ID | | | `email_address` | ```str``` | Email address | | [[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/FaxLineApi.md b/docs/FaxLineApi.md index 27ec4d0..4f1b2a4 100644 --- a/docs/FaxLineApi.md +++ b/docs/FaxLineApi.md @@ -25,28 +25,30 @@ Grants a user access to the specified Fax Line. * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineAddUserRequest( + fax_line_add_user_request = models.FaxLineAddUserRequest( number="[FAX_NUMBER]", email_address="member@dropboxsign.com", ) try: - response = fax_line_api.fax_line_add_user(data) + response = api.FaxLineApi(api_client).fax_line_add_user( + fax_line_add_user_request=fax_line_add_user_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_add_user: %s\n" % e) ``` ``` @@ -83,30 +85,32 @@ with ApiClient(configuration) as api_client: Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a list of available area codes for a given state/province and city ### Example * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_area_code_get("US", "CA") + response = api.FaxLineApi(api_client).fax_line_area_code_get( + country="US", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_area_code_get: %s\n" % e) ``` ``` @@ -114,10 +118,10 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `country` | **str** | Filter area codes by country. | | -| `state` | **str** | Filter area codes by state. | [optional] | -| `province` | **str** | Filter area codes by province. | [optional] | -| `city` | **str** | Filter area codes by city. | [optional] | +| `country` | **str** | Filter area codes by country | | +| `state` | **str** | Filter area codes by state | [optional] | +| `province` | **str** | Filter area codes by province | [optional] | +| `city` | **str** | Filter area codes by city | [optional] | ### Return type @@ -146,35 +150,37 @@ with ApiClient(configuration) as api_client: Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineCreateRequest( + fax_line_create_request = models.FaxLineCreateRequest( area_code=209, country="US", ) try: - response = fax_line_api.fax_line_create(data) + response = api.FaxLineApi(api_client).fax_line_create( + fax_line_create_request=fax_line_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_create: %s\n" % e) ``` ``` @@ -218,26 +224,27 @@ Deletes the specified Fax Line from the subscription. * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineDeleteRequest( + fax_line_delete_request = models.FaxLineDeleteRequest( number="[FAX_NUMBER]", ) try: - fax_line_api.fax_line_delete(data) + api.FaxLineApi(api_client).fax_line_delete( + fax_line_delete_request=fax_line_delete_request, + ) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_delete: %s\n" % e) ``` ``` @@ -281,23 +288,25 @@ Returns the properties and settings of a Fax Line. * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_get("[FAX_NUMBER]") + response = api.FaxLineApi(api_client).fax_line_get( + number="123-123-1234", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_get: %s\n" % e) ``` ``` @@ -305,7 +314,7 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number` | **str** | The Fax Line number. | | +| `number` | **str** | The Fax Line number | | ### Return type @@ -341,23 +350,27 @@ Returns the properties and settings of multiple Fax Lines. * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_list() + response = api.FaxLineApi(api_client).fax_line_list( + account_id="ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page=1, + page_size=20, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_list: %s\n" % e) ``` ``` @@ -366,9 +379,9 @@ with ApiClient(configuration) as api_client: | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **str** | Account ID | [optional] | -| `page` | **int** | Page | [optional][default to 1] | -| `page_size` | **int** | Page size | [optional][default to 20] | -| `show_team_lines` | **bool** | Show team lines | [optional] | +| `page` | **int** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **int** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | +| `show_team_lines` | **bool** | Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -397,35 +410,37 @@ with ApiClient(configuration) as api_client: Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineRemoveUserRequest( + fax_line_remove_user_request = models.FaxLineRemoveUserRequest( number="[FAX_NUMBER]", email_address="member@dropboxsign.com", ) try: - response = fax_line_api.fax_line_remove_user(data) + response = api.FaxLineApi(api_client).fax_line_remove_user( + fax_line_remove_user_request=fax_line_remove_user_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_remove_user: %s\n" % e) ``` ``` diff --git a/docs/FaxLineAreaCodeGetCountryEnum.md b/docs/FaxLineAreaCodeGetCountryEnum.md index 6ad763e..3bb66b2 100644 --- a/docs/FaxLineAreaCodeGetCountryEnum.md +++ b/docs/FaxLineAreaCodeGetCountryEnum.md @@ -8,3 +8,4 @@ Name | Type | Description | Notes [[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/FaxLineAreaCodeGetProvinceEnum.md b/docs/FaxLineAreaCodeGetProvinceEnum.md index 71e2411..a5d0565 100644 --- a/docs/FaxLineAreaCodeGetProvinceEnum.md +++ b/docs/FaxLineAreaCodeGetProvinceEnum.md @@ -8,3 +8,4 @@ Name | Type | Description | Notes [[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/FaxLineAreaCodeGetResponse.md b/docs/FaxLineAreaCodeGetResponse.md index b7fc28c..f3ce207 100644 --- a/docs/FaxLineAreaCodeGetResponse.md +++ b/docs/FaxLineAreaCodeGetResponse.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/FaxLineAreaCodeGetStateEnum.md b/docs/FaxLineAreaCodeGetStateEnum.md index d62ba3a..36b555f 100644 --- a/docs/FaxLineAreaCodeGetStateEnum.md +++ b/docs/FaxLineAreaCodeGetStateEnum.md @@ -8,3 +8,4 @@ Name | Type | Description | Notes [[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/FaxLineCreateRequest.md b/docs/FaxLineCreateRequest.md index b6b33b3..f28c43a 100644 --- a/docs/FaxLineCreateRequest.md +++ b/docs/FaxLineCreateRequest.md @@ -5,10 +5,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `area_code`*_required_ | ```int``` | Area code | | -| `country`*_required_ | ```str``` | Country | | -| `city` | ```str``` | City | | -| `account_id` | ```str``` | Account ID | | +| `area_code`*_required_ | ```int``` | Area code of the new Fax Line | | +| `country`*_required_ | ```str``` | Country of the area code | | +| `city` | ```str``` | City of the area code | | +| `account_id` | ```str``` | Account ID of the account that will be assigned this new Fax Line | | [[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/FaxLineDeleteRequest.md b/docs/FaxLineDeleteRequest.md index ad6985a..b8e7607 100644 --- a/docs/FaxLineDeleteRequest.md +++ b/docs/FaxLineDeleteRequest.md @@ -5,7 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | +| `number`*_required_ | ```str``` | The Fax Line number | | [[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/FaxLineListResponse.md b/docs/FaxLineListResponse.md index 7510777..bcea954 100644 --- a/docs/FaxLineListResponse.md +++ b/docs/FaxLineListResponse.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/FaxLineRemoveUserRequest.md b/docs/FaxLineRemoveUserRequest.md index 561ddea..2abb520 100644 --- a/docs/FaxLineRemoveUserRequest.md +++ b/docs/FaxLineRemoveUserRequest.md @@ -5,9 +5,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | -| `account_id` | ```str``` | Account ID | | -| `email_address` | ```str``` | Email address | | +| `number`*_required_ | ```str``` | The Fax Line number | | +| `account_id` | ```str``` | Account ID of the user to remove access | | +| `email_address` | ```str``` | Email address of the user to remove access | | [[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/FaxLineResponse.md b/docs/FaxLineResponse.md index d967591..e16ea94 100644 --- a/docs/FaxLineResponse.md +++ b/docs/FaxLineResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/FaxLineResponseFaxLine.md b/docs/FaxLineResponseFaxLine.md index f3e14c0..426f94f 100644 --- a/docs/FaxLineResponseFaxLine.md +++ b/docs/FaxLineResponseFaxLine.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/FaxListResponse.md b/docs/FaxListResponse.md index e57c188..9d2eb82 100644 --- a/docs/FaxListResponse.md +++ b/docs/FaxListResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/FaxResponse.md b/docs/FaxResponse.md index f8bc78c..81070c5 100644 --- a/docs/FaxResponse.md +++ b/docs/FaxResponse.md @@ -19,3 +19,4 @@ Name | Type | Description | Notes [[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 fb60d8b..61263d6 100644 --- a/docs/FaxResponseTransmission.md +++ b/docs/FaxResponseTransmission.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/FaxSendRequest.md b/docs/FaxSendRequest.md index cdb4f49..5f19b73 100644 --- a/docs/FaxSendRequest.md +++ b/docs/FaxSendRequest.md @@ -5,15 +5,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```str``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```str``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```str``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```List[io.IOBase]``` | Fax File to Send | | -| `file_urls` | ```List[str]``` | Fax File URL to Send | | +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `test_mode` | ```bool``` | API Test Mode Setting | [default to False] | -| `cover_page_to` | ```str``` | Fax Cover Page for Recipient | | -| `cover_page_from` | ```str``` | Fax Cover Page for Sender | | +| `cover_page_to` | ```str``` | Fax cover page recipient information | | +| `cover_page_from` | ```str``` | Fax cover page sender information | | | `cover_page_message` | ```str``` | Fax Cover Page Message | | | `title` | ```str``` | Fax Title | | [[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/FileResponse.md b/docs/FileResponse.md index db71810..93eb0b6 100644 --- a/docs/FileResponse.md +++ b/docs/FileResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/FileResponseDataUri.md b/docs/FileResponseDataUri.md index aae7f44..fa83a3d 100644 --- a/docs/FileResponseDataUri.md +++ b/docs/FileResponseDataUri.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/ListInfoResponse.md b/docs/ListInfoResponse.md index 57a3075..5a5fd32 100644 --- a/docs/ListInfoResponse.md +++ b/docs/ListInfoResponse.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/OAuthApi.md b/docs/OAuthApi.md index b267756..21bd2df 100644 --- a/docs/OAuthApi.md +++ b/docs/OAuthApi.md @@ -19,27 +19,31 @@ Once you have retrieved the code from the user callback, you will need to exchan ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration() with ApiClient(configuration) as api_client: - oauth_api = apis.OAuthApi(api_client) - - data = models.OAuthTokenGenerateRequest( - state="900e06e2", - code="1b0d28d90c86c141", + o_auth_token_generate_request = models.OAuthTokenGenerateRequest( client_id="cc91c61d00f8bb2ece1428035716b", client_secret="1d14434088507ffa390e6f5528465", + code="1b0d28d90c86c141", + state="900e06e2", + grant_type="authorization_code", ) try: - response = oauth_api.oauth_token_generate(data) + response = api.OAuthApi(api_client).oauth_token_generate( + o_auth_token_generate_request=o_auth_token_generate_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling OAuthApi#oauth_token_generate: %s\n" % e) ``` ``` @@ -82,24 +86,28 @@ Access tokens are only valid for a given period of time (typically one hour) for ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration() with ApiClient(configuration) as api_client: - oauth_api = apis.OAuthApi(api_client) - - data = models.OAuthTokenRefreshRequest( + o_auth_token_refresh_request = models.OAuthTokenRefreshRequest( + grant_type="refresh_token", refresh_token="hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", ) try: - response = oauth_api.oauth_token_refresh(data) + response = api.OAuthApi(api_client).oauth_token_refresh( + o_auth_token_refresh_request=o_auth_token_refresh_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling OAuthApi#oauth_token_refresh: %s\n" % e) ``` ``` diff --git a/docs/OAuthTokenGenerateRequest.md b/docs/OAuthTokenGenerateRequest.md index 9e53f79..e2f1ab2 100644 --- a/docs/OAuthTokenGenerateRequest.md +++ b/docs/OAuthTokenGenerateRequest.md @@ -13,3 +13,4 @@ Name | Type | Description | Notes [[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/OAuthTokenRefreshRequest.md b/docs/OAuthTokenRefreshRequest.md index 87662c9..3dd2809 100644 --- a/docs/OAuthTokenRefreshRequest.md +++ b/docs/OAuthTokenRefreshRequest.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/OAuthTokenResponse.md b/docs/OAuthTokenResponse.md index a05a77d..5bea2b6 100644 --- a/docs/OAuthTokenResponse.md +++ b/docs/OAuthTokenResponse.md @@ -13,3 +13,4 @@ Name | Type | Description | Notes [[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/ReportApi.md b/docs/ReportApi.md index 022e0c3..0ddd8c3 100644 --- a/docs/ReportApi.md +++ b/docs/ReportApi.md @@ -12,38 +12,43 @@ Method | HTTP request | Description Create Report -Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. +Request the creation of one or more report(s). + +When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. ### Example * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - report_api = apis.ReportApi(api_client) - - data = models.ReportCreateRequest( + report_create_request = models.ReportCreateRequest( start_date="09/01/2020", end_date="09/01/2020", - report_type=["user_activity" "document_status"], + report_type=[ + "user_activity", + "document_status", + ], ) try: - response = report_api.report_create(data) + response = api.ReportApi(api_client).report_create( + report_create_request=report_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ReportApi#report_create: %s\n" % e) ``` ``` diff --git a/docs/ReportCreateRequest.md b/docs/ReportCreateRequest.md index c14641c..7485256 100644 --- a/docs/ReportCreateRequest.md +++ b/docs/ReportCreateRequest.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/ReportCreateResponse.md b/docs/ReportCreateResponse.md index 2ffc8dc..46f8508 100644 --- a/docs/ReportCreateResponse.md +++ b/docs/ReportCreateResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/ReportResponse.md b/docs/ReportResponse.md index 381f19a..2215e1f 100644 --- a/docs/ReportResponse.md +++ b/docs/ReportResponse.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/SignatureRequestApi.md b/docs/SignatureRequestApi.md index 2db45f1..aa17c91 100644 --- a/docs/SignatureRequestApi.md +++ b/docs/SignatureRequestApi.md @@ -9,6 +9,10 @@ Method | HTTP request | Description |[```signature_request_cancel```](SignatureRequestApi.md#signature_request_cancel) | ```POST /signature_request/cancel/{signature_request_id}``` | Cancel Incomplete Signature Request| |[```signature_request_create_embedded```](SignatureRequestApi.md#signature_request_create_embedded) | ```POST /signature_request/create_embedded``` | Create Embedded Signature Request| |[```signature_request_create_embedded_with_template```](SignatureRequestApi.md#signature_request_create_embedded_with_template) | ```POST /signature_request/create_embedded_with_template``` | Create Embedded Signature Request with Template| +|[```signature_request_edit```](SignatureRequestApi.md#signature_request_edit) | ```PUT /signature_request/edit/{signature_request_id}``` | Edit Signature Request| +|[```signature_request_edit_embedded```](SignatureRequestApi.md#signature_request_edit_embedded) | ```PUT /signature_request/edit_embedded/{signature_request_id}``` | Edit Embedded Signature Request| +|[```signature_request_edit_embedded_with_template```](SignatureRequestApi.md#signature_request_edit_embedded_with_template) | ```PUT /signature_request/edit_embedded_with_template/{signature_request_id}``` | Edit Embedded Signature Request with Template| +|[```signature_request_edit_with_template```](SignatureRequestApi.md#signature_request_edit_with_template) | ```PUT /signature_request/edit_with_template/{signature_request_id}``` | Edit Signature Request With Template| |[```signature_request_files```](SignatureRequestApi.md#signature_request_files) | ```GET /signature_request/files/{signature_request_id}``` | Download Files| |[```signature_request_files_as_data_uri```](SignatureRequestApi.md#signature_request_files_as_data_uri) | ```GET /signature_request/files_as_data_uri/{signature_request_id}``` | Download Files as Data Uri| |[```signature_request_files_as_file_url```](SignatureRequestApi.md#signature_request_files_as_file_url) | ```GET /signature_request/files_as_file_url/{signature_request_id}``` | Download Files as File Url| @@ -27,85 +31,117 @@ Method | HTTP request | Description Embedded Bulk Send with Template -Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. +Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +**NOTE:** Only available for Standard plan and higher. ### Example * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) + signer_list_2_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="123 LLC", + ) + + signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, + ] - signer_list_1_signer = models.SubSignatureRequestTemplateSigner( + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - name="George", - email_address="george@example.com", - pin="d79a3td", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", ) - signer_list_1_custom_fields = models.SubBulkSignerListCustomField( + signer_list_2_signers = [ + signer_list_2_signers_1, + ] + + signer_list_1_custom_fields_1 = models.SubBulkSignerListCustomField( name="company", value="ABC Corp", ) - signer_list_1 = models.SubBulkSignerList( - signers=[signer_list_1_signer], - custom_fields=[signer_list_1_custom_fields], - ) + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] - signer_list_2_signer = models.SubSignatureRequestTemplateSigner( + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - name="Mary", - email_address="mary@example.com", - pin="gd9as5b", + name="George", + email_address="george@example.com", + pin="d79a3td", ) - signer_list_2_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="123 LLC", + signer_list_1_signers = [ + signer_list_1_signers_1, + ] + + signer_list_1 = models.SubBulkSignerList( + custom_fields=signer_list_1_custom_fields, + signers=signer_list_1_signers, ) signer_list_2 = models.SubBulkSignerList( - signers=[signer_list_2_signer], - custom_fields=[signer_list_2_custom_fields], + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, ) - cc_1 = models.SubCC( + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( role="Accounting", email_address="accounting@example.com", ) - data = models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest( - client_id="1a659d9ad95bccd307ecad78d72192f8", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signer_list=[signer_list_1, signer_list_2], - ccs=[cc_1], - test_mode=True, + ccs = [ + ccs_1, + ] + + signature_request_bulk_create_embedded_with_template_request = ( + models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest( + client_id="1a659d9ad95bccd307ecad78d72192f8", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signer_list=signer_list, + ccs=ccs, + ) ) try: - response = ( - signature_request_api.signature_request_bulk_create_embedded_with_template( - data - ) + response = api.SignatureRequestApi( + api_client + ).signature_request_bulk_create_embedded_with_template( + signature_request_bulk_create_embedded_with_template_request=signature_request_bulk_create_embedded_with_template_request, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: %s\n" + % e + ) ``` ``` @@ -142,7 +178,9 @@ with ApiClient(configuration) as api_client: Bulk Send with Template -Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. +Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. + +**NOTE:** Only available for Standard plan and higher. ### Example @@ -150,73 +188,517 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) + signer_list_2_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="123 LLC", + ) + + signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, + ] - signer_list_1_signer = models.SubSignatureRequestTemplateSigner( + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - name="George", - email_address="george@example.com", - pin="d79a3td", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", ) - signer_list_1_custom_fields = models.SubBulkSignerListCustomField( + signer_list_2_signers = [ + signer_list_2_signers_1, + ] + + signer_list_1_custom_fields_1 = models.SubBulkSignerListCustomField( name="company", value="ABC Corp", ) + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] + + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + pin="d79a3td", + ) + + signer_list_1_signers = [ + signer_list_1_signers_1, + ] + signer_list_1 = models.SubBulkSignerList( - signers=[signer_list_1_signer], - custom_fields=[signer_list_1_custom_fields], + custom_fields=signer_list_1_custom_fields, + signers=signer_list_1_signers, + ) + + signer_list_2 = models.SubBulkSignerList( + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, + ) + + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + signature_request_bulk_send_with_template_request = ( + models.SignatureRequestBulkSendWithTemplateRequest( + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signer_list=signer_list, + ccs=ccs, + ) + ) + + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_bulk_send_with_template( + signature_request_bulk_send_with_template_request=signature_request_bulk_send_with_template_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: %s\n" + % e + ) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_bulk_send_with_template_request` | [**SignatureRequestBulkSendWithTemplateRequest**](SignatureRequestBulkSendWithTemplateRequest.md) | | | + +### Return type + +[**BulkSendJobSendResponse**](BulkSendJobSendResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# ```signature_request_cancel``` +> ```signature_request_cancel(signature_request_id)``` + +Cancel Incomplete Signature Request + +Cancels an incomplete signature request. This action is **not reversible**. + +The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. + +This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. + +To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. + +**NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + +### Example + +* Basic Authentication (api_key): +* Bearer (JWT) Authentication (oauth2): + +```python +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.SignatureRequestApi(api_client).signature_request_cancel( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_cancel: %s\n" + % e + ) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **str** | The id of the incomplete SignatureRequest to cancel. | | + +### Return type + +void (empty response body) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# ```signature_request_create_embedded``` +> ```SignatureRequestGetResponse signature_request_create_embedded(signature_request_create_embedded_request)``` + +Create Embedded Signature Request + +Creates a new 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. + +### Example + +* Basic Authentication (api_key): +* Bearer (JWT) Authentication (oauth2): + +```python +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_create_embedded_request = models.SignatureRequestCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_create_embedded( + signature_request_create_embedded_request=signature_request_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_create_embedded: %s\n" + % e + ) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_create_embedded_request` | [**SignatureRequestCreateEmbeddedRequest**](SignatureRequestCreateEmbeddedRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# ```signature_request_create_embedded_with_template``` +> ```SignatureRequestGetResponse signature_request_create_embedded_with_template(signature_request_create_embedded_with_template_request)``` + +Create Embedded Signature Request with Template + +Creates a new 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. + +### Example + +* Basic Authentication (api_key): +* Bearer (JWT) Authentication (oauth2): + +```python +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, ) - signer_list_2_signer = models.SubSignatureRequestTemplateSigner( + signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - name="Mary", - email_address="mary@example.com", - pin="gd9as5b", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + signature_request_create_embedded_with_template_request = ( + models.SignatureRequestCreateEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ) + ) + + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_create_embedded_with_template( + signature_request_create_embedded_with_template_request=signature_request_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: %s\n" + % e + ) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_create_embedded_with_template_request` | [**SignatureRequestCreateEmbeddedWithTemplateRequest**](SignatureRequestCreateEmbeddedWithTemplateRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# ```signature_request_edit``` +> ```SignatureRequestGetResponse signature_request_edit(signature_request_id, signature_request_edit_request)``` + +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* deduct your signature request quota. + +### Example + +* Basic Authentication (api_key): +* Bearer (JWT) Authentication (oauth2): + +```python +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, ) - signer_list_2_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="123 LLC", + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, ) - signer_list_2 = models.SubBulkSignerList( - signers=[signer_list_2_signer], - custom_fields=[signer_list_2_custom_fields], + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, ) - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) + signers = [ + signers_1, + signers_2, + ] - data = models.SignatureRequestBulkSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signer_list=[signer_list_1, signer_list_2], - ccs=[cc_1], + signature_request_edit_request = models.SignatureRequestEditRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", test_mode=True, + title="NDA with Acme Co.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + metadata=json.loads( + """ + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """ + ), + field_options=field_options, + signing_options=signing_options, + signers=signers, ) try: - response = signature_request_api.signature_request_bulk_send_with_template(data) + response = api.SignatureRequestApi(api_client).signature_request_edit( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request=signature_request_edit_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_edit: %s\n" + % e + ) ``` ``` @@ -224,11 +706,12 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `signature_request_bulk_send_with_template_request` | [**SignatureRequestBulkSendWithTemplateRequest**](SignatureRequestBulkSendWithTemplateRequest.md) | | | +| `signature_request_id` | **str** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_request` | [**SignatureRequestEditRequest**](SignatureRequestEditRequest.md) | | | ### Return type -[**BulkSendJobSendResponse**](BulkSendJobSendResponse.md) +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) ### Authorization @@ -248,12 +731,14 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# ```signature_request_cancel``` -> ```signature_request_cancel(signature_request_id)``` +# ```signature_request_edit_embedded``` +> ```SignatureRequestGetResponse signature_request_edit_embedded(signature_request_id, signature_request_edit_embedded_request)``` -Cancel Incomplete Signature Request +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. -Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. +**NOTE:** Edit and resend *will* deduct your signature request quota. ### Example @@ -261,24 +746,72 @@ Cancels an incomplete signature request. This action is **not reversible**. The * Bearer (JWT) Authentication (oauth2): ```python -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" + signature_request_edit_embedded_request = models.SignatureRequestEditEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signing_options=signing_options, + signers=signers, + ) try: - signature_request_api.signature_request_cancel(signature_request_id) + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + ) + + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_edit_embedded: %s\n" + % e + ) ``` ``` @@ -286,11 +819,12 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `signature_request_id` | **str** | The id of the incomplete SignatureRequest to cancel. | | +| `signature_request_id` | **str** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_embedded_request` | [**SignatureRequestEditEmbeddedRequest**](SignatureRequestEditEmbeddedRequest.md) | | | ### Return type -void (empty response body) +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) ### Authorization @@ -298,7 +832,7 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json ### HTTP response details @@ -310,12 +844,14 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# ```signature_request_create_embedded``` -> ```SignatureRequestGetResponse signature_request_create_embedded(signature_request_create_embedded_request)``` +# ```signature_request_edit_embedded_with_template``` +> ```SignatureRequestGetResponse signature_request_edit_embedded_with_template(signature_request_id, signature_request_edit_embedded_with_template_request)``` -Create Embedded Signature Request +Edit Embedded Signature Request with Template -Creates a new 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 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 @@ -323,57 +859,64 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) - signing_options = models.SubSigningOptions( + default_type="draw", draw=True, + phone=False, type=True, upload=True, - phone=True, - default_type="draw", ) - data = models.SignatureRequestCreateEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - title="NDA with Acme Co.", - 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.", - signers=[signer_1, signer_2], - cc_email_addresses=["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"], - files=[open("example_signature_request.pdf", "rb")], - signing_options=signing_options, - test_mode=True, + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + signature_request_edit_embedded_with_template_request = ( + models.SignatureRequestEditEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ) ) try: - response = signature_request_api.signature_request_create_embedded(data) + response = api.SignatureRequestApi( + api_client + ).signature_request_edit_embedded_with_template( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_with_template_request=signature_request_edit_embedded_with_template_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: %s\n" + % e + ) ``` ``` @@ -381,7 +924,8 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `signature_request_create_embedded_request` | [**SignatureRequestCreateEmbeddedRequest**](SignatureRequestCreateEmbeddedRequest.md) | | | +| `signature_request_id` | **str** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_embedded_with_template_request` | [**SignatureRequestEditEmbeddedWithTemplateRequest**](SignatureRequestEditEmbeddedWithTemplateRequest.md) | | | ### Return type @@ -405,12 +949,14 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# ```signature_request_create_embedded_with_template``` -> ```SignatureRequestGetResponse signature_request_create_embedded_with_template(signature_request_create_embedded_with_template_request)``` +# ```signature_request_edit_with_template``` +> ```SignatureRequestGetResponse signature_request_edit_with_template(signature_request_id, signature_request_edit_with_template_request)``` -Create Embedded Signature Request with Template +Edit Signature Request With Template -Creates a new 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 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. ### Example @@ -418,51 +964,85 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="jack@example.com", - name="Jack", - ) - signing_options = models.SubSigningOptions( + default_type="draw", draw=True, + phone=False, type=True, upload=True, - phone=True, - default_type="draw", ) - data = models.SignatureRequestCreateEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - signing_options=signing_options, - test_mode=True, + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + custom_fields_1 = models.SubCustomField( + name="Cost", + editor="Client", + required=True, + value="$20,000", + ) + + custom_fields = [ + custom_fields_1, + ] + + signature_request_edit_with_template_request = ( + models.SignatureRequestEditWithTemplateRequest( + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ccs=ccs, + custom_fields=custom_fields, + ) ) try: - response = ( - signature_request_api.signature_request_create_embedded_with_template(data) + response = api.SignatureRequestApi( + api_client + ).signature_request_edit_with_template( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_with_template_request=signature_request_edit_with_template_request, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_edit_with_template: %s\n" + % e + ) ``` ``` @@ -470,7 +1050,8 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `signature_request_create_embedded_with_template_request` | [**SignatureRequestCreateEmbeddedWithTemplateRequest**](SignatureRequestCreateEmbeddedWithTemplateRequest.md) | | | +| `signature_request_id` | **str** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_with_template_request` | [**SignatureRequestEditWithTemplateRequest**](SignatureRequestEditWithTemplateRequest.md) | | | ### Return type @@ -499,7 +1080,9 @@ with ApiClient(configuration) as api_client: Download Files -Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. +Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. + +If the files are currently being prepared, a status code of `409` will be returned instead. ### Example @@ -507,29 +1090,30 @@ Obtain a copy of the current documents specified by the `signature_request_id` p * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = signature_request_api.signature_request_files( - signature_request_id, file_type="pdf" + response = api.SignatureRequestApi(api_client).signature_request_files( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + file_type="pdf", ) - open("file_response.pdf", "wb").write(response.read()) + + open("./file_response", "wb").write(response.read()) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_files: %s\n" + % e + ) ``` ``` @@ -567,7 +1151,9 @@ with ApiClient(configuration) as api_client: Download Files as Data Uri -Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. +Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). + +If the files are currently being prepared, a status code of `409` will be returned instead. ### Example @@ -575,29 +1161,31 @@ Obtain a copy of the current documents specified by the `signature_request_id` p * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = signature_request_api.signature_request_files_as_data_uri( - signature_request_id + response = api.SignatureRequestApi( + api_client + ).signature_request_files_as_data_uri( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: %s\n" + % e + ) ``` ``` @@ -634,7 +1222,9 @@ with ApiClient(configuration) as api_client: Download Files as File Url -Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. +Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). + +If the files are currently being prepared, a status code of `409` will be returned instead. ### Example @@ -642,29 +1232,32 @@ Obtain a copy of the current documents specified by the `signature_request_id` p * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = signature_request_api.signature_request_files_as_file_url( - signature_request_id + response = api.SignatureRequestApi( + api_client + ).signature_request_files_as_file_url( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + force_download=1, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_files_as_file_url: %s\n" + % e + ) ``` ``` @@ -710,27 +1303,28 @@ Returns the status of the SignatureRequest specified by the `signature_request_i * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = signature_request_api.signature_request_get(signature_request_id) + response = api.SignatureRequestApi(api_client).signature_request_get( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_get: %s\n" % e + ) ``` ``` @@ -767,7 +1361,9 @@ with ApiClient(configuration) as api_client: List Signature Requests -Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. +Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. + +Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. ### Example @@ -775,31 +1371,30 @@ Returns a list of SignatureRequests that you can access. This includes Signature * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - account_id = None - page = 1 - try: - response = signature_request_api.signature_request_list( - account_id=account_id, - page=page, + response = api.SignatureRequestApi(api_client).signature_request_list( + page=1, + page_size=20, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_list: %s\n" + % e + ) ``` ``` @@ -847,29 +1442,29 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_release_hold( - signature_request_id + response = api.SignatureRequestApi(api_client).signature_request_release_hold( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_release_hold: %s\n" + % e + ) ``` ``` @@ -906,7 +1501,9 @@ with ApiClient(configuration) as api_client: Send Request Reminder -Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. +Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. + +**NOTE:** This action can **not** be used with embedded signature requests. ### Example @@ -914,33 +1511,34 @@ Sends an email to the signer reminding them to sign the signature request. You c * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - data = models.SignatureRequestRemindRequest( + signature_request_remind_request = models.SignatureRequestRemindRequest( email_address="john@example.com", ) - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_remind( - signature_request_id, data + response = api.SignatureRequestApi(api_client).signature_request_remind( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_remind_request=signature_request_remind_request, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_remind: %s\n" + % e + ) ``` ``` @@ -978,31 +1576,37 @@ with ApiClient(configuration) as api_client: Remove Signature Request Access -Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. +Removes your access to a completed signature request. This action is **not reversible**. + +The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). + +Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. ### Example * Basic Authentication (api_key): ```python -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - signature_request_api.signature_request_remove(signature_request_id) + api.SignatureRequestApi(api_client).signature_request_remove( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_remove: %s\n" + % e + ) ``` ``` @@ -1047,68 +1651,83 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", ) signing_options = models.SubSigningOptions( + default_type="draw", draw=True, + phone=False, type=True, upload=True, - phone=True, - default_type="draw", ) - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, ) - data = models.SignatureRequestSendRequest( - title="NDA with Acme Co.", + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_send_request = models.SignatureRequestSendRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", 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.", - signers=[signer_1, signer_2], + test_mode=True, + title="NDA with Acme Co.", cc_email_addresses=[ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + metadata=json.loads( + """ + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """ + ), field_options=field_options, - test_mode=True, + signing_options=signing_options, + signers=signers, ) try: - response = signature_request_api.signature_request_send(data) + response = api.SignatureRequestApi(api_client).signature_request_send( + signature_request_send_request=signature_request_send_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_send: %s\n" + % e + ) ``` ``` @@ -1153,62 +1772,84 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) - signer_1 = models.SubSignatureRequestTemplateSigner( + signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - email_address="george@example.com", name="George", + email_address="george@example.com", ) - cc_1 = models.SubCC( + signers = [ + signers_1, + ] + + ccs_1 = models.SubCC( role="Accounting", email_address="accounting@example.com", ) - custom_field_1 = models.SubCustomField( + ccs = [ + ccs_1, + ] + + custom_fields_1 = models.SubCustomField( name="Cost", - value="$20,000", editor="Client", required=True, + value="$20,000", ) - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) - - data = models.SignatureRequestSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - ccs=[cc_1], - custom_fields=[custom_field_1], - signing_options=signing_options, - test_mode=True, + custom_fields = [ + custom_fields_1, + ] + + signature_request_send_with_template_request = ( + models.SignatureRequestSendWithTemplateRequest( + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ccs=ccs, + custom_fields=custom_fields, + ) ) try: - response = signature_request_api.signature_request_send_with_template(data) + response = api.SignatureRequestApi( + api_client + ).signature_request_send_with_template( + signature_request_send_with_template_request=signature_request_send_with_template_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_send_with_template: %s\n" + % e + ) ``` ``` @@ -1245,7 +1886,11 @@ with ApiClient(configuration) as api_client: Update Signature Request -Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. +Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. + +Updating the email address of a signer will generate a new `signature_id` value. + +**NOTE:** This action cannot be performed on a signature request with an appended signature page. ### Example @@ -1253,34 +1898,35 @@ Updates the email address and/or the name for a given signer on a signature requ * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - data = models.SignatureRequestUpdateRequest( + signature_request_update_request = models.SignatureRequestUpdateRequest( + signature_id="2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", email_address="john@example.com", - signature_id="78caf2a1d01cd39cea2bc1cbb340dac3", ) - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_update( - signature_request_id, data + response = api.SignatureRequestApi(api_client).signature_request_update( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_update_request=signature_request_update_request, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_update: %s\n" + % e + ) ``` ``` diff --git a/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index 1448d24..d09fa3c 100644 --- a/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -21,3 +21,4 @@ Name | Type | Description | Notes [[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/SignatureRequestBulkSendWithTemplateRequest.md b/docs/SignatureRequestBulkSendWithTemplateRequest.md index 6031e08..0780a3c 100644 --- a/docs/SignatureRequestBulkSendWithTemplateRequest.md +++ b/docs/SignatureRequestBulkSendWithTemplateRequest.md @@ -21,3 +21,4 @@ Name | Type | Description | Notes [[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/SignatureRequestCreateEmbeddedRequest.md b/docs/SignatureRequestCreateEmbeddedRequest.md index 98e7083..9f2fe05 100644 --- a/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/docs/SignatureRequestCreateEmbeddedRequest.md @@ -32,3 +32,4 @@ Name | Type | Description | Notes [[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/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index f3e8aca..2617597 100644 --- a/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -23,3 +23,4 @@ Name | Type | Description | Notes [[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/SignatureRequestEditEmbeddedRequest.md b/docs/SignatureRequestEditEmbeddedRequest.md new file mode 100644 index 0000000..5165d1d --- /dev/null +++ b/docs/SignatureRequestEditEmbeddedRequest.md @@ -0,0 +1,35 @@ +# SignatureRequestEditEmbeddedRequest + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `client_id`*_required_ | ```str``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to False] | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | +| `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```List[SubFormFieldGroup]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```List[SubFormFieldRule]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to False] | +| `message` | ```str``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```str``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | +| `title` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | +| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | +| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + +[[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/SignatureRequestEditEmbeddedWithTemplateRequest.md b/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md new file mode 100644 index 0000000..c0dcf6f --- /dev/null +++ b/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -0,0 +1,26 @@ +# SignatureRequestEditEmbeddedWithTemplateRequest + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `template_ids`*_required_ | ```List[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `client_id`*_required_ | ```str``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `ccs` | [```List[SubCC]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `message` | ```str``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```str``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | +| `title` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | + +[[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/SignatureRequestEditRequest.md b/docs/SignatureRequestEditRequest.md new file mode 100644 index 0000000..b4d9783 --- /dev/null +++ b/docs/SignatureRequestEditRequest.md @@ -0,0 +1,36 @@ +# SignatureRequestEditRequest + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | +| `client_id` | ```str``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```List[SubFormFieldGroup]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```List[SubFormFieldRule]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to False] | +| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to False] | +| `message` | ```str``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```str``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | +| `title` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | +| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + +[[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/SignatureRequestEditWithTemplateRequest.md b/docs/SignatureRequestEditWithTemplateRequest.md new file mode 100644 index 0000000..47b6af5 --- /dev/null +++ b/docs/SignatureRequestEditWithTemplateRequest.md @@ -0,0 +1,27 @@ +# SignatureRequestEditWithTemplateRequest + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `template_ids`*_required_ | ```List[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `ccs` | [```List[SubCC]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `client_id` | ```str``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to False] | +| `message` | ```str``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```str``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | +| `title` | ```str``` | The title you want to assign to the SignatureRequest. | | + +[[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/SignatureRequestGetResponse.md b/docs/SignatureRequestGetResponse.md index a0ee83f..a464459 100644 --- a/docs/SignatureRequestGetResponse.md +++ b/docs/SignatureRequestGetResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SignatureRequestListResponse.md b/docs/SignatureRequestListResponse.md index 532cf61..1bd179b 100644 --- a/docs/SignatureRequestListResponse.md +++ b/docs/SignatureRequestListResponse.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/SignatureRequestRemindRequest.md b/docs/SignatureRequestRemindRequest.md index c885130..eebce01 100644 --- a/docs/SignatureRequestRemindRequest.md +++ b/docs/SignatureRequestRemindRequest.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponse.md b/docs/SignatureRequestResponse.md index 552f80e..92a517b 100644 --- a/docs/SignatureRequestResponse.md +++ b/docs/SignatureRequestResponse.md @@ -33,3 +33,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseAttachment.md b/docs/SignatureRequestResponseAttachment.md index a602ec0..753b0a4 100644 --- a/docs/SignatureRequestResponseAttachment.md +++ b/docs/SignatureRequestResponseAttachment.md @@ -14,3 +14,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseCustomFieldBase.md b/docs/SignatureRequestResponseCustomFieldBase.md index 75339e0..915e6f6 100644 --- a/docs/SignatureRequestResponseCustomFieldBase.md +++ b/docs/SignatureRequestResponseCustomFieldBase.md @@ -16,3 +16,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseCustomFieldCheckbox.md b/docs/SignatureRequestResponseCustomFieldCheckbox.md index d3f9dbc..fff2585 100644 --- a/docs/SignatureRequestResponseCustomFieldCheckbox.md +++ b/docs/SignatureRequestResponseCustomFieldCheckbox.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseCustomFieldText.md b/docs/SignatureRequestResponseCustomFieldText.md index 34222b3..fee080e 100644 --- a/docs/SignatureRequestResponseCustomFieldText.md +++ b/docs/SignatureRequestResponseCustomFieldText.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseCustomFieldTypeEnum.md b/docs/SignatureRequestResponseCustomFieldTypeEnum.md index debe8e4..644955b 100644 --- a/docs/SignatureRequestResponseCustomFieldTypeEnum.md +++ b/docs/SignatureRequestResponseCustomFieldTypeEnum.md @@ -8,3 +8,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseDataBase.md b/docs/SignatureRequestResponseDataBase.md index a657e3c..e4bf791 100644 --- a/docs/SignatureRequestResponseDataBase.md +++ b/docs/SignatureRequestResponseDataBase.md @@ -13,3 +13,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseDataTypeEnum.md b/docs/SignatureRequestResponseDataTypeEnum.md index 102414e..af254fe 100644 --- a/docs/SignatureRequestResponseDataTypeEnum.md +++ b/docs/SignatureRequestResponseDataTypeEnum.md @@ -8,3 +8,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseDataValueCheckbox.md b/docs/SignatureRequestResponseDataValueCheckbox.md index f52a4be..9fe6c83 100644 --- a/docs/SignatureRequestResponseDataValueCheckbox.md +++ b/docs/SignatureRequestResponseDataValueCheckbox.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseDataValueCheckboxMerge.md b/docs/SignatureRequestResponseDataValueCheckboxMerge.md index c7ad20c..0a4c036 100644 --- a/docs/SignatureRequestResponseDataValueCheckboxMerge.md +++ b/docs/SignatureRequestResponseDataValueCheckboxMerge.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseDataValueDateSigned.md b/docs/SignatureRequestResponseDataValueDateSigned.md index d72ecc9..d8d9b40 100644 --- a/docs/SignatureRequestResponseDataValueDateSigned.md +++ b/docs/SignatureRequestResponseDataValueDateSigned.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseDataValueDropdown.md b/docs/SignatureRequestResponseDataValueDropdown.md index 9eef3d0..c588b0c 100644 --- a/docs/SignatureRequestResponseDataValueDropdown.md +++ b/docs/SignatureRequestResponseDataValueDropdown.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseDataValueInitials.md b/docs/SignatureRequestResponseDataValueInitials.md index 425498b..a342097 100644 --- a/docs/SignatureRequestResponseDataValueInitials.md +++ b/docs/SignatureRequestResponseDataValueInitials.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseDataValueRadio.md b/docs/SignatureRequestResponseDataValueRadio.md index 615a86d..53c6b68 100644 --- a/docs/SignatureRequestResponseDataValueRadio.md +++ b/docs/SignatureRequestResponseDataValueRadio.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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 a50bcc5..bb26031 100644 --- a/docs/SignatureRequestResponseDataValueSignature.md +++ b/docs/SignatureRequestResponseDataValueSignature.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseDataValueText.md b/docs/SignatureRequestResponseDataValueText.md index 4b38050..c56a907 100644 --- a/docs/SignatureRequestResponseDataValueText.md +++ b/docs/SignatureRequestResponseDataValueText.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseDataValueTextMerge.md b/docs/SignatureRequestResponseDataValueTextMerge.md index f3e90ba..90c9819 100644 --- a/docs/SignatureRequestResponseDataValueTextMerge.md +++ b/docs/SignatureRequestResponseDataValueTextMerge.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SignatureRequestResponseSignatures.md b/docs/SignatureRequestResponseSignatures.md index 8125332..fd0ad98 100644 --- a/docs/SignatureRequestResponseSignatures.md +++ b/docs/SignatureRequestResponseSignatures.md @@ -27,3 +27,4 @@ Name | Type | Description | Notes [[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/SignatureRequestSendRequest.md b/docs/SignatureRequestSendRequest.md index beb3ae0..54e5d9d 100644 --- a/docs/SignatureRequestSendRequest.md +++ b/docs/SignatureRequestSendRequest.md @@ -34,3 +34,4 @@ Name | Type | Description | Notes [[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/SignatureRequestSendWithTemplateRequest.md b/docs/SignatureRequestSendWithTemplateRequest.md index d065890..0278d63 100644 --- a/docs/SignatureRequestSendWithTemplateRequest.md +++ b/docs/SignatureRequestSendWithTemplateRequest.md @@ -25,3 +25,4 @@ Name | Type | Description | Notes [[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/SignatureRequestUpdateRequest.md b/docs/SignatureRequestUpdateRequest.md index 10ada0f..2367530 100644 --- a/docs/SignatureRequestUpdateRequest.md +++ b/docs/SignatureRequestUpdateRequest.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/SubAttachment.md b/docs/SubAttachment.md index 2730666..a817275 100644 --- a/docs/SubAttachment.md +++ b/docs/SubAttachment.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/SubBulkSignerList.md b/docs/SubBulkSignerList.md index 4079ca1..21df799 100644 --- a/docs/SubBulkSignerList.md +++ b/docs/SubBulkSignerList.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SubBulkSignerListCustomField.md b/docs/SubBulkSignerListCustomField.md index 6ff5de0..160180c 100644 --- a/docs/SubBulkSignerListCustomField.md +++ b/docs/SubBulkSignerListCustomField.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SubCC.md b/docs/SubCC.md index 0a9267d..7caebd3 100644 --- a/docs/SubCC.md +++ b/docs/SubCC.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SubCustomField.md b/docs/SubCustomField.md index 7aff768..bd7fea5 100644 --- a/docs/SubCustomField.md +++ b/docs/SubCustomField.md @@ -16,3 +16,4 @@ Name | Type | Description | Notes [[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/SubEditorOptions.md b/docs/SubEditorOptions.md index 4ee12c2..81e617b 100644 --- a/docs/SubEditorOptions.md +++ b/docs/SubEditorOptions.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SubFieldOptions.md b/docs/SubFieldOptions.md index 3d40efd..48bedb1 100644 --- a/docs/SubFieldOptions.md +++ b/docs/SubFieldOptions.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/SubFormFieldGroup.md b/docs/SubFormFieldGroup.md index af8de77..4e9f630 100644 --- a/docs/SubFormFieldGroup.md +++ b/docs/SubFormFieldGroup.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/SubFormFieldRule.md b/docs/SubFormFieldRule.md index 1e4658e..2db7e90 100644 --- a/docs/SubFormFieldRule.md +++ b/docs/SubFormFieldRule.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/SubFormFieldRuleAction.md b/docs/SubFormFieldRuleAction.md index 6d38e07..5c53f58 100644 --- a/docs/SubFormFieldRuleAction.md +++ b/docs/SubFormFieldRuleAction.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/SubFormFieldRuleTrigger.md b/docs/SubFormFieldRuleTrigger.md index 0ff0bbf..bda6d91 100644 --- a/docs/SubFormFieldRuleTrigger.md +++ b/docs/SubFormFieldRuleTrigger.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentBase.md b/docs/SubFormFieldsPerDocumentBase.md index 12da98a..fcd075f 100644 --- a/docs/SubFormFieldsPerDocumentBase.md +++ b/docs/SubFormFieldsPerDocumentBase.md @@ -32,3 +32,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentCheckbox.md b/docs/SubFormFieldsPerDocumentCheckbox.md index ac3ac20..2ccf4c3 100644 --- a/docs/SubFormFieldsPerDocumentCheckbox.md +++ b/docs/SubFormFieldsPerDocumentCheckbox.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentCheckboxMerge.md b/docs/SubFormFieldsPerDocumentCheckboxMerge.md index 70ddec8..b07f40b 100644 --- a/docs/SubFormFieldsPerDocumentCheckboxMerge.md +++ b/docs/SubFormFieldsPerDocumentCheckboxMerge.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentDateSigned.md b/docs/SubFormFieldsPerDocumentDateSigned.md index 894e416..5824322 100644 --- a/docs/SubFormFieldsPerDocumentDateSigned.md +++ b/docs/SubFormFieldsPerDocumentDateSigned.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentDropdown.md b/docs/SubFormFieldsPerDocumentDropdown.md index b2ad0d6..aecb755 100644 --- a/docs/SubFormFieldsPerDocumentDropdown.md +++ b/docs/SubFormFieldsPerDocumentDropdown.md @@ -13,3 +13,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentFontEnum.md b/docs/SubFormFieldsPerDocumentFontEnum.md index 30e4389..a92e3e2 100644 --- a/docs/SubFormFieldsPerDocumentFontEnum.md +++ b/docs/SubFormFieldsPerDocumentFontEnum.md @@ -8,3 +8,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentHyperlink.md b/docs/SubFormFieldsPerDocumentHyperlink.md index 821d474..ae3b59d 100644 --- a/docs/SubFormFieldsPerDocumentHyperlink.md +++ b/docs/SubFormFieldsPerDocumentHyperlink.md @@ -13,3 +13,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentInitials.md b/docs/SubFormFieldsPerDocumentInitials.md index 978db25..dc0d77e 100644 --- a/docs/SubFormFieldsPerDocumentInitials.md +++ b/docs/SubFormFieldsPerDocumentInitials.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentRadio.md b/docs/SubFormFieldsPerDocumentRadio.md index 96789cb..6ee33dc 100644 --- a/docs/SubFormFieldsPerDocumentRadio.md +++ b/docs/SubFormFieldsPerDocumentRadio.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentSignature.md b/docs/SubFormFieldsPerDocumentSignature.md index b1fb996..d93dbf7 100644 --- a/docs/SubFormFieldsPerDocumentSignature.md +++ b/docs/SubFormFieldsPerDocumentSignature.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentText.md b/docs/SubFormFieldsPerDocumentText.md index 0456d7b..f851ec3 100644 --- a/docs/SubFormFieldsPerDocumentText.md +++ b/docs/SubFormFieldsPerDocumentText.md @@ -19,3 +19,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentTextMerge.md b/docs/SubFormFieldsPerDocumentTextMerge.md index 5670ce9..fe812d8 100644 --- a/docs/SubFormFieldsPerDocumentTextMerge.md +++ b/docs/SubFormFieldsPerDocumentTextMerge.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/SubFormFieldsPerDocumentTypeEnum.md b/docs/SubFormFieldsPerDocumentTypeEnum.md index e2f8ca5..37bac7d 100644 --- a/docs/SubFormFieldsPerDocumentTypeEnum.md +++ b/docs/SubFormFieldsPerDocumentTypeEnum.md @@ -8,3 +8,4 @@ Name | Type | Description | Notes [[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/SubMergeField.md b/docs/SubMergeField.md index 9066c07..be4dfd7 100644 --- a/docs/SubMergeField.md +++ b/docs/SubMergeField.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SubOAuth.md b/docs/SubOAuth.md index 524b04f..f1d0490 100644 --- a/docs/SubOAuth.md +++ b/docs/SubOAuth.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SubOptions.md b/docs/SubOptions.md index 62ff1a9..871dc60 100644 --- a/docs/SubOptions.md +++ b/docs/SubOptions.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/SubSignatureRequestGroupedSigners.md b/docs/SubSignatureRequestGroupedSigners.md index 179f27b..0c03df8 100644 --- a/docs/SubSignatureRequestGroupedSigners.md +++ b/docs/SubSignatureRequestGroupedSigners.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/SubSignatureRequestSigner.md b/docs/SubSignatureRequestSigner.md index 0a122bc..4af8f72 100644 --- a/docs/SubSignatureRequestSigner.md +++ b/docs/SubSignatureRequestSigner.md @@ -14,3 +14,4 @@ Name | Type | Description | Notes [[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/SubSignatureRequestTemplateSigner.md b/docs/SubSignatureRequestTemplateSigner.md index d1ca992..392204b 100644 --- a/docs/SubSignatureRequestTemplateSigner.md +++ b/docs/SubSignatureRequestTemplateSigner.md @@ -14,3 +14,4 @@ Name | Type | Description | Notes [[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/SubSigningOptions.md b/docs/SubSigningOptions.md index a060bd1..9584478 100644 --- a/docs/SubSigningOptions.md +++ b/docs/SubSigningOptions.md @@ -15,3 +15,4 @@ Name | Type | Description | Notes [[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/SubTeamResponse.md b/docs/SubTeamResponse.md index 5c655b1..750829a 100644 --- a/docs/SubTeamResponse.md +++ b/docs/SubTeamResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SubTemplateRole.md b/docs/SubTemplateRole.md index 09d0d74..30a6deb 100644 --- a/docs/SubTemplateRole.md +++ b/docs/SubTemplateRole.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/SubUnclaimedDraftSigner.md b/docs/SubUnclaimedDraftSigner.md index a542cec..636ccf6 100644 --- a/docs/SubUnclaimedDraftSigner.md +++ b/docs/SubUnclaimedDraftSigner.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/SubUnclaimedDraftTemplateSigner.md b/docs/SubUnclaimedDraftTemplateSigner.md index 481850b..80634e8 100644 --- a/docs/SubUnclaimedDraftTemplateSigner.md +++ b/docs/SubUnclaimedDraftTemplateSigner.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/SubWhiteLabelingOptions.md b/docs/SubWhiteLabelingOptions.md index f911527..7baf360 100644 --- a/docs/SubWhiteLabelingOptions.md +++ b/docs/SubWhiteLabelingOptions.md @@ -25,3 +25,4 @@ Name | Type | Description | Notes [[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/TeamAddMemberRequest.md b/docs/TeamAddMemberRequest.md index 8b3120f..a40c8b1 100644 --- a/docs/TeamAddMemberRequest.md +++ b/docs/TeamAddMemberRequest.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/TeamApi.md b/docs/TeamApi.md index 34b6152..e61896a 100644 --- a/docs/TeamApi.md +++ b/docs/TeamApi.md @@ -29,29 +29,31 @@ Invites a user (specified using the `email_address` parameter) to your Team. If * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamAddMemberRequest( + team_add_member_request = models.TeamAddMemberRequest( email_address="george@example.com", ) try: - response = team_api.team_add_member(data) + response = api.TeamApi(api_client).team_add_member( + team_add_member_request=team_add_member_request, + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_add_member: %s\n" % e) ``` ``` @@ -97,29 +99,30 @@ Creates a new Team and makes you a member. You must not currently belong to a Te * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamCreateRequest( + team_create_request = models.TeamCreateRequest( name="New Team Name", ) try: - response = team_api.team_create(data) + response = api.TeamApi(api_client).team_create( + team_create_request=team_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_create: %s\n" % e) ``` ``` @@ -164,22 +167,22 @@ Deletes your Team. Can only be invoked when you have a Team with only one member * Bearer (JWT) Authentication (oauth2): ```python -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - try: - team_api.team_delete() + api.TeamApi(api_client).team_delete() except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_delete: %s\n" % e) ``` ``` @@ -214,7 +217,7 @@ void (empty response body) Get Team -Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. +Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned. ### Example @@ -222,25 +225,24 @@ Returns information about your Team as well as a list of its members. If you do * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - try: - response = team_api.team_get() + response = api.TeamApi(api_client).team_get() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_get: %s\n" % e) ``` ``` @@ -283,25 +285,26 @@ Provides information about a team. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - try: - response = team_api.team_info() + response = api.TeamApi(api_client).team_info( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_info: %s\n" % e) ``` ``` @@ -346,27 +349,24 @@ Provides a list of team invites (and their roles). * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - email_address = "user@dropboxsign.com" - try: - response = team_api.team_invites(email_address=email_address) + response = api.TeamApi(api_client).team_invites() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_invites: %s\n" % e) ``` ``` @@ -411,27 +411,28 @@ Provides a paginated list of members (and their roles) that belong to a given te * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - try: - response = team_api.team_members(team_id) + response = api.TeamApi(api_client).team_members( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page=1, + page_size=20, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_members: %s\n" % e) ``` ``` @@ -478,30 +479,31 @@ Removes the provided user Account from your Team. If the Account had an outstand * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamRemoveMemberRequest( + team_remove_member_request = models.TeamRemoveMemberRequest( email_address="teammate@dropboxsign.com", new_owner_email_address="new_teammate@dropboxsign.com", ) try: - response = team_api.team_remove_member(data) + response = api.TeamApi(api_client).team_remove_member( + team_remove_member_request=team_remove_member_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_remove_member: %s\n" % e) ``` ``` @@ -546,27 +548,28 @@ Provides a paginated list of sub teams that belong to a given team. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - try: - response = team_api.team_sub_teams(team_id) + response = api.TeamApi(api_client).team_sub_teams( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page=1, + page_size=20, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_sub_teams: %s\n" % e) ``` ``` @@ -613,29 +616,30 @@ Updates the name of your Team. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamUpdateRequest( + team_update_request = models.TeamUpdateRequest( name="New Team Name", ) try: - response = team_api.team_update(data) + response = api.TeamApi(api_client).team_update( + team_update_request=team_update_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_update: %s\n" % e) ``` ``` diff --git a/docs/TeamCreateRequest.md b/docs/TeamCreateRequest.md index 41d0b75..8491afc 100644 --- a/docs/TeamCreateRequest.md +++ b/docs/TeamCreateRequest.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TeamGetInfoResponse.md b/docs/TeamGetInfoResponse.md index b7c0dad..b57b05c 100644 --- a/docs/TeamGetInfoResponse.md +++ b/docs/TeamGetInfoResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TeamGetResponse.md b/docs/TeamGetResponse.md index 9443320..d7977ad 100644 --- a/docs/TeamGetResponse.md +++ b/docs/TeamGetResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TeamInfoResponse.md b/docs/TeamInfoResponse.md index 832a130..ee89910 100644 --- a/docs/TeamInfoResponse.md +++ b/docs/TeamInfoResponse.md @@ -13,3 +13,4 @@ Name | Type | Description | Notes [[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/TeamInviteResponse.md b/docs/TeamInviteResponse.md index 8e6e284..24b95e3 100644 --- a/docs/TeamInviteResponse.md +++ b/docs/TeamInviteResponse.md @@ -14,3 +14,4 @@ Name | Type | Description | Notes [[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/TeamInvitesResponse.md b/docs/TeamInvitesResponse.md index 2b8097d..477ab3b 100644 --- a/docs/TeamInvitesResponse.md +++ b/docs/TeamInvitesResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TeamMemberResponse.md b/docs/TeamMemberResponse.md index 0bb958d..64fea43 100644 --- a/docs/TeamMemberResponse.md +++ b/docs/TeamMemberResponse.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/TeamMembersResponse.md b/docs/TeamMembersResponse.md index 1d04f67..f44ca73 100644 --- a/docs/TeamMembersResponse.md +++ b/docs/TeamMembersResponse.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/TeamParentResponse.md b/docs/TeamParentResponse.md index ef6e9fb..ba3f06d 100644 --- a/docs/TeamParentResponse.md +++ b/docs/TeamParentResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TeamRemoveMemberRequest.md b/docs/TeamRemoveMemberRequest.md index 1f9445f..8369af8 100644 --- a/docs/TeamRemoveMemberRequest.md +++ b/docs/TeamRemoveMemberRequest.md @@ -13,3 +13,4 @@ Name | Type | Description | Notes [[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/TeamResponse.md b/docs/TeamResponse.md index 150fd64..f8b211b 100644 --- a/docs/TeamResponse.md +++ b/docs/TeamResponse.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/TeamSubTeamsResponse.md b/docs/TeamSubTeamsResponse.md index 549f850..91a3ef4 100644 --- a/docs/TeamSubTeamsResponse.md +++ b/docs/TeamSubTeamsResponse.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/TeamUpdateRequest.md b/docs/TeamUpdateRequest.md index 086b33d..d99b6a5 100644 --- a/docs/TeamUpdateRequest.md +++ b/docs/TeamUpdateRequest.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateAddUserRequest.md b/docs/TemplateAddUserRequest.md index a8ee5eb..08a2ac1 100644 --- a/docs/TemplateAddUserRequest.md +++ b/docs/TemplateAddUserRequest.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/TemplateApi.md b/docs/TemplateApi.md index 153be9c..5ff5a44 100644 --- a/docs/TemplateApi.md +++ b/docs/TemplateApi.md @@ -30,31 +30,31 @@ Gives the specified Account access to the specified Template. The specified Acco * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateAddUserRequest( + template_add_user_request = models.TemplateAddUserRequest( email_address="george@dropboxsign.com", ) - template_id = "f57db65d3f933b5316d398057a36176831451a35" - try: - response = template_api.template_add_user(template_id, data) + response = api.TemplateApi(api_client).template_add_user( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_add_user_request=template_add_user_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_add_user: %s\n" % e) ``` ``` @@ -100,62 +100,113 @@ Creates a template that can then be used. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) - role_1 = models.SubTemplateRole( + signer_roles_1 = models.SubTemplateRole( name="Client", order=0, ) - role_2 = models.SubTemplateRole( + signer_roles_2 = models.SubTemplateRole( name="Witness", order=1, ) - merge_field_1 = models.SubMergeField( + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( name="Full Name", type="text", ) - merge_field_2 = models.SubMergeField( + merge_fields_2 = models.SubMergeField( name="Is Registered?", type="checkbox", ) - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] - data = models.TemplateCreateRequest( + template_create_request = models.TemplateCreateRequest( client_id="37dee8d8440c66d54cfa05d92c160882", - files=[open("example_signature_request.pdf", "rb")], - title="Test Template", - subject="Please sign this document", message="For your approval", - signer_roles=[role_1, role_2], - cc_roles=["Manager"], - merge_fields=[merge_field_1, merge_field_2], - field_options=field_options, + subject="Please sign this document", test_mode=True, + title="Test Template", + cc_roles=[ + "Manager", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, ) try: - response = template_api.template_create(data) + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_create: %s\n" % e) ``` ``` @@ -200,62 +251,80 @@ The first step in an embedded template workflow. Creates a draft template that c * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - role_1 = models.SubTemplateRole( - name="Client", - order=0, - ) - - role_2 = models.SubTemplateRole( - name="Witness", - order=1, + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", ) - merge_field_1 = models.SubMergeField( + merge_fields_1 = models.SubMergeField( name="Full Name", type="text", ) - merge_field_2 = models.SubMergeField( + merge_fields_2 = models.SubMergeField( name="Is Registered?", type="checkbox", ) - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, ) - data = models.TemplateCreateEmbeddedDraftRequest( + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( client_id="37dee8d8440c66d54cfa05d92c160882", - files=[open("example_signature_request.pdf", "rb")], - title="Test Template", - subject="Please sign this document", message="For your approval", - signer_roles=[role_1, role_2], - cc_roles=["Manager"], - merge_fields=[merge_field_1, merge_field_2], - field_options=field_options, + subject="Please sign this document", test_mode=True, + title="Test Template", + cc_roles=[ + "Manager", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + field_options=field_options, + merge_fields=merge_fields, + signer_roles=signer_roles, ) try: - response = template_api.template_create_embedded_draft(data) + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling TemplateApi#template_create_embedded_draft: %s\n" + % e + ) ``` ``` @@ -300,24 +369,24 @@ Completely deletes the template specified from the account. * Bearer (JWT) Authentication (oauth2): ```python -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - template_api.template_delete(template_id) + api.TemplateApi(api_client).template_delete( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_delete: %s\n" % e) ``` ``` @@ -354,7 +423,9 @@ void (empty response body) Get Template Files -Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. +Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. + +If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. ### Example @@ -362,27 +433,26 @@ Obtain a copy of the current documents specified by the `template_id` parameter. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - response = template_api.template_files(template_id, file_type="pdf") - open("file_response.pdf", "wb").write(response.read()) + response = api.TemplateApi(api_client).template_files( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + open("./file_response", "wb").write(response.read()) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_files: %s\n" % e) ``` ``` @@ -420,7 +490,9 @@ with ApiClient(configuration) as api_client: Get Template Files as Data Uri -Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. +Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). + +If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. ### Example @@ -428,27 +500,26 @@ Obtain a copy of the current documents specified by the `template_id` parameter. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - response = template_api.template_files_as_data_uri(template_id) + response = api.TemplateApi(api_client).template_files_as_data_uri( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_files_as_data_uri: %s\n" % e) ``` ``` @@ -485,7 +556,9 @@ with ApiClient(configuration) as api_client: Get Template Files as File Url -Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. +Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). + +If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. ### Example @@ -493,27 +566,27 @@ Obtain a copy of the current documents specified by the `template_id` parameter. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - response = template_api.template_files_as_file_url(template_id) + response = api.TemplateApi(api_client).template_files_as_file_url( + template_id="f57db65d3f933b5316d398057a36176831451a35", + force_download=1, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_files_as_file_url: %s\n" % e) ``` ``` @@ -559,27 +632,26 @@ Returns the Template specified by the `template_id` parameter. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "f57db65d3f933b5316d398057a36176831451a35" - try: - response = template_api.template_get(template_id) + response = api.TemplateApi(api_client).template_get( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_get: %s\n" % e) ``` ``` @@ -616,7 +688,9 @@ with ApiClient(configuration) as api_client: List Templates -Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. +Returns a list of the Templates that are accessible by you. + +Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. ### Example @@ -624,29 +698,27 @@ Returns a list of the Templates that are accessible by you. Take a look at our * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - account_id = "f57db65d3f933b5316d398057a36176831451a35" - try: - response = template_api.template_list( - account_id=account_id, + response = api.TemplateApi(api_client).template_list( + page=1, + page_size=20, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_list: %s\n" % e) ``` ``` @@ -694,31 +766,31 @@ Removes the specified Account's access to the specified Template. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateRemoveUserRequest( + template_remove_user_request = models.TemplateRemoveUserRequest( email_address="george@dropboxsign.com", ) - template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536" - try: - response = template_api.template_remove_user(template_id, data) + response = api.TemplateApi(api_client).template_remove_user( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_remove_user_request=template_remove_user_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_remove_user: %s\n" % e) ``` ``` @@ -756,7 +828,18 @@ with ApiClient(configuration) as api_client: Update Template Files -Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). +Overlays a new file with the overlay of an existing template. The new file(s) must: + +1. have the same or higher page count +2. the same orientation as the file(s) being replaced. + +This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. + +Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. + +It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + +If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). ### Example @@ -764,31 +847,33 @@ Overlays a new file with the overlay of an existing template. The new file(s) mu * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateUpdateFilesRequest( - files=[open("example_signature_request.pdf", "rb")], + template_update_files_request = models.TemplateUpdateFilesRequest( + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], ) - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - response = template_api.template_update_files(template_id, data) + response = api.TemplateApi(api_client).template_update_files( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_update_files_request=template_update_files_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_update_files: %s\n" % e) ``` ``` diff --git a/docs/TemplateCreateEmbeddedDraftRequest.md b/docs/TemplateCreateEmbeddedDraftRequest.md index 2f25737..c63d971 100644 --- a/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/docs/TemplateCreateEmbeddedDraftRequest.md @@ -33,3 +33,4 @@ Name | Type | Description | Notes [[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/TemplateCreateEmbeddedDraftResponse.md b/docs/TemplateCreateEmbeddedDraftResponse.md index d0bfc77..ecf1a43 100644 --- a/docs/TemplateCreateEmbeddedDraftResponse.md +++ b/docs/TemplateCreateEmbeddedDraftResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateCreateEmbeddedDraftResponseTemplate.md b/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 56b48ec..0452772 100644 --- a/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/TemplateCreateRequest.md b/docs/TemplateCreateRequest.md index ec9fb40..a5341c3 100644 --- a/docs/TemplateCreateRequest.md +++ b/docs/TemplateCreateRequest.md @@ -26,3 +26,4 @@ Name | Type | Description | Notes [[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/TemplateCreateResponse.md b/docs/TemplateCreateResponse.md index 466455c..c87b262 100644 --- a/docs/TemplateCreateResponse.md +++ b/docs/TemplateCreateResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateCreateResponseTemplate.md b/docs/TemplateCreateResponseTemplate.md index 1c3d76f..21d6307 100644 --- a/docs/TemplateCreateResponseTemplate.md +++ b/docs/TemplateCreateResponseTemplate.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateEditResponse.md b/docs/TemplateEditResponse.md index acc73fb..2384cb0 100644 --- a/docs/TemplateEditResponse.md +++ b/docs/TemplateEditResponse.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateGetResponse.md b/docs/TemplateGetResponse.md index 05a0b24..c208fbb 100644 --- a/docs/TemplateGetResponse.md +++ b/docs/TemplateGetResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateListResponse.md b/docs/TemplateListResponse.md index 60fb194..1c3f0b8 100644 --- a/docs/TemplateListResponse.md +++ b/docs/TemplateListResponse.md @@ -11,3 +11,4 @@ Name | Type | Description | Notes [[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/TemplateRemoveUserRequest.md b/docs/TemplateRemoveUserRequest.md index 36b2de0..c151a0b 100644 --- a/docs/TemplateRemoveUserRequest.md +++ b/docs/TemplateRemoveUserRequest.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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 01220c9..0eb88aa 100644 --- a/docs/TemplateResponse.md +++ b/docs/TemplateResponse.md @@ -24,3 +24,4 @@ Name | Type | Description | Notes [[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/TemplateResponseAccount.md b/docs/TemplateResponseAccount.md index 7668fc7..e991a40 100644 --- a/docs/TemplateResponseAccount.md +++ b/docs/TemplateResponseAccount.md @@ -14,3 +14,4 @@ Name | Type | Description | Notes [[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/TemplateResponseAccountQuota.md b/docs/TemplateResponseAccountQuota.md index 7e83dcc..1af3306 100644 --- a/docs/TemplateResponseAccountQuota.md +++ b/docs/TemplateResponseAccountQuota.md @@ -12,3 +12,4 @@ Name | Type | Description | Notes [[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/TemplateResponseCCRole.md b/docs/TemplateResponseCCRole.md index 1aa9fa7..68b6fea 100644 --- a/docs/TemplateResponseCCRole.md +++ b/docs/TemplateResponseCCRole.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocument.md b/docs/TemplateResponseDocument.md index 8071995..7e16172 100644 --- a/docs/TemplateResponseDocument.md +++ b/docs/TemplateResponseDocument.md @@ -14,3 +14,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentCustomFieldBase.md b/docs/TemplateResponseDocumentCustomFieldBase.md index 83354a3..5773198 100644 --- a/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/docs/TemplateResponseDocumentCustomFieldBase.md @@ -18,3 +18,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentCustomFieldCheckbox.md b/docs/TemplateResponseDocumentCustomFieldCheckbox.md index 0bbf24c..121a63e 100644 --- a/docs/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/docs/TemplateResponseDocumentCustomFieldCheckbox.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentCustomFieldText.md b/docs/TemplateResponseDocumentCustomFieldText.md index 474097e..72b1d3e 100644 --- a/docs/TemplateResponseDocumentCustomFieldText.md +++ b/docs/TemplateResponseDocumentCustomFieldText.md @@ -13,3 +13,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentFieldGroup.md b/docs/TemplateResponseDocumentFieldGroup.md index 29a19c7..ec90f23 100644 --- a/docs/TemplateResponseDocumentFieldGroup.md +++ b/docs/TemplateResponseDocumentFieldGroup.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentFieldGroupRule.md b/docs/TemplateResponseDocumentFieldGroupRule.md index 3f0a44f..c23407f 100644 --- a/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/docs/TemplateResponseDocumentFieldGroupRule.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentFormFieldBase.md b/docs/TemplateResponseDocumentFormFieldBase.md index a0c465c..32e2d5d 100644 --- a/docs/TemplateResponseDocumentFormFieldBase.md +++ b/docs/TemplateResponseDocumentFormFieldBase.md @@ -17,3 +17,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentFormFieldCheckbox.md b/docs/TemplateResponseDocumentFormFieldCheckbox.md index 1a2167a..946f83a 100644 --- a/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentFormFieldDateSigned.md b/docs/TemplateResponseDocumentFormFieldDateSigned.md index a9add1a..9ab442e 100644 --- a/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentFormFieldDropdown.md b/docs/TemplateResponseDocumentFormFieldDropdown.md index 40d2cf2..2a472ec 100644 --- a/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentFormFieldHyperlink.md b/docs/TemplateResponseDocumentFormFieldHyperlink.md index ec6a6e4..c85e5e5 100644 --- a/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -14,3 +14,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentFormFieldInitials.md b/docs/TemplateResponseDocumentFormFieldInitials.md index 77acaa8..a186404 100644 --- a/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/docs/TemplateResponseDocumentFormFieldInitials.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentFormFieldRadio.md b/docs/TemplateResponseDocumentFormFieldRadio.md index 9db9a8d..67e78b5 100644 --- a/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/docs/TemplateResponseDocumentFormFieldRadio.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentFormFieldSignature.md b/docs/TemplateResponseDocumentFormFieldSignature.md index adce267..1540a03 100644 --- a/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/docs/TemplateResponseDocumentFormFieldSignature.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentFormFieldText.md b/docs/TemplateResponseDocumentFormFieldText.md index 9e66042..8d52035 100644 --- a/docs/TemplateResponseDocumentFormFieldText.md +++ b/docs/TemplateResponseDocumentFormFieldText.md @@ -15,3 +15,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentStaticFieldBase.md b/docs/TemplateResponseDocumentStaticFieldBase.md index a7347b6..bbeb828 100644 --- a/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/docs/TemplateResponseDocumentStaticFieldBase.md @@ -18,3 +18,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentStaticFieldCheckbox.md b/docs/TemplateResponseDocumentStaticFieldCheckbox.md index a1acbb1..1b2931d 100644 --- a/docs/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/docs/TemplateResponseDocumentStaticFieldCheckbox.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentStaticFieldDateSigned.md b/docs/TemplateResponseDocumentStaticFieldDateSigned.md index 62c4b1e..b03c2f7 100644 --- a/docs/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/docs/TemplateResponseDocumentStaticFieldDateSigned.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentStaticFieldDropdown.md b/docs/TemplateResponseDocumentStaticFieldDropdown.md index 302afcf..13d21c1 100644 --- a/docs/TemplateResponseDocumentStaticFieldDropdown.md +++ b/docs/TemplateResponseDocumentStaticFieldDropdown.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentStaticFieldHyperlink.md b/docs/TemplateResponseDocumentStaticFieldHyperlink.md index 52e93c2..76e556a 100644 --- a/docs/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/docs/TemplateResponseDocumentStaticFieldHyperlink.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentStaticFieldInitials.md b/docs/TemplateResponseDocumentStaticFieldInitials.md index 227f77c..11746ca 100644 --- a/docs/TemplateResponseDocumentStaticFieldInitials.md +++ b/docs/TemplateResponseDocumentStaticFieldInitials.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentStaticFieldRadio.md b/docs/TemplateResponseDocumentStaticFieldRadio.md index 8002b86..484053c 100644 --- a/docs/TemplateResponseDocumentStaticFieldRadio.md +++ b/docs/TemplateResponseDocumentStaticFieldRadio.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentStaticFieldSignature.md b/docs/TemplateResponseDocumentStaticFieldSignature.md index 4433280..18682b3 100644 --- a/docs/TemplateResponseDocumentStaticFieldSignature.md +++ b/docs/TemplateResponseDocumentStaticFieldSignature.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateResponseDocumentStaticFieldText.md b/docs/TemplateResponseDocumentStaticFieldText.md index 1988dc8..3688758 100644 --- a/docs/TemplateResponseDocumentStaticFieldText.md +++ b/docs/TemplateResponseDocumentStaticFieldText.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateResponseFieldAvgTextLength.md b/docs/TemplateResponseFieldAvgTextLength.md index f50991c..2312678 100644 --- a/docs/TemplateResponseFieldAvgTextLength.md +++ b/docs/TemplateResponseFieldAvgTextLength.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateResponseSignerRole.md b/docs/TemplateResponseSignerRole.md index 7a65a36..060870d 100644 --- a/docs/TemplateResponseSignerRole.md +++ b/docs/TemplateResponseSignerRole.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/TemplateUpdateFilesRequest.md b/docs/TemplateUpdateFilesRequest.md index 7122fad..feb2419 100644 --- a/docs/TemplateUpdateFilesRequest.md +++ b/docs/TemplateUpdateFilesRequest.md @@ -14,3 +14,4 @@ Name | Type | Description | Notes [[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/TemplateUpdateFilesResponse.md b/docs/TemplateUpdateFilesResponse.md index 75af64c..37178d4 100644 --- a/docs/TemplateUpdateFilesResponse.md +++ b/docs/TemplateUpdateFilesResponse.md @@ -9,3 +9,4 @@ Name | Type | Description | Notes [[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/TemplateUpdateFilesResponseTemplate.md b/docs/TemplateUpdateFilesResponseTemplate.md index 27ea317..4c9521e 100644 --- a/docs/TemplateUpdateFilesResponseTemplate.md +++ b/docs/TemplateUpdateFilesResponseTemplate.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/UnclaimedDraftApi.md b/docs/UnclaimedDraftApi.md index 4ed79a3..62c15dc 100644 --- a/docs/UnclaimedDraftApi.md +++ b/docs/UnclaimedDraftApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description Create Unclaimed Draft -Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. +Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. ### Example @@ -23,68 +23,47 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - signer_1 = models.SubUnclaimedDraftSigner( - email_address="jack@example.com", + signers_1 = models.SubUnclaimedDraftSigner( name="Jack", + email_address="jack@example.com", order=0, ) - signer_2 = models.SubUnclaimedDraftSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) + signers = [ + signers_1, + ] - data = models.UnclaimedDraftCreateRequest( - subject="The NDA we talked about", + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( type="request_signature", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], - cc_email_addresses=[ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, - field_options=field_options, test_mode=True, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signers=signers, ) try: - response = unclaimed_draft_api.unclaimed_draft_create(data) + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e + ) ``` ``` @@ -121,7 +100,9 @@ with ApiClient(configuration) as api_client: Create Embedded Unclaimed Draft -Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. +Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. + +**NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. ### Example @@ -129,32 +110,40 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - data = models.UnclaimedDraftCreateEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - files=[open("example_signature_request.pdf", "rb")], - requester_email_address="jack@dropboxsign.com", - test_mode=True, + unclaimed_draft_create_embedded_request = ( + models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=True, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + ) ) try: - response = unclaimed_draft_api.unclaimed_draft_create_embedded(data) + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" + % e + ) ``` ``` @@ -191,7 +180,9 @@ with ApiClient(configuration) as api_client: Create Embedded Unclaimed Draft with Template -Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. +Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. + +**NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. ### Example @@ -199,47 +190,63 @@ Creates a new Draft with a previously saved template(s) that can be claimed and * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@dropboxsign.com", + ) + + ccs = [ + ccs_1, + ] - signer_1 = models.SubUnclaimedDraftTemplateSigner( + signers_1 = models.SubUnclaimedDraftTemplateSigner( role="Client", name="George", email_address="george@example.com", ) - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - data = models.UnclaimedDraftCreateEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["61a832ff0d8423f91d503e76bfbcc750f7417c78"], - requester_email_address="jack@dropboxsign.com", - signers=[signer_1], - ccs=[cc_1], - test_mode=True, + signers = [ + signers_1, + ] + + unclaimed_draft_create_embedded_with_template_request = ( + models.UnclaimedDraftCreateEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + test_mode=False, + ccs=ccs, + signers=signers, + ) ) try: - response = unclaimed_draft_api.unclaimed_draft_create_embedded_with_template( - data + response = api.UnclaimedDraftApi( + api_client + ).unclaimed_draft_create_embedded_with_template( + unclaimed_draft_create_embedded_with_template_request=unclaimed_draft_create_embedded_with_template_request, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: %s\n" + % e + ) ``` ``` @@ -276,7 +283,9 @@ with ApiClient(configuration) as api_client: Edit and Resend Unclaimed Draft -Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. +Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. + +**NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. ### Example @@ -284,34 +293,35 @@ Creates a new signature request from an embedded request that can be edited prio * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - data = models.UnclaimedDraftEditAndResendRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - test_mode=True, + unclaimed_draft_edit_and_resend_request = models.UnclaimedDraftEditAndResendRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + test_mode=False, ) - signature_request_id = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f" - try: - response = unclaimed_draft_api.unclaimed_draft_edit_and_resend( - signature_request_id, data + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_edit_and_resend( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimed_draft_edit_and_resend_request=unclaimed_draft_edit_and_resend_request, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_edit_and_resend: %s\n" + % e + ) ``` ``` diff --git a/docs/UnclaimedDraftCreateEmbeddedRequest.md b/docs/UnclaimedDraftCreateEmbeddedRequest.md index bc81c3c..49704d2 100644 --- a/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -44,3 +44,4 @@ Name | Type | Description | Notes [[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/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index ef959b9..88a2018 100644 --- a/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -38,3 +38,4 @@ Name | Type | Description | Notes [[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/UnclaimedDraftCreateRequest.md b/docs/UnclaimedDraftCreateRequest.md index 61471fc..2d84e6e 100644 --- a/docs/UnclaimedDraftCreateRequest.md +++ b/docs/UnclaimedDraftCreateRequest.md @@ -32,3 +32,4 @@ Name | Type | Description | Notes [[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/UnclaimedDraftCreateResponse.md b/docs/UnclaimedDraftCreateResponse.md index bfb420c..41fbc83 100644 --- a/docs/UnclaimedDraftCreateResponse.md +++ b/docs/UnclaimedDraftCreateResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/UnclaimedDraftEditAndResendRequest.md b/docs/UnclaimedDraftEditAndResendRequest.md index d13a104..4782fa4 100644 --- a/docs/UnclaimedDraftEditAndResendRequest.md +++ b/docs/UnclaimedDraftEditAndResendRequest.md @@ -16,3 +16,4 @@ Name | Type | Description | Notes [[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/UnclaimedDraftResponse.md b/docs/UnclaimedDraftResponse.md index 2a3e4f9..561d632 100644 --- a/docs/UnclaimedDraftResponse.md +++ b/docs/UnclaimedDraftResponse.md @@ -14,3 +14,4 @@ Name | Type | Description | Notes [[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/WarningResponse.md b/docs/WarningResponse.md index 3de57d0..c015bda 100644 --- a/docs/WarningResponse.md +++ b/docs/WarningResponse.md @@ -10,3 +10,4 @@ Name | Type | Description | Notes [[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/dropbox_sign/__init__.py b/dropbox_sign/__init__.py index c94e664..a000968 100644 --- a/dropbox_sign/__init__.py +++ b/dropbox_sign/__init__.py @@ -3,19 +3,19 @@ # flake8: noqa """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 -__version__ = "1.8.0" +__version__ = "1.9.0" # import apis into sdk package from dropbox_sign.apis import * @@ -125,6 +125,18 @@ from dropbox_sign.models.signature_request_create_embedded_with_template_request import ( SignatureRequestCreateEmbeddedWithTemplateRequest, ) +from dropbox_sign.models.signature_request_edit_embedded_request import ( + SignatureRequestEditEmbeddedRequest, +) +from dropbox_sign.models.signature_request_edit_embedded_with_template_request import ( + SignatureRequestEditEmbeddedWithTemplateRequest, +) +from dropbox_sign.models.signature_request_edit_request import ( + SignatureRequestEditRequest, +) +from dropbox_sign.models.signature_request_edit_with_template_request import ( + SignatureRequestEditWithTemplateRequest, +) from dropbox_sign.models.signature_request_get_response import ( SignatureRequestGetResponse, ) diff --git a/dropbox_sign/api/account_api.py b/dropbox_sign/api/account_api.py index b3e5ce9..c326dc1 100644 --- a/dropbox_sign/api/account_api.py +++ b/dropbox_sign/api/account_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -253,7 +253,9 @@ def _account_create_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -571,7 +573,9 @@ def _account_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -820,7 +824,9 @@ def _account_update_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -1095,7 +1101,9 @@ def _account_verify_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False diff --git a/dropbox_sign/api/api_app_api.py b/dropbox_sign/api/api_app_api.py index 93752b1..45ce475 100644 --- a/dropbox_sign/api/api_app_api.py +++ b/dropbox_sign/api/api_app_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -251,7 +251,9 @@ def _api_app_create_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -532,7 +534,9 @@ def _api_app_delete_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -781,7 +785,9 @@ def _api_app_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1067,7 +1073,9 @@ def _api_app_list_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1335,7 +1343,9 @@ def _api_app_update_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False diff --git a/dropbox_sign/api/bulk_send_job_api.py b/dropbox_sign/api/bulk_send_job_api.py index e53401b..eb0b4bc 100644 --- a/dropbox_sign/api/bulk_send_job_api.py +++ b/dropbox_sign/api/bulk_send_job_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -311,7 +311,9 @@ def _bulk_send_job_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -605,7 +607,9 @@ def _bulk_send_job_list_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/dropbox_sign/api/embedded_api.py b/dropbox_sign/api/embedded_api.py index fcb839f..450099e 100644 --- a/dropbox_sign/api/embedded_api.py +++ b/dropbox_sign/api/embedded_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -268,7 +268,9 @@ def _embedded_edit_url_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -554,7 +556,9 @@ def _embedded_sign_url_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/dropbox_sign/api/fax_api.py b/dropbox_sign/api/fax_api.py index 3e49a16..abf615a 100644 --- a/dropbox_sign/api/fax_api.py +++ b/dropbox_sign/api/fax_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -18,7 +18,7 @@ from typing_extensions import Annotated from pydantic import Field, StrictBytes, StrictStr -from typing import Optional, Union +from typing import Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.fax_get_response import FaxGetResponse from dropbox_sign.models.fax_list_response import FaxListResponse @@ -60,7 +60,7 @@ def fax_delete( ) -> None: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -125,7 +125,7 @@ def fax_delete_with_http_info( ) -> ApiResponse[None]: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -190,7 +190,7 @@ def fax_delete_without_preload_content( ) -> RESTResponseType: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -250,7 +250,9 @@ def _fax_delete_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -301,9 +303,9 @@ def fax_files( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> io.IOBase: - """List Fax Files + """Download Fax Files - Returns list of fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -366,9 +368,9 @@ def fax_files_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[io.IOBase]: - """List Fax Files + """Download Fax Files - Returns list of fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -431,9 +433,9 @@ def fax_files_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List Fax Files + """Download Fax Files - Returns list of fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -493,7 +495,9 @@ def _fax_files_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -546,7 +550,7 @@ def fax_get( ) -> FaxGetResponse: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -611,7 +615,7 @@ def fax_get_with_http_info( ) -> ApiResponse[FaxGetResponse]: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -676,7 +680,7 @@ def fax_get_without_preload_content( ) -> RESTResponseType: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -736,7 +740,9 @@ def _fax_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -776,11 +782,15 @@ def fax_list( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -796,11 +806,11 @@ def fax_list( ) -> FaxListResponse: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -851,11 +861,15 @@ def fax_list_with_http_info( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -871,11 +885,11 @@ def fax_list_with_http_info( ) -> ApiResponse[FaxListResponse]: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -926,11 +940,15 @@ def fax_list_without_preload_content( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -946,11 +964,11 @@ def fax_list_without_preload_content( ) -> RESTResponseType: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1010,7 +1028,9 @@ def _fax_list_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1069,7 +1089,7 @@ def fax_send( ) -> FaxGetResponse: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest @@ -1134,7 +1154,7 @@ def fax_send_with_http_info( ) -> ApiResponse[FaxGetResponse]: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest @@ -1199,7 +1219,7 @@ def fax_send_without_preload_content( ) -> RESTResponseType: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest @@ -1259,7 +1279,9 @@ def _fax_send_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False diff --git a/dropbox_sign/api/fax_line_api.py b/dropbox_sign/api/fax_line_api.py index 2fbb5ac..c3ceff1 100644 --- a/dropbox_sign/api/fax_line_api.py +++ b/dropbox_sign/api/fax_line_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -256,7 +256,9 @@ def _fax_line_add_user_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -327,16 +329,16 @@ def _fax_line_add_user_serialize( def fax_line_area_code_get( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -352,15 +354,15 @@ def fax_line_area_code_get( ) -> FaxLineAreaCodeGetResponse: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/provice and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -412,16 +414,16 @@ def fax_line_area_code_get( def fax_line_area_code_get_with_http_info( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -437,15 +439,15 @@ def fax_line_area_code_get_with_http_info( ) -> ApiResponse[FaxLineAreaCodeGetResponse]: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/provice and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -497,16 +499,16 @@ def fax_line_area_code_get_with_http_info( def fax_line_area_code_get_without_preload_content( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -522,15 +524,15 @@ def fax_line_area_code_get_without_preload_content( ) -> RESTResponseType: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/provice and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -594,7 +596,9 @@ def _fax_line_area_code_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -661,7 +665,7 @@ def fax_line_create( ) -> FaxLineResponse: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -726,7 +730,7 @@ def fax_line_create_with_http_info( ) -> ApiResponse[FaxLineResponse]: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -791,7 +795,7 @@ def fax_line_create_without_preload_content( ) -> RESTResponseType: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -851,7 +855,9 @@ def _fax_line_create_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -1126,7 +1132,9 @@ def _fax_line_delete_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -1196,7 +1204,7 @@ def _fax_line_delete_serialize( @validate_call def fax_line_get( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1213,7 +1221,7 @@ def fax_line_get( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1261,7 +1269,7 @@ def fax_line_get( @validate_call def fax_line_get_with_http_info( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1278,7 +1286,7 @@ def fax_line_get_with_http_info( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1326,7 +1334,7 @@ def fax_line_get_with_http_info( @validate_call def fax_line_get_without_preload_content( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1343,7 +1351,7 @@ def fax_line_get_without_preload_content( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1401,7 +1409,9 @@ def _fax_line_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1444,12 +1454,23 @@ def fax_line_list( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1469,11 +1490,11 @@ def fax_line_list( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1527,12 +1548,23 @@ def fax_line_list_with_http_info( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1552,11 +1584,11 @@ def fax_line_list_with_http_info( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1610,12 +1642,23 @@ def fax_line_list_without_preload_content( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1635,11 +1678,11 @@ def fax_line_list_without_preload_content( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1703,7 +1746,9 @@ def _fax_line_list_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1770,7 +1815,7 @@ def fax_line_remove_user( ) -> FaxLineResponse: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest @@ -1835,7 +1880,7 @@ def fax_line_remove_user_with_http_info( ) -> ApiResponse[FaxLineResponse]: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest @@ -1900,7 +1945,7 @@ def fax_line_remove_user_without_preload_content( ) -> RESTResponseType: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest @@ -1960,7 +2005,9 @@ def _fax_line_remove_user_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False diff --git a/dropbox_sign/api/o_auth_api.py b/dropbox_sign/api/o_auth_api.py index bedd1bf..6ea59b5 100644 --- a/dropbox_sign/api/o_auth_api.py +++ b/dropbox_sign/api/o_auth_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -248,7 +248,9 @@ def _oauth_token_generate_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -524,7 +526,9 @@ def _oauth_token_refresh_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False diff --git a/dropbox_sign/api/report_api.py b/dropbox_sign/api/report_api.py index a31ee01..f739dcb 100644 --- a/dropbox_sign/api/report_api.py +++ b/dropbox_sign/api/report_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -246,7 +246,9 @@ def _report_create_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False diff --git a/dropbox_sign/api/signature_request_api.py b/dropbox_sign/api/signature_request_api.py index f78d1a2..e7c1dc4 100644 --- a/dropbox_sign/api/signature_request_api.py +++ b/dropbox_sign/api/signature_request_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -18,7 +18,7 @@ from typing_extensions import Annotated from pydantic import Field, StrictBytes, StrictInt, StrictStr, field_validator -from typing import Optional, Union +from typing import Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.bulk_send_job_send_response import BulkSendJobSendResponse from dropbox_sign.models.file_response import FileResponse @@ -35,6 +35,18 @@ from dropbox_sign.models.signature_request_create_embedded_with_template_request import ( SignatureRequestCreateEmbeddedWithTemplateRequest, ) +from dropbox_sign.models.signature_request_edit_embedded_request import ( + SignatureRequestEditEmbeddedRequest, +) +from dropbox_sign.models.signature_request_edit_embedded_with_template_request import ( + SignatureRequestEditEmbeddedWithTemplateRequest, +) +from dropbox_sign.models.signature_request_edit_request import ( + SignatureRequestEditRequest, +) +from dropbox_sign.models.signature_request_edit_with_template_request import ( + SignatureRequestEditWithTemplateRequest, +) from dropbox_sign.models.signature_request_get_response import ( SignatureRequestGetResponse, ) @@ -280,7 +292,9 @@ def _signature_request_bulk_create_embedded_with_template_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -558,7 +572,9 @@ def _signature_request_bulk_send_with_template_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -845,7 +861,9 @@ def _signature_request_cancel_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1088,7 +1106,9 @@ def _signature_request_create_embedded_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -1363,7 +1383,9 @@ def _signature_request_create_embedded_with_template_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -1433,6 +1455,1204 @@ def _signature_request_create_embedded_with_template_serialize( _request_auth=_request_auth, ) + @validate_call + def signature_request_edit( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_request: SignatureRequestEditRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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* deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_request: (required) + :type signature_request_edit_request: SignatureRequestEditRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_serialize( + signature_request_id=signature_request_id, + signature_request_edit_request=signature_request_edit_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def signature_request_edit_with_http_info( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_request: SignatureRequestEditRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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* deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_request: (required) + :type signature_request_edit_request: SignatureRequestEditRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_serialize( + signature_request_id=signature_request_id, + signature_request_edit_request=signature_request_edit_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def signature_request_edit_without_preload_content( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_request: SignatureRequestEditRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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* deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_request: (required) + :type signature_request_edit_request: SignatureRequestEditRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_serialize( + signature_request_id=signature_request_id, + signature_request_edit_request=signature_request_edit_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _signature_request_edit_serialize( + self, + signature_request_id, + signature_request_edit_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + has_files = False + body_param = signature_request_edit_request + excluded_json_fields = set([]) + for param_name, param_type in body_param.openapi_types().items(): + param_value = getattr(body_param, param_name) + if param_value is None: + continue + + if "io.IOBase" in param_type: + has_files = True + _content_type = "multipart/form-data" + excluded_json_fields.add(param_name) + + if isinstance(param_value, list): + for index, item in enumerate(param_value): + _files[f"{param_name}[{index}]"] = item + else: + _files[param_name] = param_value + + if has_files is True: + _form_params = body_param.to_json_form_params(excluded_json_fields) + + # process the path parameters + if signature_request_id is not None: + _path_params["signature_request_id"] = signature_request_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if signature_request_edit_request is not None and has_files is False: + _body_params = signature_request_edit_request + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params["Content-Type"] = _content_type + else: + _default_content_type = self.api_client.select_header_content_type( + ["application/json", "multipart/form-data"] + ) + if _default_content_type is not None: + _header_params["Content-Type"] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ["api_key", "oauth2"] + + return self.api_client.param_serialize( + method="PUT", + resource_path="/signature_request/edit/{signature_request_id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def signature_request_edit_embedded( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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. **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 + :param signature_request_edit_embedded_request: (required) + :type signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def signature_request_edit_embedded_with_http_info( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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. **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 + :param signature_request_edit_embedded_request: (required) + :type signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def signature_request_edit_embedded_without_preload_content( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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. **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 + :param signature_request_edit_embedded_request: (required) + :type signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _signature_request_edit_embedded_serialize( + self, + signature_request_id, + signature_request_edit_embedded_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + has_files = False + body_param = signature_request_edit_embedded_request + excluded_json_fields = set([]) + for param_name, param_type in body_param.openapi_types().items(): + param_value = getattr(body_param, param_name) + if param_value is None: + continue + + if "io.IOBase" in param_type: + has_files = True + _content_type = "multipart/form-data" + excluded_json_fields.add(param_name) + + if isinstance(param_value, list): + for index, item in enumerate(param_value): + _files[f"{param_name}[{index}]"] = item + else: + _files[param_name] = param_value + + if has_files is True: + _form_params = body_param.to_json_form_params(excluded_json_fields) + + # process the path parameters + if signature_request_id is not None: + _path_params["signature_request_id"] = signature_request_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if signature_request_edit_embedded_request is not None and has_files is False: + _body_params = signature_request_edit_embedded_request + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params["Content-Type"] = _content_type + else: + _default_content_type = self.api_client.select_header_content_type( + ["application/json", "multipart/form-data"] + ) + if _default_content_type is not None: + _header_params["Content-Type"] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ["api_key", "oauth2"] + + return self.api_client.param_serialize( + method="PUT", + resource_path="/signature_request/edit_embedded/{signature_request_id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def signature_request_edit_embedded_with_template( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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. **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 + :param signature_request_edit_embedded_with_template_request: (required) + :type signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_with_template_request=signature_request_edit_embedded_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def signature_request_edit_embedded_with_template_with_http_info( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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. **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 + :param signature_request_edit_embedded_with_template_request: (required) + :type signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_with_template_request=signature_request_edit_embedded_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def signature_request_edit_embedded_with_template_without_preload_content( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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. **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 + :param signature_request_edit_embedded_with_template_request: (required) + :type signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_with_template_request=signature_request_edit_embedded_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _signature_request_edit_embedded_with_template_serialize( + self, + signature_request_id, + signature_request_edit_embedded_with_template_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + has_files = False + body_param = signature_request_edit_embedded_with_template_request + excluded_json_fields = set([]) + for param_name, param_type in body_param.openapi_types().items(): + param_value = getattr(body_param, param_name) + if param_value is None: + continue + + if "io.IOBase" in param_type: + has_files = True + _content_type = "multipart/form-data" + excluded_json_fields.add(param_name) + + if isinstance(param_value, list): + for index, item in enumerate(param_value): + _files[f"{param_name}[{index}]"] = item + else: + _files[param_name] = param_value + + if has_files is True: + _form_params = body_param.to_json_form_params(excluded_json_fields) + + # process the path parameters + if signature_request_id is not None: + _path_params["signature_request_id"] = signature_request_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ( + signature_request_edit_embedded_with_template_request is not None + and has_files is False + ): + _body_params = signature_request_edit_embedded_with_template_request + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params["Content-Type"] = _content_type + else: + _default_content_type = self.api_client.select_header_content_type( + ["application/json", "multipart/form-data"] + ) + if _default_content_type is not None: + _header_params["Content-Type"] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ["api_key", "oauth2"] + + return self.api_client.param_serialize( + method="PUT", + resource_path="/signature_request/edit_embedded_with_template/{signature_request_id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def signature_request_edit_with_template( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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* deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_with_template_request: (required) + :type signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_with_template_request=signature_request_edit_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def signature_request_edit_with_template_with_http_info( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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* deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_with_template_request: (required) + :type signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_with_template_request=signature_request_edit_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def signature_request_edit_with_template_without_preload_content( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> 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* deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_with_template_request: (required) + :type signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_with_template_request=signature_request_edit_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _signature_request_edit_with_template_serialize( + self, + signature_request_id, + signature_request_edit_with_template_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + has_files = False + body_param = signature_request_edit_with_template_request + excluded_json_fields = set([]) + for param_name, param_type in body_param.openapi_types().items(): + param_value = getattr(body_param, param_name) + if param_value is None: + continue + + if "io.IOBase" in param_type: + has_files = True + _content_type = "multipart/form-data" + excluded_json_fields.add(param_name) + + if isinstance(param_value, list): + for index, item in enumerate(param_value): + _files[f"{param_name}[{index}]"] = item + else: + _files[param_name] = param_value + + if has_files is True: + _form_params = body_param.to_json_form_params(excluded_json_fields) + + # process the path parameters + if signature_request_id is not None: + _path_params["signature_request_id"] = signature_request_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ( + signature_request_edit_with_template_request is not None + and has_files is False + ): + _body_params = signature_request_edit_with_template_request + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params["Content-Type"] = _content_type + else: + _default_content_type = self.api_client.select_header_content_type( + ["application/json", "multipart/form-data"] + ) + if _default_content_type is not None: + _header_params["Content-Type"] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ["api_key", "oauth2"] + + return self.api_client.param_serialize( + method="PUT", + resource_path="/signature_request/edit_with_template/{signature_request_id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + @validate_call def signature_request_files( self, @@ -1675,7 +2895,9 @@ def _signature_request_files_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1928,7 +3150,9 @@ def _signature_request_files_as_data_uri_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2205,7 +3429,9 @@ def _signature_request_files_as_file_url_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2458,7 +3684,9 @@ def _signature_request_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2800,7 +4028,9 @@ def _signature_request_list_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -3063,7 +4293,9 @@ def _signature_request_release_hold_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -3328,7 +4560,9 @@ def _signature_request_remind_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -3611,7 +4845,9 @@ def _signature_request_remove_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -3854,7 +5090,9 @@ def _signature_request_send_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -4129,7 +5367,9 @@ def _signature_request_send_with_template_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -4426,7 +5666,9 @@ def _signature_request_update_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False diff --git a/dropbox_sign/api/team_api.py b/dropbox_sign/api/team_api.py index 142d890..f59cf5e 100644 --- a/dropbox_sign/api/team_api.py +++ b/dropbox_sign/api/team_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -275,7 +275,9 @@ def _team_add_member_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -554,7 +556,9 @@ def _team_create_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -816,7 +820,9 @@ def _team_delete_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1044,7 +1050,9 @@ def _team_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1291,7 +1299,9 @@ def _team_info_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1551,7 +1561,9 @@ def _team_invites_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1867,7 +1879,9 @@ def _team_members_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2118,7 +2132,9 @@ def _team_remove_member_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -2449,7 +2465,9 @@ def _team_sub_teams_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2700,7 +2718,9 @@ def _team_update_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False diff --git a/dropbox_sign/api/template_api.py b/dropbox_sign/api/template_api.py index 87be9f0..3205675 100644 --- a/dropbox_sign/api/template_api.py +++ b/dropbox_sign/api/template_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -18,7 +18,7 @@ from typing_extensions import Annotated from pydantic import Field, StrictBytes, StrictInt, StrictStr, field_validator -from typing import Optional, Union +from typing import Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.file_response import FileResponse from dropbox_sign.models.file_response_data_uri import FileResponseDataUri @@ -287,7 +287,9 @@ def _template_add_user_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -564,7 +566,9 @@ def _template_create_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -839,7 +843,9 @@ def _template_create_embedded_draft_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -1120,7 +1126,9 @@ def _template_delete_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1397,7 +1405,9 @@ def _template_files_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1650,7 +1660,9 @@ def _template_files_as_data_uri_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1927,7 +1939,9 @@ def _template_files_as_file_url_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2180,7 +2194,9 @@ def _template_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2522,7 +2538,9 @@ def _template_list_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2807,7 +2825,9 @@ def _template_remove_user_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -3106,7 +3126,9 @@ def _template_update_files_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False diff --git a/dropbox_sign/api/unclaimed_draft_api.py b/dropbox_sign/api/unclaimed_draft_api.py index 620a71e..4d4d743 100644 --- a/dropbox_sign/api/unclaimed_draft_api.py +++ b/dropbox_sign/api/unclaimed_draft_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings @@ -261,7 +261,9 @@ def _unclaimed_draft_create_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -536,7 +538,9 @@ def _unclaimed_draft_create_embedded_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -811,7 +815,9 @@ def _unclaimed_draft_create_embedded_with_template_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False @@ -1111,7 +1117,9 @@ def _unclaimed_draft_edit_and_resend_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None has_files = False diff --git a/dropbox_sign/api_client.py b/dropbox_sign/api_client.py index 7d2eae2..b8ac14b 100644 --- a/dropbox_sign/api_client.py +++ b/dropbox_sign/api_client.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -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.8.0/python" + self.user_agent = "OpenAPI-Generator/1.9.0/python" self.client_side_validation = configuration.client_side_validation def __enter__(self): @@ -302,6 +302,8 @@ def response_deserialize( try: if response_type == "bytearray": return_data = response_data.data + elif response_type == "io.IOBase": + return_data = self.__bytearray_to_iobase(response_data) elif response_type == "file": return_data = self.__deserialize_file(response_data) elif response_type is not None: @@ -398,12 +400,16 @@ def deserialize( data = json.loads(response_text) except ValueError: data = response_text - elif content_type.startswith("application/json"): + elif re.match( + r"^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)", + content_type, + re.IGNORECASE, + ): if response_text == "": data = "" else: data = json.loads(response_text) - elif content_type.startswith("text/plain"): + elif re.match(r"^text\/[a-z.+-]+\s*(;|$)", content_type, re.IGNORECASE): data = response_text else: raise ApiException( @@ -507,7 +513,7 @@ def parameters_to_url_query(self, params, collection_formats): if k in collection_formats: collection_format = collection_formats[k] if collection_format == "multi": - new_params.extend((k, str(value)) for value in v) + new_params.extend((k, quote(str(value))) for value in v) else: if collection_format == "ssv": delimiter = " " @@ -525,7 +531,21 @@ def parameters_to_url_query(self, params, collection_formats): return "&".join(["=".join(map(str, item)) for item in new_params]) - def files_parameters(self, files: Dict[str, Union[str, bytes, io.IOBase]]): + def files_parameters( + self, + files: Dict[ + str, + Union[ + str, + bytes, + List[str], + List[bytes], + Tuple[str, bytes, io.IOBase], + io.IOBase, + List[io.IOBase], + ], + ], + ): """Builds form parameters. :param files: File parameters. @@ -540,6 +560,12 @@ def files_parameters(self, files: Dict[str, Union[str, bytes, io.IOBase]]): elif isinstance(v, bytes): filename = k filedata = v + elif isinstance(v, tuple): + filename, filedata = v + elif isinstance(v, list): + for file_param in v: + params.extend(self.files_parameters({k: file_param})) + continue elif isinstance(v, io.IOBase): filename = os.path.basename(v.name) filedata = v.read() @@ -667,6 +693,13 @@ def __deserialize_file(self, response): return path + def __bytearray_to_iobase(self, response): + """Convert bytearray to io.IOBase""" + buffer = io.BytesIO() + buffer.write(response.data) + buffer.seek(0) + return buffer + def __deserialize_primitive(self, data, klass): """Deserializes string to primitive type. diff --git a/dropbox_sign/configuration.py b/dropbox_sign/configuration.py index 39da268..180560a 100644 --- a/dropbox_sign/configuration.py +++ b/dropbox_sign/configuration.py @@ -1,27 +1,29 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import copy +import http.client as httplib import logging from logging import FileHandler import multiprocessing import sys -from typing import Optional +from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict, Union +from typing_extensions import NotRequired, Self + import urllib3 -import http.client as httplib JSON_SCHEMA_VALIDATION_KEYWORDS = { "multipleOf", @@ -36,6 +38,107 @@ "minItems", } +ServerVariablesT = Dict[str, str] + +GenericAuthSetting = TypedDict( + "GenericAuthSetting", + { + "type": str, + "in": str, + "key": str, + "value": str, + }, +) + + +OAuth2AuthSetting = TypedDict( + "OAuth2AuthSetting", + { + "type": Literal["oauth2"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +APIKeyAuthSetting = TypedDict( + "APIKeyAuthSetting", + { + "type": Literal["api_key"], + "in": str, + "key": str, + "value": Optional[str], + }, +) + + +BasicAuthSetting = TypedDict( + "BasicAuthSetting", + { + "type": Literal["basic"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": Optional[str], + }, +) + + +BearerFormatAuthSetting = TypedDict( + "BearerFormatAuthSetting", + { + "type": Literal["bearer"], + "in": Literal["header"], + "format": Literal["JWT"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +BearerAuthSetting = TypedDict( + "BearerAuthSetting", + { + "type": Literal["bearer"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +HTTPSignatureAuthSetting = TypedDict( + "HTTPSignatureAuthSetting", + { + "type": Literal["http-signature"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": None, + }, +) + + +AuthSettings = TypedDict( + "AuthSettings", + { + "api_key": BasicAuthSetting, + "oauth2": BearerFormatAuthSetting, + }, + total=False, +) + + +class HostSettingVariable(TypedDict): + description: str + default_value: str + enum_values: List[str] + + +class HostSetting(TypedDict): + url: str + description: str + variables: NotRequired[Dict[str, HostSettingVariable]] + class Configuration: """This class contains various settings of the API client. @@ -67,6 +170,8 @@ class Configuration: :param ssl_ca_cert: str - the path to a file of concatenated CA certificates in PEM format. :param retries: Number of retries for API requests. + :param ca_cert_data: verify the peer using concatenated CA certificate data + in PEM (str) or DER (bytes) format. :Example: @@ -86,25 +191,26 @@ class Configuration: """ - _default = None + _default: ClassVar[Optional[Self]] = None def __init__( self, - host=None, - api_key=None, - api_key_prefix=None, - username=None, - password=None, - access_token=None, - server_index=None, - server_variables=None, - server_operation_index=None, - server_operation_variables=None, - ignore_operation_servers=False, - ssl_ca_cert=None, - retries=None, + host: Optional[str] = None, + api_key: Optional[Dict[str, str]] = None, + api_key_prefix: Optional[Dict[str, str]] = None, + username: Optional[str] = None, + password: Optional[str] = None, + access_token: Optional[str] = None, + server_index: Optional[int] = None, + server_variables: Optional[ServerVariablesT] = None, + server_operation_index: Optional[Dict[int, int]] = None, + server_operation_variables: Optional[Dict[int, ServerVariablesT]] = None, + ignore_operation_servers: bool = False, + ssl_ca_cert: Optional[str] = None, + retries: Optional[int] = None, + ca_cert_data: Optional[Union[str, bytes]] = None, *, - debug: Optional[bool] = None + debug: Optional[bool] = None, ) -> None: """Constructor""" self._base_path = "https://api.hellosign.com/v3" if host is None else host @@ -179,6 +285,10 @@ def __init__( self.ssl_ca_cert = ssl_ca_cert """Set this to customize the certificate file to verify the peer. """ + self.ca_cert_data = ca_cert_data + """Set this to verify the peer using PEM (str) or DER (bytes) + certificate data. + """ self.cert_file = None """client certificate file """ @@ -228,7 +338,7 @@ def __init__( """date format """ - def __deepcopy__(self, memo): + def __deepcopy__(self, memo: Dict[int, Any]) -> Self: cls = self.__class__ result = cls.__new__(cls) memo[id(self)] = result @@ -242,11 +352,11 @@ def __deepcopy__(self, memo): result.debug = self.debug return result - def __setattr__(self, name, value): + def __setattr__(self, name: str, value: Any) -> None: object.__setattr__(self, name, value) @classmethod - def set_default(cls, default): + def set_default(cls, default: Optional[Self]) -> None: """Set default instance of configuration. It stores default configuration, which can be @@ -257,7 +367,7 @@ def set_default(cls, default): cls._default = default @classmethod - def get_default_copy(cls): + def get_default_copy(cls) -> Self: """Deprecated. Please use `get_default` instead. Deprecated. Please use `get_default` instead. @@ -267,7 +377,7 @@ def get_default_copy(cls): return cls.get_default() @classmethod - def get_default(cls): + def get_default(cls) -> Self: """Return the default configuration. This method returns newly created, based on default constructor, @@ -277,11 +387,11 @@ def get_default(cls): :return: The configuration object. """ if cls._default is None: - cls._default = Configuration() + cls._default = cls() return cls._default @property - def logger_file(self): + def logger_file(self) -> Optional[str]: """The logger file. If the logger_file is None, then add stream handler and remove file @@ -293,7 +403,7 @@ def logger_file(self): return self.__logger_file @logger_file.setter - def logger_file(self, value): + def logger_file(self, value: Optional[str]) -> None: """The logger file. If the logger_file is None, then add stream handler and remove file @@ -312,7 +422,7 @@ def logger_file(self, value): logger.addHandler(self.logger_file_handler) @property - def debug(self): + def debug(self) -> bool: """Debug status :param value: The debug status, True or False. @@ -321,7 +431,7 @@ def debug(self): return self.__debug @debug.setter - def debug(self, value): + def debug(self, value: bool) -> None: """Debug status :param value: The debug status, True or False. @@ -343,7 +453,7 @@ def debug(self, value): httplib.HTTPConnection.debuglevel = 0 @property - def logger_format(self): + def logger_format(self) -> str: """The logger format. The logger_formatter will be updated when sets logger_format. @@ -354,7 +464,7 @@ def logger_format(self): return self.__logger_format @logger_format.setter - def logger_format(self, value): + def logger_format(self, value: str) -> None: """The logger format. The logger_formatter will be updated when sets logger_format. @@ -365,7 +475,9 @@ def logger_format(self, value): self.__logger_format = value self.logger_formatter = logging.Formatter(self.__logger_format) - def get_api_key_with_prefix(self, identifier, alias=None): + def get_api_key_with_prefix( + self, identifier: str, alias: Optional[str] = None + ) -> Optional[str]: """Gets API key (with prefix if set). :param identifier: The identifier of apiKey. @@ -384,7 +496,9 @@ def get_api_key_with_prefix(self, identifier, alias=None): else: return key - def get_basic_auth_token(self): + return None + + def get_basic_auth_token(self) -> Optional[str]: """Gets HTTP basic authentication header (string). :return: The token for basic HTTP authentication. @@ -399,12 +513,12 @@ def get_basic_auth_token(self): "authorization" ) - def auth_settings(self): + def auth_settings(self) -> AuthSettings: """Gets Auth Settings dict for api client. :return: The Auth Settings information dict. """ - auth = {} + auth: AuthSettings = {} if self.username is not None: auth["api_key"] = { "type": "basic", @@ -422,7 +536,7 @@ def auth_settings(self): } return auth - def to_debug_report(self): + def to_debug_report(self) -> str: """Gets the essential information for debugging. :return: The report for debugging. @@ -432,10 +546,10 @@ def to_debug_report(self): "OS: {env}\n" "Python Version: {pyversion}\n" "Version of the API: 3.0.0\n" - "SDK Version: 1.8.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): + def get_host_settings(self) -> List[HostSetting]: """Gets an array of host settings :return: An array of host settings @@ -447,7 +561,12 @@ def get_host_settings(self): } ] - def get_host_from_settings(self, index, variables=None, servers=None): + def get_host_from_settings( + self, + index: Optional[int], + variables: Optional[ServerVariablesT] = None, + servers: Optional[List[HostSetting]] = None, + ) -> str: """Gets host URL based on the index and variables :param index: array index of the host settings :param variables: hash of variable and the corresponding value @@ -487,14 +606,14 @@ def get_host_from_settings(self, index, variables=None, servers=None): return url @property - def host(self): + def host(self) -> str: """Return generated host.""" return self.get_host_from_settings( self.server_index, variables=self.server_variables ) @host.setter - def host(self, value): + def host(self, value: str) -> None: """Fix base path.""" self._base_path = value self.server_index = None diff --git a/dropbox_sign/exceptions.py b/dropbox_sign/exceptions.py index 43300ce..4395d0c 100644 --- a/dropbox_sign/exceptions.py +++ b/dropbox_sign/exceptions.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 from typing import Any, Optional @@ -154,6 +154,15 @@ def from_response( if http_resp.status == 404: raise NotFoundException(http_resp=http_resp, body=body, data=data) + # Added new conditions for 409 and 422 + if http_resp.status == 409: + raise ConflictException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 422: + raise UnprocessableEntityException( + http_resp=http_resp, body=body, data=data + ) + if 500 <= http_resp.status <= 599: raise ServiceException(http_resp=http_resp, body=body, data=data) raise ApiException(http_resp=http_resp, body=body, data=data) @@ -190,6 +199,18 @@ class ServiceException(ApiException): pass +class ConflictException(ApiException): + """Exception for HTTP 409 Conflict.""" + + pass + + +class UnprocessableEntityException(ApiException): + """Exception for HTTP 422 Unprocessable Entity.""" + + pass + + def render_path(path_to_item): """Returns a string representation of a path""" result = "" diff --git a/dropbox_sign/models/__init__.py b/dropbox_sign/models/__init__.py index 97af402..fd5331a 100644 --- a/dropbox_sign/models/__init__.py +++ b/dropbox_sign/models/__init__.py @@ -2,15 +2,15 @@ # flake8: noqa """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -108,6 +108,18 @@ from dropbox_sign.models.signature_request_create_embedded_with_template_request import ( SignatureRequestCreateEmbeddedWithTemplateRequest, ) +from dropbox_sign.models.signature_request_edit_embedded_request import ( + SignatureRequestEditEmbeddedRequest, +) +from dropbox_sign.models.signature_request_edit_embedded_with_template_request import ( + SignatureRequestEditEmbeddedWithTemplateRequest, +) +from dropbox_sign.models.signature_request_edit_request import ( + SignatureRequestEditRequest, +) +from dropbox_sign.models.signature_request_edit_with_template_request import ( + SignatureRequestEditWithTemplateRequest, +) from dropbox_sign.models.signature_request_get_response import ( SignatureRequestGetResponse, ) diff --git a/dropbox_sign/models/account_create_request.py b/dropbox_sign/models/account_create_request.py index eb0d374..06eb224 100644 --- a/dropbox_sign/models/account_create_request.py +++ b/dropbox_sign/models/account_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class AccountCreateRequest(BaseModel): diff --git a/dropbox_sign/models/account_create_response.py b/dropbox_sign/models/account_create_response.py index c1788e0..3bcabfd 100644 --- a/dropbox_sign/models/account_create_response.py +++ b/dropbox_sign/models/account_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.account_response import AccountResponse from dropbox_sign.models.o_auth_token_response import OAuthTokenResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class AccountCreateResponse(BaseModel): diff --git a/dropbox_sign/models/account_get_response.py b/dropbox_sign/models/account_get_response.py index 1be99f4..9a12adb 100644 --- a/dropbox_sign/models/account_get_response.py +++ b/dropbox_sign/models/account_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.account_response import AccountResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class AccountGetResponse(BaseModel): diff --git a/dropbox_sign/models/account_response.py b/dropbox_sign/models/account_response.py index 8af0a6f..5273773 100644 --- a/dropbox_sign/models/account_response.py +++ b/dropbox_sign/models/account_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.account_response_quotas import AccountResponseQuotas from dropbox_sign.models.account_response_usage import AccountResponseUsage -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class AccountResponse(BaseModel): diff --git a/dropbox_sign/models/account_response_quotas.py b/dropbox_sign/models/account_response_quotas.py index a584445..d2b2ffb 100644 --- a/dropbox_sign/models/account_response_quotas.py +++ b/dropbox_sign/models/account_response_quotas.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class AccountResponseQuotas(BaseModel): diff --git a/dropbox_sign/models/account_response_usage.py b/dropbox_sign/models/account_response_usage.py index 8efc7a6..6fc7593 100644 --- a/dropbox_sign/models/account_response_usage.py +++ b/dropbox_sign/models/account_response_usage.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class AccountResponseUsage(BaseModel): diff --git a/dropbox_sign/models/account_update_request.py b/dropbox_sign/models/account_update_request.py index 7b5c95d..a0cafd7 100644 --- a/dropbox_sign/models/account_update_request.py +++ b/dropbox_sign/models/account_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class AccountUpdateRequest(BaseModel): diff --git a/dropbox_sign/models/account_verify_request.py b/dropbox_sign/models/account_verify_request.py index a3a95c3..39804b0 100644 --- a/dropbox_sign/models/account_verify_request.py +++ b/dropbox_sign/models/account_verify_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class AccountVerifyRequest(BaseModel): diff --git a/dropbox_sign/models/account_verify_response.py b/dropbox_sign/models/account_verify_response.py index c5f1960..3b0ee8d 100644 --- a/dropbox_sign/models/account_verify_response.py +++ b/dropbox_sign/models/account_verify_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -24,11 +24,11 @@ AccountVerifyResponseAccount, ) from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class AccountVerifyResponse(BaseModel): diff --git a/dropbox_sign/models/account_verify_response_account.py b/dropbox_sign/models/account_verify_response_account.py index 3724cd0..98f5fb3 100644 --- a/dropbox_sign/models/account_verify_response_account.py +++ b/dropbox_sign/models/account_verify_response_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class AccountVerifyResponseAccount(BaseModel): diff --git a/dropbox_sign/models/api_app_create_request.py b/dropbox_sign/models/api_app_create_request.py index 4f7181b..2e8e6a7 100644 --- a/dropbox_sign/models/api_app_create_request.py +++ b/dropbox_sign/models/api_app_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -19,16 +19,16 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBytes, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_o_auth import SubOAuth from dropbox_sign.models.sub_options import SubOptions from dropbox_sign.models.sub_white_labeling_options import SubWhiteLabelingOptions -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ApiAppCreateRequest(BaseModel): @@ -44,7 +44,9 @@ class ApiAppCreateRequest(BaseModel): default=None, description="The URL at which the ApiApp should receive event callbacks.", ) - custom_logo_file: Optional[Union[StrictBytes, StrictStr, io.IOBase]] = Field( + custom_logo_file: Optional[ + 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)", ) diff --git a/dropbox_sign/models/api_app_get_response.py b/dropbox_sign/models/api_app_get_response.py index 5c03394..4337be1 100644 --- a/dropbox_sign/models/api_app_get_response.py +++ b/dropbox_sign/models/api_app_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.api_app_response import ApiAppResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ApiAppGetResponse(BaseModel): diff --git a/dropbox_sign/models/api_app_list_response.py b/dropbox_sign/models/api_app_list_response.py index 748cc93..98a950e 100644 --- a/dropbox_sign/models/api_app_list_response.py +++ b/dropbox_sign/models/api_app_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.api_app_response import ApiAppResponse from dropbox_sign.models.list_info_response import ListInfoResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ApiAppListResponse(BaseModel): diff --git a/dropbox_sign/models/api_app_response.py b/dropbox_sign/models/api_app_response.py index a1f0bf1..ad4e872 100644 --- a/dropbox_sign/models/api_app_response.py +++ b/dropbox_sign/models/api_app_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -28,11 +28,11 @@ from dropbox_sign.models.api_app_response_white_labeling_options import ( ApiAppResponseWhiteLabelingOptions, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ApiAppResponse(BaseModel): diff --git a/dropbox_sign/models/api_app_response_o_auth.py b/dropbox_sign/models/api_app_response_o_auth.py index 981f94d..b078c1a 100644 --- a/dropbox_sign/models/api_app_response_o_auth.py +++ b/dropbox_sign/models/api_app_response_o_auth.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ApiAppResponseOAuth(BaseModel): diff --git a/dropbox_sign/models/api_app_response_options.py b/dropbox_sign/models/api_app_response_options.py index 751daf0..ec34ed9 100644 --- a/dropbox_sign/models/api_app_response_options.py +++ b/dropbox_sign/models/api_app_response_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ApiAppResponseOptions(BaseModel): diff --git a/dropbox_sign/models/api_app_response_owner_account.py b/dropbox_sign/models/api_app_response_owner_account.py index c1ed456..d579948 100644 --- a/dropbox_sign/models/api_app_response_owner_account.py +++ b/dropbox_sign/models/api_app_response_owner_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ApiAppResponseOwnerAccount(BaseModel): diff --git a/dropbox_sign/models/api_app_response_white_labeling_options.py b/dropbox_sign/models/api_app_response_white_labeling_options.py index 734022f..b574721 100644 --- a/dropbox_sign/models/api_app_response_white_labeling_options.py +++ b/dropbox_sign/models/api_app_response_white_labeling_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ApiAppResponseWhiteLabelingOptions(BaseModel): diff --git a/dropbox_sign/models/api_app_update_request.py b/dropbox_sign/models/api_app_update_request.py index e3f2a1a..7e1f872 100644 --- a/dropbox_sign/models/api_app_update_request.py +++ b/dropbox_sign/models/api_app_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -19,16 +19,16 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBytes, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_o_auth import SubOAuth from dropbox_sign.models.sub_options import SubOptions from dropbox_sign.models.sub_white_labeling_options import SubWhiteLabelingOptions -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ApiAppUpdateRequest(BaseModel): @@ -40,7 +40,9 @@ class ApiAppUpdateRequest(BaseModel): default=None, description="The URL at which the API App should receive event callbacks.", ) - custom_logo_file: Optional[Union[StrictBytes, StrictStr, io.IOBase]] = Field( + custom_logo_file: Optional[ + 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)", ) diff --git a/dropbox_sign/models/bulk_send_job_get_response.py b/dropbox_sign/models/bulk_send_job_get_response.py index 749ba54..9461ccf 100644 --- a/dropbox_sign/models/bulk_send_job_get_response.py +++ b/dropbox_sign/models/bulk_send_job_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -26,11 +26,11 @@ from dropbox_sign.models.bulk_send_job_response import BulkSendJobResponse from dropbox_sign.models.list_info_response import ListInfoResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class BulkSendJobGetResponse(BaseModel): 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 de4b9a2..704089b 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 @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -32,11 +32,11 @@ from dropbox_sign.models.signature_request_response_signatures import ( SignatureRequestResponseSignatures, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class BulkSendJobGetResponseSignatureRequests(BaseModel): diff --git a/dropbox_sign/models/bulk_send_job_list_response.py b/dropbox_sign/models/bulk_send_job_list_response.py index 91d471c..8f97918 100644 --- a/dropbox_sign/models/bulk_send_job_list_response.py +++ b/dropbox_sign/models/bulk_send_job_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.bulk_send_job_response import BulkSendJobResponse from dropbox_sign.models.list_info_response import ListInfoResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class BulkSendJobListResponse(BaseModel): diff --git a/dropbox_sign/models/bulk_send_job_response.py b/dropbox_sign/models/bulk_send_job_response.py index 0812cb8..8d6eeee 100644 --- a/dropbox_sign/models/bulk_send_job_response.py +++ b/dropbox_sign/models/bulk_send_job_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class BulkSendJobResponse(BaseModel): diff --git a/dropbox_sign/models/bulk_send_job_send_response.py b/dropbox_sign/models/bulk_send_job_send_response.py index e340ab8..a2eca97 100644 --- a/dropbox_sign/models/bulk_send_job_send_response.py +++ b/dropbox_sign/models/bulk_send_job_send_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.bulk_send_job_response import BulkSendJobResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class BulkSendJobSendResponse(BaseModel): diff --git a/dropbox_sign/models/embedded_edit_url_request.py b/dropbox_sign/models/embedded_edit_url_request.py index 525dfa8..849ebf4 100644 --- a/dropbox_sign/models/embedded_edit_url_request.py +++ b/dropbox_sign/models/embedded_edit_url_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.sub_editor_options import SubEditorOptions from dropbox_sign.models.sub_merge_field import SubMergeField -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class EmbeddedEditUrlRequest(BaseModel): diff --git a/dropbox_sign/models/embedded_edit_url_response.py b/dropbox_sign/models/embedded_edit_url_response.py index 6c8ecc3..653ca7c 100644 --- a/dropbox_sign/models/embedded_edit_url_response.py +++ b/dropbox_sign/models/embedded_edit_url_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -24,11 +24,11 @@ EmbeddedEditUrlResponseEmbedded, ) from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class EmbeddedEditUrlResponse(BaseModel): diff --git a/dropbox_sign/models/embedded_edit_url_response_embedded.py b/dropbox_sign/models/embedded_edit_url_response_embedded.py index 3dfe4d2..67413cb 100644 --- a/dropbox_sign/models/embedded_edit_url_response_embedded.py +++ b/dropbox_sign/models/embedded_edit_url_response_embedded.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class EmbeddedEditUrlResponseEmbedded(BaseModel): diff --git a/dropbox_sign/models/embedded_sign_url_response.py b/dropbox_sign/models/embedded_sign_url_response.py index ca92cdc..f0e03a1 100644 --- a/dropbox_sign/models/embedded_sign_url_response.py +++ b/dropbox_sign/models/embedded_sign_url_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -24,11 +24,11 @@ EmbeddedSignUrlResponseEmbedded, ) from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class EmbeddedSignUrlResponse(BaseModel): diff --git a/dropbox_sign/models/embedded_sign_url_response_embedded.py b/dropbox_sign/models/embedded_sign_url_response_embedded.py index 6de5a5b..dc71457 100644 --- a/dropbox_sign/models/embedded_sign_url_response_embedded.py +++ b/dropbox_sign/models/embedded_sign_url_response_embedded.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class EmbeddedSignUrlResponseEmbedded(BaseModel): diff --git a/dropbox_sign/models/error_response.py b/dropbox_sign/models/error_response.py index f85c247..98c6e5a 100644 --- a/dropbox_sign/models/error_response.py +++ b/dropbox_sign/models/error_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict from typing import Any, ClassVar, Dict, List from dropbox_sign.models.error_response_error import ErrorResponseError -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ErrorResponse(BaseModel): diff --git a/dropbox_sign/models/error_response_error.py b/dropbox_sign/models/error_response_error.py index 6577b27..6991a0a 100644 --- a/dropbox_sign/models/error_response_error.py +++ b/dropbox_sign/models/error_response_error.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ErrorResponseError(BaseModel): diff --git a/dropbox_sign/models/event_callback_request.py b/dropbox_sign/models/event_callback_request.py index 7689837..f8ac847 100644 --- a/dropbox_sign/models/event_callback_request.py +++ b/dropbox_sign/models/event_callback_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -24,11 +24,11 @@ from dropbox_sign.models.event_callback_request_event import EventCallbackRequestEvent from dropbox_sign.models.signature_request_response import SignatureRequestResponse from dropbox_sign.models.template_response import TemplateResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class EventCallbackRequest(BaseModel): diff --git a/dropbox_sign/models/event_callback_request_event.py b/dropbox_sign/models/event_callback_request_event.py index 971fff9..7f263da 100644 --- a/dropbox_sign/models/event_callback_request_event.py +++ b/dropbox_sign/models/event_callback_request_event.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.event_callback_request_event_metadata import ( EventCallbackRequestEventMetadata, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class EventCallbackRequestEvent(BaseModel): diff --git a/dropbox_sign/models/event_callback_request_event_metadata.py b/dropbox_sign/models/event_callback_request_event_metadata.py index 572abb5..fee5309 100644 --- a/dropbox_sign/models/event_callback_request_event_metadata.py +++ b/dropbox_sign/models/event_callback_request_event_metadata.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class EventCallbackRequestEventMetadata(BaseModel): diff --git a/dropbox_sign/models/fax_get_response.py b/dropbox_sign/models/fax_get_response.py index 8c2b224..25bf9d2 100644 --- a/dropbox_sign/models/fax_get_response.py +++ b/dropbox_sign/models/fax_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.fax_response import FaxResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxGetResponse(BaseModel): diff --git a/dropbox_sign/models/fax_line_add_user_request.py b/dropbox_sign/models/fax_line_add_user_request.py index aaa2b47..7a7a92b 100644 --- a/dropbox_sign/models/fax_line_add_user_request.py +++ b/dropbox_sign/models/fax_line_add_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxLineAddUserRequest(BaseModel): @@ -32,7 +32,7 @@ class FaxLineAddUserRequest(BaseModel): FaxLineAddUserRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") + number: StrictStr = Field(description="The Fax Line number") account_id: Optional[StrictStr] = Field(default=None, description="Account ID") email_address: Optional[StrictStr] = Field( default=None, description="Email address" diff --git a/dropbox_sign/models/fax_line_area_code_get_country_enum.py b/dropbox_sign/models/fax_line_area_code_get_country_enum.py index 62b87eb..94df885 100644 --- a/dropbox_sign/models/fax_line_area_code_get_country_enum.py +++ b/dropbox_sign/models/fax_line_area_code_get_country_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/dropbox_sign/models/fax_line_area_code_get_province_enum.py b/dropbox_sign/models/fax_line_area_code_get_province_enum.py index cbe1eea..e7994f3 100644 --- a/dropbox_sign/models/fax_line_area_code_get_province_enum.py +++ b/dropbox_sign/models/fax_line_area_code_get_province_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/dropbox_sign/models/fax_line_area_code_get_response.py b/dropbox_sign/models/fax_line_area_code_get_response.py index ac8722d..4d41c9b 100644 --- a/dropbox_sign/models/fax_line_area_code_get_response.py +++ b/dropbox_sign/models/fax_line_area_code_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, StrictInt from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxLineAreaCodeGetResponse(BaseModel): diff --git a/dropbox_sign/models/fax_line_area_code_get_state_enum.py b/dropbox_sign/models/fax_line_area_code_get_state_enum.py index 51f9da0..8cfe5ad 100644 --- a/dropbox_sign/models/fax_line_area_code_get_state_enum.py +++ b/dropbox_sign/models/fax_line_area_code_get_state_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/dropbox_sign/models/fax_line_create_request.py b/dropbox_sign/models/fax_line_create_request.py index 42e16de..7a8d88c 100644 --- a/dropbox_sign/models/fax_line_create_request.py +++ b/dropbox_sign/models/fax_line_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxLineCreateRequest(BaseModel): @@ -32,10 +32,13 @@ class FaxLineCreateRequest(BaseModel): FaxLineCreateRequest """ # noqa: E501 - area_code: StrictInt = Field(description="Area code") - country: StrictStr = Field(description="Country") - city: Optional[StrictStr] = Field(default=None, description="City") - account_id: Optional[StrictStr] = Field(default=None, description="Account ID") + area_code: StrictInt = Field(description="Area code of the new Fax Line") + country: StrictStr = Field(description="Country of the area code") + city: Optional[StrictStr] = Field(default=None, description="City of the area code") + account_id: Optional[StrictStr] = Field( + default=None, + description="Account ID of the account that will be assigned this new Fax Line", + ) __properties: ClassVar[List[str]] = ["area_code", "country", "city", "account_id"] @field_validator("country") diff --git a/dropbox_sign/models/fax_line_delete_request.py b/dropbox_sign/models/fax_line_delete_request.py index 7f5ebe5..9e96609 100644 --- a/dropbox_sign/models/fax_line_delete_request.py +++ b/dropbox_sign/models/fax_line_delete_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxLineDeleteRequest(BaseModel): @@ -32,7 +32,7 @@ class FaxLineDeleteRequest(BaseModel): FaxLineDeleteRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") + number: StrictStr = Field(description="The Fax Line number") __properties: ClassVar[List[str]] = ["number"] model_config = ConfigDict( diff --git a/dropbox_sign/models/fax_line_list_response.py b/dropbox_sign/models/fax_line_list_response.py index 099c3cc..07581a3 100644 --- a/dropbox_sign/models/fax_line_list_response.py +++ b/dropbox_sign/models/fax_line_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.fax_line_response_fax_line import FaxLineResponseFaxLine from dropbox_sign.models.list_info_response import ListInfoResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxLineListResponse(BaseModel): diff --git a/dropbox_sign/models/fax_line_remove_user_request.py b/dropbox_sign/models/fax_line_remove_user_request.py index e36be30..6021a0c 100644 --- a/dropbox_sign/models/fax_line_remove_user_request.py +++ b/dropbox_sign/models/fax_line_remove_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxLineRemoveUserRequest(BaseModel): @@ -32,10 +32,12 @@ class FaxLineRemoveUserRequest(BaseModel): FaxLineRemoveUserRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") - account_id: Optional[StrictStr] = Field(default=None, description="Account ID") + number: StrictStr = Field(description="The Fax Line number") + account_id: Optional[StrictStr] = Field( + default=None, description="Account ID of the user to remove access" + ) email_address: Optional[StrictStr] = Field( - default=None, description="Email address" + default=None, description="Email address of the user to remove access" ) __properties: ClassVar[List[str]] = ["number", "account_id", "email_address"] diff --git a/dropbox_sign/models/fax_line_response.py b/dropbox_sign/models/fax_line_response.py index a719bc9..bb733f4 100644 --- a/dropbox_sign/models/fax_line_response.py +++ b/dropbox_sign/models/fax_line_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.fax_line_response_fax_line import FaxLineResponseFaxLine from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxLineResponse(BaseModel): diff --git a/dropbox_sign/models/fax_line_response_fax_line.py b/dropbox_sign/models/fax_line_response_fax_line.py index 7d89f44..8a0676c 100644 --- a/dropbox_sign/models/fax_line_response_fax_line.py +++ b/dropbox_sign/models/fax_line_response_fax_line.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.account_response import AccountResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxLineResponseFaxLine(BaseModel): diff --git a/dropbox_sign/models/fax_list_response.py b/dropbox_sign/models/fax_list_response.py index b62b406..99140e3 100644 --- a/dropbox_sign/models/fax_list_response.py +++ b/dropbox_sign/models/fax_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List from dropbox_sign.models.fax_response import FaxResponse from dropbox_sign.models.list_info_response import ListInfoResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxListResponse(BaseModel): diff --git a/dropbox_sign/models/fax_response.py b/dropbox_sign/models/fax_response.py index 976606e..1648df8 100644 --- a/dropbox_sign/models/fax_response.py +++ b/dropbox_sign/models/fax_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr 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 import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxResponse(BaseModel): diff --git a/dropbox_sign/models/fax_response_transmission.py b/dropbox_sign/models/fax_response_transmission.py index 28cf397..66c613d 100644 --- a/dropbox_sign/models/fax_response_transmission.py +++ b/dropbox_sign/models/fax_response_transmission.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxResponseTransmission(BaseModel): diff --git a/dropbox_sign/models/fax_send_request.py b/dropbox_sign/models/fax_send_request.py index 9fe6c54..c4f0af8 100644 --- a/dropbox_sign/models/fax_send_request.py +++ b/dropbox_sign/models/fax_send_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -19,12 +19,12 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union -from typing import Optional, Set, Tuple +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FaxSendRequest(BaseModel): @@ -32,24 +32,30 @@ class FaxSendRequest(BaseModel): FaxSendRequest """ # noqa: E501 - recipient: StrictStr = Field(description="Fax Send To Recipient") + recipient: StrictStr = Field( + description="Recipient of the fax Can be a phone number in E.164 format or email address" + ) sender: Optional[StrictStr] = Field( default=None, description="Fax Send From Sender (used only with fax number)" ) - files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( - default=None, description="Fax File to Send" + files: Optional[ + 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.", ) file_urls: Optional[List[StrictStr]] = Field( - default=None, description="Fax File URL to Send" + default=None, + description="Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.", ) test_mode: Optional[StrictBool] = Field( default=False, description="API Test Mode Setting" ) cover_page_to: Optional[StrictStr] = Field( - default=None, description="Fax Cover Page for Recipient" + default=None, description="Fax cover page recipient information" ) cover_page_from: Optional[StrictStr] = Field( - default=None, description="Fax Cover Page for Sender" + default=None, description="Fax cover page sender information" ) cover_page_message: Optional[StrictStr] = Field( default=None, description="Fax Cover Page Message" diff --git a/dropbox_sign/models/file_response.py b/dropbox_sign/models/file_response.py index e0479e3..434a4f1 100644 --- a/dropbox_sign/models/file_response.py +++ b/dropbox_sign/models/file_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FileResponse(BaseModel): diff --git a/dropbox_sign/models/file_response_data_uri.py b/dropbox_sign/models/file_response_data_uri.py index c7c2e40..da1384d 100644 --- a/dropbox_sign/models/file_response_data_uri.py +++ b/dropbox_sign/models/file_response_data_uri.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class FileResponseDataUri(BaseModel): diff --git a/dropbox_sign/models/list_info_response.py b/dropbox_sign/models/list_info_response.py index b516272..cdca4fa 100644 --- a/dropbox_sign/models/list_info_response.py +++ b/dropbox_sign/models/list_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ListInfoResponse(BaseModel): diff --git a/dropbox_sign/models/o_auth_token_generate_request.py b/dropbox_sign/models/o_auth_token_generate_request.py index ff2aefb..06359f4 100644 --- a/dropbox_sign/models/o_auth_token_generate_request.py +++ b/dropbox_sign/models/o_auth_token_generate_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class OAuthTokenGenerateRequest(BaseModel): diff --git a/dropbox_sign/models/o_auth_token_refresh_request.py b/dropbox_sign/models/o_auth_token_refresh_request.py index 5730363..025a581 100644 --- a/dropbox_sign/models/o_auth_token_refresh_request.py +++ b/dropbox_sign/models/o_auth_token_refresh_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class OAuthTokenRefreshRequest(BaseModel): diff --git a/dropbox_sign/models/o_auth_token_response.py b/dropbox_sign/models/o_auth_token_response.py index e42732a..4b91161 100644 --- a/dropbox_sign/models/o_auth_token_response.py +++ b/dropbox_sign/models/o_auth_token_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class OAuthTokenResponse(BaseModel): diff --git a/dropbox_sign/models/report_create_request.py b/dropbox_sign/models/report_create_request.py index 4bed0f9..bdee210 100644 --- a/dropbox_sign/models/report_create_request.py +++ b/dropbox_sign/models/report_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List from typing_extensions import Annotated -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ReportCreateRequest(BaseModel): diff --git a/dropbox_sign/models/report_create_response.py b/dropbox_sign/models/report_create_response.py index 6fc7ec8..3d781b9 100644 --- a/dropbox_sign/models/report_create_response.py +++ b/dropbox_sign/models/report_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.report_response import ReportResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ReportCreateResponse(BaseModel): diff --git a/dropbox_sign/models/report_response.py b/dropbox_sign/models/report_response.py index 2ed765c..f1fbe51 100644 --- a/dropbox_sign/models/report_response.py +++ b/dropbox_sign/models/report_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class ReportResponse(BaseModel): diff --git a/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py b/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py index a3250eb..54fd997 100644 --- a/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py +++ b/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -19,16 +19,16 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_bulk_signer_list import SubBulkSignerList from dropbox_sign.models.sub_cc import SubCC from dropbox_sign.models.sub_custom_field import SubCustomField -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestBulkCreateEmbeddedWithTemplateRequest(BaseModel): @@ -42,7 +42,9 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest(BaseModel): client_id: StrictStr = Field( 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]] = Field( + signer_file: Optional[ + 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 ```", ) diff --git a/dropbox_sign/models/signature_request_bulk_send_with_template_request.py b/dropbox_sign/models/signature_request_bulk_send_with_template_request.py index 6c12257..54cb980 100644 --- a/dropbox_sign/models/signature_request_bulk_send_with_template_request.py +++ b/dropbox_sign/models/signature_request_bulk_send_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -19,16 +19,16 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_bulk_signer_list import SubBulkSignerList from dropbox_sign.models.sub_cc import SubCC from dropbox_sign.models.sub_custom_field import SubCustomField -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestBulkSendWithTemplateRequest(BaseModel): @@ -39,7 +39,9 @@ class SignatureRequestBulkSendWithTemplateRequest(BaseModel): template_ids: List[StrictStr] = Field( 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]] = Field( + signer_file: Optional[ + 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 ```", ) diff --git a/dropbox_sign/models/signature_request_create_embedded_request.py b/dropbox_sign/models/signature_request_create_embedded_request.py index 8912b45..72ef4be 100644 --- a/dropbox_sign/models/signature_request_create_embedded_request.py +++ b/dropbox_sign/models/signature_request_create_embedded_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -27,7 +27,7 @@ StrictInt, StrictStr, ) -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_attachment import SubAttachment from dropbox_sign.models.sub_custom_field import SubCustomField @@ -42,11 +42,11 @@ ) from dropbox_sign.models.sub_signature_request_signer import SubSignatureRequestSigner from dropbox_sign.models.sub_signing_options import SubSigningOptions -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestCreateEmbeddedRequest(BaseModel): @@ -57,7 +57,9 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel): client_id: StrictStr = Field( 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]]] = Field( + files: Optional[ + 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.", ) diff --git a/dropbox_sign/models/signature_request_create_embedded_with_template_request.py b/dropbox_sign/models/signature_request_create_embedded_with_template_request.py index 2c7d080..07c2d0c 100644 --- a/dropbox_sign/models/signature_request_create_embedded_with_template_request.py +++ b/dropbox_sign/models/signature_request_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_cc import SubCC from dropbox_sign.models.sub_custom_field import SubCustomField @@ -27,11 +27,11 @@ SubSignatureRequestTemplateSigner, ) from dropbox_sign.models.sub_signing_options import SubSigningOptions -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestCreateEmbeddedWithTemplateRequest(BaseModel): @@ -60,7 +60,9 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest(BaseModel): default=None, description="An array defining values and options for custom fields. Required when a custom field exists in the Template.", ) - files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + files: Optional[ + 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.", ) diff --git a/dropbox_sign/models/signature_request_edit_embedded_request.py b/dropbox_sign/models/signature_request_edit_embedded_request.py new file mode 100644 index 0000000..6e952ad --- /dev/null +++ b/dropbox_sign/models/signature_request_edit_embedded_request.py @@ -0,0 +1,444 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import ( + BaseModel, + ConfigDict, + Field, + StrictBool, + StrictBytes, + StrictInt, + StrictStr, +) +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated +from dropbox_sign.models.sub_attachment import SubAttachment +from dropbox_sign.models.sub_custom_field import SubCustomField +from dropbox_sign.models.sub_field_options import SubFieldOptions +from dropbox_sign.models.sub_form_field_group import SubFormFieldGroup +from dropbox_sign.models.sub_form_field_rule import SubFormFieldRule +from dropbox_sign.models.sub_form_fields_per_document_base import ( + SubFormFieldsPerDocumentBase, +) +from dropbox_sign.models.sub_signature_request_grouped_signers import ( + SubSignatureRequestGroupedSigners, +) +from dropbox_sign.models.sub_signature_request_signer import SubSignatureRequestSigner +from dropbox_sign.models.sub_signing_options import SubSigningOptions +from typing import Optional, Set +from typing_extensions import Self +from typing import Tuple, Union +import io +from pydantic import StrictBool + + +class SignatureRequestEditEmbeddedRequest(BaseModel): + """ + SignatureRequestEditEmbeddedRequest + """ # noqa: E501 + + client_id: StrictStr = Field( + 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]]] + ] = 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.", + ) + file_urls: Optional[List[StrictStr]] = Field( + default=None, + description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + signers: Optional[List[SubSignatureRequestSigner]] = Field( + default=None, + description="Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + ) + grouped_signers: Optional[List[SubSignatureRequestGroupedSigners]] = Field( + default=None, + description="Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + ) + allow_decline: Optional[StrictBool] = Field( + default=False, + description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", + ) + allow_reassign: Optional[StrictBool] = Field( + default=False, + description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan.", + ) + attachments: Optional[List[SubAttachment]] = Field( + default=None, description="A list describing the attachments" + ) + cc_email_addresses: Optional[List[StrictStr]] = Field( + default=None, description="The email addresses that should be CCed." + ) + custom_fields: Optional[List[SubCustomField]] = Field( + default=None, + description='When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.', + ) + field_options: Optional[SubFieldOptions] = None + form_field_groups: Optional[List[SubFormFieldGroup]] = Field( + default=None, + description="Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.", + ) + form_field_rules: Optional[List[SubFormFieldRule]] = Field( + default=None, + description="Conditional Logic rules for fields defined in `form_fields_per_document`.", + ) + form_fields_per_document: Optional[List[SubFormFieldsPerDocumentBase]] = Field( + default=None, + description="The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`", + ) + hide_text_tags: Optional[StrictBool] = Field( + default=False, + description="Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.", + ) + message: Optional[Annotated[str, Field(strict=True, max_length=5000)]] = Field( + default=None, + description="The custom message in the email that will be sent to the signers.", + ) + metadata: Optional[Dict[str, Any]] = Field( + default=None, + description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + ) + signing_options: Optional[SubSigningOptions] = None + subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The subject in the email that will be sent to the signers.", + ) + test_mode: Optional[StrictBool] = Field( + default=False, + description="Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.", + ) + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The title you want to assign to the SignatureRequest.", + ) + use_text_tags: Optional[StrictBool] = Field( + default=False, + description="Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.", + ) + populate_auto_fill_fields: Optional[StrictBool] = Field( + default=False, + description="Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.", + ) + expires_at: Optional[StrictInt] = Field( + default=None, + description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", + ) + __properties: ClassVar[List[str]] = [ + "client_id", + "files", + "file_urls", + "signers", + "grouped_signers", + "allow_decline", + "allow_reassign", + "attachments", + "cc_email_addresses", + "custom_fields", + "field_options", + "form_field_groups", + "form_field_rules", + "form_fields_per_document", + "hide_text_tags", + "message", + "metadata", + "signing_options", + "subject", + "test_mode", + "title", + "use_text_tags", + "populate_auto_fill_fields", + "expires_at", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SignatureRequestEditEmbeddedRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in signers (list) + _items = [] + if self.signers: + for _item_signers in self.signers: + if _item_signers: + _items.append(_item_signers.to_dict()) + _dict["signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in grouped_signers (list) + _items = [] + if self.grouped_signers: + for _item_grouped_signers in self.grouped_signers: + if _item_grouped_signers: + _items.append(_item_grouped_signers.to_dict()) + _dict["grouped_signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in attachments (list) + _items = [] + if self.attachments: + for _item_attachments in self.attachments: + if _item_attachments: + _items.append(_item_attachments.to_dict()) + _dict["attachments"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) + _items = [] + if self.custom_fields: + for _item_custom_fields in self.custom_fields: + if _item_custom_fields: + _items.append(_item_custom_fields.to_dict()) + _dict["custom_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of field_options + if self.field_options: + _dict["field_options"] = self.field_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in form_field_groups (list) + _items = [] + if self.form_field_groups: + for _item_form_field_groups in self.form_field_groups: + if _item_form_field_groups: + _items.append(_item_form_field_groups.to_dict()) + _dict["form_field_groups"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in form_field_rules (list) + _items = [] + if self.form_field_rules: + for _item_form_field_rules in self.form_field_rules: + if _item_form_field_rules: + _items.append(_item_form_field_rules.to_dict()) + _dict["form_field_rules"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in form_fields_per_document (list) + _items = [] + if self.form_fields_per_document: + for _item_form_fields_per_document in self.form_fields_per_document: + if _item_form_fields_per_document: + _items.append(_item_form_fields_per_document.to_dict()) + _dict["form_fields_per_document"] = _items + # override the default output from pydantic by calling `to_dict()` of signing_options + if self.signing_options: + _dict["signing_options"] = self.signing_options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SignatureRequestEditEmbeddedRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "client_id": obj.get("client_id"), + "files": obj.get("files"), + "file_urls": obj.get("file_urls"), + "signers": ( + [ + SubSignatureRequestSigner.from_dict(_item) + for _item in obj["signers"] + ] + if obj.get("signers") is not None + else None + ), + "grouped_signers": ( + [ + SubSignatureRequestGroupedSigners.from_dict(_item) + for _item in obj["grouped_signers"] + ] + if obj.get("grouped_signers") is not None + else None + ), + "allow_decline": ( + obj.get("allow_decline") + if obj.get("allow_decline") is not None + else False + ), + "allow_reassign": ( + obj.get("allow_reassign") + if obj.get("allow_reassign") is not None + else False + ), + "attachments": ( + [SubAttachment.from_dict(_item) for _item in obj["attachments"]] + if obj.get("attachments") is not None + else None + ), + "cc_email_addresses": obj.get("cc_email_addresses"), + "custom_fields": ( + [SubCustomField.from_dict(_item) for _item in obj["custom_fields"]] + if obj.get("custom_fields") is not None + else None + ), + "field_options": ( + SubFieldOptions.from_dict(obj["field_options"]) + if obj.get("field_options") is not None + else None + ), + "form_field_groups": ( + [ + SubFormFieldGroup.from_dict(_item) + for _item in obj["form_field_groups"] + ] + if obj.get("form_field_groups") is not None + else None + ), + "form_field_rules": ( + [ + SubFormFieldRule.from_dict(_item) + for _item in obj["form_field_rules"] + ] + if obj.get("form_field_rules") is not None + else None + ), + "form_fields_per_document": ( + [ + SubFormFieldsPerDocumentBase.from_dict(_item) + for _item in obj["form_fields_per_document"] + ] + if obj.get("form_fields_per_document") is not None + else None + ), + "hide_text_tags": ( + obj.get("hide_text_tags") + if obj.get("hide_text_tags") is not None + else False + ), + "message": obj.get("message"), + "metadata": obj.get("metadata"), + "signing_options": ( + SubSigningOptions.from_dict(obj["signing_options"]) + if obj.get("signing_options") is not None + else None + ), + "subject": obj.get("subject"), + "test_mode": ( + obj.get("test_mode") if obj.get("test_mode") is not None else False + ), + "title": obj.get("title"), + "use_text_tags": ( + obj.get("use_text_tags") + if obj.get("use_text_tags") is not None + else False + ), + "populate_auto_fill_fields": ( + obj.get("populate_auto_fill_fields") + if obj.get("populate_auto_fill_fields") is not None + else False + ), + "expires_at": obj.get("expires_at"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "client_id": "(str,)", + "files": "(List[io.IOBase],)", + "file_urls": "(List[str],)", + "signers": "(List[SubSignatureRequestSigner],)", + "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", + "allow_decline": "(bool,)", + "allow_reassign": "(bool,)", + "attachments": "(List[SubAttachment],)", + "cc_email_addresses": "(List[str],)", + "custom_fields": "(List[SubCustomField],)", + "field_options": "(SubFieldOptions,)", + "form_field_groups": "(List[SubFormFieldGroup],)", + "form_field_rules": "(List[SubFormFieldRule],)", + "form_fields_per_document": "(List[SubFormFieldsPerDocumentBase],)", + "hide_text_tags": "(bool,)", + "message": "(str,)", + "metadata": "(Dict[str, object],)", + "signing_options": "(SubSigningOptions,)", + "subject": "(str,)", + "test_mode": "(bool,)", + "title": "(str,)", + "use_text_tags": "(bool,)", + "populate_auto_fill_fields": "(bool,)", + "expires_at": "(int,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "files", + "file_urls", + "signers", + "grouped_signers", + "attachments", + "cc_email_addresses", + "custom_fields", + "form_field_groups", + "form_field_rules", + "form_fields_per_document", + ] diff --git a/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py b/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py new file mode 100644 index 0000000..0061169 --- /dev/null +++ b/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py @@ -0,0 +1,290 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated +from dropbox_sign.models.sub_cc import SubCC +from dropbox_sign.models.sub_custom_field import SubCustomField +from dropbox_sign.models.sub_signature_request_template_signer import ( + SubSignatureRequestTemplateSigner, +) +from dropbox_sign.models.sub_signing_options import SubSigningOptions +from typing import Optional, Set +from typing_extensions import Self +from typing import Tuple, Union +import io +from pydantic import StrictBool + + +class SignatureRequestEditEmbeddedWithTemplateRequest(BaseModel): + """ + SignatureRequestEditEmbeddedWithTemplateRequest + """ # noqa: E501 + + template_ids: List[StrictStr] = Field( + description="Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used." + ) + client_id: StrictStr = Field( + description="Client id of the app you're using to create this embedded signature request. Used for security purposes." + ) + signers: List[SubSignatureRequestTemplateSigner] = Field( + description="Add Signers to your Templated-based Signature Request." + ) + allow_decline: Optional[StrictBool] = Field( + default=False, + description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", + ) + ccs: Optional[List[SubCC]] = Field( + default=None, + description="Add CC email recipients. Required when a CC role exists for the Template.", + ) + custom_fields: Optional[List[SubCustomField]] = Field( + default=None, + description="An array defining values and options for custom fields. Required when a custom field exists in the Template.", + ) + files: Optional[ + 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.", + ) + file_urls: Optional[List[StrictStr]] = Field( + default=None, + description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + message: Optional[Annotated[str, Field(strict=True, max_length=5000)]] = Field( + default=None, + description="The custom message in the email that will be sent to the signers.", + ) + metadata: Optional[Dict[str, Any]] = Field( + default=None, + description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + ) + signing_options: Optional[SubSigningOptions] = None + subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The subject in the email that will be sent to the signers.", + ) + test_mode: Optional[StrictBool] = Field( + default=False, + description="Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.", + ) + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The title you want to assign to the SignatureRequest.", + ) + populate_auto_fill_fields: Optional[StrictBool] = Field( + default=False, + description="Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.", + ) + __properties: ClassVar[List[str]] = [ + "template_ids", + "client_id", + "signers", + "allow_decline", + "ccs", + "custom_fields", + "files", + "file_urls", + "message", + "metadata", + "signing_options", + "subject", + "test_mode", + "title", + "populate_auto_fill_fields", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SignatureRequestEditEmbeddedWithTemplateRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in signers (list) + _items = [] + if self.signers: + for _item_signers in self.signers: + if _item_signers: + _items.append(_item_signers.to_dict()) + _dict["signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in ccs (list) + _items = [] + if self.ccs: + for _item_ccs in self.ccs: + if _item_ccs: + _items.append(_item_ccs.to_dict()) + _dict["ccs"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) + _items = [] + if self.custom_fields: + for _item_custom_fields in self.custom_fields: + if _item_custom_fields: + _items.append(_item_custom_fields.to_dict()) + _dict["custom_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of signing_options + if self.signing_options: + _dict["signing_options"] = self.signing_options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SignatureRequestEditEmbeddedWithTemplateRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "template_ids": obj.get("template_ids"), + "client_id": obj.get("client_id"), + "signers": ( + [ + SubSignatureRequestTemplateSigner.from_dict(_item) + for _item in obj["signers"] + ] + if obj.get("signers") is not None + else None + ), + "allow_decline": ( + obj.get("allow_decline") + if obj.get("allow_decline") is not None + else False + ), + "ccs": ( + [SubCC.from_dict(_item) for _item in obj["ccs"]] + if obj.get("ccs") is not None + else None + ), + "custom_fields": ( + [SubCustomField.from_dict(_item) for _item in obj["custom_fields"]] + if obj.get("custom_fields") is not None + else None + ), + "files": obj.get("files"), + "file_urls": obj.get("file_urls"), + "message": obj.get("message"), + "metadata": obj.get("metadata"), + "signing_options": ( + SubSigningOptions.from_dict(obj["signing_options"]) + if obj.get("signing_options") is not None + else None + ), + "subject": obj.get("subject"), + "test_mode": ( + obj.get("test_mode") if obj.get("test_mode") is not None else False + ), + "title": obj.get("title"), + "populate_auto_fill_fields": ( + obj.get("populate_auto_fill_fields") + if obj.get("populate_auto_fill_fields") is not None + else False + ), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "template_ids": "(List[str],)", + "client_id": "(str,)", + "signers": "(List[SubSignatureRequestTemplateSigner],)", + "allow_decline": "(bool,)", + "ccs": "(List[SubCC],)", + "custom_fields": "(List[SubCustomField],)", + "files": "(List[io.IOBase],)", + "file_urls": "(List[str],)", + "message": "(str,)", + "metadata": "(Dict[str, object],)", + "signing_options": "(SubSigningOptions,)", + "subject": "(str,)", + "test_mode": "(bool,)", + "title": "(str,)", + "populate_auto_fill_fields": "(bool,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "template_ids", + "signers", + "ccs", + "custom_fields", + "files", + "file_urls", + ] diff --git a/dropbox_sign/models/signature_request_edit_request.py b/dropbox_sign/models/signature_request_edit_request.py new file mode 100644 index 0000000..4bd18cf --- /dev/null +++ b/dropbox_sign/models/signature_request_edit_request.py @@ -0,0 +1,448 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import ( + BaseModel, + ConfigDict, + Field, + StrictBool, + StrictBytes, + StrictInt, + StrictStr, +) +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated +from dropbox_sign.models.sub_attachment import SubAttachment +from dropbox_sign.models.sub_custom_field import SubCustomField +from dropbox_sign.models.sub_field_options import SubFieldOptions +from dropbox_sign.models.sub_form_field_group import SubFormFieldGroup +from dropbox_sign.models.sub_form_field_rule import SubFormFieldRule +from dropbox_sign.models.sub_form_fields_per_document_base import ( + SubFormFieldsPerDocumentBase, +) +from dropbox_sign.models.sub_signature_request_grouped_signers import ( + SubSignatureRequestGroupedSigners, +) +from dropbox_sign.models.sub_signature_request_signer import SubSignatureRequestSigner +from dropbox_sign.models.sub_signing_options import SubSigningOptions +from typing import Optional, Set +from typing_extensions import Self +from typing import Tuple, Union +import io +from pydantic import StrictBool + + +class SignatureRequestEditRequest(BaseModel): + """ + SignatureRequestEditRequest + """ # noqa: E501 + + files: Optional[ + 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.", + ) + file_urls: Optional[List[StrictStr]] = Field( + default=None, + description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + signers: Optional[List[SubSignatureRequestSigner]] = Field( + default=None, + description="Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + ) + grouped_signers: Optional[List[SubSignatureRequestGroupedSigners]] = Field( + default=None, + description="Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + ) + allow_decline: Optional[StrictBool] = Field( + default=False, + description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", + ) + allow_reassign: Optional[StrictBool] = Field( + default=False, + description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", + ) + attachments: Optional[List[SubAttachment]] = Field( + default=None, description="A list describing the attachments" + ) + cc_email_addresses: Optional[List[StrictStr]] = Field( + default=None, description="The email addresses that should be CCed." + ) + client_id: Optional[StrictStr] = Field( + default=None, + description="The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.", + ) + custom_fields: Optional[List[SubCustomField]] = Field( + default=None, + description='When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.', + ) + field_options: Optional[SubFieldOptions] = None + form_field_groups: Optional[List[SubFormFieldGroup]] = Field( + default=None, + description="Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.", + ) + form_field_rules: Optional[List[SubFormFieldRule]] = Field( + default=None, + description="Conditional Logic rules for fields defined in `form_fields_per_document`.", + ) + form_fields_per_document: Optional[List[SubFormFieldsPerDocumentBase]] = Field( + default=None, + description="The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`", + ) + hide_text_tags: Optional[StrictBool] = Field( + default=False, + description="Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.", + ) + is_eid: Optional[StrictBool] = Field( + default=False, + description="Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.", + ) + message: Optional[Annotated[str, Field(strict=True, max_length=5000)]] = Field( + default=None, + description="The custom message in the email that will be sent to the signers.", + ) + metadata: Optional[Dict[str, Any]] = Field( + default=None, + description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + ) + signing_options: Optional[SubSigningOptions] = None + signing_redirect_url: Optional[StrictStr] = Field( + default=None, + description="The URL you want signers redirected to after they successfully sign.", + ) + subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The subject in the email that will be sent to the signers.", + ) + test_mode: Optional[StrictBool] = Field( + default=False, + description="Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.", + ) + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The title you want to assign to the SignatureRequest.", + ) + use_text_tags: Optional[StrictBool] = Field( + default=False, + description="Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.", + ) + expires_at: Optional[StrictInt] = Field( + default=None, + description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", + ) + __properties: ClassVar[List[str]] = [ + "files", + "file_urls", + "signers", + "grouped_signers", + "allow_decline", + "allow_reassign", + "attachments", + "cc_email_addresses", + "client_id", + "custom_fields", + "field_options", + "form_field_groups", + "form_field_rules", + "form_fields_per_document", + "hide_text_tags", + "is_eid", + "message", + "metadata", + "signing_options", + "signing_redirect_url", + "subject", + "test_mode", + "title", + "use_text_tags", + "expires_at", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SignatureRequestEditRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in signers (list) + _items = [] + if self.signers: + for _item_signers in self.signers: + if _item_signers: + _items.append(_item_signers.to_dict()) + _dict["signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in grouped_signers (list) + _items = [] + if self.grouped_signers: + for _item_grouped_signers in self.grouped_signers: + if _item_grouped_signers: + _items.append(_item_grouped_signers.to_dict()) + _dict["grouped_signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in attachments (list) + _items = [] + if self.attachments: + for _item_attachments in self.attachments: + if _item_attachments: + _items.append(_item_attachments.to_dict()) + _dict["attachments"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) + _items = [] + if self.custom_fields: + for _item_custom_fields in self.custom_fields: + if _item_custom_fields: + _items.append(_item_custom_fields.to_dict()) + _dict["custom_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of field_options + if self.field_options: + _dict["field_options"] = self.field_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in form_field_groups (list) + _items = [] + if self.form_field_groups: + for _item_form_field_groups in self.form_field_groups: + if _item_form_field_groups: + _items.append(_item_form_field_groups.to_dict()) + _dict["form_field_groups"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in form_field_rules (list) + _items = [] + if self.form_field_rules: + for _item_form_field_rules in self.form_field_rules: + if _item_form_field_rules: + _items.append(_item_form_field_rules.to_dict()) + _dict["form_field_rules"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in form_fields_per_document (list) + _items = [] + if self.form_fields_per_document: + for _item_form_fields_per_document in self.form_fields_per_document: + if _item_form_fields_per_document: + _items.append(_item_form_fields_per_document.to_dict()) + _dict["form_fields_per_document"] = _items + # override the default output from pydantic by calling `to_dict()` of signing_options + if self.signing_options: + _dict["signing_options"] = self.signing_options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SignatureRequestEditRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "files": obj.get("files"), + "file_urls": obj.get("file_urls"), + "signers": ( + [ + SubSignatureRequestSigner.from_dict(_item) + for _item in obj["signers"] + ] + if obj.get("signers") is not None + else None + ), + "grouped_signers": ( + [ + SubSignatureRequestGroupedSigners.from_dict(_item) + for _item in obj["grouped_signers"] + ] + if obj.get("grouped_signers") is not None + else None + ), + "allow_decline": ( + obj.get("allow_decline") + if obj.get("allow_decline") is not None + else False + ), + "allow_reassign": ( + obj.get("allow_reassign") + if obj.get("allow_reassign") is not None + else False + ), + "attachments": ( + [SubAttachment.from_dict(_item) for _item in obj["attachments"]] + if obj.get("attachments") is not None + else None + ), + "cc_email_addresses": obj.get("cc_email_addresses"), + "client_id": obj.get("client_id"), + "custom_fields": ( + [SubCustomField.from_dict(_item) for _item in obj["custom_fields"]] + if obj.get("custom_fields") is not None + else None + ), + "field_options": ( + SubFieldOptions.from_dict(obj["field_options"]) + if obj.get("field_options") is not None + else None + ), + "form_field_groups": ( + [ + SubFormFieldGroup.from_dict(_item) + for _item in obj["form_field_groups"] + ] + if obj.get("form_field_groups") is not None + else None + ), + "form_field_rules": ( + [ + SubFormFieldRule.from_dict(_item) + for _item in obj["form_field_rules"] + ] + if obj.get("form_field_rules") is not None + else None + ), + "form_fields_per_document": ( + [ + SubFormFieldsPerDocumentBase.from_dict(_item) + for _item in obj["form_fields_per_document"] + ] + if obj.get("form_fields_per_document") is not None + else None + ), + "hide_text_tags": ( + obj.get("hide_text_tags") + if obj.get("hide_text_tags") is not None + else False + ), + "is_eid": obj.get("is_eid") if obj.get("is_eid") is not None else False, + "message": obj.get("message"), + "metadata": obj.get("metadata"), + "signing_options": ( + SubSigningOptions.from_dict(obj["signing_options"]) + if obj.get("signing_options") is not None + else None + ), + "signing_redirect_url": obj.get("signing_redirect_url"), + "subject": obj.get("subject"), + "test_mode": ( + obj.get("test_mode") if obj.get("test_mode") is not None else False + ), + "title": obj.get("title"), + "use_text_tags": ( + obj.get("use_text_tags") + if obj.get("use_text_tags") is not None + else False + ), + "expires_at": obj.get("expires_at"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "files": "(List[io.IOBase],)", + "file_urls": "(List[str],)", + "signers": "(List[SubSignatureRequestSigner],)", + "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", + "allow_decline": "(bool,)", + "allow_reassign": "(bool,)", + "attachments": "(List[SubAttachment],)", + "cc_email_addresses": "(List[str],)", + "client_id": "(str,)", + "custom_fields": "(List[SubCustomField],)", + "field_options": "(SubFieldOptions,)", + "form_field_groups": "(List[SubFormFieldGroup],)", + "form_field_rules": "(List[SubFormFieldRule],)", + "form_fields_per_document": "(List[SubFormFieldsPerDocumentBase],)", + "hide_text_tags": "(bool,)", + "is_eid": "(bool,)", + "message": "(str,)", + "metadata": "(Dict[str, object],)", + "signing_options": "(SubSigningOptions,)", + "signing_redirect_url": "(str,)", + "subject": "(str,)", + "test_mode": "(bool,)", + "title": "(str,)", + "use_text_tags": "(bool,)", + "expires_at": "(int,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "files", + "file_urls", + "signers", + "grouped_signers", + "attachments", + "cc_email_addresses", + "custom_fields", + "form_field_groups", + "form_field_rules", + "form_fields_per_document", + ] diff --git a/dropbox_sign/models/signature_request_edit_with_template_request.py b/dropbox_sign/models/signature_request_edit_with_template_request.py new file mode 100644 index 0000000..fedc9af --- /dev/null +++ b/dropbox_sign/models/signature_request_edit_with_template_request.py @@ -0,0 +1,292 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated +from dropbox_sign.models.sub_cc import SubCC +from dropbox_sign.models.sub_custom_field import SubCustomField +from dropbox_sign.models.sub_signature_request_template_signer import ( + SubSignatureRequestTemplateSigner, +) +from dropbox_sign.models.sub_signing_options import SubSigningOptions +from typing import Optional, Set +from typing_extensions import Self +from typing import Tuple, Union +import io +from pydantic import StrictBool + + +class SignatureRequestEditWithTemplateRequest(BaseModel): + """ """ # noqa: E501 + + template_ids: List[StrictStr] = Field( + description="Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used." + ) + signers: List[SubSignatureRequestTemplateSigner] = Field( + description="Add Signers to your Templated-based Signature Request." + ) + allow_decline: Optional[StrictBool] = Field( + default=False, + description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", + ) + ccs: Optional[List[SubCC]] = Field( + default=None, + description="Add CC email recipients. Required when a CC role exists for the Template.", + ) + client_id: Optional[StrictStr] = Field( + default=None, + description="Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.", + ) + custom_fields: Optional[List[SubCustomField]] = Field( + default=None, + description="An array defining values and options for custom fields. Required when a custom field exists in the Template.", + ) + files: Optional[ + 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.", + ) + file_urls: Optional[List[StrictStr]] = Field( + default=None, + description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + is_eid: Optional[StrictBool] = Field( + default=False, + description="Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.", + ) + message: Optional[Annotated[str, Field(strict=True, max_length=5000)]] = Field( + default=None, + description="The custom message in the email that will be sent to the signers.", + ) + metadata: Optional[Dict[str, Any]] = Field( + default=None, + description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + ) + signing_options: Optional[SubSigningOptions] = None + signing_redirect_url: Optional[StrictStr] = Field( + default=None, + description="The URL you want signers redirected to after they successfully sign.", + ) + subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The subject in the email that will be sent to the signers.", + ) + test_mode: Optional[StrictBool] = Field( + default=False, + description="Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.", + ) + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The title you want to assign to the SignatureRequest.", + ) + __properties: ClassVar[List[str]] = [ + "template_ids", + "signers", + "allow_decline", + "ccs", + "client_id", + "custom_fields", + "files", + "file_urls", + "is_eid", + "message", + "metadata", + "signing_options", + "signing_redirect_url", + "subject", + "test_mode", + "title", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SignatureRequestEditWithTemplateRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in signers (list) + _items = [] + if self.signers: + for _item_signers in self.signers: + if _item_signers: + _items.append(_item_signers.to_dict()) + _dict["signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in ccs (list) + _items = [] + if self.ccs: + for _item_ccs in self.ccs: + if _item_ccs: + _items.append(_item_ccs.to_dict()) + _dict["ccs"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) + _items = [] + if self.custom_fields: + for _item_custom_fields in self.custom_fields: + if _item_custom_fields: + _items.append(_item_custom_fields.to_dict()) + _dict["custom_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of signing_options + if self.signing_options: + _dict["signing_options"] = self.signing_options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SignatureRequestEditWithTemplateRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "template_ids": obj.get("template_ids"), + "signers": ( + [ + SubSignatureRequestTemplateSigner.from_dict(_item) + for _item in obj["signers"] + ] + if obj.get("signers") is not None + else None + ), + "allow_decline": ( + obj.get("allow_decline") + if obj.get("allow_decline") is not None + else False + ), + "ccs": ( + [SubCC.from_dict(_item) for _item in obj["ccs"]] + if obj.get("ccs") is not None + else None + ), + "client_id": obj.get("client_id"), + "custom_fields": ( + [SubCustomField.from_dict(_item) for _item in obj["custom_fields"]] + if obj.get("custom_fields") is not None + else None + ), + "files": obj.get("files"), + "file_urls": obj.get("file_urls"), + "is_eid": obj.get("is_eid") if obj.get("is_eid") is not None else False, + "message": obj.get("message"), + "metadata": obj.get("metadata"), + "signing_options": ( + SubSigningOptions.from_dict(obj["signing_options"]) + if obj.get("signing_options") is not None + else None + ), + "signing_redirect_url": obj.get("signing_redirect_url"), + "subject": obj.get("subject"), + "test_mode": ( + obj.get("test_mode") if obj.get("test_mode") is not None else False + ), + "title": obj.get("title"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "template_ids": "(List[str],)", + "signers": "(List[SubSignatureRequestTemplateSigner],)", + "allow_decline": "(bool,)", + "ccs": "(List[SubCC],)", + "client_id": "(str,)", + "custom_fields": "(List[SubCustomField],)", + "files": "(List[io.IOBase],)", + "file_urls": "(List[str],)", + "is_eid": "(bool,)", + "message": "(str,)", + "metadata": "(Dict[str, object],)", + "signing_options": "(SubSigningOptions,)", + "signing_redirect_url": "(str,)", + "subject": "(str,)", + "test_mode": "(bool,)", + "title": "(str,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "template_ids", + "signers", + "ccs", + "custom_fields", + "files", + "file_urls", + ] diff --git a/dropbox_sign/models/signature_request_get_response.py b/dropbox_sign/models/signature_request_get_response.py index 8a1c556..546c12c 100644 --- a/dropbox_sign/models/signature_request_get_response.py +++ b/dropbox_sign/models/signature_request_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.signature_request_response import SignatureRequestResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestGetResponse(BaseModel): diff --git a/dropbox_sign/models/signature_request_list_response.py b/dropbox_sign/models/signature_request_list_response.py index 02f8d74..2df4cbf 100644 --- a/dropbox_sign/models/signature_request_list_response.py +++ b/dropbox_sign/models/signature_request_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.list_info_response import ListInfoResponse from dropbox_sign.models.signature_request_response import SignatureRequestResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestListResponse(BaseModel): diff --git a/dropbox_sign/models/signature_request_remind_request.py b/dropbox_sign/models/signature_request_remind_request.py index 21483ce..df37e04 100644 --- a/dropbox_sign/models/signature_request_remind_request.py +++ b/dropbox_sign/models/signature_request_remind_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestRemindRequest(BaseModel): diff --git a/dropbox_sign/models/signature_request_response.py b/dropbox_sign/models/signature_request_response.py index e367012..7720256 100644 --- a/dropbox_sign/models/signature_request_response.py +++ b/dropbox_sign/models/signature_request_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -32,11 +32,11 @@ from dropbox_sign.models.signature_request_response_signatures import ( SignatureRequestResponseSignatures, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponse(BaseModel): diff --git a/dropbox_sign/models/signature_request_response_attachment.py b/dropbox_sign/models/signature_request_response_attachment.py index a8f364b..30af758 100644 --- a/dropbox_sign/models/signature_request_response_attachment.py +++ b/dropbox_sign/models/signature_request_response_attachment.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseAttachment(BaseModel): diff --git a/dropbox_sign/models/signature_request_response_custom_field_base.py b/dropbox_sign/models/signature_request_response_custom_field_base.py index 03fd81e..61ecdd6 100644 --- a/dropbox_sign/models/signature_request_response_custom_field_base.py +++ b/dropbox_sign/models/signature_request_response_custom_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from importlib import import_module from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional, Union -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union from typing import TYPE_CHECKING diff --git a/dropbox_sign/models/signature_request_response_custom_field_checkbox.py b/dropbox_sign/models/signature_request_response_custom_field_checkbox.py index 229a9f2..de55b64 100644 --- a/dropbox_sign/models/signature_request_response_custom_field_checkbox.py +++ b/dropbox_sign/models/signature_request_response_custom_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.signature_request_response_custom_field_base import ( SignatureRequestResponseCustomFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseCustomFieldCheckbox( diff --git a/dropbox_sign/models/signature_request_response_custom_field_text.py b/dropbox_sign/models/signature_request_response_custom_field_text.py index b4605b5..48fa24f 100644 --- a/dropbox_sign/models/signature_request_response_custom_field_text.py +++ b/dropbox_sign/models/signature_request_response_custom_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.signature_request_response_custom_field_base import ( SignatureRequestResponseCustomFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseCustomFieldText(SignatureRequestResponseCustomFieldBase): diff --git a/dropbox_sign/models/signature_request_response_custom_field_type_enum.py b/dropbox_sign/models/signature_request_response_custom_field_type_enum.py index db67d68..8f715ae 100644 --- a/dropbox_sign/models/signature_request_response_custom_field_type_enum.py +++ b/dropbox_sign/models/signature_request_response_custom_field_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/dropbox_sign/models/signature_request_response_data_base.py b/dropbox_sign/models/signature_request_response_data_base.py index 1e72f17..374d2cc 100644 --- a/dropbox_sign/models/signature_request_response_data_base.py +++ b/dropbox_sign/models/signature_request_response_data_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from importlib import import_module from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional, Union -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union from typing import TYPE_CHECKING diff --git a/dropbox_sign/models/signature_request_response_data_type_enum.py b/dropbox_sign/models/signature_request_response_data_type_enum.py index edd8ac0..8c4d01d 100644 --- a/dropbox_sign/models/signature_request_response_data_type_enum.py +++ b/dropbox_sign/models/signature_request_response_data_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/dropbox_sign/models/signature_request_response_data_value_checkbox.py b/dropbox_sign/models/signature_request_response_data_value_checkbox.py index 97dd0eb..4e25833 100644 --- a/dropbox_sign/models/signature_request_response_data_value_checkbox.py +++ b/dropbox_sign/models/signature_request_response_data_value_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.signature_request_response_data_base import ( SignatureRequestResponseDataBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseDataValueCheckbox(SignatureRequestResponseDataBase): diff --git a/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py b/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py index a48b3d0..0a25a7c 100644 --- a/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py +++ b/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.signature_request_response_data_base import ( SignatureRequestResponseDataBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseDataValueCheckboxMerge(SignatureRequestResponseDataBase): diff --git a/dropbox_sign/models/signature_request_response_data_value_date_signed.py b/dropbox_sign/models/signature_request_response_data_value_date_signed.py index b06f89b..ac09c26 100644 --- a/dropbox_sign/models/signature_request_response_data_value_date_signed.py +++ b/dropbox_sign/models/signature_request_response_data_value_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.signature_request_response_data_base import ( SignatureRequestResponseDataBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseDataValueDateSigned(SignatureRequestResponseDataBase): diff --git a/dropbox_sign/models/signature_request_response_data_value_dropdown.py b/dropbox_sign/models/signature_request_response_data_value_dropdown.py index 94ea1c7..9eb7352 100644 --- a/dropbox_sign/models/signature_request_response_data_value_dropdown.py +++ b/dropbox_sign/models/signature_request_response_data_value_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.signature_request_response_data_base import ( SignatureRequestResponseDataBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseDataValueDropdown(SignatureRequestResponseDataBase): 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 f5a493c..9a5f190 100644 --- a/dropbox_sign/models/signature_request_response_data_value_initials.py +++ b/dropbox_sign/models/signature_request_response_data_value_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.signature_request_response_data_base import ( SignatureRequestResponseDataBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseDataValueInitials(SignatureRequestResponseDataBase): diff --git a/dropbox_sign/models/signature_request_response_data_value_radio.py b/dropbox_sign/models/signature_request_response_data_value_radio.py index 8b531ec..38b3cc0 100644 --- a/dropbox_sign/models/signature_request_response_data_value_radio.py +++ b/dropbox_sign/models/signature_request_response_data_value_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.signature_request_response_data_base import ( SignatureRequestResponseDataBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseDataValueRadio(SignatureRequestResponseDataBase): 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 86461b3..a928d10 100644 --- a/dropbox_sign/models/signature_request_response_data_value_signature.py +++ b/dropbox_sign/models/signature_request_response_data_value_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.signature_request_response_data_base import ( SignatureRequestResponseDataBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseDataValueSignature(SignatureRequestResponseDataBase): diff --git a/dropbox_sign/models/signature_request_response_data_value_text.py b/dropbox_sign/models/signature_request_response_data_value_text.py index df76cb6..7b5b782 100644 --- a/dropbox_sign/models/signature_request_response_data_value_text.py +++ b/dropbox_sign/models/signature_request_response_data_value_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.signature_request_response_data_base import ( SignatureRequestResponseDataBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseDataValueText(SignatureRequestResponseDataBase): diff --git a/dropbox_sign/models/signature_request_response_data_value_text_merge.py b/dropbox_sign/models/signature_request_response_data_value_text_merge.py index 15ffbb3..13b9591 100644 --- a/dropbox_sign/models/signature_request_response_data_value_text_merge.py +++ b/dropbox_sign/models/signature_request_response_data_value_text_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.signature_request_response_data_base import ( SignatureRequestResponseDataBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseDataValueTextMerge(SignatureRequestResponseDataBase): diff --git a/dropbox_sign/models/signature_request_response_signatures.py b/dropbox_sign/models/signature_request_response_signatures.py index 0a964e5..9b36e81 100644 --- a/dropbox_sign/models/signature_request_response_signatures.py +++ b/dropbox_sign/models/signature_request_response_signatures.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestResponseSignatures(BaseModel): diff --git a/dropbox_sign/models/signature_request_send_request.py b/dropbox_sign/models/signature_request_send_request.py index 806a1de..d1f7b72 100644 --- a/dropbox_sign/models/signature_request_send_request.py +++ b/dropbox_sign/models/signature_request_send_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -27,7 +27,7 @@ StrictInt, StrictStr, ) -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_attachment import SubAttachment from dropbox_sign.models.sub_custom_field import SubCustomField @@ -42,11 +42,11 @@ ) from dropbox_sign.models.sub_signature_request_signer import SubSignatureRequestSigner from dropbox_sign.models.sub_signing_options import SubSigningOptions -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestSendRequest(BaseModel): @@ -54,7 +54,9 @@ class SignatureRequestSendRequest(BaseModel): SignatureRequestSendRequest """ # noqa: E501 - files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + files: Optional[ + 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.", ) diff --git a/dropbox_sign/models/signature_request_send_with_template_request.py b/dropbox_sign/models/signature_request_send_with_template_request.py index 9c4045a..f097278 100644 --- a/dropbox_sign/models/signature_request_send_with_template_request.py +++ b/dropbox_sign/models/signature_request_send_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_cc import SubCC from dropbox_sign.models.sub_custom_field import SubCustomField @@ -27,11 +27,11 @@ SubSignatureRequestTemplateSigner, ) from dropbox_sign.models.sub_signing_options import SubSigningOptions -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestSendWithTemplateRequest(BaseModel): @@ -59,7 +59,9 @@ class SignatureRequestSendWithTemplateRequest(BaseModel): default=None, description="An array defining values and options for custom fields. Required when a custom field exists in the Template.", ) - files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + files: Optional[ + 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.", ) diff --git a/dropbox_sign/models/signature_request_update_request.py b/dropbox_sign/models/signature_request_update_request.py index 37c4e18..a5ec1dd 100644 --- a/dropbox_sign/models/signature_request_update_request.py +++ b/dropbox_sign/models/signature_request_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SignatureRequestUpdateRequest(BaseModel): diff --git a/dropbox_sign/models/sub_attachment.py b/dropbox_sign/models/sub_attachment.py index a0c288d..82daeb1 100644 --- a/dropbox_sign/models/sub_attachment.py +++ b/dropbox_sign/models/sub_attachment.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubAttachment(BaseModel): diff --git a/dropbox_sign/models/sub_bulk_signer_list.py b/dropbox_sign/models/sub_bulk_signer_list.py index d5d8edb..899f577 100644 --- a/dropbox_sign/models/sub_bulk_signer_list.py +++ b/dropbox_sign/models/sub_bulk_signer_list.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -26,11 +26,11 @@ from dropbox_sign.models.sub_signature_request_template_signer import ( SubSignatureRequestTemplateSigner, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubBulkSignerList(BaseModel): diff --git a/dropbox_sign/models/sub_bulk_signer_list_custom_field.py b/dropbox_sign/models/sub_bulk_signer_list_custom_field.py index dbd925d..0efdff2 100644 --- a/dropbox_sign/models/sub_bulk_signer_list_custom_field.py +++ b/dropbox_sign/models/sub_bulk_signer_list_custom_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubBulkSignerListCustomField(BaseModel): diff --git a/dropbox_sign/models/sub_cc.py b/dropbox_sign/models/sub_cc.py index a0aa829..fb14ef0 100644 --- a/dropbox_sign/models/sub_cc.py +++ b/dropbox_sign/models/sub_cc.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubCC(BaseModel): diff --git a/dropbox_sign/models/sub_custom_field.py b/dropbox_sign/models/sub_custom_field.py index aa837bc..ec74927 100644 --- a/dropbox_sign/models/sub_custom_field.py +++ b/dropbox_sign/models/sub_custom_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubCustomField(BaseModel): diff --git a/dropbox_sign/models/sub_editor_options.py b/dropbox_sign/models/sub_editor_options.py index 7e4315c..8693cfa 100644 --- a/dropbox_sign/models/sub_editor_options.py +++ b/dropbox_sign/models/sub_editor_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubEditorOptions(BaseModel): diff --git a/dropbox_sign/models/sub_field_options.py b/dropbox_sign/models/sub_field_options.py index bd4ca3a..12336e6 100644 --- a/dropbox_sign/models/sub_field_options.py +++ b/dropbox_sign/models/sub_field_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFieldOptions(BaseModel): diff --git a/dropbox_sign/models/sub_form_field_group.py b/dropbox_sign/models/sub_form_field_group.py index 9a9964b..a892d21 100644 --- a/dropbox_sign/models/sub_form_field_group.py +++ b/dropbox_sign/models/sub_form_field_group.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldGroup(BaseModel): diff --git a/dropbox_sign/models/sub_form_field_rule.py b/dropbox_sign/models/sub_form_field_rule.py index 3451226..f09ac20 100644 --- a/dropbox_sign/models/sub_form_field_rule.py +++ b/dropbox_sign/models/sub_form_field_rule.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from typing_extensions import Annotated from dropbox_sign.models.sub_form_field_rule_action import SubFormFieldRuleAction from dropbox_sign.models.sub_form_field_rule_trigger import SubFormFieldRuleTrigger -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldRule(BaseModel): diff --git a/dropbox_sign/models/sub_form_field_rule_action.py b/dropbox_sign/models/sub_form_field_rule_action.py index 2e8eedf..59be433 100644 --- a/dropbox_sign/models/sub_form_field_rule_action.py +++ b/dropbox_sign/models/sub_form_field_rule_action.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -27,11 +27,11 @@ field_validator, ) from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldRuleAction(BaseModel): diff --git a/dropbox_sign/models/sub_form_field_rule_trigger.py b/dropbox_sign/models/sub_form_field_rule_trigger.py index 124a921..ff6c5be 100644 --- a/dropbox_sign/models/sub_form_field_rule_trigger.py +++ b/dropbox_sign/models/sub_form_field_rule_trigger.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldRuleTrigger(BaseModel): diff --git a/dropbox_sign/models/sub_form_fields_per_document_base.py b/dropbox_sign/models/sub_form_fields_per_document_base.py index 0f05fbe..615f108 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_base.py +++ b/dropbox_sign/models/sub_form_fields_per_document_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from importlib import import_module from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional, Union -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union from typing import TYPE_CHECKING diff --git a/dropbox_sign/models/sub_form_fields_per_document_checkbox.py b/dropbox_sign/models/sub_form_fields_per_document_checkbox.py index f1765d1..9053898 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_checkbox.py +++ b/dropbox_sign/models/sub_form_fields_per_document_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.sub_form_fields_per_document_base import ( SubFormFieldsPerDocumentBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldsPerDocumentCheckbox(SubFormFieldsPerDocumentBase): diff --git a/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py b/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py index 157a66f..aa94733 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py +++ b/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.sub_form_fields_per_document_base import ( SubFormFieldsPerDocumentBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldsPerDocumentCheckboxMerge(SubFormFieldsPerDocumentBase): diff --git a/dropbox_sign/models/sub_form_fields_per_document_date_signed.py b/dropbox_sign/models/sub_form_fields_per_document_date_signed.py index 298b43a..583a3a8 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_date_signed.py +++ b/dropbox_sign/models/sub_form_fields_per_document_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.sub_form_fields_per_document_base import ( SubFormFieldsPerDocumentBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldsPerDocumentDateSigned(SubFormFieldsPerDocumentBase): diff --git a/dropbox_sign/models/sub_form_fields_per_document_dropdown.py b/dropbox_sign/models/sub_form_fields_per_document_dropdown.py index 331b617..c668c35 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_dropdown.py +++ b/dropbox_sign/models/sub_form_fields_per_document_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -24,11 +24,11 @@ from dropbox_sign.models.sub_form_fields_per_document_base import ( SubFormFieldsPerDocumentBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldsPerDocumentDropdown(SubFormFieldsPerDocumentBase): diff --git a/dropbox_sign/models/sub_form_fields_per_document_font_enum.py b/dropbox_sign/models/sub_form_fields_per_document_font_enum.py index 5244ac2..8865fdc 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_font_enum.py +++ b/dropbox_sign/models/sub_form_fields_per_document_font_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py b/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py index f8c9d0c..650d766 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py +++ b/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.sub_form_fields_per_document_base import ( SubFormFieldsPerDocumentBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldsPerDocumentHyperlink(SubFormFieldsPerDocumentBase): diff --git a/dropbox_sign/models/sub_form_fields_per_document_initials.py b/dropbox_sign/models/sub_form_fields_per_document_initials.py index 8962b4c..3383d71 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_initials.py +++ b/dropbox_sign/models/sub_form_fields_per_document_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.sub_form_fields_per_document_base import ( SubFormFieldsPerDocumentBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldsPerDocumentInitials(SubFormFieldsPerDocumentBase): diff --git a/dropbox_sign/models/sub_form_fields_per_document_radio.py b/dropbox_sign/models/sub_form_fields_per_document_radio.py index 69407f5..a91bd86 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_radio.py +++ b/dropbox_sign/models/sub_form_fields_per_document_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.sub_form_fields_per_document_base import ( SubFormFieldsPerDocumentBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldsPerDocumentRadio(SubFormFieldsPerDocumentBase): diff --git a/dropbox_sign/models/sub_form_fields_per_document_signature.py b/dropbox_sign/models/sub_form_fields_per_document_signature.py index e900a75..11a056c 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_signature.py +++ b/dropbox_sign/models/sub_form_fields_per_document_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.sub_form_fields_per_document_base import ( SubFormFieldsPerDocumentBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldsPerDocumentSignature(SubFormFieldsPerDocumentBase): diff --git a/dropbox_sign/models/sub_form_fields_per_document_text.py b/dropbox_sign/models/sub_form_fields_per_document_text.py index b7f473d..c2e2c3a 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_text.py +++ b/dropbox_sign/models/sub_form_fields_per_document_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -30,11 +30,11 @@ from dropbox_sign.models.sub_form_fields_per_document_base import ( SubFormFieldsPerDocumentBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldsPerDocumentText(SubFormFieldsPerDocumentBase): diff --git a/dropbox_sign/models/sub_form_fields_per_document_text_merge.py b/dropbox_sign/models/sub_form_fields_per_document_text_merge.py index 318deab..990c237 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_text_merge.py +++ b/dropbox_sign/models/sub_form_fields_per_document_text_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.sub_form_fields_per_document_base import ( SubFormFieldsPerDocumentBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubFormFieldsPerDocumentTextMerge(SubFormFieldsPerDocumentBase): diff --git a/dropbox_sign/models/sub_form_fields_per_document_type_enum.py b/dropbox_sign/models/sub_form_fields_per_document_type_enum.py index e2ca133..e1d61ca 100644 --- a/dropbox_sign/models/sub_form_fields_per_document_type_enum.py +++ b/dropbox_sign/models/sub_form_fields_per_document_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/dropbox_sign/models/sub_merge_field.py b/dropbox_sign/models/sub_merge_field.py index dba544e..e83058e 100644 --- a/dropbox_sign/models/sub_merge_field.py +++ b/dropbox_sign/models/sub_merge_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubMergeField(BaseModel): diff --git a/dropbox_sign/models/sub_o_auth.py b/dropbox_sign/models/sub_o_auth.py index 979d595..2c11784 100644 --- a/dropbox_sign/models/sub_o_auth.py +++ b/dropbox_sign/models/sub_o_auth.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubOAuth(BaseModel): diff --git a/dropbox_sign/models/sub_options.py b/dropbox_sign/models/sub_options.py index bd4f00a..e7965f4 100644 --- a/dropbox_sign/models/sub_options.py +++ b/dropbox_sign/models/sub_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubOptions(BaseModel): diff --git a/dropbox_sign/models/sub_signature_request_grouped_signers.py b/dropbox_sign/models/sub_signature_request_grouped_signers.py index 24671c9..a14f315 100644 --- a/dropbox_sign/models/sub_signature_request_grouped_signers.py +++ b/dropbox_sign/models/sub_signature_request_grouped_signers.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.sub_signature_request_signer import SubSignatureRequestSigner -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubSignatureRequestGroupedSigners(BaseModel): diff --git a/dropbox_sign/models/sub_signature_request_signer.py b/dropbox_sign/models/sub_signature_request_signer.py index ac567d5..3337098 100644 --- a/dropbox_sign/models/sub_signature_request_signer.py +++ b/dropbox_sign/models/sub_signature_request_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubSignatureRequestSigner(BaseModel): diff --git a/dropbox_sign/models/sub_signature_request_template_signer.py b/dropbox_sign/models/sub_signature_request_template_signer.py index 44b6881..4d1e239 100644 --- a/dropbox_sign/models/sub_signature_request_template_signer.py +++ b/dropbox_sign/models/sub_signature_request_template_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubSignatureRequestTemplateSigner(BaseModel): diff --git a/dropbox_sign/models/sub_signing_options.py b/dropbox_sign/models/sub_signing_options.py index e6cd960..717d3a8 100644 --- a/dropbox_sign/models/sub_signing_options.py +++ b/dropbox_sign/models/sub_signing_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -27,11 +27,11 @@ field_validator, ) from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubSigningOptions(BaseModel): diff --git a/dropbox_sign/models/sub_team_response.py b/dropbox_sign/models/sub_team_response.py index 98e55e1..5a3b7f7 100644 --- a/dropbox_sign/models/sub_team_response.py +++ b/dropbox_sign/models/sub_team_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubTeamResponse(BaseModel): diff --git a/dropbox_sign/models/sub_template_role.py b/dropbox_sign/models/sub_template_role.py index 187fa77..fd40763 100644 --- a/dropbox_sign/models/sub_template_role.py +++ b/dropbox_sign/models/sub_template_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubTemplateRole(BaseModel): diff --git a/dropbox_sign/models/sub_unclaimed_draft_signer.py b/dropbox_sign/models/sub_unclaimed_draft_signer.py index fcc70e3..318fd80 100644 --- a/dropbox_sign/models/sub_unclaimed_draft_signer.py +++ b/dropbox_sign/models/sub_unclaimed_draft_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubUnclaimedDraftSigner(BaseModel): diff --git a/dropbox_sign/models/sub_unclaimed_draft_template_signer.py b/dropbox_sign/models/sub_unclaimed_draft_template_signer.py index 2154537..a668e9f 100644 --- a/dropbox_sign/models/sub_unclaimed_draft_template_signer.py +++ b/dropbox_sign/models/sub_unclaimed_draft_template_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubUnclaimedDraftTemplateSigner(BaseModel): diff --git a/dropbox_sign/models/sub_white_labeling_options.py b/dropbox_sign/models/sub_white_labeling_options.py index 218da2a..9fe6f14 100644 --- a/dropbox_sign/models/sub_white_labeling_options.py +++ b/dropbox_sign/models/sub_white_labeling_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -27,11 +27,11 @@ field_validator, ) from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class SubWhiteLabelingOptions(BaseModel): diff --git a/dropbox_sign/models/team_add_member_request.py b/dropbox_sign/models/team_add_member_request.py index 275ccf0..9fa1fbc 100644 --- a/dropbox_sign/models/team_add_member_request.py +++ b/dropbox_sign/models/team_add_member_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamAddMemberRequest(BaseModel): diff --git a/dropbox_sign/models/team_create_request.py b/dropbox_sign/models/team_create_request.py index 0c0c696..94d38e6 100644 --- a/dropbox_sign/models/team_create_request.py +++ b/dropbox_sign/models/team_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamCreateRequest(BaseModel): diff --git a/dropbox_sign/models/team_get_info_response.py b/dropbox_sign/models/team_get_info_response.py index 3453baa..e716e4d 100644 --- a/dropbox_sign/models/team_get_info_response.py +++ b/dropbox_sign/models/team_get_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.team_info_response import TeamInfoResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamGetInfoResponse(BaseModel): diff --git a/dropbox_sign/models/team_get_response.py b/dropbox_sign/models/team_get_response.py index 65845b2..3c137e3 100644 --- a/dropbox_sign/models/team_get_response.py +++ b/dropbox_sign/models/team_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.team_response import TeamResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamGetResponse(BaseModel): diff --git a/dropbox_sign/models/team_info_response.py b/dropbox_sign/models/team_info_response.py index 4c6ae50..b10d7cb 100644 --- a/dropbox_sign/models/team_info_response.py +++ b/dropbox_sign/models/team_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.team_parent_response import TeamParentResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamInfoResponse(BaseModel): diff --git a/dropbox_sign/models/team_invite_response.py b/dropbox_sign/models/team_invite_response.py index fbc7d13..0f37720 100644 --- a/dropbox_sign/models/team_invite_response.py +++ b/dropbox_sign/models/team_invite_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamInviteResponse(BaseModel): diff --git a/dropbox_sign/models/team_invites_response.py b/dropbox_sign/models/team_invites_response.py index aa448da..e6171e8 100644 --- a/dropbox_sign/models/team_invites_response.py +++ b/dropbox_sign/models/team_invites_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.team_invite_response import TeamInviteResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamInvitesResponse(BaseModel): diff --git a/dropbox_sign/models/team_member_response.py b/dropbox_sign/models/team_member_response.py index 0930eaa..d59fc5d 100644 --- a/dropbox_sign/models/team_member_response.py +++ b/dropbox_sign/models/team_member_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamMemberResponse(BaseModel): diff --git a/dropbox_sign/models/team_members_response.py b/dropbox_sign/models/team_members_response.py index f150d6e..73ed1c4 100644 --- a/dropbox_sign/models/team_members_response.py +++ b/dropbox_sign/models/team_members_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.list_info_response import ListInfoResponse from dropbox_sign.models.team_member_response import TeamMemberResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamMembersResponse(BaseModel): diff --git a/dropbox_sign/models/team_parent_response.py b/dropbox_sign/models/team_parent_response.py index 633b10b..2478765 100644 --- a/dropbox_sign/models/team_parent_response.py +++ b/dropbox_sign/models/team_parent_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamParentResponse(BaseModel): diff --git a/dropbox_sign/models/team_remove_member_request.py b/dropbox_sign/models/team_remove_member_request.py index d21215d..0df67ab 100644 --- a/dropbox_sign/models/team_remove_member_request.py +++ b/dropbox_sign/models/team_remove_member_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamRemoveMemberRequest(BaseModel): diff --git a/dropbox_sign/models/team_response.py b/dropbox_sign/models/team_response.py index 57bec33..9f72e11 100644 --- a/dropbox_sign/models/team_response.py +++ b/dropbox_sign/models/team_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.account_response import AccountResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamResponse(BaseModel): diff --git a/dropbox_sign/models/team_sub_teams_response.py b/dropbox_sign/models/team_sub_teams_response.py index 6d6b76c..15e0a30 100644 --- a/dropbox_sign/models/team_sub_teams_response.py +++ b/dropbox_sign/models/team_sub_teams_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.list_info_response import ListInfoResponse from dropbox_sign.models.sub_team_response import SubTeamResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamSubTeamsResponse(BaseModel): diff --git a/dropbox_sign/models/team_update_request.py b/dropbox_sign/models/team_update_request.py index e7bdb43..9c4b17e 100644 --- a/dropbox_sign/models/team_update_request.py +++ b/dropbox_sign/models/team_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TeamUpdateRequest(BaseModel): diff --git a/dropbox_sign/models/template_add_user_request.py b/dropbox_sign/models/template_add_user_request.py index 34c4ed6..2e44471 100644 --- a/dropbox_sign/models/template_add_user_request.py +++ b/dropbox_sign/models/template_add_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateAddUserRequest(BaseModel): diff --git a/dropbox_sign/models/template_create_embedded_draft_request.py b/dropbox_sign/models/template_create_embedded_draft_request.py index 983d872..808ba1c 100644 --- a/dropbox_sign/models/template_create_embedded_draft_request.py +++ b/dropbox_sign/models/template_create_embedded_draft_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_attachment import SubAttachment from dropbox_sign.models.sub_editor_options import SubEditorOptions @@ -31,11 +31,11 @@ ) from dropbox_sign.models.sub_merge_field import SubMergeField from dropbox_sign.models.sub_template_role import SubTemplateRole -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateCreateEmbeddedDraftRequest(BaseModel): @@ -46,7 +46,9 @@ class TemplateCreateEmbeddedDraftRequest(BaseModel): client_id: StrictStr = Field( description="Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app." ) - files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + files: Optional[ + 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.", ) diff --git a/dropbox_sign/models/template_create_embedded_draft_response.py b/dropbox_sign/models/template_create_embedded_draft_response.py index 5e728e7..fb9a0eb 100644 --- a/dropbox_sign/models/template_create_embedded_draft_response.py +++ b/dropbox_sign/models/template_create_embedded_draft_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -24,11 +24,11 @@ TemplateCreateEmbeddedDraftResponseTemplate, ) from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateCreateEmbeddedDraftResponse(BaseModel): diff --git a/dropbox_sign/models/template_create_embedded_draft_response_template.py b/dropbox_sign/models/template_create_embedded_draft_response_template.py index be23c20..3016dce 100644 --- a/dropbox_sign/models/template_create_embedded_draft_response_template.py +++ b/dropbox_sign/models/template_create_embedded_draft_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateCreateEmbeddedDraftResponseTemplate(BaseModel): diff --git a/dropbox_sign/models/template_create_request.py b/dropbox_sign/models/template_create_request.py index fa6df56..5320276 100644 --- a/dropbox_sign/models/template_create_request.py +++ b/dropbox_sign/models/template_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_attachment import SubAttachment from dropbox_sign.models.sub_field_options import SubFieldOptions @@ -30,11 +30,11 @@ ) from dropbox_sign.models.sub_merge_field import SubMergeField from dropbox_sign.models.sub_template_role import SubTemplateRole -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateCreateRequest(BaseModel): @@ -48,7 +48,9 @@ class TemplateCreateRequest(BaseModel): signer_roles: List[SubTemplateRole] = Field( description="An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template." ) - files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + files: Optional[ + 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.", ) diff --git a/dropbox_sign/models/template_create_response.py b/dropbox_sign/models/template_create_response.py index a42054f..bc5f6c6 100644 --- a/dropbox_sign/models/template_create_response.py +++ b/dropbox_sign/models/template_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -24,11 +24,11 @@ TemplateCreateResponseTemplate, ) from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateCreateResponse(BaseModel): diff --git a/dropbox_sign/models/template_create_response_template.py b/dropbox_sign/models/template_create_response_template.py index e4f253e..25d9bd7 100644 --- a/dropbox_sign/models/template_create_response_template.py +++ b/dropbox_sign/models/template_create_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateCreateResponseTemplate(BaseModel): diff --git a/dropbox_sign/models/template_edit_response.py b/dropbox_sign/models/template_edit_response.py index 05b99f4..1988138 100644 --- a/dropbox_sign/models/template_edit_response.py +++ b/dropbox_sign/models/template_edit_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateEditResponse(BaseModel): diff --git a/dropbox_sign/models/template_get_response.py b/dropbox_sign/models/template_get_response.py index a32292b..10d714c 100644 --- a/dropbox_sign/models/template_get_response.py +++ b/dropbox_sign/models/template_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response import TemplateResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateGetResponse(BaseModel): diff --git a/dropbox_sign/models/template_list_response.py b/dropbox_sign/models/template_list_response.py index 5deebe2..5ccaba7 100644 --- a/dropbox_sign/models/template_list_response.py +++ b/dropbox_sign/models/template_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.list_info_response import ListInfoResponse from dropbox_sign.models.template_response import TemplateResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateListResponse(BaseModel): diff --git a/dropbox_sign/models/template_remove_user_request.py b/dropbox_sign/models/template_remove_user_request.py index 565c47e..44ddbf4 100644 --- a/dropbox_sign/models/template_remove_user_request.py +++ b/dropbox_sign/models/template_remove_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateRemoveUserRequest(BaseModel): diff --git a/dropbox_sign/models/template_response.py b/dropbox_sign/models/template_response.py index 01f36b3..667465f 100644 --- a/dropbox_sign/models/template_response.py +++ b/dropbox_sign/models/template_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -33,11 +33,11 @@ TemplateResponseDocumentFormFieldBase, ) from dropbox_sign.models.template_response_signer_role import TemplateResponseSignerRole -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponse(BaseModel): diff --git a/dropbox_sign/models/template_response_account.py b/dropbox_sign/models/template_response_account.py index 71358ff..d29db33 100644 --- a/dropbox_sign/models/template_response_account.py +++ b/dropbox_sign/models/template_response_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_account_quota import ( TemplateResponseAccountQuota, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseAccount(BaseModel): diff --git a/dropbox_sign/models/template_response_account_quota.py b/dropbox_sign/models/template_response_account_quota.py index 6c03eff..e4fa366 100644 --- a/dropbox_sign/models/template_response_account_quota.py +++ b/dropbox_sign/models/template_response_account_quota.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseAccountQuota(BaseModel): diff --git a/dropbox_sign/models/template_response_cc_role.py b/dropbox_sign/models/template_response_cc_role.py index 8c00522..89a3b4c 100644 --- a/dropbox_sign/models/template_response_cc_role.py +++ b/dropbox_sign/models/template_response_cc_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseCCRole(BaseModel): diff --git a/dropbox_sign/models/template_response_document.py b/dropbox_sign/models/template_response_document.py index 56e887b..d2f0caf 100644 --- a/dropbox_sign/models/template_response_document.py +++ b/dropbox_sign/models/template_response_document.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -32,11 +32,11 @@ from dropbox_sign.models.template_response_document_static_field_base import ( TemplateResponseDocumentStaticFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocument(BaseModel): diff --git a/dropbox_sign/models/template_response_document_custom_field_base.py b/dropbox_sign/models/template_response_document_custom_field_base.py index a7d2fa6..6c6a35b 100644 --- a/dropbox_sign/models/template_response_document_custom_field_base.py +++ b/dropbox_sign/models/template_response_document_custom_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from importlib import import_module from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional, Union -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union from typing import TYPE_CHECKING diff --git a/dropbox_sign/models/template_response_document_custom_field_checkbox.py b/dropbox_sign/models/template_response_document_custom_field_checkbox.py index 4edf644..35e3915 100644 --- a/dropbox_sign/models/template_response_document_custom_field_checkbox.py +++ b/dropbox_sign/models/template_response_document_custom_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_custom_field_base import ( TemplateResponseDocumentCustomFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentCustomFieldCheckbox( diff --git a/dropbox_sign/models/template_response_document_custom_field_text.py b/dropbox_sign/models/template_response_document_custom_field_text.py index 760dd57..09a85e2 100644 --- a/dropbox_sign/models/template_response_document_custom_field_text.py +++ b/dropbox_sign/models/template_response_document_custom_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -26,11 +26,11 @@ from dropbox_sign.models.template_response_field_avg_text_length import ( TemplateResponseFieldAvgTextLength, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentCustomFieldText(TemplateResponseDocumentCustomFieldBase): diff --git a/dropbox_sign/models/template_response_document_field_group.py b/dropbox_sign/models/template_response_document_field_group.py index 201bd13..8f3bc1a 100644 --- a/dropbox_sign/models/template_response_document_field_group.py +++ b/dropbox_sign/models/template_response_document_field_group.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_field_group_rule import ( TemplateResponseDocumentFieldGroupRule, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentFieldGroup(BaseModel): diff --git a/dropbox_sign/models/template_response_document_field_group_rule.py b/dropbox_sign/models/template_response_document_field_group_rule.py index e5ade9d..17d81cb 100644 --- a/dropbox_sign/models/template_response_document_field_group_rule.py +++ b/dropbox_sign/models/template_response_document_field_group_rule.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentFieldGroupRule(BaseModel): diff --git a/dropbox_sign/models/template_response_document_form_field_base.py b/dropbox_sign/models/template_response_document_form_field_base.py index 62f6d5f..6f8777a 100644 --- a/dropbox_sign/models/template_response_document_form_field_base.py +++ b/dropbox_sign/models/template_response_document_form_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from importlib import import_module from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional, Union -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union from typing import TYPE_CHECKING diff --git a/dropbox_sign/models/template_response_document_form_field_checkbox.py b/dropbox_sign/models/template_response_document_form_field_checkbox.py index 29c4ff1..d81d657 100644 --- a/dropbox_sign/models/template_response_document_form_field_checkbox.py +++ b/dropbox_sign/models/template_response_document_form_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentFormFieldCheckbox(TemplateResponseDocumentFormFieldBase): diff --git a/dropbox_sign/models/template_response_document_form_field_date_signed.py b/dropbox_sign/models/template_response_document_form_field_date_signed.py index 9b466fa..8ee5fe3 100644 --- a/dropbox_sign/models/template_response_document_form_field_date_signed.py +++ b/dropbox_sign/models/template_response_document_form_field_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentFormFieldDateSigned( diff --git a/dropbox_sign/models/template_response_document_form_field_dropdown.py b/dropbox_sign/models/template_response_document_form_field_dropdown.py index 65b253c..2b30ae4 100644 --- a/dropbox_sign/models/template_response_document_form_field_dropdown.py +++ b/dropbox_sign/models/template_response_document_form_field_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentFormFieldDropdown(TemplateResponseDocumentFormFieldBase): diff --git a/dropbox_sign/models/template_response_document_form_field_hyperlink.py b/dropbox_sign/models/template_response_document_form_field_hyperlink.py index 90f0c1f..0102248 100644 --- a/dropbox_sign/models/template_response_document_form_field_hyperlink.py +++ b/dropbox_sign/models/template_response_document_form_field_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -26,11 +26,11 @@ from dropbox_sign.models.template_response_field_avg_text_length import ( TemplateResponseFieldAvgTextLength, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentFormFieldHyperlink(TemplateResponseDocumentFormFieldBase): diff --git a/dropbox_sign/models/template_response_document_form_field_initials.py b/dropbox_sign/models/template_response_document_form_field_initials.py index bc8512b..64321ad 100644 --- a/dropbox_sign/models/template_response_document_form_field_initials.py +++ b/dropbox_sign/models/template_response_document_form_field_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentFormFieldInitials(TemplateResponseDocumentFormFieldBase): diff --git a/dropbox_sign/models/template_response_document_form_field_radio.py b/dropbox_sign/models/template_response_document_form_field_radio.py index 7e76f9e..0f0c344 100644 --- a/dropbox_sign/models/template_response_document_form_field_radio.py +++ b/dropbox_sign/models/template_response_document_form_field_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentFormFieldRadio(TemplateResponseDocumentFormFieldBase): diff --git a/dropbox_sign/models/template_response_document_form_field_signature.py b/dropbox_sign/models/template_response_document_form_field_signature.py index 7e742ce..c509f92 100644 --- a/dropbox_sign/models/template_response_document_form_field_signature.py +++ b/dropbox_sign/models/template_response_document_form_field_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentFormFieldSignature(TemplateResponseDocumentFormFieldBase): diff --git a/dropbox_sign/models/template_response_document_form_field_text.py b/dropbox_sign/models/template_response_document_form_field_text.py index c04d1b5..e6800d2 100644 --- a/dropbox_sign/models/template_response_document_form_field_text.py +++ b/dropbox_sign/models/template_response_document_form_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -33,11 +33,11 @@ from dropbox_sign.models.template_response_field_avg_text_length import ( TemplateResponseFieldAvgTextLength, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentFormFieldText(TemplateResponseDocumentFormFieldBase): diff --git a/dropbox_sign/models/template_response_document_static_field_base.py b/dropbox_sign/models/template_response_document_static_field_base.py index 4c16302..d9735c7 100644 --- a/dropbox_sign/models/template_response_document_static_field_base.py +++ b/dropbox_sign/models/template_response_document_static_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from importlib import import_module from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional, Union -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union from typing import TYPE_CHECKING diff --git a/dropbox_sign/models/template_response_document_static_field_checkbox.py b/dropbox_sign/models/template_response_document_static_field_checkbox.py index ea1c2b7..0afba0d 100644 --- a/dropbox_sign/models/template_response_document_static_field_checkbox.py +++ b/dropbox_sign/models/template_response_document_static_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_static_field_base import ( TemplateResponseDocumentStaticFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentStaticFieldCheckbox( diff --git a/dropbox_sign/models/template_response_document_static_field_date_signed.py b/dropbox_sign/models/template_response_document_static_field_date_signed.py index 3a9bf86..0b232a6 100644 --- a/dropbox_sign/models/template_response_document_static_field_date_signed.py +++ b/dropbox_sign/models/template_response_document_static_field_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_static_field_base import ( TemplateResponseDocumentStaticFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentStaticFieldDateSigned( diff --git a/dropbox_sign/models/template_response_document_static_field_dropdown.py b/dropbox_sign/models/template_response_document_static_field_dropdown.py index 8444e77..7ac71ec 100644 --- a/dropbox_sign/models/template_response_document_static_field_dropdown.py +++ b/dropbox_sign/models/template_response_document_static_field_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_static_field_base import ( TemplateResponseDocumentStaticFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentStaticFieldDropdown( diff --git a/dropbox_sign/models/template_response_document_static_field_hyperlink.py b/dropbox_sign/models/template_response_document_static_field_hyperlink.py index 43106f1..bdd27c9 100644 --- a/dropbox_sign/models/template_response_document_static_field_hyperlink.py +++ b/dropbox_sign/models/template_response_document_static_field_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_static_field_base import ( TemplateResponseDocumentStaticFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentStaticFieldHyperlink( diff --git a/dropbox_sign/models/template_response_document_static_field_initials.py b/dropbox_sign/models/template_response_document_static_field_initials.py index 8844253..bd755ee 100644 --- a/dropbox_sign/models/template_response_document_static_field_initials.py +++ b/dropbox_sign/models/template_response_document_static_field_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_static_field_base import ( TemplateResponseDocumentStaticFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentStaticFieldInitials( diff --git a/dropbox_sign/models/template_response_document_static_field_radio.py b/dropbox_sign/models/template_response_document_static_field_radio.py index e0701f1..a78d5b8 100644 --- a/dropbox_sign/models/template_response_document_static_field_radio.py +++ b/dropbox_sign/models/template_response_document_static_field_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_static_field_base import ( TemplateResponseDocumentStaticFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentStaticFieldRadio(TemplateResponseDocumentStaticFieldBase): diff --git a/dropbox_sign/models/template_response_document_static_field_signature.py b/dropbox_sign/models/template_response_document_static_field_signature.py index dbd1211..c0ff8ee 100644 --- a/dropbox_sign/models/template_response_document_static_field_signature.py +++ b/dropbox_sign/models/template_response_document_static_field_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_static_field_base import ( TemplateResponseDocumentStaticFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentStaticFieldSignature( diff --git a/dropbox_sign/models/template_response_document_static_field_text.py b/dropbox_sign/models/template_response_document_static_field_text.py index 7fe3d59..03a3a48 100644 --- a/dropbox_sign/models/template_response_document_static_field_text.py +++ b/dropbox_sign/models/template_response_document_static_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_response_document_static_field_base import ( TemplateResponseDocumentStaticFieldBase, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseDocumentStaticFieldText(TemplateResponseDocumentStaticFieldBase): diff --git a/dropbox_sign/models/template_response_field_avg_text_length.py b/dropbox_sign/models/template_response_field_avg_text_length.py index b3b5d4a..1936e75 100644 --- a/dropbox_sign/models/template_response_field_avg_text_length.py +++ b/dropbox_sign/models/template_response_field_avg_text_length.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseFieldAvgTextLength(BaseModel): diff --git a/dropbox_sign/models/template_response_signer_role.py b/dropbox_sign/models/template_response_signer_role.py index aab8250..2cada15 100644 --- a/dropbox_sign/models/template_response_signer_role.py +++ b/dropbox_sign/models/template_response_signer_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateResponseSignerRole(BaseModel): diff --git a/dropbox_sign/models/template_update_files_request.py b/dropbox_sign/models/template_update_files_request.py index e8d3f22..18612dd 100644 --- a/dropbox_sign/models/template_update_files_request.py +++ b/dropbox_sign/models/template_update_files_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -19,13 +19,13 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateUpdateFilesRequest(BaseModel): @@ -37,7 +37,9 @@ class TemplateUpdateFilesRequest(BaseModel): default=None, description="Client id of the app you're using to update this template.", ) - files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + files: Optional[ + List[Union[StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]]] + ] = Field( default=None, description="Use `files[]` to indicate the uploaded file(s) to use for the template. This endpoint requires either **files** or **file_urls[]**, but not both.", ) diff --git a/dropbox_sign/models/template_update_files_response.py b/dropbox_sign/models/template_update_files_response.py index d2c0776..67b1d3b 100644 --- a/dropbox_sign/models/template_update_files_response.py +++ b/dropbox_sign/models/template_update_files_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -23,11 +23,11 @@ from dropbox_sign.models.template_update_files_response_template import ( TemplateUpdateFilesResponseTemplate, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateUpdateFilesResponse(BaseModel): diff --git a/dropbox_sign/models/template_update_files_response_template.py b/dropbox_sign/models/template_update_files_response_template.py index a8fb50f..2a8cd11 100644 --- a/dropbox_sign/models/template_update_files_response_template.py +++ b/dropbox_sign/models/template_update_files_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class TemplateUpdateFilesResponseTemplate(BaseModel): diff --git a/dropbox_sign/models/unclaimed_draft_create_embedded_request.py b/dropbox_sign/models/unclaimed_draft_create_embedded_request.py index 33b1650..53527e3 100644 --- a/dropbox_sign/models/unclaimed_draft_create_embedded_request.py +++ b/dropbox_sign/models/unclaimed_draft_create_embedded_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -28,7 +28,7 @@ StrictStr, field_validator, ) -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_attachment import SubAttachment from dropbox_sign.models.sub_custom_field import SubCustomField @@ -41,11 +41,11 @@ ) from dropbox_sign.models.sub_signing_options import SubSigningOptions from dropbox_sign.models.sub_unclaimed_draft_signer import SubUnclaimedDraftSigner -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class UnclaimedDraftCreateEmbeddedRequest(BaseModel): @@ -57,7 +57,9 @@ class UnclaimedDraftCreateEmbeddedRequest(BaseModel): requester_email_address: StrictStr = Field( description="The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`." ) - files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + files: Optional[ + 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.", ) diff --git a/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py b/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py index a09307d..3ab7023 100644 --- a/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py +++ b/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_cc import SubCC from dropbox_sign.models.sub_custom_field import SubCustomField @@ -29,11 +29,11 @@ from dropbox_sign.models.sub_unclaimed_draft_template_signer import ( SubUnclaimedDraftTemplateSigner, ) -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class UnclaimedDraftCreateEmbeddedWithTemplateRequest(BaseModel): @@ -68,7 +68,9 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest(BaseModel): ) editor_options: Optional[SubEditorOptions] = None field_options: Optional[SubFieldOptions] = None - files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + files: Optional[ + List[Union[StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]]] + ] = Field( default=None, description="Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. **files** or **file_urls[]** is required, but not both.", ) diff --git a/dropbox_sign/models/unclaimed_draft_create_request.py b/dropbox_sign/models/unclaimed_draft_create_request.py index 2833e23..49a7aee 100644 --- a/dropbox_sign/models/unclaimed_draft_create_request.py +++ b/dropbox_sign/models/unclaimed_draft_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -28,7 +28,7 @@ StrictStr, field_validator, ) -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_attachment import SubAttachment from dropbox_sign.models.sub_custom_field import SubCustomField @@ -40,11 +40,11 @@ ) from dropbox_sign.models.sub_signing_options import SubSigningOptions from dropbox_sign.models.sub_unclaimed_draft_signer import SubUnclaimedDraftSigner -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class UnclaimedDraftCreateRequest(BaseModel): @@ -53,7 +53,9 @@ class UnclaimedDraftCreateRequest(BaseModel): type: StrictStr = Field( description="The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional." ) - files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + files: Optional[ + 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.", ) diff --git a/dropbox_sign/models/unclaimed_draft_create_response.py b/dropbox_sign/models/unclaimed_draft_create_response.py index 11ae0d9..085e5b9 100644 --- a/dropbox_sign/models/unclaimed_draft_create_response.py +++ b/dropbox_sign/models/unclaimed_draft_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.unclaimed_draft_response import UnclaimedDraftResponse from dropbox_sign.models.warning_response import WarningResponse -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class UnclaimedDraftCreateResponse(BaseModel): diff --git a/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py b/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py index 4b84d10..38903be 100644 --- a/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py +++ b/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -21,11 +21,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.sub_editor_options import SubEditorOptions -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class UnclaimedDraftEditAndResendRequest(BaseModel): diff --git a/dropbox_sign/models/unclaimed_draft_response.py b/dropbox_sign/models/unclaimed_draft_response.py index 1cd9509..51fdcfa 100644 --- a/dropbox_sign/models/unclaimed_draft_response.py +++ b/dropbox_sign/models/unclaimed_draft_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class UnclaimedDraftResponse(BaseModel): diff --git a/dropbox_sign/models/warning_response.py b/dropbox_sign/models/warning_response.py index f5aa127..d2a26d5 100644 --- a/dropbox_sign/models/warning_response.py +++ b/dropbox_sign/models/warning_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -20,11 +20,11 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List -from typing import Optional, Set, Tuple +from typing import Optional, Set from typing_extensions import Self +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union class WarningResponse(BaseModel): diff --git a/dropbox_sign/rest.py b/dropbox_sign/rest.py index b369c3f..4aaa80d 100644 --- a/dropbox_sign/rest.py +++ b/dropbox_sign/rest.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 @@ -77,6 +77,7 @@ def __init__(self, configuration) -> None: "ca_certs": configuration.ssl_ca_cert, "cert_file": configuration.cert_file, "key_file": configuration.key_file, + "ca_cert_data": configuration.ca_cert_data, } if configuration.assert_hostname is not None: pool_args["assert_hostname"] = configuration.assert_hostname @@ -212,7 +213,9 @@ def request( headers=headers, preload_content=False, ) - elif headers["Content-Type"] == "text/plain" and isinstance(body, bool): + elif headers["Content-Type"].startswith("text/") and isinstance( + body, bool + ): request_body = "true" if body else "false" r = self.pool_manager.request( method, diff --git a/examples/AccountCreate.py b/examples/AccountCreateExample.py similarity index 52% rename from examples/AccountCreate.py rename to examples/AccountCreateExample.py index 6bdaebb..f911a89 100644 --- a/examples/AccountCreate.py +++ b/examples/AccountCreateExample.py @@ -1,23 +1,24 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountCreateRequest( + account_create_request = models.AccountCreateRequest( email_address="newuser@dropboxsign.com", ) try: - response = account_api.account_create(data) + response = api.AccountApi(api_client).account_create( + account_create_request=account_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_create: %s\n" % e) diff --git a/examples/AccountCreateOauthExample.py b/examples/AccountCreateOauthExample.py new file mode 100644 index 0000000..8930f04 --- /dev/null +++ b/examples/AccountCreateOauthExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + account_create_request = models.AccountCreateRequest( + email_address="newuser@dropboxsign.com", + client_id="cc91c61d00f8bb2ece1428035716b", + client_secret="1d14434088507ffa390e6f5528465", + ) + + try: + response = api.AccountApi(api_client).account_create( + account_create_request=account_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling AccountApi#account_create: %s\n" % e) diff --git a/examples/TeamInfo.py b/examples/AccountGetExample.py similarity index 54% rename from examples/TeamInfo.py rename to examples/AccountGetExample.py index fe54802..d7e910d 100644 --- a/examples/TeamInfo.py +++ b/examples/AccountGetExample.py @@ -1,19 +1,18 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - try: - response = team_api.team_info() + response = api.AccountApi(api_client).account_get() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_get: %s\n" % e) diff --git a/examples/AccountUpdate.py b/examples/AccountUpdateExample.py similarity index 51% rename from examples/AccountUpdate.py rename to examples/AccountUpdateExample.py index d1cf4a4..5ef5466 100644 --- a/examples/AccountUpdate.py +++ b/examples/AccountUpdateExample.py @@ -1,23 +1,25 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountUpdateRequest( + account_update_request = models.AccountUpdateRequest( callback_url="https://www.example.com/callback", + locale="en-US", ) try: - response = account_api.account_update(data) + response = api.AccountApi(api_client).account_update( + account_update_request=account_update_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_update: %s\n" % e) diff --git a/examples/AccountVerify.py b/examples/AccountVerifyExample.py similarity index 52% rename from examples/AccountVerify.py rename to examples/AccountVerifyExample.py index 0e95fa2..65bdb80 100644 --- a/examples/AccountVerify.py +++ b/examples/AccountVerifyExample.py @@ -1,23 +1,24 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountVerifyRequest( + account_verify_request = models.AccountVerifyRequest( email_address="some_user@dropboxsign.com", ) try: - response = account_api.account_verify(data) + response = api.AccountApi(api_client).account_verify( + account_verify_request=account_verify_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_verify: %s\n" % e) diff --git a/examples/ApiAppCreate.py b/examples/ApiAppCreateExample.py similarity index 55% rename from examples/ApiAppCreate.py rename to examples/ApiAppCreateExample.py index 634057b..345edd0 100644 --- a/examples/ApiAppCreate.py +++ b/examples/ApiAppCreateExample.py @@ -1,20 +1,21 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - oauth = models.SubOAuth( callback_url="https://example.com/oauth", - scopes=["basic_account_info" "request_signature"], + scopes=[ + "basic_account_info", + "request_signature", + ], ) white_labeling_options = models.SubWhiteLabelingOptions( @@ -22,18 +23,21 @@ primary_button_text_color="#ffffff", ) - custom_logo_file = open("./CustomLogoFile.png", "rb") - - data = models.ApiAppCreateRequest( + api_app_create_request = models.ApiAppCreateRequest( name="My Production App", - domains=["example.com"], + domains=[ + "example.com", + ], + custom_logo_file=open("CustomLogoFile.png", "rb").read(), oauth=oauth, white_labeling_options=white_labeling_options, - custom_logo_file=custom_logo_file, ) try: - response = api_app_api.api_app_create(data) + response = api.ApiAppApi(api_client).api_app_create( + api_app_create_request=api_app_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_create: %s\n" % e) diff --git a/examples/ApiAppDelete.py b/examples/ApiAppDelete.py deleted file mode 100644 index 3733306..0000000 --- a/examples/ApiAppDelete.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - - try: - api_app_api.api_app_delete(client_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppDeleteExample.py b/examples/ApiAppDeleteExample.py new file mode 100644 index 0000000..bcfe5d6 --- /dev/null +++ b/examples/ApiAppDeleteExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.ApiAppApi(api_client).api_app_delete( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + ) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_delete: %s\n" % e) diff --git a/examples/ApiAppGet.py b/examples/ApiAppGet.py deleted file mode 100644 index 07330bf..0000000 --- a/examples/ApiAppGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - - try: - response = api_app_api.api_app_get(client_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/AccountGet.py b/examples/ApiAppGetExample.py similarity index 50% rename from examples/AccountGet.py rename to examples/ApiAppGetExample.py index 659cb62..0eee76c 100644 --- a/examples/AccountGet.py +++ b/examples/ApiAppGetExample.py @@ -1,19 +1,20 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - try: - response = account_api.account_get(email_address="jack@example.com") + response = api.ApiAppApi(api_client).api_app_get( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_get: %s\n" % e) diff --git a/examples/ApiAppList.py b/examples/ApiAppList.py deleted file mode 100644 index 6c6ada0..0000000 --- a/examples/ApiAppList.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - page = 1 - page_size = 2 - - try: - response = api_app_api.api_app_list( - page=page, - page_size=page_size, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppListExample.py b/examples/ApiAppListExample.py new file mode 100644 index 0000000..c0bca67 --- /dev/null +++ b/examples/ApiAppListExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.ApiAppApi(api_client).api_app_list( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_list: %s\n" % e) diff --git a/examples/ApiAppUpdate.py b/examples/ApiAppUpdate.py deleted file mode 100644 index 97ea065..0000000 --- a/examples/ApiAppUpdate.py +++ /dev/null @@ -1,35 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - white_labeling_options = models.SubWhiteLabelingOptions( - primary_button_color="#00b3e6", - primary_button_text_color="#ffffff", - ) - - custom_logo_file = open("./CustomLogoFile.png", "rb") - - data = models.ApiAppUpdateRequest( - name="New Name", - callback_url="http://example.com/dropboxsign", - white_labeling_options=white_labeling_options, - custom_logo_file=custom_logo_file, - ) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - - try: - response = api_app_api.api_app_update(client_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppUpdateExample.py b/examples/ApiAppUpdateExample.py new file mode 100644 index 0000000..0021219 --- /dev/null +++ b/examples/ApiAppUpdateExample.py @@ -0,0 +1,45 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + oauth = models.SubOAuth( + callback_url="https://example.com/oauth", + scopes=[ + "basic_account_info", + "request_signature", + ], + ) + + white_labeling_options = models.SubWhiteLabelingOptions( + primary_button_color="#00b3e6", + primary_button_text_color="#ffffff", + ) + + api_app_update_request = models.ApiAppUpdateRequest( + callback_url="https://example.com/dropboxsign", + name="New Name", + domains=[ + "example.com", + ], + custom_logo_file=open("CustomLogoFile.png", "rb").read(), + oauth=oauth, + white_labeling_options=white_labeling_options, + ) + + try: + response = api.ApiAppApi(api_client).api_app_update( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + api_app_update_request=api_app_update_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_update: %s\n" % e) diff --git a/examples/BulkSendJobGet.py b/examples/BulkSendJobGet.py deleted file mode 100644 index ed92e97..0000000 --- a/examples/BulkSendJobGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - bulk_send_job_api = apis.BulkSendJobApi(api_client) - - bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174" - - try: - response = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/BulkSendJobGetExample.py b/examples/BulkSendJobGetExample.py new file mode 100644 index 0000000..58b8657 --- /dev/null +++ b/examples/BulkSendJobGetExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.BulkSendJobApi(api_client).bulk_send_job_get( + bulk_send_job_id="6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling BulkSendJobApi#bulk_send_job_get: %s\n" % e) diff --git a/examples/BulkSendJobList.py b/examples/BulkSendJobList.py deleted file mode 100644 index 61bf511..0000000 --- a/examples/BulkSendJobList.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - bulk_send_job_api = apis.BulkSendJobApi(api_client) - - page = 1 - page_size = 20 - - try: - response = bulk_send_job_api.bulk_send_job_list( - page=page, - page_size=page_size, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/BulkSendJobListExample.py b/examples/BulkSendJobListExample.py new file mode 100644 index 0000000..cb688f2 --- /dev/null +++ b/examples/BulkSendJobListExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.BulkSendJobApi(api_client).bulk_send_job_list( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling BulkSendJobApi#bulk_send_job_list: %s\n" % e) diff --git a/examples/EmbeddedEditUrl.py b/examples/EmbeddedEditUrl.py deleted file mode 100644 index dd65723..0000000 --- a/examples/EmbeddedEditUrl.py +++ /dev/null @@ -1,26 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - embedded_api = apis.EmbeddedApi(api_client) - - data = models.EmbeddedEditUrlRequest( - cc_roles=[""], - merge_fields=[], - ) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = embedded_api.embedded_edit_url(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/EmbeddedEditUrlExample.py b/examples/EmbeddedEditUrlExample.py new file mode 100644 index 0000000..90e9127 --- /dev/null +++ b/examples/EmbeddedEditUrlExample.py @@ -0,0 +1,30 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + merge_fields = [] + + embedded_edit_url_request = models.EmbeddedEditUrlRequest( + cc_roles=[ + "", + ], + merge_fields=merge_fields, + ) + + try: + response = api.EmbeddedApi(api_client).embedded_edit_url( + template_id="f57db65d3f933b5316d398057a36176831451a35", + embedded_edit_url_request=embedded_edit_url_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling EmbeddedApi#embedded_edit_url: %s\n" % e) diff --git a/examples/EmbeddedSignUrl.py b/examples/EmbeddedSignUrl.py deleted file mode 100644 index 64d5c20..0000000 --- a/examples/EmbeddedSignUrl.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - embedded_api = apis.EmbeddedApi(api_client) - - signature_id = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" - - try: - response = embedded_api.embedded_sign_url(signature_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/EmbeddedSignUrlExample.py b/examples/EmbeddedSignUrlExample.py new file mode 100644 index 0000000..903945d --- /dev/null +++ b/examples/EmbeddedSignUrlExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.EmbeddedApi(api_client).embedded_sign_url( + signature_id="50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling EmbeddedApi#embedded_sign_url: %s\n" % e) diff --git a/examples/EventCallback.py b/examples/EventCallbackExample.py similarity index 100% rename from examples/EventCallback.py rename to examples/EventCallbackExample.py diff --git a/examples/FaxDelete.py b/examples/FaxDelete.py deleted file mode 100644 index adf2a5d..0000000 --- a/examples/FaxDelete.py +++ /dev/null @@ -1,16 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - try: - fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxDeleteExample.py b/examples/FaxDeleteExample.py new file mode 100644 index 0000000..76774d7 --- /dev/null +++ b/examples/FaxDeleteExample.py @@ -0,0 +1,17 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + api.FaxApi(api_client).fax_delete( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print("Exception when calling FaxApi#fax_delete: %s\n" % e) diff --git a/examples/FaxFiles.py b/examples/FaxFiles.py deleted file mode 100644 index 110a0f7..0000000 --- a/examples/FaxFiles.py +++ /dev/null @@ -1,19 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = fax_api.fax_files(fax_id) - open("file_response.pdf", "wb").write(response.read()) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxFilesExample.py b/examples/FaxFilesExample.py new file mode 100644 index 0000000..4bc18d6 --- /dev/null +++ b/examples/FaxFilesExample.py @@ -0,0 +1,19 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxApi(api_client).fax_files( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling FaxApi#fax_files: %s\n" % e) diff --git a/examples/FaxGet.py b/examples/FaxGetExample.py similarity index 50% rename from examples/FaxGet.py rename to examples/FaxGetExample.py index c566568..e1288e6 100644 --- a/examples/FaxGet.py +++ b/examples/FaxGetExample.py @@ -1,19 +1,19 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = fax_api.fax_get(fax_id) + response = api.FaxApi(api_client).fax_get( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_get: %s\n" % e) diff --git a/examples/FaxLineAddUser.py b/examples/FaxLineAddUser.py deleted file mode 100644 index cf5ecea..0000000 --- a/examples/FaxLineAddUser.py +++ /dev/null @@ -1,22 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineAddUserRequest( - number="[FAX_NUMBER]", - email_address="member@dropboxsign.com", - ) - - try: - response = fax_line_api.fax_line_add_user(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineRemoveUser.py b/examples/FaxLineAddUserExample.py similarity index 50% rename from examples/FaxLineRemoveUser.py rename to examples/FaxLineAddUserExample.py index d692950..255ac24 100644 --- a/examples/FaxLineRemoveUser.py +++ b/examples/FaxLineAddUserExample.py @@ -1,22 +1,24 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineRemoveUserRequest( + fax_line_add_user_request = models.FaxLineAddUserRequest( number="[FAX_NUMBER]", email_address="member@dropboxsign.com", ) try: - response = fax_line_api.fax_line_remove_user(data) + response = api.FaxLineApi(api_client).fax_line_add_user( + fax_line_add_user_request=fax_line_add_user_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_add_user: %s\n" % e) diff --git a/examples/FaxLineAreaCodeGetExample.py b/examples/FaxLineAreaCodeGetExample.py new file mode 100644 index 0000000..52310c7 --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.py @@ -0,0 +1,19 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxLineApi(api_client).fax_line_area_code_get( + country="US", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_area_code_get: %s\n" % e) diff --git a/examples/FaxLineCreate.py b/examples/FaxLineCreate.py deleted file mode 100644 index bcbd585..0000000 --- a/examples/FaxLineCreate.py +++ /dev/null @@ -1,22 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineCreateRequest( - area_code=209, - country="US", - ) - - try: - response = fax_line_api.fax_line_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineCreateExample.py b/examples/FaxLineCreateExample.py new file mode 100644 index 0000000..3f7be12 --- /dev/null +++ b/examples/FaxLineCreateExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_create_request = models.FaxLineCreateRequest( + area_code=209, + country="US", + ) + + try: + response = api.FaxLineApi(api_client).fax_line_create( + fax_line_create_request=fax_line_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_create: %s\n" % e) diff --git a/examples/FaxLineDelete.py b/examples/FaxLineDelete.py deleted file mode 100644 index 0603039..0000000 --- a/examples/FaxLineDelete.py +++ /dev/null @@ -1,20 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineDeleteRequest( - number="[FAX_NUMBER]", - ) - - try: - fax_line_api.fax_line_delete(data) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineDeleteExample.py b/examples/FaxLineDeleteExample.py new file mode 100644 index 0000000..e5e7c23 --- /dev/null +++ b/examples/FaxLineDeleteExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_delete_request = models.FaxLineDeleteRequest( + number="[FAX_NUMBER]", + ) + + try: + api.FaxLineApi(api_client).fax_line_delete( + fax_line_delete_request=fax_line_delete_request, + ) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_delete: %s\n" % e) diff --git a/examples/FaxLineGet.py b/examples/FaxLineGetExample.py similarity index 52% rename from examples/FaxLineGet.py rename to examples/FaxLineGetExample.py index f550474..56d2a20 100644 --- a/examples/FaxLineGet.py +++ b/examples/FaxLineGetExample.py @@ -1,17 +1,19 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_get("[FAX_NUMBER]") + response = api.FaxLineApi(api_client).fax_line_get( + number="123-123-1234", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_get: %s\n" % e) diff --git a/examples/FaxLineListExample.py b/examples/FaxLineListExample.py new file mode 100644 index 0000000..5e3822e --- /dev/null +++ b/examples/FaxLineListExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxLineApi(api_client).fax_line_list( + account_id="ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_list: %s\n" % e) diff --git a/examples/FaxLineRemoveUserExample.py b/examples/FaxLineRemoveUserExample.py new file mode 100644 index 0000000..366957b --- /dev/null +++ b/examples/FaxLineRemoveUserExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_remove_user_request = models.FaxLineRemoveUserRequest( + number="[FAX_NUMBER]", + email_address="member@dropboxsign.com", + ) + + try: + response = api.FaxLineApi(api_client).fax_line_remove_user( + fax_line_remove_user_request=fax_line_remove_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_remove_user: %s\n" % e) diff --git a/examples/FaxList.py b/examples/FaxList.py deleted file mode 100644 index 6b71f79..0000000 --- a/examples/FaxList.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - page = 1 - page_size = 2 - - try: - response = fax_api.fax_list( - page=page, - page_size=page_size, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineAreaCodeGet.py b/examples/FaxListExample.py similarity index 52% rename from examples/FaxLineAreaCodeGet.py rename to examples/FaxListExample.py index f001c02..44f840a 100644 --- a/examples/FaxLineAreaCodeGet.py +++ b/examples/FaxListExample.py @@ -1,17 +1,20 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_area_code_get("US", "CA") + response = api.FaxApi(api_client).fax_list( + page=1, + page_size=20, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_list: %s\n" % e) diff --git a/examples/FaxSend.py b/examples/FaxSendExample.py similarity index 59% rename from examples/FaxSend.py rename to examples/FaxSendExample.py index c24d6ad..77fbf8b 100644 --- a/examples/FaxSend.py +++ b/examples/FaxSendExample.py @@ -1,28 +1,32 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - data = models.FaxSendRequest( - files=[open("example_signature_request.pdf", "rb")], - test_mode=True, + fax_send_request = models.FaxSendRequest( recipient="16690000001", sender="16690000000", + test_mode=True, cover_page_to="Jill Fax", - cover_page_message="I'm sending you a fax!", cover_page_from="Faxer Faxerson", + cover_page_message="I'm sending you a fax!", title="This is what the fax is about!", + files=[ + open("./example_fax.pdf", "rb").read(), + ], ) try: - response = fax_api.fax_send(data) + response = api.FaxApi(api_client).fax_send( + fax_send_request=fax_send_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_send: %s\n" % e) diff --git a/examples/OauthTokenGenerate.py b/examples/OauthTokenGenerateExample.py similarity index 50% rename from examples/OauthTokenGenerate.py rename to examples/OauthTokenGenerateExample.py index abe76c7..0c541ed 100644 --- a/examples/OauthTokenGenerate.py +++ b/examples/OauthTokenGenerateExample.py @@ -1,21 +1,25 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration() with ApiClient(configuration) as api_client: - oauth_api = apis.OAuthApi(api_client) - - data = models.OAuthTokenGenerateRequest( - state="900e06e2", - code="1b0d28d90c86c141", + o_auth_token_generate_request = models.OAuthTokenGenerateRequest( client_id="cc91c61d00f8bb2ece1428035716b", client_secret="1d14434088507ffa390e6f5528465", + code="1b0d28d90c86c141", + state="900e06e2", + grant_type="authorization_code", ) try: - response = oauth_api.oauth_token_generate(data) + response = api.OAuthApi(api_client).oauth_token_generate( + o_auth_token_generate_request=o_auth_token_generate_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling OAuthApi#oauth_token_generate: %s\n" % e) diff --git a/examples/OauthTokenRefresh.py b/examples/OauthTokenRefresh.py deleted file mode 100644 index fb6d5e3..0000000 --- a/examples/OauthTokenRefresh.py +++ /dev/null @@ -1,18 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration() - -with ApiClient(configuration) as api_client: - oauth_api = apis.OAuthApi(api_client) - - data = models.OAuthTokenRefreshRequest( - refresh_token="hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", - ) - - try: - response = oauth_api.oauth_token_refresh(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/OauthTokenRefreshExample.py b/examples/OauthTokenRefreshExample.py new file mode 100644 index 0000000..c359591 --- /dev/null +++ b/examples/OauthTokenRefreshExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration() + +with ApiClient(configuration) as api_client: + o_auth_token_refresh_request = models.OAuthTokenRefreshRequest( + grant_type="refresh_token", + refresh_token="hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", + ) + + try: + response = api.OAuthApi(api_client).oauth_token_refresh( + o_auth_token_refresh_request=o_auth_token_refresh_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling OAuthApi#oauth_token_refresh: %s\n" % e) diff --git a/examples/ReportCreate.py b/examples/ReportCreate.py deleted file mode 100644 index e736c4a..0000000 --- a/examples/ReportCreate.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - report_api = apis.ReportApi(api_client) - - data = models.ReportCreateRequest( - start_date="09/01/2020", - end_date="09/01/2020", - report_type=["user_activity" "document_status"], - ) - - try: - response = report_api.report_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ReportCreateExample.py b/examples/ReportCreateExample.py new file mode 100644 index 0000000..cfcc85d --- /dev/null +++ b/examples/ReportCreateExample.py @@ -0,0 +1,28 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + report_create_request = models.ReportCreateRequest( + start_date="09/01/2020", + end_date="09/01/2020", + report_type=[ + "user_activity", + "document_status", + ], + ) + + try: + response = api.ReportApi(api_client).report_create( + report_create_request=report_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ReportApi#report_create: %s\n" % e) diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py deleted file mode 100644 index 71bcd0b..0000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py +++ /dev/null @@ -1,72 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_list_1_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="George", - email_address="george@example.com", - pin="d79a3td", - ) - - signer_list_1_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="ABC Corp", - ) - - signer_list_1 = models.SubBulkSignerList( - signers=[signer_list_1_signer], - custom_fields=[signer_list_1_custom_fields], - ) - - signer_list_2_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="Mary", - email_address="mary@example.com", - pin="gd9as5b", - ) - - signer_list_2_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="123 LLC", - ) - - signer_list_2 = models.SubBulkSignerList( - signers=[signer_list_2_signer], - custom_fields=[signer_list_2_custom_fields], - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - data = models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest( - client_id="1a659d9ad95bccd307ecad78d72192f8", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signer_list=[signer_list_1, signer_list_2], - ccs=[cc_1], - test_mode=True, - ) - - try: - response = ( - signature_request_api.signature_request_bulk_create_embedded_with_template( - data - ) - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py new file mode 100644 index 0000000..4a0b11b --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,102 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + signer_list_2_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="123 LLC", + ) + + signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, + ] + + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", + ) + + signer_list_2_signers = [ + signer_list_2_signers_1, + ] + + signer_list_1_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="ABC Corp", + ) + + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] + + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + pin="d79a3td", + ) + + signer_list_1_signers = [ + signer_list_1_signers_1, + ] + + signer_list_1 = models.SubBulkSignerList( + custom_fields=signer_list_1_custom_fields, + signers=signer_list_1_signers, + ) + + signer_list_2 = models.SubBulkSignerList( + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, + ) + + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + signature_request_bulk_create_embedded_with_template_request = ( + models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest( + client_id="1a659d9ad95bccd307ecad78d72192f8", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signer_list=signer_list, + ccs=ccs, + ) + ) + + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_bulk_create_embedded_with_template( + signature_request_bulk_create_embedded_with_template_request=signature_request_bulk_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: %s\n" + % e + ) diff --git a/examples/SignatureRequestBulkSendWithTemplate.py b/examples/SignatureRequestBulkSendWithTemplate.py deleted file mode 100644 index f120679..0000000 --- a/examples/SignatureRequestBulkSendWithTemplate.py +++ /dev/null @@ -1,67 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_list_1_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="George", - email_address="george@example.com", - pin="d79a3td", - ) - - signer_list_1_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="ABC Corp", - ) - - signer_list_1 = models.SubBulkSignerList( - signers=[signer_list_1_signer], - custom_fields=[signer_list_1_custom_fields], - ) - - signer_list_2_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="Mary", - email_address="mary@example.com", - pin="gd9as5b", - ) - - signer_list_2_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="123 LLC", - ) - - signer_list_2 = models.SubBulkSignerList( - signers=[signer_list_2_signer], - custom_fields=[signer_list_2_custom_fields], - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - data = models.SignatureRequestBulkSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signer_list=[signer_list_1, signer_list_2], - ccs=[cc_1], - test_mode=True, - ) - - try: - response = signature_request_api.signature_request_bulk_send_with_template(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.py b/examples/SignatureRequestBulkSendWithTemplateExample.py new file mode 100644 index 0000000..d83b191 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.py @@ -0,0 +1,102 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signer_list_2_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="123 LLC", + ) + + signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, + ] + + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", + ) + + signer_list_2_signers = [ + signer_list_2_signers_1, + ] + + signer_list_1_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="ABC Corp", + ) + + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] + + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + pin="d79a3td", + ) + + signer_list_1_signers = [ + signer_list_1_signers_1, + ] + + signer_list_1 = models.SubBulkSignerList( + custom_fields=signer_list_1_custom_fields, + signers=signer_list_1_signers, + ) + + signer_list_2 = models.SubBulkSignerList( + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, + ) + + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + signature_request_bulk_send_with_template_request = ( + models.SignatureRequestBulkSendWithTemplateRequest( + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signer_list=signer_list, + ccs=ccs, + ) + ) + + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_bulk_send_with_template( + signature_request_bulk_send_with_template_request=signature_request_bulk_send_with_template_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: %s\n" + % e + ) diff --git a/examples/SignatureRequestCancel.py b/examples/SignatureRequestCancel.py deleted file mode 100644 index 5330623..0000000 --- a/examples/SignatureRequestCancel.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - signature_request_api.signature_request_cancel(signature_request_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestCancelExample.py b/examples/SignatureRequestCancelExample.py new file mode 100644 index 0000000..ccc4312 --- /dev/null +++ b/examples/SignatureRequestCancelExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.SignatureRequestApi(api_client).signature_request_cancel( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_cancel: %s\n" + % e + ) diff --git a/examples/SignatureRequestCreateEmbedded.py b/examples/SignatureRequestCreateEmbedded.py deleted file mode 100644 index d35615c..0000000 --- a/examples/SignatureRequestCreateEmbedded.py +++ /dev/null @@ -1,51 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestCreateEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - title="NDA with Acme Co.", - 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.", - signers=[signer_1, signer_2], - cc_email_addresses=["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"], - files=[open("example_signature_request.pdf", "rb")], - signing_options=signing_options, - test_mode=True, - ) - - try: - response = signature_request_api.signature_request_create_embedded(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/UnclaimedDraftCreate.py b/examples/SignatureRequestCreateEmbeddedExample.py similarity index 50% rename from examples/UnclaimedDraftCreate.py rename to examples/SignatureRequestCreateEmbeddedExample.py index 3ae3016..6ded13b 100644 --- a/examples/UnclaimedDraftCreate.py +++ b/examples/SignatureRequestCreateEmbeddedExample.py @@ -1,62 +1,67 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) - signer_1 = models.SubUnclaimedDraftSigner( - email_address="jack@example.com", + signers_1 = models.SubSignatureRequestSigner( name="Jack", + email_address="jack@example.com", order=0, ) - signer_2 = models.SubUnclaimedDraftSigner( - email_address="jill@example.com", + signers_2 = models.SubSignatureRequestSigner( name="Jill", + email_address="jill@example.com", order=1, ) - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) + signers = [ + signers_1, + signers_2, + ] - data = models.UnclaimedDraftCreateRequest( + signature_request_create_embedded_request = models.SignatureRequestCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", subject="The NDA we talked about", - type="request_signature", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], + test_mode=True, + title="NDA with Acme Co.", cc_email_addresses=[ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], signing_options=signing_options, - field_options=field_options, - test_mode=True, + signers=signers, ) try: - response = unclaimed_draft_api.unclaimed_draft_create(data) + response = api.SignatureRequestApi( + api_client + ).signature_request_create_embedded( + signature_request_create_embedded_request=signature_request_create_embedded_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_create_embedded: %s\n" + % e + ) diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py new file mode 100644 index 0000000..4b18d40 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py @@ -0,0 +1,97 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_create_embedded_request = models.SignatureRequestCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_create_embedded( + signature_request_create_embedded_request=signature_request_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_create_embedded: %s\n" + % e + ) diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.py b/examples/SignatureRequestCreateEmbeddedWithTemplate.py deleted file mode 100644 index 1b60db4..0000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.py +++ /dev/null @@ -1,45 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="jack@example.com", - name="Jack", - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestCreateEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - signing_options=signing_options, - test_mode=True, - ) - - try: - response = ( - signature_request_api.signature_request_create_embedded_with_template(data) - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py new file mode 100644 index 0000000..b252818 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,57 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + signature_request_create_embedded_with_template_request = ( + models.SignatureRequestCreateEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ) + ) + + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_create_embedded_with_template( + signature_request_create_embedded_with_template_request=signature_request_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: %s\n" + % e + ) diff --git a/examples/SignatureRequestEditEmbedded.py b/examples/SignatureRequestEditEmbedded.py deleted file mode 100644 index 1bbac3c..0000000 --- a/examples/SignatureRequestEditEmbedded.py +++ /dev/null @@ -1,55 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestEditEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - title="NDA with Acme Co.", - 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.", - signers=[signer_1, signer_2], - cc_email_addresses=["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"], - files=[open("example_signature_request.pdf", "rb")], - signing_options=signing_options, - test_mode=True, - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_edit_embedded( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbeddedExample.py b/examples/SignatureRequestEditEmbeddedExample.py new file mode 100644 index 0000000..b623c40 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.py @@ -0,0 +1,66 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_edit_embedded_request = models.SignatureRequestEditEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_edit_embedded: %s\n" + % e + ) diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py new file mode 100644 index 0000000..a0c9665 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py @@ -0,0 +1,96 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_edit_embedded_request = models.SignatureRequestEditEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_edit_embedded: %s\n" + % e + ) diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.py b/examples/SignatureRequestEditEmbeddedWithTemplate.py deleted file mode 100644 index 2e0be01..0000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.py +++ /dev/null @@ -1,47 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="jack@example.com", - name="Jack", - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestEditEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - signing_options=signing_options, - test_mode=True, - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_edit_embedded_with_template( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.py b/examples/SignatureRequestEditEmbeddedWithTemplateExample.py new file mode 100644 index 0000000..308eb5a --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.py @@ -0,0 +1,58 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + signature_request_edit_embedded_with_template_request = ( + models.SignatureRequestEditEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ) + ) + + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_edit_embedded_with_template( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_with_template_request=signature_request_edit_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: %s\n" + % e + ) diff --git a/examples/SignatureRequestSend.py b/examples/SignatureRequestEditExample.py similarity index 51% rename from examples/SignatureRequestSend.py rename to examples/SignatureRequestEditExample.py index 74a624e..08cc2c5 100644 --- a/examples/SignatureRequestSend.py +++ b/examples/SignatureRequestEditExample.py @@ -1,62 +1,78 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", ) signing_options = models.SubSigningOptions( + default_type="draw", draw=True, + phone=False, type=True, upload=True, - phone=True, - default_type="draw", ) - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, ) - data = models.SignatureRequestSendRequest( - title="NDA with Acme Co.", + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_edit_request = models.SignatureRequestEditRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", 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.", - signers=[signer_1, signer_2], + test_mode=True, + title="NDA with Acme Co.", cc_email_addresses=[ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + metadata=json.loads( + """ + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """ + ), field_options=field_options, - test_mode=True, + signing_options=signing_options, + signers=signers, ) try: - response = signature_request_api.signature_request_send(data) + response = api.SignatureRequestApi(api_client).signature_request_edit( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request=signature_request_edit_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_edit: %s\n" + % e + ) diff --git a/examples/SignatureRequestEditGroupedSignersExample.py b/examples/SignatureRequestEditGroupedSignersExample.py new file mode 100644 index 0000000..01e81f7 --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.py @@ -0,0 +1,108 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_edit_request = models.SignatureRequestEditRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata=json.loads( + """ + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """ + ), + field_options=field_options, + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request=signature_request_edit_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_edit: %s\n" + % e + ) diff --git a/examples/SignatureRequestEditWithTemplate.py b/examples/SignatureRequestEditWithTemplate.py deleted file mode 100644 index 399b516..0000000 --- a/examples/SignatureRequestEditWithTemplate.py +++ /dev/null @@ -1,60 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="george@example.com", - name="George", - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - custom_field_1 = models.SubCustomField( - name="Cost", - value="$20,000", - editor="Client", - required=True, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) - - data = models.SignatureRequestSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - ccs=[cc_1], - custom_fields=[custom_field_1], - signing_options=signing_options, - test_mode=True, - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_edit_with_template( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestEditWithTemplateExample.py b/examples/SignatureRequestEditWithTemplateExample.py new file mode 100644 index 0000000..e39b55b --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.py @@ -0,0 +1,79 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + custom_fields_1 = models.SubCustomField( + name="Cost", + editor="Client", + required=True, + value="$20,000", + ) + + custom_fields = [ + custom_fields_1, + ] + + signature_request_edit_with_template_request = ( + models.SignatureRequestEditWithTemplateRequest( + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ccs=ccs, + custom_fields=custom_fields, + ) + ) + + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_edit_with_template( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_with_template_request=signature_request_edit_with_template_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_edit_with_template: %s\n" + % e + ) diff --git a/examples/SignatureRequestFiles.py b/examples/SignatureRequestFiles.py deleted file mode 100644 index 1c32d32..0000000 --- a/examples/SignatureRequestFiles.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_files( - signature_request_id, file_type="pdf" - ) - open("file_response.pdf", "wb").write(response.read()) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestFilesAsDataUri.py b/examples/SignatureRequestFilesAsDataUri.py deleted file mode 100644 index 46bb015..0000000 --- a/examples/SignatureRequestFilesAsDataUri.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_files_as_data_uri( - signature_request_id - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestFilesAsDataUriExample.py b/examples/SignatureRequestFilesAsDataUriExample.py new file mode 100644 index 0000000..d13de91 --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_files_as_data_uri( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: %s\n" + % e + ) diff --git a/examples/SignatureRequestFilesAsFileUrl.py b/examples/SignatureRequestFilesAsFileUrl.py deleted file mode 100644 index 9c6a5da..0000000 --- a/examples/SignatureRequestFilesAsFileUrl.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_files_as_file_url( - signature_request_id - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestFilesAsFileUrlExample.py b/examples/SignatureRequestFilesAsFileUrlExample.py new file mode 100644 index 0000000..1969a6e --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_files_as_file_url( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + force_download=1, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_files_as_file_url: %s\n" + % e + ) diff --git a/examples/SignatureRequestFilesExample.py b/examples/SignatureRequestFilesExample.py new file mode 100644 index 0000000..cc70305 --- /dev/null +++ b/examples/SignatureRequestFilesExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_files( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + file_type="pdf", + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_files: %s\n" + % e + ) diff --git a/examples/SignatureRequestGet.py b/examples/SignatureRequestGet.py deleted file mode 100644 index 50d3409..0000000 --- a/examples/SignatureRequestGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_get(signature_request_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestGetExample.py b/examples/SignatureRequestGetExample.py new file mode 100644 index 0000000..3eb5f58 --- /dev/null +++ b/examples/SignatureRequestGetExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_get( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_get: %s\n" % e + ) diff --git a/examples/SignatureRequestList.py b/examples/SignatureRequestList.py deleted file mode 100644 index b35f92b..0000000 --- a/examples/SignatureRequestList.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - account_id = None - page = 1 - - try: - response = signature_request_api.signature_request_list( - account_id=account_id, - page=page, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestListExample.py b/examples/SignatureRequestListExample.py new file mode 100644 index 0000000..9f81fe2 --- /dev/null +++ b/examples/SignatureRequestListExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_list( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_list: %s\n" + % e + ) diff --git a/examples/SignatureRequestReleaseHold.py b/examples/SignatureRequestReleaseHold.py deleted file mode 100644 index 4f6b26a..0000000 --- a/examples/SignatureRequestReleaseHold.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_release_hold( - signature_request_id - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestReleaseHoldExample.py b/examples/SignatureRequestReleaseHoldExample.py new file mode 100644 index 0000000..fb26250 --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.py @@ -0,0 +1,23 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_release_hold( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_release_hold: %s\n" + % e + ) diff --git a/examples/SignatureRequestRemind.py b/examples/SignatureRequestRemind.py deleted file mode 100644 index 52d093f..0000000 --- a/examples/SignatureRequestRemind.py +++ /dev/null @@ -1,27 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - data = models.SignatureRequestRemindRequest( - email_address="john@example.com", - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_remind( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestRemindExample.py b/examples/SignatureRequestRemindExample.py new file mode 100644 index 0000000..48c9d38 --- /dev/null +++ b/examples/SignatureRequestRemindExample.py @@ -0,0 +1,28 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_remind_request = models.SignatureRequestRemindRequest( + email_address="john@example.com", + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_remind( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_remind_request=signature_request_remind_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_remind: %s\n" + % e + ) diff --git a/examples/SignatureRequestRemove.py b/examples/SignatureRequestRemove.py deleted file mode 100644 index 0663bf8..0000000 --- a/examples/SignatureRequestRemove.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - signature_request_api.signature_request_remove(signature_request_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestRemoveExample.py b/examples/SignatureRequestRemoveExample.py new file mode 100644 index 0000000..2f9f686 --- /dev/null +++ b/examples/SignatureRequestRemoveExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + api.SignatureRequestApi(api_client).signature_request_remove( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_remove: %s\n" + % e + ) diff --git a/examples/SignatureRequestEdit.py b/examples/SignatureRequestSendExample.py similarity index 53% rename from examples/SignatureRequestEdit.py rename to examples/SignatureRequestSendExample.py index 213bed8..fdc3256 100644 --- a/examples/SignatureRequestEdit.py +++ b/examples/SignatureRequestSendExample.py @@ -1,66 +1,77 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", ) signing_options = models.SubSigningOptions( + default_type="draw", draw=True, + phone=False, type=True, upload=True, - phone=True, - default_type="draw", ) - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, ) - data = models.SignatureRequestEditRequest( - title="NDA with Acme Co.", + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_send_request = models.SignatureRequestSendRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", 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.", - signers=[signer_1, signer_2], + test_mode=True, + title="NDA with Acme Co.", cc_email_addresses=[ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + metadata=json.loads( + """ + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """ + ), field_options=field_options, - test_mode=True, + signing_options=signing_options, + signers=signers, ) - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_edit( - signature_request_id, data + response = api.SignatureRequestApi(api_client).signature_request_send( + signature_request_send_request=signature_request_send_request, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_send: %s\n" + % e + ) diff --git a/examples/SignatureRequestSendGroupedSignersExample.py b/examples/SignatureRequestSendGroupedSignersExample.py new file mode 100644 index 0000000..1029ec2 --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_send_request = models.SignatureRequestSendRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata=json.loads( + """ + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """ + ), + field_options=field_options, + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_send( + signature_request_send_request=signature_request_send_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_send: %s\n" + % e + ) diff --git a/examples/SignatureRequestSendWithTemplate.py b/examples/SignatureRequestSendWithTemplate.py deleted file mode 100644 index 2390366..0000000 --- a/examples/SignatureRequestSendWithTemplate.py +++ /dev/null @@ -1,56 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="george@example.com", - name="George", - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - custom_field_1 = models.SubCustomField( - name="Cost", - value="$20,000", - editor="Client", - required=True, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) - - data = models.SignatureRequestSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - ccs=[cc_1], - custom_fields=[custom_field_1], - signing_options=signing_options, - test_mode=True, - ) - - try: - response = signature_request_api.signature_request_send_with_template(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestSendWithTemplateExample.py b/examples/SignatureRequestSendWithTemplateExample.py new file mode 100644 index 0000000..34c38a5 --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.py @@ -0,0 +1,78 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + custom_fields_1 = models.SubCustomField( + name="Cost", + editor="Client", + required=True, + value="$20,000", + ) + + custom_fields = [ + custom_fields_1, + ] + + signature_request_send_with_template_request = ( + models.SignatureRequestSendWithTemplateRequest( + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ccs=ccs, + custom_fields=custom_fields, + ) + ) + + try: + response = api.SignatureRequestApi( + api_client + ).signature_request_send_with_template( + signature_request_send_with_template_request=signature_request_send_with_template_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_send_with_template: %s\n" + % e + ) diff --git a/examples/SignatureRequestUpdate.py b/examples/SignatureRequestUpdate.py deleted file mode 100644 index 3690000..0000000 --- a/examples/SignatureRequestUpdate.py +++ /dev/null @@ -1,28 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - data = models.SignatureRequestUpdateRequest( - email_address="john@example.com", - signature_id="78caf2a1d01cd39cea2bc1cbb340dac3", - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_update( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestUpdateExample.py b/examples/SignatureRequestUpdateExample.py new file mode 100644 index 0000000..7121bf2 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.py @@ -0,0 +1,29 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_update_request = models.SignatureRequestUpdateRequest( + signature_id="2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", + email_address="john@example.com", + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_update( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_update_request=signature_request_update_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling SignatureRequestApi#signature_request_update: %s\n" + % e + ) diff --git a/examples/TeamAddMember.py b/examples/TeamAddMember.py deleted file mode 100644 index 67900f4..0000000 --- a/examples/TeamAddMember.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamAddMemberRequest( - email_address="george@example.com", - ) - - try: - response = team_api.team_add_member(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamAddMemberAccountIdExample.py b/examples/TeamAddMemberAccountIdExample.py new file mode 100644 index 0000000..402e0f2 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_add_member_request = models.TeamAddMemberRequest( + account_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + try: + response = api.TeamApi(api_client).team_add_member( + team_add_member_request=team_add_member_request, + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_add_member: %s\n" % e) diff --git a/examples/TeamAddMemberExample.py b/examples/TeamAddMemberExample.py new file mode 100644 index 0000000..caef04e --- /dev/null +++ b/examples/TeamAddMemberExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_add_member_request = models.TeamAddMemberRequest( + email_address="george@example.com", + ) + + try: + response = api.TeamApi(api_client).team_add_member( + team_add_member_request=team_add_member_request, + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_add_member: %s\n" % e) diff --git a/examples/TeamCreate.py b/examples/TeamCreateExample.py similarity index 52% rename from examples/TeamCreate.py rename to examples/TeamCreateExample.py index 4c13846..8877210 100644 --- a/examples/TeamCreate.py +++ b/examples/TeamCreateExample.py @@ -1,23 +1,24 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamCreateRequest( + team_create_request = models.TeamCreateRequest( name="New Team Name", ) try: - response = team_api.team_create(data) + response = api.TeamApi(api_client).team_create( + team_create_request=team_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_create: %s\n" % e) diff --git a/examples/TeamDelete.py b/examples/TeamDeleteExample.py similarity index 50% rename from examples/TeamDelete.py rename to examples/TeamDeleteExample.py index 9548749..2da2f0b 100644 --- a/examples/TeamDelete.py +++ b/examples/TeamDeleteExample.py @@ -1,16 +1,16 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - try: - team_api.team_delete() + api.TeamApi(api_client).team_delete() except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_delete: %s\n" % e) diff --git a/examples/TeamGet.py b/examples/TeamGetExample.py similarity index 54% rename from examples/TeamGet.py rename to examples/TeamGetExample.py index 7272e46..dc0b053 100644 --- a/examples/TeamGet.py +++ b/examples/TeamGetExample.py @@ -1,19 +1,18 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - try: - response = team_api.team_get() + response = api.TeamApi(api_client).team_get() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_get: %s\n" % e) diff --git a/examples/TeamInfoExample.py b/examples/TeamInfoExample.py new file mode 100644 index 0000000..994688d --- /dev/null +++ b/examples/TeamInfoExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_info( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_info: %s\n" % e) diff --git a/examples/TeamInvites.py b/examples/TeamInvites.py deleted file mode 100644 index 898e641..0000000 --- a/examples/TeamInvites.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - email_address = "user@dropboxsign.com" - - try: - response = team_api.team_invites(email_address=email_address) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineList.py b/examples/TeamInvitesExample.py similarity index 53% rename from examples/FaxLineList.py rename to examples/TeamInvitesExample.py index f868cd4..c9764ae 100644 --- a/examples/FaxLineList.py +++ b/examples/TeamInvitesExample.py @@ -1,17 +1,18 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_list() + response = api.TeamApi(api_client).team_invites() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_invites: %s\n" % e) diff --git a/examples/TeamMembers.py b/examples/TeamMembers.py deleted file mode 100644 index ed27ca8..0000000 --- a/examples/TeamMembers.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - - try: - response = team_api.team_members(team_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamMembersExample.py b/examples/TeamMembersExample.py new file mode 100644 index 0000000..92c3eba --- /dev/null +++ b/examples/TeamMembersExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_members( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_members: %s\n" % e) diff --git a/examples/TeamRemoveMemberAccountIdExample.py b/examples/TeamRemoveMemberAccountIdExample.py new file mode 100644 index 0000000..132ab54 --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_remove_member_request = models.TeamRemoveMemberRequest( + account_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + try: + response = api.TeamApi(api_client).team_remove_member( + team_remove_member_request=team_remove_member_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_remove_member: %s\n" % e) diff --git a/examples/TeamRemoveMember.py b/examples/TeamRemoveMemberExample.py similarity index 55% rename from examples/TeamRemoveMember.py rename to examples/TeamRemoveMemberExample.py index 5dfe5b0..7847d72 100644 --- a/examples/TeamRemoveMember.py +++ b/examples/TeamRemoveMemberExample.py @@ -1,24 +1,25 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamRemoveMemberRequest( + team_remove_member_request = models.TeamRemoveMemberRequest( email_address="teammate@dropboxsign.com", new_owner_email_address="new_teammate@dropboxsign.com", ) try: - response = team_api.team_remove_member(data) + response = api.TeamApi(api_client).team_remove_member( + team_remove_member_request=team_remove_member_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_remove_member: %s\n" % e) diff --git a/examples/TeamSubTeams.py b/examples/TeamSubTeams.py deleted file mode 100644 index d6f7dc1..0000000 --- a/examples/TeamSubTeams.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - - try: - response = team_api.team_sub_teams(team_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamSubTeamsExample.py b/examples/TeamSubTeamsExample.py new file mode 100644 index 0000000..93afde1 --- /dev/null +++ b/examples/TeamSubTeamsExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_sub_teams( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_sub_teams: %s\n" % e) diff --git a/examples/TeamUpdate.py b/examples/TeamUpdateExample.py similarity index 52% rename from examples/TeamUpdate.py rename to examples/TeamUpdateExample.py index b89ef11..e28eb29 100644 --- a/examples/TeamUpdate.py +++ b/examples/TeamUpdateExample.py @@ -1,23 +1,24 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamUpdateRequest( + team_update_request = models.TeamUpdateRequest( name="New Team Name", ) try: - response = team_api.team_update(data) + response = api.TeamApi(api_client).team_update( + team_update_request=team_update_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_update: %s\n" % e) diff --git a/examples/TemplateAddUser.py b/examples/TemplateAddUser.py deleted file mode 100644 index 5476f8e..0000000 --- a/examples/TemplateAddUser.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateAddUserRequest( - email_address="george@dropboxsign.com", - ) - - template_id = "f57db65d3f933b5316d398057a36176831451a35" - - try: - response = template_api.template_add_user(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateAddUserExample.py b/examples/TemplateAddUserExample.py new file mode 100644 index 0000000..5259a01 --- /dev/null +++ b/examples/TemplateAddUserExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_add_user_request = models.TemplateAddUserRequest( + email_address="george@dropboxsign.com", + ) + + try: + response = api.TemplateApi(api_client).template_add_user( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_add_user_request=template_add_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_add_user: %s\n" % e) diff --git a/examples/TemplateCreate.py b/examples/TemplateCreate.py deleted file mode 100644 index cb7b60e..0000000 --- a/examples/TemplateCreate.py +++ /dev/null @@ -1,56 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - role_1 = models.SubTemplateRole( - name="Client", - order=0, - ) - - role_2 = models.SubTemplateRole( - name="Witness", - order=1, - ) - - merge_field_1 = models.SubMergeField( - name="Full Name", - type="text", - ) - - merge_field_2 = models.SubMergeField( - name="Is Registered?", - type="checkbox", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) - - data = models.TemplateCreateRequest( - client_id="37dee8d8440c66d54cfa05d92c160882", - files=[open("example_signature_request.pdf", "rb")], - title="Test Template", - subject="Please sign this document", - message="For your approval", - signer_roles=[role_1, role_2], - cc_roles=["Manager"], - merge_fields=[merge_field_1, merge_field_2], - field_options=field_options, - test_mode=True, - ) - - try: - response = template_api.template_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraft.py b/examples/TemplateCreateEmbeddedDraft.py deleted file mode 100644 index 9b49f03..0000000 --- a/examples/TemplateCreateEmbeddedDraft.py +++ /dev/null @@ -1,56 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - role_1 = models.SubTemplateRole( - name="Client", - order=0, - ) - - role_2 = models.SubTemplateRole( - name="Witness", - order=1, - ) - - merge_field_1 = models.SubMergeField( - name="Full Name", - type="text", - ) - - merge_field_2 = models.SubMergeField( - name="Is Registered?", - type="checkbox", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) - - data = models.TemplateCreateEmbeddedDraftRequest( - client_id="37dee8d8440c66d54cfa05d92c160882", - files=[open("example_signature_request.pdf", "rb")], - title="Test Template", - subject="Please sign this document", - message="For your approval", - signer_roles=[role_1, role_2], - cc_roles=["Manager"], - merge_fields=[merge_field_1, merge_field_2], - field_options=field_options, - test_mode=True, - ) - - try: - response = template_api.template_create_embedded_draft(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraftExample.py b/examples/TemplateCreateEmbeddedDraftExample.py new file mode 100644 index 0000000..428e772 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.py @@ -0,0 +1,74 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + cc_roles=[ + "Manager", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + field_options=field_options, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling TemplateApi#template_create_embedded_draft: %s\n" + % e + ) diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py new file mode 100644 index 0000000..b2c38f0 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py @@ -0,0 +1,123 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling TemplateApi#template_create_embedded_draft: %s\n" + % e + ) diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.py b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.py new file mode 100644 index 0000000..093c5f5 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.py @@ -0,0 +1,141 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling TemplateApi#template_create_embedded_draft: %s\n" + % e + ) diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py new file mode 100644 index 0000000..05cd574 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py @@ -0,0 +1,110 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling TemplateApi#template_create_embedded_draft: %s\n" + % e + ) diff --git a/examples/TemplateCreateExample.py b/examples/TemplateCreateExample.py new file mode 100644 index 0000000..a6ed361 --- /dev/null +++ b/examples/TemplateCreateExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + cc_roles=[ + "Manager", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateCreateFormFieldGroupsExample.py b/examples/TemplateCreateFormFieldGroupsExample.py new file mode 100644 index 0000000..6a755d0 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.py @@ -0,0 +1,120 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + form_field_groups=form_field_groups, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateCreateFormFieldRulesExample.py b/examples/TemplateCreateFormFieldRulesExample.py new file mode 100644 index 0000000..a7f2d94 --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.py @@ -0,0 +1,138 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + form_field_rules=form_field_rules, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.py b/examples/TemplateCreateFormFieldsPerDocumentExample.py new file mode 100644 index 0000000..6e2185a --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateDelete.py b/examples/TemplateDelete.py deleted file mode 100644 index c87622e..0000000 --- a/examples/TemplateDelete.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - template_api.template_delete(template_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateDeleteExample.py b/examples/TemplateDeleteExample.py new file mode 100644 index 0000000..3bf63f5 --- /dev/null +++ b/examples/TemplateDeleteExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.TemplateApi(api_client).template_delete( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + except ApiException as e: + print("Exception when calling TemplateApi#template_delete: %s\n" % e) diff --git a/examples/TemplateFiles.py b/examples/TemplateFiles.py deleted file mode 100644 index 59874bc..0000000 --- a/examples/TemplateFiles.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_files(template_id, file_type="pdf") - open("file_response.pdf", "wb").write(response.read()) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateFilesAsDataUri.py b/examples/TemplateFilesAsDataUri.py deleted file mode 100644 index 9dbc44e..0000000 --- a/examples/TemplateFilesAsDataUri.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_files_as_data_uri(template_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateFilesAsDataUriExample.py b/examples/TemplateFilesAsDataUriExample.py new file mode 100644 index 0000000..ce91dc6 --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files_as_data_uri( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_files_as_data_uri: %s\n" % e) diff --git a/examples/TemplateFilesAsFileUrl.py b/examples/TemplateFilesAsFileUrl.py deleted file mode 100644 index c1a8da3..0000000 --- a/examples/TemplateFilesAsFileUrl.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_files_as_file_url(template_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateFilesAsFileUrlExample.py b/examples/TemplateFilesAsFileUrlExample.py new file mode 100644 index 0000000..052891d --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files_as_file_url( + template_id="f57db65d3f933b5316d398057a36176831451a35", + force_download=1, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_files_as_file_url: %s\n" % e) diff --git a/examples/TemplateFilesExample.py b/examples/TemplateFilesExample.py new file mode 100644 index 0000000..d1f056a --- /dev/null +++ b/examples/TemplateFilesExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling TemplateApi#template_files: %s\n" % e) diff --git a/examples/TemplateGet.py b/examples/TemplateGet.py deleted file mode 100644 index 1c41b36..0000000 --- a/examples/TemplateGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "f57db65d3f933b5316d398057a36176831451a35" - - try: - response = template_api.template_get(template_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateGetExample.py b/examples/TemplateGetExample.py new file mode 100644 index 0000000..2226f74 --- /dev/null +++ b/examples/TemplateGetExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_get( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_get: %s\n" % e) diff --git a/examples/TemplateList.py b/examples/TemplateList.py deleted file mode 100644 index 4ce779f..0000000 --- a/examples/TemplateList.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - account_id = "f57db65d3f933b5316d398057a36176831451a35" - - try: - response = template_api.template_list( - account_id=account_id, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateListExample.py b/examples/TemplateListExample.py new file mode 100644 index 0000000..429531e --- /dev/null +++ b/examples/TemplateListExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_list( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_list: %s\n" % e) diff --git a/examples/TemplateRemoveUser.py b/examples/TemplateRemoveUser.py deleted file mode 100644 index c16c4b0..0000000 --- a/examples/TemplateRemoveUser.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateRemoveUserRequest( - email_address="george@dropboxsign.com", - ) - - template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536" - - try: - response = template_api.template_remove_user(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateRemoveUserExample.py b/examples/TemplateRemoveUserExample.py new file mode 100644 index 0000000..c44814c --- /dev/null +++ b/examples/TemplateRemoveUserExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_remove_user_request = models.TemplateRemoveUserRequest( + email_address="george@dropboxsign.com", + ) + + try: + response = api.TemplateApi(api_client).template_remove_user( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_remove_user_request=template_remove_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_remove_user: %s\n" % e) diff --git a/examples/TemplateUpdateFiles.py b/examples/TemplateUpdateFiles.py deleted file mode 100644 index 341af50..0000000 --- a/examples/TemplateUpdateFiles.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateUpdateFilesRequest( - files=[open("example_signature_request.pdf", "rb")], - ) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_update_files(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateUpdateFilesExample.py b/examples/TemplateUpdateFilesExample.py new file mode 100644 index 0000000..71ab006 --- /dev/null +++ b/examples/TemplateUpdateFilesExample.py @@ -0,0 +1,27 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_update_files_request = models.TemplateUpdateFilesRequest( + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + ) + + try: + response = api.TemplateApi(api_client).template_update_files( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_update_files_request=template_update_files_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_update_files: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbedded.py b/examples/UnclaimedDraftCreateEmbedded.py deleted file mode 100644 index a5f260c..0000000 --- a/examples/UnclaimedDraftCreateEmbedded.py +++ /dev/null @@ -1,26 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - data = models.UnclaimedDraftCreateEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - files=[open("example_signature_request.pdf", "rb")], - requester_email_address="jack@dropboxsign.com", - test_mode=True, - ) - - try: - response = unclaimed_draft_api.unclaimed_draft_create_embedded(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.py b/examples/UnclaimedDraftCreateEmbeddedExample.py new file mode 100644 index 0000000..c750c86 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.py @@ -0,0 +1,34 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + unclaimed_draft_create_embedded_request = ( + models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=True, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + ) + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" + % e + ) diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py new file mode 100644 index 0000000..fcf77f4 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py @@ -0,0 +1,83 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = ( + models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + ) + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" + % e + ) diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py new file mode 100644 index 0000000..2037cbe --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py @@ -0,0 +1,101 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = ( + models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + ) + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" + % e + ) diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py new file mode 100644 index 0000000..4e40298 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py @@ -0,0 +1,70 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = ( + models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_fields_per_document=form_fields_per_document, + ) + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" + % e + ) diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py deleted file mode 100644 index c4122b1..0000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py +++ /dev/null @@ -1,41 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - signer_1 = models.SubUnclaimedDraftTemplateSigner( - role="Client", - name="George", - email_address="george@example.com", - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - data = models.UnclaimedDraftCreateEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["61a832ff0d8423f91d503e76bfbcc750f7417c78"], - requester_email_address="jack@dropboxsign.com", - signers=[signer_1], - ccs=[cc_1], - test_mode=True, - ) - - try: - response = unclaimed_draft_api.unclaimed_draft_create_embedded_with_template( - data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py new file mode 100644 index 0000000..36888e6 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,57 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@dropboxsign.com", + ) + + ccs = [ + ccs_1, + ] + + signers_1 = models.SubUnclaimedDraftTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + unclaimed_draft_create_embedded_with_template_request = ( + models.UnclaimedDraftCreateEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + test_mode=False, + ccs=ccs, + signers=signers, + ) + ) + + try: + response = api.UnclaimedDraftApi( + api_client + ).unclaimed_draft_create_embedded_with_template( + unclaimed_draft_create_embedded_with_template_request=unclaimed_draft_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: %s\n" + % e + ) diff --git a/examples/UnclaimedDraftCreateExample.py b/examples/UnclaimedDraftCreateExample.py new file mode 100644 index 0000000..29da5b0 --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.py @@ -0,0 +1,41 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signers_1 = models.SubUnclaimedDraftSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers = [ + signers_1, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=True, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signers=signers, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e + ) diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.py b/examples/UnclaimedDraftCreateFormFieldGroupsExample.py new file mode 100644 index 0000000..285bdea --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.py @@ -0,0 +1,79 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e + ) diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.py b/examples/UnclaimedDraftCreateFormFieldRulesExample.py new file mode 100644 index 0000000..5bfab83 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.py @@ -0,0 +1,97 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e + ) diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.py b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.py new file mode 100644 index 0000000..da39f6f --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.py @@ -0,0 +1,66 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e + ) diff --git a/examples/UnclaimedDraftEditAndResend.py b/examples/UnclaimedDraftEditAndResend.py deleted file mode 100644 index bbcad88..0000000 --- a/examples/UnclaimedDraftEditAndResend.py +++ /dev/null @@ -1,28 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - data = models.UnclaimedDraftEditAndResendRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - test_mode=True, - ) - - signature_request_id = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f" - - try: - response = unclaimed_draft_api.unclaimed_draft_edit_and_resend( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/UnclaimedDraftEditAndResendExample.py b/examples/UnclaimedDraftEditAndResendExample.py new file mode 100644 index 0000000..bfae153 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.py @@ -0,0 +1,29 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + unclaimed_draft_edit_and_resend_request = models.UnclaimedDraftEditAndResendRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + test_mode=False, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_edit_and_resend( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimed_draft_edit_and_resend_request=unclaimed_draft_edit_and_resend_request, + ) + + pprint(response) + except ApiException as e: + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_edit_and_resend: %s\n" + % e + ) diff --git a/openapi-config.yaml b/openapi-config.yaml index fb119ff..0e7bd04 100644 --- a/openapi-config.yaml +++ b/openapi-config.yaml @@ -2,10 +2,10 @@ generatorName: python typeMappings: "bytearray": "io.IOBase" additionalProperties: - generatorLanguageVersion: ">=3.7" + generatorLanguageVersion: ">=3.8" packageName: dropbox_sign projectName: dropbox-sign - packageVersion: 1.8.0 + packageVersion: 1.9.0 sortModelPropertiesByRequiredFlag: true legacyDiscriminatorBehavior: true packageAuthor: Dropbox Sign API Team @@ -13,6 +13,9 @@ additionalProperties: infoName: Official Python SDK for the Dropbox Sign API useCustomTemplateCode: true licenseCopyrightYear: 2024 + oseg.propertyNamingConvention: snake_case + oseg.security.api_key.username: YOUR_API_KEY + oseg.security.oauth2.access_token: YOUR_ACCESS_TOKEN files: dropbox-__init__apis.mustache: templateType: SupportingFiles diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 608b57d..c832450 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -27,12 +27,12 @@ paths: schema: $ref: '#/components/schemas/AccountCreateRequest' examples: - default_example: - $ref: '#/components/examples/AccountCreateRequestDefaultExample' - oauth: - $ref: '#/components/examples/AccountCreateRequestOAuthExample' + example: + $ref: '#/components/examples/AccountCreateRequest' + oauth_example: + $ref: '#/components/examples/AccountCreateRequestOAuth' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -46,11 +46,11 @@ paths: schema: $ref: '#/components/schemas/AccountCreateResponse' examples: - default_example: - $ref: '#/components/examples/AccountCreateResponseExample' - oauth: - $ref: '#/components/examples/AccountCreateOAuthResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountCreateResponse' + oauth_example: + $ref: '#/components/examples/AccountCreateOAuthResponse' + '4XX': description: failed_operation content: application/json: @@ -58,15 +58,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -78,42 +78,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountCreate.php + $ref: examples/AccountCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountCreate.js + $ref: examples/AccountCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountCreate.ts + $ref: examples/AccountCreateExample.ts - lang: Java label: Java source: - $ref: examples/AccountCreate.java + $ref: examples/AccountCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountCreate.rb + $ref: examples/AccountCreateExample.rb - lang: Python label: Python source: - $ref: examples/AccountCreate.py + $ref: examples/AccountCreateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountCreate.sh + $ref: examples/AccountCreateExample.sh x-meta: seo: title: 'Create Account | API Documentation | Dropbox Sign for Developers' @@ -147,7 +142,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -161,9 +156,9 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountGetResponse' + '4XX': description: failed_operation content: application/json: @@ -171,15 +166,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -192,42 +187,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountGet.php + $ref: examples/AccountGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountGet.js + $ref: examples/AccountGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountGet.ts + $ref: examples/AccountGetExample.ts - lang: Java label: Java source: - $ref: examples/AccountGet.java + $ref: examples/AccountGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountGet.rb + $ref: examples/AccountGetExample.rb - lang: Python label: Python source: - $ref: examples/AccountGet.py + $ref: examples/AccountGetExample.py - lang: cURL label: cURL source: - $ref: examples/AccountGet.sh + $ref: examples/AccountGetExample.sh x-meta: seo: title: 'Get Account | API Documentation | Dropbox Sign for Developers' @@ -245,10 +235,10 @@ paths: schema: $ref: '#/components/schemas/AccountUpdateRequest' examples: - default_example: - $ref: '#/components/examples/AccountUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/AccountUpdateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -262,9 +252,9 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -272,17 +262,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -294,42 +284,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountUpdate.php + $ref: examples/AccountUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountUpdate.js + $ref: examples/AccountUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountUpdate.ts + $ref: examples/AccountUpdateExample.ts - lang: Java label: Java source: - $ref: examples/AccountUpdate.java + $ref: examples/AccountUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountUpdate.rb + $ref: examples/AccountUpdateExample.rb - lang: Python label: Python source: - $ref: examples/AccountUpdate.py + $ref: examples/AccountUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountUpdate.sh + $ref: examples/AccountUpdateExample.sh x-meta: seo: title: 'Update Account | API Documentation | Dropbox Sign for Developers' @@ -348,10 +333,10 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyRequest' examples: - default_example: - $ref: '#/components/examples/AccountVerifyRequestDefaultExample' + example: + $ref: '#/components/examples/AccountVerifyRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -365,11 +350,11 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyResponse' examples: - default_example: - $ref: '#/components/examples/AccountVerifyFoundResponseExample' - not_found: - $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountVerifyFoundResponse' + not_found_example: + $ref: '#/components/examples/AccountVerifyNotFoundResponse' + '4XX': description: failed_operation content: application/json: @@ -377,15 +362,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -397,42 +382,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountVerify.php + $ref: examples/AccountVerifyExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountVerify.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountVerify.js + $ref: examples/AccountVerifyExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountVerify.ts + $ref: examples/AccountVerifyExample.ts - lang: Java label: Java source: - $ref: examples/AccountVerify.java + $ref: examples/AccountVerifyExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountVerify.rb + $ref: examples/AccountVerifyExample.rb - lang: Python label: Python source: - $ref: examples/AccountVerify.py + $ref: examples/AccountVerifyExample.py - lang: cURL label: cURL source: - $ref: examples/AccountVerify.sh + $ref: examples/AccountVerifyExample.sh x-meta: seo: title: 'Verify Account | API Documentation | Dropbox Sign for Developers' @@ -451,13 +431,13 @@ paths: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppCreateRequest' responses: - 201: + '201': description: 'successful operation' headers: X-RateLimit-Limit: @@ -471,9 +451,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -481,17 +461,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -503,42 +483,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppCreate.php + $ref: examples/ApiAppCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppCreate.js + $ref: examples/ApiAppCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppCreate.ts + $ref: examples/ApiAppCreateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppCreate.java + $ref: examples/ApiAppCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppCreate.rb + $ref: examples/ApiAppCreateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppCreate.py + $ref: examples/ApiAppCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppCreate.sh + $ref: examples/ApiAppCreateExample.sh x-meta: seo: title: 'Create API App | API Documentation | Dropbox Sign for Developers' @@ -560,7 +535,7 @@ paths: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -574,9 +549,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppGetResponse' + '4XX': description: failed_operation content: application/json: @@ -584,19 +559,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -608,42 +583,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppGet.php + $ref: examples/ApiAppGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppGet.js + $ref: examples/ApiAppGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppGet.ts + $ref: examples/ApiAppGetExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppGet.java + $ref: examples/ApiAppGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppGet.rb + $ref: examples/ApiAppGetExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppGet.py + $ref: examples/ApiAppGetExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppGet.sh + $ref: examples/ApiAppGetExample.sh x-meta: seo: title: 'Get API App | API Documentation | Dropbox Sign for Developers' @@ -670,13 +640,13 @@ paths: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -690,9 +660,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -700,19 +670,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -724,42 +694,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppUpdate.php + $ref: examples/ApiAppUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppUpdate.js + $ref: examples/ApiAppUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppUpdate.ts + $ref: examples/ApiAppUpdateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppUpdate.java + $ref: examples/ApiAppUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppUpdate.rb + $ref: examples/ApiAppUpdateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppUpdate.py + $ref: examples/ApiAppUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppUpdate.sh + $ref: examples/ApiAppUpdateExample.sh x-meta: seo: title: 'Update API App | API Documentation | Dropbox Sign for Developers' @@ -780,7 +745,7 @@ paths: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: - 204: + '204': description: 'successful operation' headers: X-RateLimit-Limit: @@ -789,7 +754,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -797,17 +762,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -819,42 +784,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppDelete.php + $ref: examples/ApiAppDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppDelete.js + $ref: examples/ApiAppDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppDelete.ts + $ref: examples/ApiAppDeleteExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppDelete.java + $ref: examples/ApiAppDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppDelete.rb + $ref: examples/ApiAppDeleteExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppDelete.py + $ref: examples/ApiAppDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppDelete.sh + $ref: examples/ApiAppDeleteExample.sh x-meta: seo: title: 'Delete API App | API Documentation | Dropbox Sign for Developers' @@ -882,7 +842,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -896,9 +856,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppListResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppListResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppListResponse' + '4XX': description: failed_operation content: application/json: @@ -906,15 +866,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -926,42 +886,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppList.php + $ref: examples/ApiAppListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppList.js + $ref: examples/ApiAppListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppList.ts + $ref: examples/ApiAppListExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppList.java + $ref: examples/ApiAppListExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppList.rb + $ref: examples/ApiAppListExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppList.py + $ref: examples/ApiAppListExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppList.sh + $ref: examples/ApiAppListExample.sh x-meta: seo: title: 'List API Apps | API Documentation | Dropbox Sign for Developers' @@ -997,7 +952,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1011,9 +966,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobGetResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/BulkSendJobGetResponse' + '4XX': description: failed_operation content: application/json: @@ -1021,15 +976,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1042,42 +997,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobGet.php + $ref: examples/BulkSendJobGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobGet.js + $ref: examples/BulkSendJobGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobGet.ts + $ref: examples/BulkSendJobGetExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobGet.java + $ref: examples/BulkSendJobGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobGet.rb + $ref: examples/BulkSendJobGetExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobGet.py + $ref: examples/BulkSendJobGetExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobGet.sh + $ref: examples/BulkSendJobGetExample.sh x-meta: seo: title: 'Get Bulk Send Job | API Documentation | Dropbox Sign for Developers' @@ -1105,7 +1055,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1119,9 +1069,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobListResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobListResponseExample' - 4XX: + example: + $ref: '#/components/examples/BulkSendJobListResponse' + '4XX': description: failed_operation content: application/json: @@ -1129,15 +1079,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1150,42 +1100,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobList.php + $ref: examples/BulkSendJobListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobList.js + $ref: examples/BulkSendJobListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobList.ts + $ref: examples/BulkSendJobListExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobList.java + $ref: examples/BulkSendJobListExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobList.rb + $ref: examples/BulkSendJobListExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobList.py + $ref: examples/BulkSendJobListExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobList.sh + $ref: examples/BulkSendJobListExample.sh x-meta: seo: title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' @@ -1213,10 +1158,10 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlRequest' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1230,9 +1175,9 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlResponseExample' - 4XX: + example: + $ref: '#/components/examples/EmbeddedEditUrlResponse' + '4XX': description: failed_operation content: application/json: @@ -1240,17 +1185,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1262,42 +1207,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedEditUrl.php + $ref: examples/EmbeddedEditUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedEditUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedEditUrl.js + $ref: examples/EmbeddedEditUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedEditUrl.ts + $ref: examples/EmbeddedEditUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedEditUrl.java + $ref: examples/EmbeddedEditUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedEditUrl.rb + $ref: examples/EmbeddedEditUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedEditUrl.py + $ref: examples/EmbeddedEditUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedEditUrl.sh + $ref: examples/EmbeddedEditUrlExample.sh x-meta: seo: title: 'Get Embedded Template URL | iFrame | Dropbox Sign for Developers' @@ -1319,7 +1259,7 @@ paths: type: string example: 50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1333,9 +1273,9 @@ paths: schema: $ref: '#/components/schemas/EmbeddedSignUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedSignUrlResponseExample' - 4XX: + example: + $ref: '#/components/examples/EmbeddedSignUrlResponse' + '4XX': description: failed_operation content: application/json: @@ -1343,21 +1283,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1369,42 +1309,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedSignUrl.php + $ref: examples/EmbeddedSignUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedSignUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedSignUrl.js + $ref: examples/EmbeddedSignUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedSignUrl.ts + $ref: examples/EmbeddedSignUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedSignUrl.java + $ref: examples/EmbeddedSignUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedSignUrl.rb + $ref: examples/EmbeddedSignUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedSignUrl.py + $ref: examples/EmbeddedSignUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedSignUrl.sh + $ref: examples/EmbeddedSignUrlExample.sh x-meta: seo: title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' @@ -1414,7 +1349,7 @@ paths: tags: - Fax summary: 'Get Fax' - description: 'Returns information about fax' + description: 'Returns information about a Fax' operationId: faxGet parameters: - @@ -1426,7 +1361,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1440,9 +1375,9 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxGetResponse' + '4XX': description: failed_operation content: application/json: @@ -1450,19 +1385,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1471,51 +1406,46 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxGet.php + $ref: examples/FaxGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxGet.js + $ref: examples/FaxGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxGet.ts + $ref: examples/FaxGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxGet.java + $ref: examples/FaxGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxGet.rb + $ref: examples/FaxGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxGet.py + $ref: examples/FaxGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxGet.sh + $ref: examples/FaxGetExample.sh x-meta: seo: title: 'Get Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here.' delete: tags: - Fax summary: 'Delete Fax' - description: 'Deletes the specified Fax from the system.' + description: 'Deletes the specified Fax from the system' operationId: faxDelete parameters: - @@ -1527,7 +1457,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 204: + '204': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1536,7 +1466,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1544,19 +1474,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1565,42 +1495,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxDelete.php + $ref: examples/FaxDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxDelete.js + $ref: examples/FaxDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxDelete.ts + $ref: examples/FaxDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxDelete.java + $ref: examples/FaxDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxDelete.rb + $ref: examples/FaxDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxDelete.py + $ref: examples/FaxDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxDelete.sh + $ref: examples/FaxDeleteExample.sh x-meta: seo: title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' @@ -1609,8 +1534,8 @@ paths: get: tags: - Fax - summary: 'List Fax Files' - description: 'Returns list of fax files' + summary: 'Download Fax Files' + description: 'Downloads files associated with a Fax' operationId: faxFiles parameters: - @@ -1622,7 +1547,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1636,7 +1561,7 @@ paths: schema: type: string format: binary - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1644,21 +1569,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1667,46 +1592,41 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxFiles.php + $ref: examples/FaxFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxFiles.js + $ref: examples/FaxFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxFiles.ts + $ref: examples/FaxFilesExample.ts - lang: Java label: Java source: - $ref: examples/FaxFiles.java + $ref: examples/FaxFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxFiles.rb + $ref: examples/FaxFilesExample.rb - lang: Python label: Python source: - $ref: examples/FaxFiles.py + $ref: examples/FaxFilesExample.py - lang: cURL label: cURL source: - $ref: examples/FaxFiles.sh + $ref: examples/FaxFilesExample.sh x-meta: seo: title: 'Fax Files | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here.' /fax_line/add_user: put: tags: @@ -1721,10 +1641,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineAddUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineAddUserRequestExample' + example: + $ref: '#/components/examples/FaxLineAddUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1738,9 +1658,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -1748,17 +1668,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1767,42 +1687,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAddUser.php + $ref: examples/FaxLineAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAddUser.js + $ref: examples/FaxLineAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAddUser.ts + $ref: examples/FaxLineAddUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAddUser.java + $ref: examples/FaxLineAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAddUser.rb + $ref: examples/FaxLineAddUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAddUser.py + $ref: examples/FaxLineAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAddUser.sh + $ref: examples/FaxLineAddUserExample.sh x-meta: seo: title: 'Fax Line Add User | API Documentation | Dropbox Fax for Developers' @@ -1812,13 +1727,13 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/provice and city.' + description: 'Returns a list of available area codes for a given state/province and city' operationId: faxLineAreaCodeGet parameters: - name: country in: query - description: 'Filter area codes by country.' + description: 'Filter area codes by country' required: true schema: type: string @@ -1826,10 +1741,11 @@ paths: - CA - US - UK + example: US - name: state in: query - description: 'Filter area codes by state.' + description: 'Filter area codes by state' schema: type: string enum: @@ -1887,7 +1803,7 @@ paths: - name: province in: query - description: 'Filter area codes by province.' + description: 'Filter area codes by province' schema: type: string enum: @@ -1907,11 +1823,11 @@ paths: - name: city in: query - description: 'Filter area codes by city.' + description: 'Filter area codes by city' schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1925,9 +1841,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineAreaCodeGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineAreaCodeGetResponse' + '4XX': description: failed_operation content: application/json: @@ -1935,15 +1851,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1952,52 +1868,47 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAreaCodeGet.php + $ref: examples/FaxLineAreaCodeGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAreaCodeGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAreaCodeGet.js + $ref: examples/FaxLineAreaCodeGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAreaCodeGet.ts + $ref: examples/FaxLineAreaCodeGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAreaCodeGet.java + $ref: examples/FaxLineAreaCodeGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAreaCodeGet.rb + $ref: examples/FaxLineAreaCodeGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAreaCodeGet.py + $ref: examples/FaxLineAreaCodeGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAreaCodeGet.sh + $ref: examples/FaxLineAreaCodeGetExample.sh x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.' /fax_line/create: post: tags: - 'Fax Line' summary: 'Purchase Fax Line' - description: 'Purchases a new Fax Line.' + description: 'Purchases a new Fax Line' operationId: faxLineCreate requestBody: required: true @@ -2006,10 +1917,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineCreateRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineCreateRequestExample' + example: + $ref: '#/components/examples/FaxLineCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2023,9 +1934,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -2033,17 +1944,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2052,42 +1963,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineCreate.php + $ref: examples/FaxLineCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineCreate.js + $ref: examples/FaxLineCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineCreate.ts + $ref: examples/FaxLineCreateExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineCreate.java + $ref: examples/FaxLineCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineCreate.rb + $ref: examples/FaxLineCreateExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineCreate.py + $ref: examples/FaxLineCreateExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineCreate.sh + $ref: examples/FaxLineCreateExample.sh x-meta: seo: title: 'Purchase Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2103,12 +2009,13 @@ paths: - name: number in: query - description: 'The Fax Line number.' + description: 'The Fax Line number' required: true schema: type: string + example: 123-123-1234 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2122,9 +2029,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -2132,17 +2039,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2151,46 +2058,41 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineGet.php + $ref: examples/FaxLineGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineGet.js + $ref: examples/FaxLineGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineGet.ts + $ref: examples/FaxLineGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineGet.java + $ref: examples/FaxLineGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineGet.rb + $ref: examples/FaxLineGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineGet.py + $ref: examples/FaxLineGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineGet.sh + $ref: examples/FaxLineGetExample.sh x-meta: seo: title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.' delete: tags: - 'Fax Line' @@ -2204,10 +2106,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineDeleteRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineDeleteRequestExample' + example: + $ref: '#/components/examples/FaxLineDeleteRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2218,7 +2120,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2226,17 +2128,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2245,42 +2147,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineDelete.php + $ref: examples/FaxLineDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineDelete.js + $ref: examples/FaxLineDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineDelete.ts + $ref: examples/FaxLineDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineDelete.java + $ref: examples/FaxLineDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineDelete.rb + $ref: examples/FaxLineDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineDelete.py + $ref: examples/FaxLineDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineDelete.sh + $ref: examples/FaxLineDeleteExample.sh x-meta: seo: title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2299,31 +2196,31 @@ paths: description: 'Account ID' schema: type: string - example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 - name: page in: query - description: Page + description: 'Which page number of the Fax Line List to return. Defaults to `1`.' schema: type: integer default: 1 - example: 1 + example: 1 - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 - example: 20 + example: 20 - name: show_team_lines in: query - description: 'Show team lines' + description: 'Include Fax Lines belonging to team members in the list' schema: type: boolean responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2337,9 +2234,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineListResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineListResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineListResponse' + '4XX': description: failed_operation content: application/json: @@ -2347,15 +2244,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2364,42 +2261,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineList.php + $ref: examples/FaxLineListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineList.js + $ref: examples/FaxLineListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineList.ts + $ref: examples/FaxLineListExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineList.java + $ref: examples/FaxLineListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineList.rb + $ref: examples/FaxLineListExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineList.py + $ref: examples/FaxLineListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineList.sh + $ref: examples/FaxLineListExample.sh x-meta: seo: title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers' @@ -2409,7 +2301,7 @@ paths: tags: - 'Fax Line' summary: 'Remove Fax Line Access' - description: 'Removes a user''s access to the specified Fax Line.' + description: 'Removes a user''s access to the specified Fax Line' operationId: faxLineRemoveUser requestBody: required: true @@ -2418,10 +2310,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineRemoveUserRequestExample' + example: + $ref: '#/components/examples/FaxLineRemoveUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2435,9 +2327,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -2445,17 +2337,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2464,42 +2356,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineRemoveUser.php + $ref: examples/FaxLineRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineRemoveUser.js + $ref: examples/FaxLineRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineRemoveUser.ts + $ref: examples/FaxLineRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineRemoveUser.java + $ref: examples/FaxLineRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineRemoveUser.rb + $ref: examples/FaxLineRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineRemoveUser.py + $ref: examples/FaxLineRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineRemoveUser.sh + $ref: examples/FaxLineRemoveUserExample.sh x-meta: seo: title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' @@ -2509,13 +2396,13 @@ paths: tags: - Fax summary: 'Lists Faxes' - description: 'Returns properties of multiple faxes' + description: 'Returns properties of multiple Faxes' operationId: faxList parameters: - name: page in: query - description: Page + description: 'Which page number of the Fax List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2524,7 +2411,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2532,7 +2419,7 @@ paths: minimum: 1 example: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2546,9 +2433,9 @@ paths: schema: $ref: '#/components/schemas/FaxListResponse' examples: - default_example: - $ref: '#/components/examples/FaxListResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxListResponse' + '4XX': description: failed_operation content: application/json: @@ -2556,15 +2443,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2573,42 +2460,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxList.php + $ref: examples/FaxListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxList.js + $ref: examples/FaxListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxList.ts + $ref: examples/FaxListExample.ts - lang: Java label: Java source: - $ref: examples/FaxList.java + $ref: examples/FaxListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxList.rb + $ref: examples/FaxListExample.rb - lang: Python label: Python source: - $ref: examples/FaxList.py + $ref: examples/FaxListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxList.sh + $ref: examples/FaxListExample.sh x-meta: seo: title: 'List Faxes | API Documentation | Dropbox Fax for Developers' @@ -2618,7 +2500,7 @@ paths: tags: - Fax summary: 'Send Fax' - description: 'Action to prepare and send a fax' + description: 'Creates and sends a new Fax with the submitted file(s)' operationId: faxSend requestBody: required: true @@ -2627,13 +2509,13 @@ paths: schema: $ref: '#/components/schemas/FaxSendRequest' examples: - default_example: - $ref: '#/components/examples/FaxSendRequestExample' + example: + $ref: '#/components/examples/FaxSendRequest' multipart/form-data: schema: $ref: '#/components/schemas/FaxSendRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2647,9 +2529,9 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxGetResponse' + '4XX': description: failed_operation content: application/json: @@ -2657,19 +2539,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2678,45 +2560,40 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxSend.php + $ref: examples/FaxSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxSend.js + $ref: examples/FaxSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxSend.ts + $ref: examples/FaxSendExample.ts - lang: Java label: Java source: - $ref: examples/FaxSend.java + $ref: examples/FaxSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxSend.rb + $ref: examples/FaxSendExample.rb - lang: Python label: Python source: - $ref: examples/FaxSend.py + $ref: examples/FaxSendExample.py - lang: cURL label: cURL source: - $ref: examples/FaxSend.sh + $ref: examples/FaxSendExample.sh x-meta: seo: - title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + title: 'Send Fax | API Documentation | Dropbox Fax for Developers' description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' /oauth/token: post: @@ -2732,10 +2609,10 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenGenerateRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateRequestExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2749,9 +2626,9 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateResponseExample' - 4XX: + example: + $ref: '#/components/examples/OAuthTokenGenerateResponse' + '4XX': description: failed_operation content: application/json: @@ -2759,15 +2636,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2777,42 +2654,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenGenerate.php + $ref: examples/OauthTokenGenerateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenGenerate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenGenerate.js + $ref: examples/OauthTokenGenerateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenGenerate.ts + $ref: examples/OauthTokenGenerateExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenGenerate.java + $ref: examples/OauthTokenGenerateExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenGenerate.rb + $ref: examples/OauthTokenGenerateExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenGenerate.py + $ref: examples/OauthTokenGenerateExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenGenerate.sh + $ref: examples/OauthTokenGenerateExample.sh x-meta: seo: title: 'Generate OAuth Token | Documentation | Dropbox Sign for Developers' @@ -2832,10 +2704,10 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenRefreshRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshRequestExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2849,9 +2721,9 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshResponseExample' - 4XX: + example: + $ref: '#/components/examples/OAuthTokenRefreshResponse' + '4XX': description: failed_operation content: application/json: @@ -2859,15 +2731,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2877,42 +2749,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenRefresh.php + $ref: examples/OauthTokenRefreshExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenRefresh.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenRefresh.js + $ref: examples/OauthTokenRefreshExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenRefresh.ts + $ref: examples/OauthTokenRefreshExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenRefresh.java + $ref: examples/OauthTokenRefreshExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenRefresh.rb + $ref: examples/OauthTokenRefreshExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenRefresh.py + $ref: examples/OauthTokenRefreshExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenRefresh.sh + $ref: examples/OauthTokenRefreshExample.sh x-meta: seo: title: 'OAuth Token Refresh | Documentation | Dropbox Sign for Developers' @@ -2935,10 +2802,10 @@ paths: schema: $ref: '#/components/schemas/ReportCreateRequest' examples: - default_example: - $ref: '#/components/examples/ReportCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ReportCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2952,9 +2819,9 @@ paths: schema: $ref: '#/components/schemas/ReportCreateResponse' examples: - default_example: - $ref: '#/components/examples/ReportCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/ReportCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -2962,15 +2829,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2979,42 +2846,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ReportCreate.php + $ref: examples/ReportCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ReportCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ReportCreate.js + $ref: examples/ReportCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ReportCreate.ts + $ref: examples/ReportCreateExample.ts - lang: Java label: Java source: - $ref: examples/ReportCreate.java + $ref: examples/ReportCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ReportCreate.rb + $ref: examples/ReportCreateExample.rb - lang: Python label: Python source: - $ref: examples/ReportCreate.py + $ref: examples/ReportCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ReportCreate.sh + $ref: examples/ReportCreateExample.sh x-meta: seo: title: 'Create Report | API Documentation | Dropbox Sign for Developers' @@ -3036,13 +2898,13 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3056,9 +2918,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3066,21 +2928,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3089,42 +2951,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Embedded Bulk Send with Template | Dropbox Sign for Developers' @@ -3146,13 +3003,13 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3166,9 +3023,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3176,17 +3033,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3199,42 +3056,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkSendWithTemplate.php + $ref: examples/SignatureRequestBulkSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkSendWithTemplate.js + $ref: examples/SignatureRequestBulkSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkSendWithTemplate.ts + $ref: examples/SignatureRequestBulkSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkSendWithTemplate.java + $ref: examples/SignatureRequestBulkSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkSendWithTemplate.rb + $ref: examples/SignatureRequestBulkSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkSendWithTemplate.py + $ref: examples/SignatureRequestBulkSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkSendWithTemplate.sh + $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh x-meta: seo: title: 'Bulk Send with Template | REST API | Dropbox Sign for Developers' @@ -3265,7 +3117,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3276,7 +3128,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3284,21 +3136,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3311,42 +3163,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCancel.php + $ref: examples/SignatureRequestCancelExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCancel.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCancel.js + $ref: examples/SignatureRequestCancelExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCancel.ts + $ref: examples/SignatureRequestCancelExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCancel.java + $ref: examples/SignatureRequestCancelExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCancel.rb + $ref: examples/SignatureRequestCancelExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCancel.py + $ref: examples/SignatureRequestCancelExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCancel.sh + $ref: examples/SignatureRequestCancelExample.sh x-meta: seo: title: 'Cancel Incomplete Signature Request | Dropbox Sign for Developers' @@ -3365,15 +3212,15 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3387,9 +3234,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' + '4XX': description: failed_operation content: application/json: @@ -3397,19 +3244,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3421,42 +3268,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbedded.php + $ref: examples/SignatureRequestCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbedded.js + $ref: examples/SignatureRequestCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbedded.ts + $ref: examples/SignatureRequestCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbedded.java + $ref: examples/SignatureRequestCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbedded.rb + $ref: examples/SignatureRequestCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbedded.py + $ref: examples/SignatureRequestCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbedded.sh + $ref: examples/SignatureRequestCreateEmbeddedExample.sh x-meta: seo: title: 'Create Embedded Signature Request | Dropbox Sign for Developers' @@ -3475,13 +3317,13 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3495,9 +3337,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3505,19 +3347,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3529,77 +3371,76 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Signature Request with Template | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here.' - '/signature_request/files/{signature_request_id}': - get: + '/signature_request/edit/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files' + summary: 'Edit Signature Request' description: |- - Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. + 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. - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFiles + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEdit parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - - name: file_type - in: query - description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' - schema: - type: string - default: pdf - enum: - - pdf - - zip + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditRequestGroupedSigners' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3609,15 +3450,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/pdf: - schema: - type: string - format: binary - application/zip: + application/json: schema: - type: string - format: binary - 4XX: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestSendResponse' + '4XX': description: failed_operation content: application/json: @@ -3625,23 +3464,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3654,67 +3491,76 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFiles.php + $ref: examples/SignatureRequestEditExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFiles.js + $ref: examples/SignatureRequestEditExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFiles.ts + $ref: examples/SignatureRequestEditExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFiles.java + $ref: examples/SignatureRequestEditExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFiles.rb + $ref: examples/SignatureRequestEditExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFiles.py + $ref: examples/SignatureRequestEditExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFiles.sh + $ref: examples/SignatureRequestEditExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/files_as_data_uri/{signature_request_id}': - get: + title: 'Edit Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.' + '/signature_request/edit_embedded/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files as Data Uri' + summary: 'Edit Embedded Signature Request' description: |- - Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). + 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. - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFilesAsDataUri + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEditEmbedded parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSigners' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3726,11 +3572,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponseDataUri' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' + '4XX': description: failed_operation content: application/json: @@ -3738,103 +3584,100 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsDataUri.php + $ref: examples/SignatureRequestEditEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsDataUri.js + $ref: examples/SignatureRequestEditEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsDataUri.ts + $ref: examples/SignatureRequestEditEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsDataUri.java + $ref: examples/SignatureRequestEditEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsDataUri.rb + $ref: examples/SignatureRequestEditEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsDataUri.py + $ref: examples/SignatureRequestEditEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsDataUri.sh + $ref: examples/SignatureRequestEditEmbeddedExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/files_as_file_url/{signature_request_id}': - get: + title: 'Edit Embedded Signature Request | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here.' + '/signature_request/edit_embedded_with_template/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files as File Url' + summary: 'Edit Embedded Signature Request with Template' description: |- - Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). + 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. - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFilesAsFileUrl + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEditEmbeddedWithTemplate parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - - name: force_download - in: query - description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.' - schema: - type: integer - default: 1 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3846,11 +3689,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3858,93 +3701,100 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsFileUrl.php + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsFileUrl.js + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsFileUrl.ts + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsFileUrl.java + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsFileUrl.rb + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsFileUrl.py + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsFileUrl.sh + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/{signature_request_id}': - get: + title: 'Signature Request with Template | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based on the given Template, click here.' + '/signature_request/edit_with_template/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Get Signature Request' - description: 'Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.' - operationId: signatureRequestGet + summary: 'Edit Signature Request With Template' + description: |- + 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. + operationId: signatureRequestEditWithTemplate parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3958,9 +3808,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3968,19 +3818,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3993,86 +3845,72 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestGet.php + $ref: examples/SignatureRequestEditWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestGet.js + $ref: examples/SignatureRequestEditWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestGet.ts + $ref: examples/SignatureRequestEditWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestGet.java + $ref: examples/SignatureRequestEditWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestGet.rb + $ref: examples/SignatureRequestEditWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestGet.py + $ref: examples/SignatureRequestEditWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestGet.sh + $ref: examples/SignatureRequestEditWithTemplateExample.sh x-meta: seo: - title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.' - /signature_request/list: + title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based off of the Template, click here.' + '/signature_request/files/{signature_request_id}': get: tags: - 'Signature Request' - summary: 'List Signature Requests' + summary: 'Download Files' description: |- - Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. + Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. - Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. - operationId: signatureRequestList + If the files are currently being prepared, a status code of `409` will be returned instead. + operationId: signatureRequestFiles parameters: - - name: account_id - in: query - description: 'Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to retrieve.' + required: true schema: type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - name: page + name: file_type in: query - description: 'Which page number of the SignatureRequest List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - example: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - - - name: query - in: query - description: 'String that includes search terms and/or fields to be used to filter the SignatureRequest objects.' + description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' schema: type: string + default: pdf + enum: + - pdf + - zip responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4082,13 +3920,15 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/SignatureRequestListResponse' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestListResponseExample' - 4XX: + type: string + format: binary + application/zip: + schema: + type: string + format: binary + '4XX': description: failed_operation content: application/json: @@ -4096,17 +3936,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4119,64 +3965,62 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestList.php + $ref: examples/SignatureRequestFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestList.js + $ref: examples/SignatureRequestFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestList.ts + $ref: examples/SignatureRequestFilesExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestList.java + $ref: examples/SignatureRequestFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestList.rb + $ref: examples/SignatureRequestFilesExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestList.py + $ref: examples/SignatureRequestFilesExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestList.sh + $ref: examples/SignatureRequestFilesExample.sh x-meta: seo: - title: 'List Signature Requests | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.' - '/signature_request/release_hold/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/files_as_data_uri/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Release On-Hold Signature Request' - description: 'Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.' - operationId: signatureRequestReleaseHold + summary: 'Download Files as Data Uri' + description: |- + Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). + + If the files are currently being prepared, a status code of `409` will be returned instead. + operationId: signatureRequestFilesAsDataUri parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to release.' + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4188,11 +4032,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -4200,98 +4044,98 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: + - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestReleaseHold.php + $ref: examples/SignatureRequestFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestReleaseHold.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestReleaseHold.js + $ref: examples/SignatureRequestFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestReleaseHold.ts + $ref: examples/SignatureRequestFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestReleaseHold.java + $ref: examples/SignatureRequestFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestReleaseHold.rb + $ref: examples/SignatureRequestFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestReleaseHold.py + $ref: examples/SignatureRequestFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestReleaseHold.sh + $ref: examples/SignatureRequestFilesAsDataUriExample.sh x-meta: seo: - title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.' - '/signature_request/remind/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/files_as_file_url/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Send Request Reminder' + summary: 'Download Files as File Url' description: |- - Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. + Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). - **NOTE:** This action can **not** be used with embedded signature requests. - operationId: signatureRequestRemind + If the files are currently being prepared, a status code of `409` will be returned instead. + operationId: signatureRequestFilesAsFileUrl parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to send a reminder for.' + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestRemindRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' + - + name: force_download + in: query + description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.' + schema: + type: integer + default: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4303,11 +4147,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -4315,23 +4159,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4344,69 +4188,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemind.php + $ref: examples/SignatureRequestFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemind.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemind.js + $ref: examples/SignatureRequestFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemind.ts + $ref: examples/SignatureRequestFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemind.java + $ref: examples/SignatureRequestFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemind.rb + $ref: examples/SignatureRequestFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemind.py + $ref: examples/SignatureRequestFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemind.sh + $ref: examples/SignatureRequestFilesAsFileUrlExample.sh x-meta: seo: - title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.' - '/signature_request/remove/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Remove Signature Request Access' - description: |- - Removes your access to a completed signature request. This action is **not reversible**. - - The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). - - Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. - operationId: signatureRequestRemove + summary: 'Get Signature Request' + description: 'Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.' + operationId: signatureRequestGet parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to remove.' + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4416,8 +4250,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: {} - 4XX: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestGetResponse' + '4XX': description: failed_operation content: application/json: @@ -4425,92 +4264,106 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] + - + oauth2: + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemove.php + $ref: examples/SignatureRequestGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemove.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemove.js + $ref: examples/SignatureRequestGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemove.ts + $ref: examples/SignatureRequestGetExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemove.java + $ref: examples/SignatureRequestGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemove.rb + $ref: examples/SignatureRequestGetExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemove.py + $ref: examples/SignatureRequestGetExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemove.sh + $ref: examples/SignatureRequestGetExample.sh x-meta: seo: - title: 'Remove Signature Request Access | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.' - /signature_request/send: - post: + title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.' + /signature_request/list: + get: tags: - 'Signature Request' - summary: 'Send Signature Request' - description: 'Creates and sends a new 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.' - operationId: signatureRequestSend - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestSendRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' - grouped_signers_example: - $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/SignatureRequestSendRequest' + summary: 'List Signature Requests' + description: |- + Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. + + Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + operationId: signatureRequestList + parameters: + - + name: account_id + in: query + description: 'Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + schema: + type: string + - + name: page + in: query + description: 'Which page number of the SignatureRequest List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + example: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + - + name: query + in: query + description: 'String that includes search terms and/or fields to be used to filter the SignatureRequest objects.' + schema: + type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4522,11 +4375,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/SignatureRequestListResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestListResponse' + '4XX': description: failed_operation content: application/json: @@ -4534,19 +4387,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4559,67 +4410,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSend.php + $ref: examples/SignatureRequestListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSend.js + $ref: examples/SignatureRequestListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSend.ts + $ref: examples/SignatureRequestListExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSend.java + $ref: examples/SignatureRequestListExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSend.rb + $ref: examples/SignatureRequestListExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSend.py + $ref: examples/SignatureRequestListExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSend.sh + $ref: examples/SignatureRequestListExample.sh x-meta: seo: - title: 'Send Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.' - /signature_request/send_with_template: + title: 'List Signature Requests | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.' + '/signature_request/release_hold/{signature_request_id}': post: tags: - 'Signature Request' - summary: 'Send with Template' - description: 'Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.' - operationId: signatureRequestSendWithTemplate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' + summary: 'Release On-Hold Signature Request' + description: 'Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.' + operationId: signatureRequestReleaseHold + parameters: + - + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to release.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4633,9 +4476,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestReleaseHoldResponse' + '4XX': description: failed_operation content: application/json: @@ -4643,86 +4486,78 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestSendWithTemplate.php + $ref: examples/SignatureRequestReleaseHoldExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSendWithTemplate.js + $ref: examples/SignatureRequestReleaseHoldExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSendWithTemplate.ts + $ref: examples/SignatureRequestReleaseHoldExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSendWithTemplate.java + $ref: examples/SignatureRequestReleaseHoldExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSendWithTemplate.rb + $ref: examples/SignatureRequestReleaseHoldExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSendWithTemplate.py + $ref: examples/SignatureRequestReleaseHoldExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSendWithTemplate.sh + $ref: examples/SignatureRequestReleaseHoldExample.sh x-meta: seo: - title: 'Send with Template | API Documentation | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.' - '/signature_request/update/{signature_request_id}': + title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.' + '/signature_request/remind/{signature_request_id}': post: tags: - 'Signature Request' - summary: 'Update Signature Request' + summary: 'Send Request Reminder' description: |- - Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. - - Updating the email address of a signer will generate a new `signature_id` value. + Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. - **NOTE:** This action cannot be performed on a signature request with an appended signature page. - operationId: signatureRequestUpdate + **NOTE:** This action can **not** be used with embedded signature requests. + operationId: signatureRequestRemind parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to update.' + description: 'The id of the SignatureRequest to send a reminder for.' required: true schema: type: string @@ -4732,12 +4567,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestUpdateRequest' + $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestRemindRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4751,9 +4586,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestRemindResponse' + '4XX': description: failed_operation content: application/json: @@ -4761,97 +4596,93 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: + - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestUpdate.php + $ref: examples/SignatureRequestRemindExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestUpdate.js + $ref: examples/SignatureRequestRemindExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestUpdate.ts + $ref: examples/SignatureRequestRemindExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestUpdate.java + $ref: examples/SignatureRequestRemindExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestUpdate.rb + $ref: examples/SignatureRequestRemindExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestUpdate.py + $ref: examples/SignatureRequestRemindExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestUpdate.sh + $ref: examples/SignatureRequestRemindExample.sh x-meta: seo: - title: 'Update Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.' - /team/add_member: - put: + title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.' + '/signature_request/remove/{signature_request_id}': + post: tags: - - Team - summary: 'Add User to Team' - description: 'Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.' - operationId: teamAddMember + - 'Signature Request' + summary: 'Remove Signature Request Access' + description: |- + Removes your access to a completed signature request. This action is **not reversible**. + + The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). + + Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + operationId: signatureRequestRemove parameters: - - name: team_id - in: query - description: 'The id of the team.' - required: false + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to remove.' + required: true schema: type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TeamAddMemberRequest' - examples: - email_address: - $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4861,13 +4692,8 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: - schema: - $ref: '#/components/schemas/TeamGetResponse' - examples: - default_example: - $ref: '#/components/examples/TeamAddMemberResponseExample' - 4XX: + application/json: {} + '4XX': description: failed_operation content: application/json: @@ -4875,86 +4701,87 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - - - oauth2: - - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamAddMember.php + $ref: examples/SignatureRequestRemoveExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamAddMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamAddMember.js + $ref: examples/SignatureRequestRemoveExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamAddMember.ts + $ref: examples/SignatureRequestRemoveExample.ts - lang: Java label: Java source: - $ref: examples/TeamAddMember.java + $ref: examples/SignatureRequestRemoveExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamAddMember.rb + $ref: examples/SignatureRequestRemoveExample.rb - lang: Python label: Python source: - $ref: examples/TeamAddMember.py + $ref: examples/SignatureRequestRemoveExample.py - lang: cURL label: cURL source: - $ref: examples/TeamAddMember.sh + $ref: examples/SignatureRequestRemoveExample.sh x-meta: seo: - title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.' - /team/create: + title: 'Remove Signature Request Access | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.' + /signature_request/send: post: tags: - - Team - summary: 'Create Team' - description: 'Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.' - operationId: teamCreate + - 'Signature Request' + summary: 'Send Signature Request' + description: 'Creates and sends a new 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.' + operationId: signatureRequestSend requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamCreateRequest' + $ref: '#/components/schemas/SignatureRequestSendRequest' examples: - default_example: - $ref: '#/components/examples/TeamCreateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestSendRequestGroupedSigners' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestSendRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4966,11 +4793,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestSendResponse' + '4XX': description: failed_operation content: application/json: @@ -4978,75 +4805,87 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - team_access + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamCreate.php + $ref: examples/SignatureRequestSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamCreate.js + $ref: examples/SignatureRequestSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamCreate.ts + $ref: examples/SignatureRequestSendExample.ts - lang: Java label: Java source: - $ref: examples/TeamCreate.java + $ref: examples/SignatureRequestSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamCreate.rb + $ref: examples/SignatureRequestSendExample.rb - lang: Python label: Python source: - $ref: examples/TeamCreate.py + $ref: examples/SignatureRequestSendExample.py - lang: cURL label: cURL source: - $ref: examples/TeamCreate.sh + $ref: examples/SignatureRequestSendExample.sh x-meta: seo: - title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.' - /team/destroy: - delete: + title: 'Send Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.' + /signature_request/send_with_template: + post: tags: - - Team - summary: 'Delete Team' - description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).' - operationId: teamDelete + - 'Signature Request' + summary: 'Send with Template' + description: 'Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.' + operationId: signatureRequestSendWithTemplate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5055,7 +4894,14 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -5063,75 +4909,96 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - team_access + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamDelete.php + $ref: examples/SignatureRequestSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamDelete.js + $ref: examples/SignatureRequestSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamDelete.ts + $ref: examples/SignatureRequestSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/TeamDelete.java + $ref: examples/SignatureRequestSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamDelete.rb + $ref: examples/SignatureRequestSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/TeamDelete.py + $ref: examples/SignatureRequestSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamDelete.sh + $ref: examples/SignatureRequestSendWithTemplateExample.sh x-meta: seo: - title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.' - /team: - get: + title: 'Send with Template | API Documentation | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.' + '/signature_request/update/{signature_request_id}': + post: tags: - - Team - summary: 'Get Team' - description: 'Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.' - operationId: teamGet + - 'Signature Request' + summary: 'Update Signature Request' + description: |- + Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. + + Updating the email address of a signer will generate a new `signature_id` value. + + **NOTE:** This action cannot be performed on a signature request with an appended signature page. + operationId: signatureRequestUpdate + parameters: + - + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to update.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestUpdateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestUpdateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5143,11 +5010,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -5155,85 +5022,92 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - team_access + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamGet.php + $ref: examples/SignatureRequestUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamGet.js + $ref: examples/SignatureRequestUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamGet.ts + $ref: examples/SignatureRequestUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamGet.java + $ref: examples/SignatureRequestUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamGet.rb + $ref: examples/SignatureRequestUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamGet.py + $ref: examples/SignatureRequestUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamGet.sh + $ref: examples/SignatureRequestUpdateExample.sh x-meta: seo: - title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.' + title: 'Update Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.' + /team/add_member: put: tags: - Team - summary: 'Update Team' - description: 'Updates the name of your Team.' - operationId: teamUpdate + summary: 'Add User to Team' + description: 'Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.' + operationId: teamAddMember + parameters: + - + name: team_id + in: query + description: 'The id of the team.' + required: false + schema: + type: string + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamUpdateRequest' + $ref: '#/components/schemas/TeamAddMemberRequest' examples: - default_example: - $ref: '#/components/examples/TeamUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamAddMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamAddMemberRequestAccountId' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5247,9 +5121,9 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamAddMemberResponse' + '4XX': description: failed_operation content: application/json: @@ -5257,15 +5131,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5277,64 +5153,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamUpdate.php + $ref: examples/TeamAddMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamUpdate.js + $ref: examples/TeamAddMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamUpdate.ts + $ref: examples/TeamAddMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamUpdate.java + $ref: examples/TeamAddMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamUpdate.rb + $ref: examples/TeamAddMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamUpdate.py + $ref: examples/TeamAddMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamUpdate.sh + $ref: examples/TeamAddMemberExample.sh x-meta: seo: - title: 'Update Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.' - /team/info: - get: + title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.' + /team/create: + post: tags: - Team - summary: 'Get Team Info' - description: 'Provides information about a team.' - operationId: teamInfo - parameters: - - - name: team_id - in: query - description: 'The id of the team.' - required: false - schema: - type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + summary: 'Create Team' + description: 'Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.' + operationId: teamCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TeamCreateRequest' + examples: + example: + $ref: '#/components/examples/TeamCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5346,11 +5217,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetInfoResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetInfoResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -5358,19 +5229,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5382,63 +5249,50 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInfo.php + $ref: examples/TeamCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInfo.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInfo.js + $ref: examples/TeamCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInfo.ts + $ref: examples/TeamCreateExample.ts - lang: Java label: Java source: - $ref: examples/TeamInfo.java + $ref: examples/TeamCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInfo.rb + $ref: examples/TeamCreateExample.rb - lang: Python label: Python source: - $ref: examples/TeamInfo.py + $ref: examples/TeamCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInfo.sh + $ref: examples/TeamCreateExample.sh x-meta: seo: - title: 'Get Team Info | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.' - /team/invites: - get: + title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.' + /team/destroy: + delete: tags: - Team - summary: 'List Team Invites' - description: 'Provides a list of team invites (and their roles).' - operationId: teamInvites - parameters: - - - name: email_address - in: query - description: 'The email address for which to display the team invites.' - required: false - schema: - type: string + summary: 'Delete Team' + description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).' + operationId: teamDelete responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5447,14 +5301,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - content: - application/json: - schema: - $ref: '#/components/schemas/TeamInvitesResponse' - examples: - default_example: - $ref: '#/components/examples/TeamInvitesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5462,101 +5309,70 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - account_access - - basic_account_info + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamInvites.php + $ref: examples/TeamDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInvites.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInvites.js + $ref: examples/TeamDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInvites.ts + $ref: examples/TeamDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TeamInvites.java + $ref: examples/TeamDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInvites.rb + $ref: examples/TeamDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TeamInvites.py + $ref: examples/TeamDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInvites.sh + $ref: examples/TeamDeleteExample.sh x-meta: seo: - title: 'List Team Invites | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.' - '/team/members/{team_id}': + title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.' + /team: get: tags: - Team - summary: 'List Team Members' - description: 'Provides a paginated list of members (and their roles) that belong to a given team.' - operationId: teamMembers - parameters: - - - name: team_id - in: path - description: 'The id of the team that a member list is being requested from.' - required: true - schema: - type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - - - name: page - in: query - description: 'Which page number of the team member list to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 + summary: 'Get Team' + description: 'Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.' + operationId: teamGet responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5568,11 +5384,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamMembersResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamMembersResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamGetResponse' + '4XX': description: failed_operation content: application/json: @@ -5580,19 +5396,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5604,66 +5418,58 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamMembers.php + $ref: examples/TeamGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamMembers.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamMembers.js + $ref: examples/TeamGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamMembers.ts + $ref: examples/TeamGetExample.ts - lang: Java label: Java source: - $ref: examples/TeamMembers.java + $ref: examples/TeamGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamMembers.rb + $ref: examples/TeamGetExample.rb - lang: Python label: Python source: - $ref: examples/TeamMembers.py + $ref: examples/TeamGetExample.py - lang: cURL label: cURL source: - $ref: examples/TeamMembers.sh + $ref: examples/TeamGetExample.sh x-meta: seo: - title: 'List Team Members | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.' - /team/remove_member: - post: + title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.' + put: tags: - Team - summary: 'Remove User from Team' - description: 'Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.' - operationId: teamRemoveMember + summary: 'Update Team' + description: 'Updates the name of your Team.' + operationId: teamUpdate requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamRemoveMemberRequest' + $ref: '#/components/schemas/TeamUpdateRequest' examples: - email_address: - $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamUpdateRequest' responses: - 201: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5677,9 +5483,9 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamRemoveMemberResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -5687,17 +5493,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5709,80 +5513,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamRemoveMember.php + $ref: examples/TeamUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamRemoveMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamRemoveMember.js + $ref: examples/TeamUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamRemoveMember.ts + $ref: examples/TeamUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamRemoveMember.java + $ref: examples/TeamUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamRemoveMember.rb + $ref: examples/TeamUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamRemoveMember.py + $ref: examples/TeamUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamRemoveMember.sh + $ref: examples/TeamUpdateExample.sh x-meta: seo: - title: 'Remove User from Team | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.' - '/team/sub_teams/{team_id}': + title: 'Update Team | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.' + /team/info: get: tags: - Team - summary: 'List Sub Teams' - description: 'Provides a paginated list of sub teams that belong to a given team.' - operationId: teamSubTeams + summary: 'Get Team Info' + description: 'Provides information about a team.' + operationId: teamInfo parameters: - name: team_id - in: path - description: 'The id of the parent Team.' - required: true + in: query + description: 'The id of the team.' + required: false schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - - - name: page - in: query - description: 'Which page number of the SubTeam List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5794,11 +5577,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamSubTeamsResponse' + $ref: '#/components/schemas/TeamGetInfoResponse' examples: - default_example: - $ref: '#/components/examples/TeamSubTeamsResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamGetInfoResponse' + '4XX': description: failed_operation content: application/json: @@ -5806,19 +5589,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5830,73 +5613,58 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamSubTeams.php + $ref: examples/TeamInfoExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamSubTeams.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamSubTeams.js + $ref: examples/TeamInfoExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamSubTeams.ts + $ref: examples/TeamInfoExample.ts - lang: Java label: Java source: - $ref: examples/TeamSubTeams.java + $ref: examples/TeamInfoExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamSubTeams.rb + $ref: examples/TeamInfoExample.rb - lang: Python label: Python source: - $ref: examples/TeamSubTeams.py + $ref: examples/TeamInfoExample.py - lang: cURL label: cURL source: - $ref: examples/TeamSubTeams.sh + $ref: examples/TeamInfoExample.sh x-meta: seo: - title: 'List Sub Teams | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.' - '/template/add_user/{template_id}': - post: + title: 'Get Team Info | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.' + /team/invites: + get: tags: - - Template - summary: 'Add User to Template' - description: 'Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.' - operationId: templateAddUser + - Team + summary: 'List Team Invites' + description: 'Provides a list of team invites (and their roles).' + operationId: teamInvites parameters: - - name: template_id - in: path - description: 'The id of the Template to give the Account access to.' - required: true + name: email_address + in: query + description: 'The email address for which to display the team invites.' + required: false schema: type: string - example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateAddUserRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5908,11 +5676,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateGetResponse' + $ref: '#/components/schemas/TeamInvitesResponse' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamInvitesResponse' + '4XX': description: failed_operation content: application/json: @@ -5920,95 +5688,96 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - account_access + - basic_account_info x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateAddUser.php + $ref: examples/TeamInvitesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateAddUser.js + $ref: examples/TeamInvitesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateAddUser.ts + $ref: examples/TeamInvitesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateAddUser.java + $ref: examples/TeamInvitesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateAddUser.rb + $ref: examples/TeamInvitesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateAddUser.py + $ref: examples/TeamInvitesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateAddUser.sh + $ref: examples/TeamInvitesExample.sh x-meta: seo: - title: 'Add User to Template | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.' - /template/create: - post: + title: 'List Team Invites | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.' + '/team/members/{team_id}': + get: tags: - - Template - summary: 'Create Template' - description: 'Creates a template that can then be used.' - operationId: templateCreate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateCreateRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateCreateRequest' + - Team + summary: 'List Team Members' + description: 'Provides a paginated list of members (and their roles) that belong to a given team.' + operationId: teamMembers + parameters: + - + name: team_id + in: path + description: 'The id of the team that a member list is being requested from.' + required: true + schema: + type: string + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + - + name: page + in: query + description: 'Which page number of the team member list to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6020,11 +5789,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateResponse' + $ref: '#/components/schemas/TeamMembersResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamMembersResponse' + '4XX': description: failed_operation content: application/json: @@ -6032,97 +5801,85 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateCreate.php + $ref: examples/TeamMembersExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreate.js + $ref: examples/TeamMembersExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreate.ts + $ref: examples/TeamMembersExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreate.java + $ref: examples/TeamMembersExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreate.rb + $ref: examples/TeamMembersExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreate.py + $ref: examples/TeamMembersExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreate.sh + $ref: examples/TeamMembersExample.sh x-meta: seo: - title: 'Create Template | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.' - /template/create_embedded_draft: + title: 'List Team Members | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.' + /team/remove_member: post: tags: - - Template - summary: 'Create Embedded Template Draft' - description: 'The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ''edit'' stage.' - operationId: templateCreateEmbeddedDraft + - Team + summary: 'Remove User from Team' + description: 'Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.' + operationId: teamRemoveMember requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + example: + $ref: '#/components/examples/TeamRemoveMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamRemoveMemberRequestAccountId' responses: - 200: + '201': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6134,11 +5891,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamRemoveMemberResponse' + '4XX': description: failed_operation content: application/json: @@ -6146,88 +5903,97 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateCreateEmbeddedDraft.php + $ref: examples/TeamRemoveMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreateEmbeddedDraft.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreateEmbeddedDraft.js + $ref: examples/TeamRemoveMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreateEmbeddedDraft.ts + $ref: examples/TeamRemoveMemberExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreateEmbeddedDraft.java + $ref: examples/TeamRemoveMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreateEmbeddedDraft.rb + $ref: examples/TeamRemoveMemberExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreateEmbeddedDraft.py + $ref: examples/TeamRemoveMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreateEmbeddedDraft.sh + $ref: examples/TeamRemoveMemberExample.sh x-meta: seo: - title: 'Create Embedded Template Draft | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.' - '/template/delete/{template_id}': - post: + title: 'Remove User from Team | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.' + '/team/sub_teams/{team_id}': + get: tags: - - Template - summary: 'Delete Template' - description: 'Completely deletes the template specified from the account.' - operationId: templateDelete + - Team + summary: 'List Sub Teams' + description: 'Provides a paginated list of sub teams that belong to a given team.' + operationId: teamSubTeams parameters: - - name: template_id + name: team_id in: path - description: 'The id of the Template to delete.' + description: 'The id of the parent Team.' required: true schema: type: string - example: f57db65d3f933b5316d398057a36176831451a35 - responses: - 200: + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + - + name: page + in: query + description: 'Which page number of the SubTeam List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 + responses: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6237,8 +6003,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: {} - 4XX: + application/json: + schema: + $ref: '#/components/schemas/TeamSubTeamsResponse' + examples: + example: + $ref: '#/components/examples/TeamSubTeamsResponse' + '4XX': description: failed_operation content: application/json: @@ -6246,100 +6017,92 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateDelete.php + $ref: examples/TeamSubTeamsExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateDelete.js + $ref: examples/TeamSubTeamsExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateDelete.ts + $ref: examples/TeamSubTeamsExample.ts - lang: Java label: Java source: - $ref: examples/TemplateDelete.java + $ref: examples/TeamSubTeamsExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateDelete.rb + $ref: examples/TeamSubTeamsExample.rb - lang: Python label: Python source: - $ref: examples/TemplateDelete.py + $ref: examples/TeamSubTeamsExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateDelete.sh + $ref: examples/TeamSubTeamsExample.sh x-meta: seo: - title: 'Delete Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.' - '/template/files/{template_id}': - get: + title: 'List Sub Teams | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.' + '/template/add_user/{template_id}': + post: tags: - Template - summary: 'Get Template Files' - description: |- - Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. - - If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. - operationId: templateFiles + summary: 'Add User to Template' + description: 'Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.' + operationId: templateAddUser parameters: - name: template_id in: path - description: 'The id of the template files to retrieve.' + description: 'The id of the Template to give the Account access to.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - - - name: file_type - in: query - description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' - schema: - type: string - enum: - - pdf - - zip + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateAddUserRequest' + examples: + example: + $ref: '#/components/examples/TemplateAddUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6349,15 +6112,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/pdf: - schema: - type: string - format: binary - application/zip: + application/json: schema: - type: string - format: binary - 4XX: + $ref: '#/components/schemas/TemplateGetResponse' + examples: + example: + $ref: '#/components/examples/TemplateAddUserResponse' + '4XX': description: failed_operation content: application/json: @@ -6365,23 +6126,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6393,67 +6148,68 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFiles.php + $ref: examples/TemplateAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFiles.js + $ref: examples/TemplateAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFiles.ts + $ref: examples/TemplateAddUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFiles.java + $ref: examples/TemplateAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFiles.rb + $ref: examples/TemplateAddUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFiles.py + $ref: examples/TemplateAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFiles.sh + $ref: examples/TemplateAddUserExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/files_as_data_uri/{template_id}': - get: + title: 'Add User to Template | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.' + /template/create: + post: tags: - Template - summary: 'Get Template Files as Data Uri' - description: |- - Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). - - If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. - operationId: templateFilesAsDataUri - parameters: - - - name: template_id - in: path - description: 'The id of the template files to retrieve.' - required: true - schema: - type: string - example: f57db65d3f933b5316d398057a36176831451a35 + summary: 'Create Template' + description: 'Creates a template that can then be used.' + operationId: templateCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateCreateRequest' + examples: + example: + $ref: '#/components/examples/TemplateCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6465,11 +6221,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponseDataUri' + $ref: '#/components/schemas/TemplateCreateResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -6477,23 +6233,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6505,74 +6257,68 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsDataUri.php + $ref: examples/TemplateCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsDataUri.js + $ref: examples/TemplateCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsDataUri.ts + $ref: examples/TemplateCreateExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsDataUri.java + $ref: examples/TemplateCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsDataUri.rb + $ref: examples/TemplateCreateExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsDataUri.py + $ref: examples/TemplateCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsDataUri.sh + $ref: examples/TemplateCreateExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/files_as_file_url/{template_id}': - get: + title: 'Create Template | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.' + /template/create_embedded_draft: + post: tags: - Template - summary: 'Get Template Files as File Url' - description: |- - Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). - - If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. - operationId: templateFilesAsFileUrl - parameters: - - - name: template_id - in: path - description: 'The id of the template files to retrieve.' - required: true - schema: - type: string - example: f57db65d3f933b5316d398057a36176831451a35 - - - name: force_download - in: query - description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.' - schema: - type: integer - default: 1 + summary: 'Create Embedded Template Draft' + description: 'The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ''edit'' stage.' + operationId: templateCreateEmbeddedDraft + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + examples: + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6584,11 +6330,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponse' + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponse' + '4XX': description: failed_operation content: application/json: @@ -6596,23 +6342,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6624,64 +6366,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsFileUrl.php + $ref: examples/TemplateCreateEmbeddedDraftExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsFileUrl.js + $ref: examples/TemplateCreateEmbeddedDraftExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsFileUrl.ts + $ref: examples/TemplateCreateEmbeddedDraftExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsFileUrl.java + $ref: examples/TemplateCreateEmbeddedDraftExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsFileUrl.rb + $ref: examples/TemplateCreateEmbeddedDraftExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsFileUrl.py + $ref: examples/TemplateCreateEmbeddedDraftExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsFileUrl.sh + $ref: examples/TemplateCreateEmbeddedDraftExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/{template_id}': - get: + title: 'Create Embedded Template Draft | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.' + '/template/delete/{template_id}': + post: tags: - Template - summary: 'Get Template' - description: 'Returns the Template specified by the `template_id` parameter.' - operationId: templateGet + summary: 'Delete Template' + description: 'Completely deletes the template specified from the account.' + operationId: templateDelete parameters: - name: template_id in: path - description: 'The id of the Template to retrieve.' + description: 'The id of the Template to delete.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6691,13 +6428,8 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: - schema: - $ref: '#/components/schemas/TemplateGetResponse' - examples: - default_example: - $ref: '#/components/examples/TemplateGetResponseExample' - 4XX: + application/json: {} + '4XX': description: failed_operation content: application/json: @@ -6705,19 +6437,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6729,87 +6461,71 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateGet.php + $ref: examples/TemplateDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateGet.js + $ref: examples/TemplateDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateGet.ts + $ref: examples/TemplateDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TemplateGet.java + $ref: examples/TemplateDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateGet.rb + $ref: examples/TemplateDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TemplateGet.py + $ref: examples/TemplateDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateGet.sh + $ref: examples/TemplateDeleteExample.sh x-meta: seo: - title: 'Get Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.' - /template/list: + title: 'Delete Template | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.' + '/template/files/{template_id}': get: tags: - Template - summary: 'List Templates' + summary: 'Get Template Files' description: |- - Returns a list of the Templates that are accessible by you. + Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. - Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. - operationId: templateList + If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + operationId: templateFiles parameters: - - name: account_id - in: query - description: 'Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + name: template_id + in: path + description: 'The id of the template files to retrieve.' + required: true schema: type: string + example: f57db65d3f933b5316d398057a36176831451a35 - - name: page - in: query - description: 'Which page number of the Template List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 - - - name: query + name: file_type in: query - description: 'String that includes search terms and/or fields to be used to filter the Template objects.' + description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' schema: type: string + enum: + - pdf + - zip responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6819,13 +6535,15 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/TemplateListResponse' - examples: - default_example: - $ref: '#/components/examples/TemplateListResponseExample' - 4XX: + type: string + format: binary + application/zip: + schema: + type: string + format: binary + '4XX': description: failed_operation content: application/json: @@ -6833,19 +6551,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6857,73 +6579,62 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateList.php + $ref: examples/TemplateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateList.js + $ref: examples/TemplateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateList.ts + $ref: examples/TemplateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateList.java + $ref: examples/TemplateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateList.rb + $ref: examples/TemplateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateList.py + $ref: examples/TemplateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateList.sh + $ref: examples/TemplateFilesExample.sh x-meta: seo: - title: 'List Templates | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.' - '/template/remove_user/{template_id}': - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/files_as_data_uri/{template_id}': + get: tags: - Template - summary: 'Remove User from Template' - description: 'Removes the specified Account''s access to the specified Template.' - operationId: templateRemoveUser + summary: 'Get Template Files as Data Uri' + description: |- + Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). + + If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + operationId: templateFilesAsDataUri parameters: - name: template_id in: path - description: 'The id of the Template to remove the Account''s access to.' + description: 'The id of the template files to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateRemoveUserRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6935,11 +6646,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateGetResponse' + $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -6947,17 +6658,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6969,88 +6686,69 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateRemoveUser.php + $ref: examples/TemplateFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateRemoveUser.js + $ref: examples/TemplateFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateRemoveUser.ts + $ref: examples/TemplateFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/TemplateRemoveUser.java + $ref: examples/TemplateFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateRemoveUser.rb + $ref: examples/TemplateFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/TemplateRemoveUser.py + $ref: examples/TemplateFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateRemoveUser.sh + $ref: examples/TemplateFilesAsDataUriExample.sh x-meta: seo: - title: 'Remove User from Template | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.' - '/template/update_files/{template_id}': - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/files_as_file_url/{template_id}': + get: tags: - Template - summary: 'Update Template Files' + summary: 'Get Template Files as File Url' description: |- - Overlays a new file with the overlay of an existing template. The new file(s) must: - - 1. have the same or higher page count - 2. the same orientation as the file(s) being replaced. - - This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. - - Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. - - It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). - If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). - operationId: templateUpdateFiles + If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + operationId: templateFilesAsFileUrl parameters: - name: template_id in: path - description: 'The ID of the template whose files to update.' + description: 'The id of the template files to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateUpdateFilesRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateUpdateFilesRequest' + - + name: force_download + in: query + description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.' + schema: + type: integer + default: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7062,11 +6760,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateUpdateFilesResponse' + $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -7074,21 +6772,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7100,73 +6800,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateUpdateFiles.php + $ref: examples/TemplateFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateUpdateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateUpdateFiles.js + $ref: examples/TemplateFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateUpdateFiles.ts + $ref: examples/TemplateFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/TemplateUpdateFiles.java + $ref: examples/TemplateFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateUpdateFiles.rb + $ref: examples/TemplateFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/TemplateUpdateFiles.py + $ref: examples/TemplateFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateUpdateFiles.sh + $ref: examples/TemplateFilesAsFileUrlExample.sh x-meta: seo: - title: 'Update Template Files | REST API | Dropbox Sign for Developers' - description: 'Overlays a new file with the overlay of an existing template' - /unclaimed_draft/create: - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/{template_id}': + get: tags: - - 'Unclaimed Draft' - summary: 'Create Unclaimed Draft' - description: 'Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.' - operationId: unclaimedDraftCreate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateRequest' - examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + - Template + summary: 'Get Template' + description: 'Returns the Template specified by the `template_id` parameter.' + operationId: templateGet + parameters: + - + name: template_id + in: path + description: 'The id of the Template to retrieve.' + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7178,11 +6864,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateGetResponse' + '4XX': description: failed_operation content: application/json: @@ -7190,96 +6876,106 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreate.php + $ref: examples/TemplateGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreate.js + $ref: examples/TemplateGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreate.ts + $ref: examples/TemplateGetExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreate.java + $ref: examples/TemplateGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreate.rb + $ref: examples/TemplateGetExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreate.py + $ref: examples/TemplateGetExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreate.sh + $ref: examples/TemplateGetExample.sh x-meta: seo: - title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.' - /unclaimed_draft/create_embedded: - post: + title: 'Get Template | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.' + /template/list: + get: tags: - - 'Unclaimed Draft' - summary: 'Create Embedded Unclaimed Draft' + - Template + summary: 'List Templates' description: |- - Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. + Returns a list of the Templates that are accessible by you. - **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. - operationId: unclaimedDraftCreateEmbedded - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' - examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + operationId: templateList + parameters: + - + name: account_id + in: query + description: 'Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + schema: + type: string + - + name: page + in: query + description: 'Which page number of the Template List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 + - + name: query + in: query + description: 'String that includes search terms and/or fields to be used to filter the Template objects.' + schema: + type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7291,11 +6987,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateListResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateListResponse' + '4XX': description: failed_operation content: application/json: @@ -7303,95 +6999,92 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbedded.php + $ref: examples/TemplateListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbedded.js + $ref: examples/TemplateListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbedded.ts + $ref: examples/TemplateListExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbedded.java + $ref: examples/TemplateListExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbedded.rb + $ref: examples/TemplateListExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbedded.py + $ref: examples/TemplateListExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbedded.sh + $ref: examples/TemplateListExample.sh x-meta: seo: - title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.' - /unclaimed_draft/create_embedded_with_template: + title: 'List Templates | API Documentation | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.' + '/template/remove_user/{template_id}': post: tags: - - 'Unclaimed Draft' - summary: 'Create Embedded Unclaimed Draft with Template' - description: |- - Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. - - **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. - operationId: unclaimedDraftCreateEmbeddedWithTemplate + - Template + summary: 'Remove User from Template' + description: 'Removes the specified Account''s access to the specified Template.' + operationId: templateRemoveUser + parameters: + - + name: template_id + in: path + description: 'The id of the Template to remove the Account''s access to.' + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + example: + $ref: '#/components/examples/TemplateRemoveUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7403,11 +7096,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateRemoveUserResponse' + '4XX': description: failed_operation content: application/json: @@ -7415,102 +7108,105 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php + $ref: examples/TemplateRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js + $ref: examples/TemplateRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts + $ref: examples/TemplateRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java + $ref: examples/TemplateRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb + $ref: examples/TemplateRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py + $ref: examples/TemplateRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh + $ref: examples/TemplateRemoveUserExample.sh x-meta: seo: - title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.' - '/unclaimed_draft/edit_and_resend/{signature_request_id}': + title: 'Remove User from Template | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.' + '/template/update_files/{template_id}': post: tags: - - 'Unclaimed Draft' - summary: 'Edit and Resend Unclaimed Draft' + - Template + summary: 'Update Template Files' description: |- - Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. + Overlays a new file with the overlay of an existing template. The new file(s) must: - **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. - operationId: unclaimedDraftEditAndResend - parameters: - - - name: signature_request_id - in: path - description: 'The ID of the signature request to edit and resend.' + 1. have the same or higher page count + 2. the same orientation as the file(s) being replaced. + + This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. + + Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. + + It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + + If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + operationId: templateUpdateFiles + parameters: + - + name: template_id + in: path + description: 'The ID of the template whose files to update.' required: true schema: type: string - example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' + $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateUpdateFilesRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7522,11 +7218,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' - 4XX: + example: + $ref: '#/components/examples/TemplateUpdateFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -7534,123 +7230,558 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftEditAndResend.php + $ref: examples/TemplateUpdateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.cs + $ref: examples/TemplateUpdateFilesExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/TemplateUpdateFilesExample.ts + - + lang: Java + label: Java + source: + $ref: examples/TemplateUpdateFilesExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/TemplateUpdateFilesExample.rb + - + lang: Python + label: Python + source: + $ref: examples/TemplateUpdateFilesExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/TemplateUpdateFilesExample.sh + x-meta: + seo: + title: 'Update Template Files | REST API | Dropbox Sign for Developers' + description: 'Overlays a new file with the overlay of an existing template' + /unclaimed_draft/create: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Unclaimed Draft' + description: 'Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.' + operationId: unclaimedDraftCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateResponse' + '4XX': + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftCreateExample.php - - lang: JavaScript - label: JavaScript + lang: 'C#' + label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.js + $ref: examples/UnclaimedDraftCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftEditAndResend.ts + $ref: examples/UnclaimedDraftCreateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftEditAndResend.java + $ref: examples/UnclaimedDraftCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftEditAndResend.rb + $ref: examples/UnclaimedDraftCreateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftEditAndResend.py + $ref: examples/UnclaimedDraftCreateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftEditAndResend.sh + $ref: examples/UnclaimedDraftCreateExample.sh x-meta: seo: - title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.' -components: - schemas: - AccountCreateRequest: - required: - - email_address - properties: - client_id: - description: |- - Used when creating a new account with OAuth authorization. + title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.' + /unclaimed_draft/create_embedded: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Embedded Unclaimed Draft' + description: |- + Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. - See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) - type: string - client_secret: - description: |- - Used when creating a new account with OAuth authorization. + **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + operationId: unclaimedDraftCreateEmbedded + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponse' + '4XX': + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.sh + x-meta: + seo: + title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.' + /unclaimed_draft/create_embedded_with_template: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Embedded Unclaimed Draft with Template' + description: |- + Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. - See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) - type: string - email_address: - description: 'The email address which will be associated with the new Account.' - type: string - format: email - locale: - description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' - type: string - type: object - AccountUpdateRequest: - properties: - account_id: - description: 'The ID of the Account' - type: string - nullable: true - callback_url: - description: 'The URL that Dropbox Sign should POST events to.' - type: string - locale: - description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' - type: string - type: object - AccountVerifyRequest: - required: - - email_address - properties: - email_address: - description: 'Email address to run the verification for.' - type: string - format: email - type: object - ApiAppCreateRequest: - required: + **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + operationId: unclaimedDraftCreateEmbeddedWithTemplate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponse' + '4XX': + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh + x-meta: + seo: + title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.' + '/unclaimed_draft/edit_and_resend/{signature_request_id}': + post: + tags: + - 'Unclaimed Draft' + summary: 'Edit and Resend Unclaimed Draft' + description: |- + Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. + + **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + operationId: unclaimedDraftEditAndResend + parameters: + - + name: signature_request_id + in: path + description: 'The ID of the signature request to edit and resend.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendRequest' + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResend' + '4XX': + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftEditAndResendExample.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftEditAndResendExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftEditAndResendExample.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftEditAndResendExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftEditAndResendExample.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftEditAndResendExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftEditAndResendExample.sh + x-meta: + seo: + title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.' +components: + schemas: + AccountCreateRequest: + required: + - email_address + properties: + client_id: + description: |- + Used when creating a new account with OAuth authorization. + + See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) + type: string + client_secret: + description: |- + Used when creating a new account with OAuth authorization. + + See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) + type: string + email_address: + description: 'The email address which will be associated with the new Account.' + type: string + format: email + locale: + description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' + type: string + type: object + AccountUpdateRequest: + properties: + account_id: + description: 'The ID of the Account' + type: string + nullable: true + callback_url: + description: 'The URL that Dropbox Sign should POST events to.' + type: string + locale: + description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' + type: string + type: object + AccountVerifyRequest: + required: + - email_address + properties: + email_address: + description: 'Email address to run the verification for.' + type: string + format: email + type: object + ApiAppCreateRequest: + required: - name - domains properties: @@ -7757,7 +7888,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: description: 'Account ID' @@ -7850,20 +7981,20 @@ components: - country properties: area_code: - description: 'Area code' + description: 'Area code of the new Fax Line' type: integer country: - description: Country + description: 'Country of the area code' type: string enum: - CA - US - UK city: - description: City + description: 'City of the area code' type: string account_id: - description: 'Account ID' + description: 'Account ID of the account that will be assigned this new Fax Line' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 type: object @@ -7872,7 +8003,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string type: object FaxLineRemoveUserRequest: @@ -7880,14 +8011,14 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: - description: 'Account ID' + description: 'Account ID of the user to remove access' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 email_address: - description: 'Email address' + description: 'Email address of the user to remove access' type: string format: email type: object @@ -7896,7 +8027,9 @@ components: - recipient properties: recipient: - description: 'Fax Send To Recipient' + description: |- + Recipient of the fax + Can be a phone number in E.164 format or email address type: string example: recipient@example.com sender: @@ -7904,13 +8037,19 @@ components: type: string example: sender@example.com files: - description: 'Fax File to Send' + description: |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: - description: 'Fax File URL to Send' + description: |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string @@ -7919,11 +8058,11 @@ components: type: boolean default: false cover_page_to: - description: 'Fax Cover Page for Recipient' + description: 'Fax cover page recipient information' type: string example: 'Recipient Name' cover_page_from: - description: 'Fax Cover Page for Sender' + description: 'Fax cover page sender information' type: string example: 'Sender Name' cover_page_message: @@ -8119,27 +8258,361 @@ components: Example CSV: - ``` - name, email_address, pin, company_field - George, george@example.com, d79a3td, ABC Corp - Mary, mary@example.com, gd9as5b, 123 LLC - ``` - type: string - format: binary - signer_list: - description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.' + ``` + name, email_address, pin, company_field + George, george@example.com, d79a3td, ABC Corp + Mary, mary@example.com, gd9as5b, 123 LLC + ``` + type: string + format: binary + signer_list: + description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.' + type: array + items: + $ref: '#/components/schemas/SubBulkSignerList' + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.' + type: string + custom_fields: + description: |- + When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + + Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + + For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + type: array + items: + $ref: '#/components/schemas/SubCustomField' + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signing_redirect_url: + description: 'The URL you want signers redirected to after they successfully sign.' + type: string + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + type: object + SignatureRequestCreateEmbeddedRequest: + required: + - client_id + properties: + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + signers: + description: |- + Add Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: |- + Add Grouped Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + allow_reassign: + description: |- + Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + + **NOTE:** Only available for Premium plan. + type: boolean + default: false + attachments: + description: 'A list describing the attachments' + type: array + items: + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: 'The email addresses that should be CCed.' + type: array + items: + type: string + format: email + client_id: + description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' + type: string + custom_fields: + description: |- + When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + + Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + + For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + type: array + items: + $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + form_field_groups: + description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + form_field_rules: + description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + form_fields_per_document: + description: |- + The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + + **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + + * Text Field use `SubFormFieldsPerDocumentText` + * Dropdown Field use `SubFormFieldsPerDocumentDropdown` + * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` + * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` + * Radio Field use `SubFormFieldsPerDocumentRadio` + * Signature Field use `SubFormFieldsPerDocumentSignature` + * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` + * Initials Field use `SubFormFieldsPerDocumentInitials` + * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` + * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + hide_text_tags: + description: |- + Enables automatic Text Tag removal when set to true. + + **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + type: boolean + default: false + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + use_text_tags: + description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' + type: boolean + default: false + populate_auto_fill_fields: + description: |- + Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. + + **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + type: boolean + default: false + expires_at: + description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' + type: integer + nullable: true + type: object + SignatureRequestCreateEmbeddedWithTemplateRequest: + required: + - client_id + - template_ids + - signers + properties: + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + type: array + items: + type: string + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' + type: string + custom_fields: + description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signers: + description: 'Add Signers to your Templated-based Signature Request.' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + populate_auto_fill_fields: + description: |- + Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. + + **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + type: boolean + default: false + type: object + SignatureRequestEditRequest: + properties: + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + signers: + description: |- + Add Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: |- + Add Grouped Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. type: array items: - $ref: '#/components/schemas/SubBulkSignerList' + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - ccs: - description: 'Add CC email recipients. Required when a CC role exists for the Template.' + allow_reassign: + description: |- + Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + + **NOTE:** Only available for Premium plan and higher. + type: boolean + default: false + attachments: + description: 'A list describing the attachments' type: array items: - $ref: '#/components/schemas/SubCC' + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: 'The email addresses that should be CCed.' + type: array + items: + type: string + format: email client_id: description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.' type: string @@ -8153,6 +8626,52 @@ components: type: array items: $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + form_field_groups: + description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + form_field_rules: + description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + form_fields_per_document: + description: |- + The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + + **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + + * Text Field use `SubFormFieldsPerDocumentText` + * Dropdown Field use `SubFormFieldsPerDocumentDropdown` + * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` + * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` + * Radio Field use `SubFormFieldsPerDocumentRadio` + * Signature Field use `SubFormFieldsPerDocumentSignature` + * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` + * Initials Field use `SubFormFieldsPerDocumentInitials` + * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` + * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + hide_text_tags: + description: |- + Enables automatic Text Tag removal when set to true. + + **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + type: boolean + default: false + is_eid: + description: |- + Send with a value of `true` if you wish to enable + [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + type: boolean + default: false message: description: 'The custom message in the email that will be sent to the signers.' type: string @@ -8165,6 +8684,8 @@ components: type: object maxItems: 10 additionalProperties: {} + signing_options: + $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string @@ -8180,8 +8701,16 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + use_text_tags: + description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' + type: boolean + default: false + expires_at: + description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' + type: integer + nullable: true type: object - SignatureRequestCreateEmbeddedRequest: + SignatureRequestEditEmbeddedRequest: required: - client_id properties: @@ -8333,7 +8862,7 @@ components: type: integer nullable: true type: object - SignatureRequestCreateEmbeddedWithTemplateRequest: + SignatureRequestEditEmbeddedWithTemplateRequest: required: - client_id - template_ids @@ -8417,6 +8946,94 @@ components: type: boolean default: false type: object + SignatureRequestEditWithTemplateRequest: + description: '' + required: + - signers + - template_ids + properties: + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + type: array + items: + type: string + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.' + type: string + custom_fields: + description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + is_eid: + description: |- + Send with a value of `true` if you wish to enable + [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + type: boolean + default: false + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signers: + description: 'Add Signers to your Templated-based Signature Request.' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + signing_redirect_url: + description: 'The URL you want signers redirected to after they successfully sign.' + type: string + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + type: object SignatureRequestRemindRequest: required: - email_address @@ -13085,498 +13702,522 @@ components: type: string default: 'Hello API Event Received' examples: - AccountCreateRequestDefaultExample: + AccountCreateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountCreateRequestDefaultExample.json - AccountCreateRequestOAuthExample: + $ref: examples/json/AccountCreateRequest.json + AccountCreateRequestOAuth: summary: 'OAuth Example' value: - $ref: examples/json/AccountCreateRequestOAuthExample.json - AccountUpdateRequestDefaultExample: + $ref: examples/json/AccountCreateRequestOAuth.json + AccountUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountUpdateRequestDefaultExample.json - AccountVerifyRequestDefaultExample: + $ref: examples/json/AccountUpdateRequest.json + AccountVerifyRequest: summary: 'Default Example' value: - $ref: examples/json/AccountVerifyRequestDefaultExample.json - ApiAppCreateRequestDefaultExample: + $ref: examples/json/AccountVerifyRequest.json + ApiAppCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppCreateRequestDefaultExample.json - ApiAppUpdateRequestDefaultExample: + $ref: examples/json/ApiAppCreateRequest.json + ApiAppUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppUpdateRequestDefaultExample.json - EmbeddedEditUrlRequestDefaultExample: + $ref: examples/json/ApiAppUpdateRequest.json + EmbeddedEditUrlRequest: summary: 'Default Example' value: - $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json - FaxLineAddUserRequestExample: + $ref: examples/json/EmbeddedEditUrlRequest.json + FaxLineAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineAddUserRequestExample.json - FaxLineCreateRequestExample: + $ref: examples/json/FaxLineAddUserRequest.json + FaxLineCreateRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineCreateRequestExample.json - FaxLineDeleteRequestExample: + $ref: examples/json/FaxLineCreateRequest.json + FaxLineDeleteRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineDeleteRequestExample.json - FaxLineRemoveUserRequestExample: + $ref: examples/json/FaxLineDeleteRequest.json + FaxLineRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineRemoveUserRequestExample.json - FaxSendRequestExample: + $ref: examples/json/FaxLineRemoveUserRequest.json + FaxSendRequest: summary: 'Default Example' value: - $ref: examples/json/FaxSendRequestExample.json - OAuthTokenGenerateRequestExample: + $ref: examples/json/FaxSendRequest.json + OAuthTokenGenerateRequest: summary: 'OAuth Token Generate Example' value: - $ref: examples/json/OAuthTokenGenerateRequestExample.json - OAuthTokenRefreshRequestExample: + $ref: examples/json/OAuthTokenGenerateRequest.json + OAuthTokenRefreshRequest: summary: 'OAuth Token Refresh Example' value: - $ref: examples/json/OAuthTokenRefreshRequestExample.json - ReportCreateRequestDefaultExample: + $ref: examples/json/OAuthTokenRefreshRequest.json + ReportCreateRequest: + summary: 'Default Example' + value: + $ref: examples/json/ReportCreateRequest.json + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json + SignatureRequestBulkSendWithTemplateRequest: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestBulkSendWithTemplateRequest.json + SignatureRequestCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/ReportCreateRequestDefaultExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequest.json + SignatureRequestCreateEmbeddedRequestGroupedSigners: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json + SignatureRequestCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestBulkSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json + SignatureRequestEditRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestEditRequest.json + SignatureRequestEditRequestGroupedSigners: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestEditRequestGroupedSigners.json + SignatureRequestEditEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequest.json + SignatureRequestEditEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json - SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json + SignatureRequestEditEmbeddedWithTemplateRequest: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json + SignatureRequestEditWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestRemindRequestDefaultExample: + $ref: examples/json/SignatureRequestEditWithTemplateRequest.json + SignatureRequestRemindRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestRemindRequestDefaultExample.json - SignatureRequestSendRequestDefaultExample: + $ref: examples/json/SignatureRequestRemindRequest.json + SignatureRequestSendRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendRequestDefaultExample.json - SignatureRequestSendRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestSendRequest.json + SignatureRequestSendRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestSendRequestGroupedSignersExample.json - SignatureRequestSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendRequestGroupedSigners.json + SignatureRequestSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json - SignatureRequestUpdateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendWithTemplateRequest.json + SignatureRequestUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestUpdateRequestDefaultExample.json - TeamAddMemberRequestEmailAddressExample: + $ref: examples/json/SignatureRequestUpdateRequest.json + TeamAddMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamAddMemberRequestEmailAddressExample.json - TeamAddMemberRequestAccountIdExample: + $ref: examples/json/TeamAddMemberRequest.json + TeamAddMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamAddMemberRequestAccountIdExample.json - TeamCreateRequestDefaultExample: + $ref: examples/json/TeamAddMemberRequestAccountId.json + TeamCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamCreateRequestDefaultExample.json - TeamRemoveMemberRequestEmailAddressExample: + $ref: examples/json/TeamCreateRequest.json + TeamRemoveMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamRemoveMemberRequestEmailAddressExample.json - TeamRemoveMemberRequestAccountIdExample: + $ref: examples/json/TeamRemoveMemberRequest.json + TeamRemoveMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamRemoveMemberRequestAccountIdExample.json - TeamUpdateRequestDefaultExample: + $ref: examples/json/TeamRemoveMemberRequestAccountId.json + TeamUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamUpdateRequestDefaultExample.json - TemplateAddUserRequestDefaultExample: + $ref: examples/json/TeamUpdateRequest.json + TemplateAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateAddUserRequestDefaultExample.json - TemplateCreateRequestDefaultExample: + $ref: examples/json/TemplateAddUserRequest.json + TemplateCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateRequestDefaultExample.json - TemplateCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateRequest.json + TemplateCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json - TemplateCreateRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateRequestFormFieldsPerDocument.json + TemplateCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json - TemplateCreateRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateRequestFormFieldGroups.json + TemplateCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json - TemplateCreateEmbeddedDraftRequestDefaultExample: + $ref: examples/json/TemplateCreateRequestFormFieldRules.json + TemplateCreateEmbeddedDraftRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json - TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequest.json + TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json - TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json + TemplateCreateEmbeddedDraftRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json - TemplateCreateEmbeddedDraftRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json + TemplateCreateEmbeddedDraftRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json - TemplateRemoveUserRequestDefaultExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json + TemplateRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateRemoveUserRequestDefaultExample.json - TemplateUpdateFilesRequestDefaultExample: + $ref: examples/json/TemplateRemoveUserRequest.json + TemplateUpdateFilesRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateUpdateFilesRequestDefaultExample.json - UnclaimedDraftCreateRequestDefaultExample: + $ref: examples/json/TemplateUpdateFilesRequest.json + UnclaimedDraftCreateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestDefaultExample.json - UnclaimedDraftCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateRequest.json + UnclaimedDraftCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json + UnclaimedDraftCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json - UnclaimedDraftCreateRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json + UnclaimedDraftCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequest.json + UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json + UnclaimedDraftCreateEmbeddedRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json + UnclaimedDraftCreateEmbeddedRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json - UnclaimedDraftEditAndResendRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json + UnclaimedDraftEditAndResendRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json - AccountCreateResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResendRequest.json + AccountCreateResponse: summary: 'Account Create' value: - $ref: examples/json/AccountCreateResponseExample.json - AccountCreateOAuthResponseExample: + $ref: examples/json/AccountCreateResponse.json + AccountCreateOAuthResponse: summary: 'Account Create with OAuth Authorization' value: - $ref: examples/json/AccountCreateOAuthResponseExample.json - AccountGetResponseExample: + $ref: examples/json/AccountCreateOAuthResponse.json + AccountGetResponse: summary: 'Account Get' value: - $ref: examples/json/AccountGetResponseExample.json - AccountVerifyFoundResponseExample: + $ref: examples/json/AccountGetResponse.json + AccountVerifyFoundResponse: summary: 'Account Found' value: - $ref: examples/json/AccountVerifyFoundResponseExample.json - AccountVerifyNotFoundResponseExample: + $ref: examples/json/AccountVerifyFoundResponse.json + AccountVerifyNotFoundResponse: summary: 'Account Not Found' value: - $ref: examples/json/AccountVerifyNotFoundResponseExample.json - ApiAppGetResponseExample: + $ref: examples/json/AccountVerifyNotFoundResponse.json + ApiAppGetResponse: summary: 'API App' value: - $ref: examples/json/ApiAppGetResponseExample.json - ApiAppListResponseExample: + $ref: examples/json/ApiAppGetResponse.json + ApiAppListResponse: summary: 'API App List' value: - $ref: examples/json/ApiAppListResponseExample.json - BulkSendJobGetResponseExample: + $ref: examples/json/ApiAppListResponse.json + BulkSendJobGetResponse: summary: 'Bulk Send Job' value: - $ref: examples/json/BulkSendJobGetResponseExample.json - BulkSendJobListResponseExample: + $ref: examples/json/BulkSendJobGetResponse.json + BulkSendJobListResponse: summary: 'Bulk Send Job List' value: - $ref: examples/json/BulkSendJobListResponseExample.json - EmbeddedEditUrlResponseExample: + $ref: examples/json/BulkSendJobListResponse.json + EmbeddedEditUrlResponse: summary: 'Embedded Edit URL' value: - $ref: examples/json/EmbeddedEditUrlResponseExample.json - EmbeddedSignUrlResponseExample: + $ref: examples/json/EmbeddedEditUrlResponse.json + EmbeddedSignUrlResponse: summary: 'Embedded Sign URL' value: - $ref: examples/json/EmbeddedSignUrlResponseExample.json - Error400ResponseExample: + $ref: examples/json/EmbeddedSignUrlResponse.json + Error400Response: summary: 'Error 400 bad_request' value: - $ref: examples/json/Error400ResponseExample.json - Error401ResponseExample: + $ref: examples/json/Error400Response.json + Error401Response: summary: 'Error 401 unauthorized' value: - $ref: examples/json/Error401ResponseExample.json - Error402ResponseExample: + $ref: examples/json/Error401Response.json + Error402Response: summary: 'Error 402 payment_required' value: - $ref: examples/json/Error402ResponseExample.json - Error403ResponseExample: + $ref: examples/json/Error402Response.json + Error403Response: summary: 'Error 403 forbidden' value: - $ref: examples/json/Error403ResponseExample.json - Error404ResponseExample: + $ref: examples/json/Error403Response.json + Error404Response: summary: 'Error 404 not_found' value: - $ref: examples/json/Error404ResponseExample.json - Error409ResponseExample: + $ref: examples/json/Error404Response.json + Error409Response: summary: 'Error 409 conflict' value: - $ref: examples/json/Error409ResponseExample.json - Error410ResponseExample: + $ref: examples/json/Error409Response.json + Error410Response: summary: 'Error 410 deleted' value: - $ref: examples/json/Error410ResponseExample.json - Error422ResponseExample: + $ref: examples/json/Error410Response.json + Error422Response: summary: 'Error 422 unprocessable_entity' value: - $ref: examples/json/Error422ResponseExample.json - Error429ResponseExample: + $ref: examples/json/Error422Response.json + Error429Response: summary: 'Error 429 exceeded_rate' value: - $ref: examples/json/Error429ResponseExample.json - Error4XXResponseExample: + $ref: examples/json/Error429Response.json + Error4XXResponse: summary: 'Error 4XX failed_operation' value: - $ref: examples/json/Error4XXResponseExample.json - FaxGetResponseExample: + $ref: examples/json/Error4XXResponse.json + FaxGetResponse: summary: 'Fax Response' value: - $ref: examples/json/FaxGetResponseExample.json - FaxLineResponseExample: + $ref: examples/json/FaxGetResponse.json + FaxLineResponse: summary: 'Sample Fax Line Response' value: - $ref: examples/json/FaxLineResponseExample.json - FaxLineAreaCodeGetResponseExample: + $ref: examples/json/FaxLineResponse.json + FaxLineAreaCodeGetResponse: summary: 'Sample Area Code Response' value: - $ref: examples/json/FaxLineAreaCodeGetResponseExample.json - FaxLineListResponseExample: + $ref: examples/json/FaxLineAreaCodeGetResponse.json + FaxLineListResponse: summary: 'Sample Fax Line List Response' value: - $ref: examples/json/FaxLineListResponseExample.json - FaxListResponseExample: - summary: 'Returns the properties and settings of multiple Faxes.' + $ref: examples/json/FaxLineListResponse.json + FaxListResponse: + summary: 'Returns the properties and settings of multiple Faxes' value: - $ref: examples/json/FaxListResponseExample.json - ReportCreateResponseExample: + $ref: examples/json/FaxListResponse.json + ReportCreateResponse: summary: Report value: - $ref: examples/json/ReportCreateResponseExample.json - SignatureRequestGetResponseExample: + $ref: examples/json/ReportCreateResponse.json + SignatureRequestGetResponse: summary: 'Get Signature Request' value: - $ref: examples/json/SignatureRequestGetResponseExample.json - SignatureRequestListResponseExample: + $ref: examples/json/SignatureRequestGetResponse.json + SignatureRequestListResponse: summary: 'List Signature Requests' value: - $ref: examples/json/SignatureRequestListResponseExample.json - AccountUpdateResponseExample: + $ref: examples/json/SignatureRequestListResponse.json + AccountUpdateResponse: summary: 'Account Update' value: - $ref: examples/json/AccountUpdateResponseExample.json - OAuthTokenGenerateResponseExample: + $ref: examples/json/AccountUpdateResponse.json + OAuthTokenGenerateResponse: summary: 'Retrieving the OAuth token' value: - $ref: examples/json/OAuthTokenGenerateResponseExample.json - OAuthTokenRefreshResponseExample: + $ref: examples/json/OAuthTokenGenerateResponse.json + OAuthTokenRefreshResponse: summary: 'Refresh an existing OAuth token' value: - $ref: examples/json/OAuthTokenRefreshResponseExample.json - ApiAppCreateResponseExample: + $ref: examples/json/OAuthTokenRefreshResponse.json + ApiAppCreateResponse: summary: 'API App' value: - $ref: examples/json/ApiAppCreateResponseExample.json - ApiAppUpdateResponseExample: + $ref: examples/json/ApiAppCreateResponse.json + ApiAppUpdateResponse: summary: 'API App Update' value: - $ref: examples/json/ApiAppUpdateResponseExample.json - SignatureRequestCreateEmbeddedResponseExample: + $ref: examples/json/ApiAppUpdateResponse.json + SignatureRequestCreateEmbeddedResponse: summary: 'Create Embedded Signature Request' value: - $ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json - SignatureRequestCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json + SignatureRequestCreateEmbeddedWithTemplateResponse: summary: 'Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json - SignatureRequestFilesResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json + SignatureRequestFilesResponse: summary: 'Signature Requests Files' value: - $ref: examples/json/SignatureRequestFilesResponseExample.json - SignatureRequestReleaseHoldResponseExample: + $ref: examples/json/SignatureRequestFilesResponse.json + SignatureRequestReleaseHoldResponse: summary: 'Send Signature Release Hold' value: - $ref: examples/json/SignatureRequestReleaseHoldResponseExample.json - SignatureRequestRemindResponseExample: + $ref: examples/json/SignatureRequestReleaseHoldResponse.json + SignatureRequestRemindResponse: summary: 'Send Signature Request Reminder' value: - $ref: examples/json/SignatureRequestRemindResponseExample.json - SignatureRequestSendResponseExample: + $ref: examples/json/SignatureRequestRemindResponse.json + SignatureRequestSendResponse: summary: 'Send Signature Request' value: - $ref: examples/json/SignatureRequestSendResponseExample.json - SignatureRequestSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestSendResponse.json + SignatureRequestSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json - SignatureRequestUpdateResponseExample: + $ref: examples/json/SignatureRequestSendWithTemplateResponse.json + SignatureRequestUpdateResponse: summary: 'Signature Request Update' value: - $ref: examples/json/SignatureRequestUpdateResponseExample.json - SignatureRequestBulkSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestUpdateResponse.json + SignatureRequestBulkSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json + SignatureRequestBulkCreateEmbeddedWithTemplateResponse: summary: 'Bulk Send Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json - TeamCreateResponseExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json + TeamCreateResponse: summary: 'Team Create' value: - $ref: examples/json/TeamCreateResponseExample.json - TeamMembersResponseExample: + $ref: examples/json/TeamCreateResponse.json + TeamMembersResponse: summary: 'Team Members List' value: - $ref: examples/json/TeamMembersResponseExample.json - TeamRemoveMemberResponseExample: + $ref: examples/json/TeamMembersResponse.json + TeamRemoveMemberResponse: summary: 'Team Remove Member' value: - $ref: examples/json/TeamRemoveMemberResponseExample.json - TeamUpdateResponseExample: + $ref: examples/json/TeamRemoveMemberResponse.json + TeamUpdateResponse: summary: 'Team Update' value: - $ref: examples/json/TeamUpdateResponseExample.json - TeamDoesNotExistResponseExample: + $ref: examples/json/TeamUpdateResponse.json + TeamDoesNotExistResponse: summary: 'Team Does Not Exist' value: - $ref: examples/json/TeamDoesNotExistResponseExample.json - TemplateAddUserResponseExample: + $ref: examples/json/TeamDoesNotExistResponse.json + TemplateAddUserResponse: summary: 'Add User to Template' value: - $ref: examples/json/TemplateAddUserResponseExample.json - TemplateFilesResponseExample: + $ref: examples/json/TemplateAddUserResponse.json + TemplateFilesResponse: summary: 'Template Files' value: - $ref: examples/json/TemplateFilesResponseExample.json - TemplateRemoveUserResponseExample: + $ref: examples/json/TemplateFilesResponse.json + TemplateRemoveUserResponse: summary: 'Remove User from Template' value: - $ref: examples/json/TemplateRemoveUserResponseExample.json - UnclaimedDraftCreateEmbeddedResponseExample: + $ref: examples/json/TemplateRemoveUserResponse.json + UnclaimedDraftCreateEmbeddedResponse: summary: 'Unclaimed Draft Create Embedded' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json - UnclaimedDraftCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json + UnclaimedDraftCreateEmbeddedWithTemplateResponse: summary: 'Unclaimed Draft Create Embedded With Template' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json - UnclaimedDraftEditAndResendExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json + UnclaimedDraftEditAndResend: summary: 'Unclaimed Draft Edit and Resend' value: - $ref: examples/json/UnclaimedDraftEditAndResendExample.json - TeamGetResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResend.json + TeamGetResponse: summary: 'Team Get' value: - $ref: examples/json/TeamGetResponseExample.json - TeamGetInfoResponseExample: + $ref: examples/json/TeamGetResponse.json + TeamGetInfoResponse: summary: 'Team Get Info' value: - $ref: examples/json/TeamGetInfoResponseExample.json - TeamInvitesResponseExample: + $ref: examples/json/TeamGetInfoResponse.json + TeamInvitesResponse: summary: 'Team Invites' value: - $ref: examples/json/TeamInvitesResponseExample.json - TeamAddMemberResponseExample: + $ref: examples/json/TeamInvitesResponse.json + TeamAddMemberResponse: summary: 'Team Add Member' value: - $ref: examples/json/TeamAddMemberResponseExample.json - TeamSubTeamsResponseExample: + $ref: examples/json/TeamAddMemberResponse.json + TeamSubTeamsResponse: summary: 'Team Sub Teams List' value: - $ref: examples/json/TeamSubTeamsResponseExample.json - TemplateCreateResponseExample: + $ref: examples/json/TeamSubTeamsResponse.json + TemplateCreateResponse: summary: 'Create Template' value: - $ref: examples/json/TemplateCreateResponseExample.json - TemplateCreateEmbeddedDraftResponseExample: + $ref: examples/json/TemplateCreateResponse.json + TemplateCreateEmbeddedDraftResponse: summary: 'Create Embedded Draft Template' value: - $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json - TemplateGetResponseExample: + $ref: examples/json/TemplateCreateEmbeddedDraftResponse.json + TemplateGetResponse: summary: 'Get Template' value: - $ref: examples/json/TemplateGetResponseExample.json - TemplateListResponseExample: + $ref: examples/json/TemplateGetResponse.json + TemplateListResponse: summary: 'List Templates' value: - $ref: examples/json/TemplateListResponseExample.json - TemplateUpdateFilesResponseExample: + $ref: examples/json/TemplateListResponse.json + TemplateUpdateFilesResponse: summary: 'Update Template Files' value: - $ref: examples/json/TemplateUpdateFilesResponseExample.json - UnclaimedDraftCreateResponseExample: + $ref: examples/json/TemplateUpdateFilesResponse.json + UnclaimedDraftCreateResponse: summary: 'Unclaimed Draft Create' value: - $ref: examples/json/UnclaimedDraftCreateResponseExample.json - EventCallbackAccountSignatureRequestSentExample: + $ref: examples/json/UnclaimedDraftCreateResponse.json + EventCallbackAccountSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json - EventCallbackAccountTemplateCreatedExample: + $ref: examples/json/EventCallbackAccountSignatureRequestSent.json + EventCallbackAccountTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json - EventCallbackAppAccountConfirmedExample: + $ref: examples/json/EventCallbackAccountTemplateCreated.json + EventCallbackAppAccountConfirmed: summary: 'Example: account_confirmed' value: - $ref: examples/json/EventCallbackAppAccountConfirmedExample.json - EventCallbackAppSignatureRequestSentExample: + $ref: examples/json/EventCallbackAppAccountConfirmed.json + EventCallbackAppSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json - EventCallbackAppTemplateCreatedExample: + $ref: examples/json/EventCallbackAppSignatureRequestSent.json + EventCallbackAppTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAppTemplateCreatedExample.json + $ref: examples/json/EventCallbackAppTemplateCreated.json requestBodies: EventCallbackAccountRequest: description: |- @@ -13588,9 +14229,9 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAccountSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAccountTemplateCreated' EventCallbackAppRequest: description: |- **API App Callback Payloads --** @@ -13601,11 +14242,11 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: account_confirmed_example: - $ref: '#/components/examples/EventCallbackAppAccountConfirmedExample' + $ref: '#/components/examples/EventCallbackAppAccountConfirmed' signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAppSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAppSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAppTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAppTemplateCreated' headers: X-RateLimit-Limit: description: 'The maximum number of requests per hour that you can make.' @@ -13642,6 +14283,7 @@ components: security: - api_key: [] + - oauth2: - account_access - signature_request_access @@ -13669,37 +14311,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: @@ -13722,37 +14359,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: diff --git a/pyproject.toml b/pyproject.toml index 9e4a325..9c6179c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "dropbox_sign" -version = "1.8.0" +version = "1.9.0" description = "Dropbox Sign API" authors = ["Official Python SDK for the Dropbox Sign API "] license = "MIT" @@ -10,19 +10,20 @@ keywords = ["OpenAPI", "OpenAPI-Generator", "Dropbox Sign API"] include = ["dropbox_sign/py.typed"] [tool.poetry.dependencies] -python = "^3.7" +python = "^3.8" -urllib3 = ">= 1.25.3" -python-dateutil = ">=2.8.2" -pydantic = ">=2" -typing-extensions = ">=4.7.1" +urllib3 = ">= 1.25.3, < 3.0.0" +python-dateutil = ">= 2.8.2" +pydantic = ">= 2" +typing-extensions = ">= 4.7.1" [tool.poetry.dev-dependencies] -pytest = ">=7.2.1" -tox = ">=3.9.0" -flake8 = ">=4.0.0" -types-python-dateutil = ">=2.8.19.14" -mypy = "1.4.1" +pytest = ">= 7.2.1" +pytest-cov = ">= 2.8.1" +tox = ">= 3.9.0" +flake8 = ">= 4.0.0" +types-python-dateutil = ">= 2.8.19.14" +mypy = ">= 1.5" [build-system] @@ -48,7 +49,7 @@ warn_unused_ignores = true ## Getting these passing should be easy strict_equality = true -strict_concatenate = true +extra_checks = true ## Strongly recommend enabling this one as soon as you can check_untyped_defs = true @@ -69,3 +70,20 @@ disallow_any_generics = true # ### This one can be tricky to get passing if you use a lot of untyped libraries #warn_return_any = true + +[[tool.mypy.overrides]] +module = [ + "dropbox_sign.configuration", +] +warn_unused_ignores = true +strict_equality = true +extra_checks = true +check_untyped_defs = true +disallow_subclassing_any = true +disallow_untyped_decorators = true +disallow_any_generics = true +disallow_untyped_calls = true +disallow_incomplete_defs = true +disallow_untyped_defs = true +no_implicit_reexport = true +warn_return_any = true diff --git a/requirements.txt b/requirements.txt index cc85509..67f7f68 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,4 @@ -python_dateutil >= 2.5.3 -setuptools >= 21.0.0 -urllib3 >= 1.25.3, < 2.1.0 +urllib3 >= 1.25.3, < 3.0.0 +python_dateutil >= 2.8.2 pydantic >= 2 typing-extensions >= 4.7.1 diff --git a/run-build b/run-build index bfa3008..179dec4 100755 --- a/run-build +++ b/run-build @@ -18,7 +18,7 @@ rm -f "${DIR}/dropbox_sign/models/"*.py docker run --rm \ -v "${DIR}/:/local" \ - openapitools/openapi-generator-cli:v7.8.0 generate \ + openapitools/openapi-generator-cli:v7.12.0 generate \ -i "/local/openapi-sdk.yaml" \ -c "/local/openapi-config.yaml" \ -t "/local/templates" \ diff --git a/setup.py b/setup.py index 15a2f1c..a33217a 100644 --- a/setup.py +++ b/setup.py @@ -23,11 +23,11 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "dropbox-sign" -VERSION = "1.8.0" -PYTHON_REQUIRES = ">=3.7" +VERSION = "1.9.0" +PYTHON_REQUIRES = ">= 3.8" REQUIRES = [ - "urllib3 >= 1.25.3, < 2.1.0", - "python-dateutil", + "urllib3 >= 1.25.3, < 3.0.0", + "python-dateutil >= 2.8.2", "pydantic >= 2", "typing-extensions >= 4.7.1", ] diff --git a/templates/README.mustache b/templates/README.mustache index 5fe4264..bcbbacf 100644 --- a/templates/README.mustache +++ b/templates/README.mustache @@ -111,6 +111,7 @@ import {{{packageName}}} {{^useCustomTemplateCode}} ### Tests + Execute `pytest` to run the tests. {{/useCustomTemplateCode}} diff --git a/templates/README_onlypackage.mustache b/templates/README_onlypackage.mustache index ae547b1..2b8bd82 100644 --- a/templates/README_onlypackage.mustache +++ b/templates/README_onlypackage.mustache @@ -26,15 +26,21 @@ This python library package is generated without supporting files like setup.py To be able to use it, you will need these dependencies in your own package that uses this library: -* urllib3 >= 1.25.3 -* python-dateutil +* urllib3 >= 1.25.3, < 3.0.0 +* python-dateutil >= 2.8.2 {{#asyncio}} -* aiohttp +* aiohttp >= 3.8.4 +* aiohttp-retry >= 2.8.3 {{/asyncio}} {{#tornado}} -* tornado>=4.2,<5 +* tornado >= 4.2, < 5 {{/tornado}} -* pydantic +{{#hasHttpSignatureMethods}} +* pem >= 19.3.0 +* pycryptodome >= 3.9.0 +{{/hasHttpSignatureMethods}} +* pydantic >= 2 +* typing-extensions >= 4.7.1 ## Getting Started diff --git a/templates/api.mustache b/templates/api.mustache index 3a3c7cd..f723aea 100644 --- a/templates/api.mustache +++ b/templates/api.mustache @@ -104,7 +104,9 @@ class {{classname}}: _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} _body_params: Optional[bytes] = None {{#useCustomTemplateCode}} @@ -199,6 +201,9 @@ class {{classname}}: if isinstance({{paramName}}, str): with open({{paramName}}, "rb") as _fp: _body_params = _fp.read() + elif isinstance({{paramName}}, tuple): + # drop the filename from the tuple + _body_params = {{paramName}}[1] else: _body_params = {{paramName}} {{/isBinary}} diff --git a/templates/api_client.mustache b/templates/api_client.mustache index 69e75c9..3fd4b39 100644 --- a/templates/api_client.mustache +++ b/templates/api_client.mustache @@ -318,6 +318,10 @@ class ApiClient: try: if response_type == "bytearray": return_data = response_data.data +{{#useCustomTemplateCode}} + elif response_type == "io.IOBase": + return_data = self.__bytearray_to_iobase(response_data) +{{/useCustomTemplateCode}} elif response_type == "file": return_data = self.__deserialize_file(response_data) elif response_type is not None: @@ -415,12 +419,12 @@ class ApiClient: data = json.loads(response_text) except ValueError: data = response_text - elif content_type.startswith("application/json"): + elif re.match(r'^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE): if response_text == "": data = "" else: data = json.loads(response_text) - elif content_type.startswith("text/plain"): + elif re.match(r'^text\/[a-z.+-]+\s*(;|$)', content_type, re.IGNORECASE): data = response_text else: raise ApiException( @@ -528,7 +532,7 @@ class ApiClient: if k in collection_formats: collection_format = collection_formats[k] if collection_format == 'multi': - new_params.extend((k, str(value)) for value in v) + new_params.extend((k, quote(str(value))) for value in v) else: if collection_format == 'ssv': delimiter = ' ' @@ -546,12 +550,15 @@ class ApiClient: return "&".join(["=".join(map(str, item)) for item in new_params]) + def files_parameters( + self, {{^useCustomTemplateCode}} - def files_parameters(self, files: Dict[str, Union[str, bytes]]): + files: Dict[str, Union[str, bytes, List[str], List[bytes], Tuple[str, bytes]]], {{/useCustomTemplateCode}} {{#useCustomTemplateCode}} - def files_parameters(self, files: Dict[str, Union[str, bytes, io.IOBase]]): + files: Dict[str, Union[str, bytes, List[str], List[bytes], Tuple[str, bytes, io.IOBase], io.IOBase, List[io.IOBase]]], {{/useCustomTemplateCode}} + ): """Builds form parameters. :param files: File parameters. @@ -566,6 +573,12 @@ class ApiClient: elif isinstance(v, bytes): filename = k filedata = v + elif isinstance(v, tuple): + filename, filedata = v + elif isinstance(v, list): + for file_param in v: + params.extend(self.files_parameters({k: file_param})) + continue {{#useCustomTemplateCode}} elif isinstance(v, io.IOBase): filename = os.path.basename(v.name) @@ -730,6 +743,15 @@ class ApiClient: return path + {{#useCustomTemplateCode}} + def __bytearray_to_iobase(self, response): + """Convert bytearray to io.IOBase""" + buffer = io.BytesIO() + buffer.write(response.data) + buffer.seek(0) + return buffer + + {{/useCustomTemplateCode}} def __deserialize_primitive(self, data, klass): """Deserializes string to primitive type. diff --git a/templates/api_doc.mustache b/templates/api_doc.mustache index ac6d3f8..b4e3ef5 100644 --- a/templates/api_doc.mustache +++ b/templates/api_doc.mustache @@ -31,10 +31,14 @@ Method | HTTP request | Description > ```{{#returnType}}{{{.}}} {{/returnType}}{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}{{^-last}}, {{/-last}}{{/defaultValue}}{{/requiredParams}})``` {{/useCustomTemplateCode}} -{{{summary}}}{{#notes}} +{{#summary}} +{{{summary}}} -{{{.}}}{{/notes}} +{{/summary}} +{{#unescapedNotes}} +{{{.}}} +{{/unescapedNotes}} ### Example {{#hasAuthMethods}} diff --git a/templates/api_test.mustache b/templates/api_test.mustache index 5354d3c..9d11c83 100644 --- a/templates/api_test.mustache +++ b/templates/api_test.mustache @@ -7,17 +7,31 @@ import unittest from {{apiPackage}}.{{classFilename}} import {{classname}} -class {{#operations}}Test{{classname}}(unittest.TestCase): +class {{#operations}}Test{{classname}}(unittest.{{#asyncio}}IsolatedAsyncio{{/asyncio}}TestCase): """{{classname}} unit test stubs""" + {{#asyncio}} + async def asyncSetUp(self) -> None: + self.api = {{classname}}() + + async def asyncTearDown(self) -> None: + await self.api.api_client.close() + {{/asyncio}} + {{^asyncio}} def setUp(self) -> None: self.api = {{classname}}() def tearDown(self) -> None: pass + {{/asyncio}} {{#operation}} + {{#asyncio}} + async def test_{{operationId}}(self) -> None: + {{/asyncio}} + {{^asyncio}} def test_{{operationId}}(self) -> None: + {{/asyncio}} """Test case for {{{operationId}}} {{#summary}} diff --git a/templates/asyncio/rest.mustache b/templates/asyncio/rest.mustache index c3f8643..937e76e 100644 --- a/templates/asyncio/rest.mustache +++ b/templates/asyncio/rest.mustache @@ -44,51 +44,32 @@ class RESTClientObject: def __init__(self, configuration) -> None: # maxsize is number of requests to host that are allowed in parallel - maxsize = configuration.connection_pool_maxsize + self.maxsize = configuration.connection_pool_maxsize - ssl_context = ssl.create_default_context( - cafile=configuration.ssl_ca_cert + self.ssl_context = ssl.create_default_context( + cafile=configuration.ssl_ca_cert, + cadata=configuration.ca_cert_data, ) if configuration.cert_file: - ssl_context.load_cert_chain( + self.ssl_context.load_cert_chain( configuration.cert_file, keyfile=configuration.key_file ) if not configuration.verify_ssl: - ssl_context.check_hostname = False - ssl_context.verify_mode = ssl.CERT_NONE - - connector = aiohttp.TCPConnector( - limit=maxsize, - ssl=ssl_context - ) + self.ssl_context.check_hostname = False + self.ssl_context.verify_mode = ssl.CERT_NONE self.proxy = configuration.proxy self.proxy_headers = configuration.proxy_headers - # https pool manager - self.pool_manager = aiohttp.ClientSession( - connector=connector, - trust_env=True - ) + self.retries = configuration.retries - retries = configuration.retries - self.retry_client: Optional[aiohttp_retry.RetryClient] - if retries is not None: - self.retry_client = aiohttp_retry.RetryClient( - client_session=self.pool_manager, - retry_options=aiohttp_retry.ExponentialRetry( - attempts=retries, - factor=2.0, - start_timeout=0.1, - max_timeout=120.0 - ) - ) - else: - self.retry_client = None + self.pool_manager: Optional[aiohttp.ClientSession] = None + self.retry_client: Optional[aiohttp_retry.RetryClient] = None - async def close(self): - await self.pool_manager.close() + async def close(self) -> None: + if self.pool_manager: + await self.pool_manager.close() if self.retry_client is not None: await self.retry_client.close() @@ -174,6 +155,11 @@ class RESTClientObject: content_type=v[2] ) else: + # Ensures that dict objects are serialized + if isinstance(v, dict): + v = json.dumps(v) + elif isinstance(v, int): + v = str(v) data.add_field(k, v) args["data"] = data @@ -190,16 +176,28 @@ class RESTClientObject: raise ApiException(status=0, reason=msg) pool_manager: Union[aiohttp.ClientSession, aiohttp_retry.RetryClient] - if self.retry_client is not None and method in ALLOW_RETRY_METHODS: + + # https pool manager + if self.pool_manager is None: + self.pool_manager = aiohttp.ClientSession( + connector=aiohttp.TCPConnector(limit=self.maxsize, ssl=self.ssl_context), + trust_env=True, + ) + pool_manager = self.pool_manager + + if self.retries is not None and method in ALLOW_RETRY_METHODS: + if self.retry_client is None: + self.retry_client = aiohttp_retry.RetryClient( + client_session=self.pool_manager, + retry_options=aiohttp_retry.ExponentialRetry( + attempts=self.retries, + factor=2.0, + start_timeout=0.1, + max_timeout=120.0 + ) + ) pool_manager = self.retry_client - else: - pool_manager = self.pool_manager r = await pool_manager.request(**args) return RESTResponse(r) - - - - - diff --git a/templates/configuration.mustache b/templates/configuration.mustache index 798fc0e..9dfedc7 100644 --- a/templates/configuration.mustache +++ b/templates/configuration.mustache @@ -3,16 +3,21 @@ {{>partial_header}} import copy +import http.client as httplib import logging from logging import FileHandler {{^asyncio}} import multiprocessing {{/asyncio}} import sys -from typing import Optional +from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict, Union +from typing_extensions import NotRequired, Self + import urllib3 -import http.client as httplib +{{#hasHttpSignatureMethods}} +from {{packageName}}.signing import HttpSigningConfiguration +{{/hasHttpSignatureMethods}} JSON_SCHEMA_VALIDATION_KEYWORDS = { 'multipleOf', 'maximum', 'exclusiveMaximum', @@ -20,6 +25,130 @@ JSON_SCHEMA_VALIDATION_KEYWORDS = { 'minLength', 'pattern', 'maxItems', 'minItems' } +ServerVariablesT = Dict[str, str] + +GenericAuthSetting = TypedDict( + "GenericAuthSetting", + { + "type": str, + "in": str, + "key": str, + "value": str, + }, +) + + +OAuth2AuthSetting = TypedDict( + "OAuth2AuthSetting", + { + "type": Literal["oauth2"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +APIKeyAuthSetting = TypedDict( + "APIKeyAuthSetting", + { + "type": Literal["api_key"], + "in": str, + "key": str, + "value": Optional[str], + }, +) + + +BasicAuthSetting = TypedDict( + "BasicAuthSetting", + { + "type": Literal["basic"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": Optional[str], + }, +) + + +BearerFormatAuthSetting = TypedDict( + "BearerFormatAuthSetting", + { + "type": Literal["bearer"], + "in": Literal["header"], + "format": Literal["JWT"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +BearerAuthSetting = TypedDict( + "BearerAuthSetting", + { + "type": Literal["bearer"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +HTTPSignatureAuthSetting = TypedDict( + "HTTPSignatureAuthSetting", + { + "type": Literal["http-signature"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": None, + }, +) + + +AuthSettings = TypedDict( + "AuthSettings", + { +{{#authMethods}} +{{#isOAuth}} + "{{name}}": OAuth2AuthSetting, +{{/isOAuth}} +{{#isApiKey}} + "{{name}}": APIKeyAuthSetting, +{{/isApiKey}} +{{#isBasic}} + {{#isBasicBasic}} + "{{name}}": BasicAuthSetting, + {{/isBasicBasic}} + {{#isBasicBearer}} + {{#bearerFormat}} + "{{name}}": BearerFormatAuthSetting, + {{/bearerFormat}} + {{^bearerFormat}} + "{{name}}": BearerAuthSetting, + {{/bearerFormat}} + {{/isBasicBearer}} + {{#isHttpSignature}} + "{{name}}": HTTPSignatureAuthSetting, + {{/isHttpSignature}} +{{/isBasic}} +{{/authMethods}} + }, + total=False, +) + + +class HostSettingVariable(TypedDict): + description: str + default_value: str + enum_values: List[str] + + +class HostSetting(TypedDict): + url: str + description: str + variables: NotRequired[Dict[str, HostSettingVariable]] + + class Configuration: """This class contains various settings of the API client. @@ -54,6 +183,8 @@ class Configuration: :param ssl_ca_cert: str - the path to a file of concatenated CA certificates in PEM format. :param retries: Number of retries for API requests. + :param ca_cert_data: verify the peer using concatenated CA certificate data + in PEM (str) or DER (bytes) format. {{#hasAuthMethods}} :Example: @@ -145,23 +276,30 @@ conf = {{{packageName}}}.Configuration( {{/hasAuthMethods}} """ - _default = None + _default: ClassVar[Optional[Self]] = None - def __init__(self, host=None, - api_key=None, api_key_prefix=None, - username=None, password=None, - access_token=None, + def __init__( + self, + host: Optional[str]=None, + api_key: Optional[Dict[str, str]]=None, + api_key_prefix: Optional[Dict[str, str]]=None, + username: Optional[str]=None, + password: Optional[str]=None, + access_token: Optional[str]=None, {{#hasHttpSignatureMethods}} - signing_info=None, + signing_info: Optional[HttpSigningConfiguration]=None, {{/hasHttpSignatureMethods}} - server_index=None, server_variables=None, - server_operation_index=None, server_operation_variables=None, - ignore_operation_servers=False, - ssl_ca_cert=None, - retries=None, - *, - debug: Optional[bool] = None - ) -> None: + server_index: Optional[int]=None, + server_variables: Optional[ServerVariablesT]=None, + server_operation_index: Optional[Dict[int, int]]=None, + server_operation_variables: Optional[Dict[int, ServerVariablesT]]=None, + ignore_operation_servers: bool=False, + ssl_ca_cert: Optional[str]=None, + retries: Optional[int] = None, + ca_cert_data: Optional[Union[str, bytes]] = None, + *, + debug: Optional[bool] = None, + ) -> None: """Constructor """ self._base_path = "{{{basePath}}}" if host is None else host @@ -248,6 +386,10 @@ conf = {{{packageName}}}.Configuration( self.ssl_ca_cert = ssl_ca_cert """Set this to customize the certificate file to verify the peer. """ + self.ca_cert_data = ca_cert_data + """Set this to verify the peer using PEM (str) or DER (bytes) + certificate data. + """ self.cert_file = None """client certificate file """ @@ -305,7 +447,7 @@ conf = {{{packageName}}}.Configuration( """date format """ - def __deepcopy__(self, memo): + def __deepcopy__(self, memo: Dict[int, Any]) -> Self: cls = self.__class__ result = cls.__new__(cls) memo[id(self)] = result @@ -319,7 +461,7 @@ conf = {{{packageName}}}.Configuration( result.debug = self.debug return result - def __setattr__(self, name, value): + def __setattr__(self, name: str, value: Any) -> None: object.__setattr__(self, name, value) {{#hasHttpSignatureMethods}} if name == "signing_info" and value is not None: @@ -329,7 +471,7 @@ conf = {{{packageName}}}.Configuration( {{/hasHttpSignatureMethods}} @classmethod - def set_default(cls, default): + def set_default(cls, default: Optional[Self]) -> None: """Set default instance of configuration. It stores default configuration, which can be @@ -340,7 +482,7 @@ conf = {{{packageName}}}.Configuration( cls._default = default @classmethod - def get_default_copy(cls): + def get_default_copy(cls) -> Self: """Deprecated. Please use `get_default` instead. Deprecated. Please use `get_default` instead. @@ -350,7 +492,7 @@ conf = {{{packageName}}}.Configuration( return cls.get_default() @classmethod - def get_default(cls): + def get_default(cls) -> Self: """Return the default configuration. This method returns newly created, based on default constructor, @@ -360,11 +502,11 @@ conf = {{{packageName}}}.Configuration( :return: The configuration object. """ if cls._default is None: - cls._default = Configuration() + cls._default = cls() return cls._default @property - def logger_file(self): + def logger_file(self) -> Optional[str]: """The logger file. If the logger_file is None, then add stream handler and remove file @@ -376,7 +518,7 @@ conf = {{{packageName}}}.Configuration( return self.__logger_file @logger_file.setter - def logger_file(self, value): + def logger_file(self, value: Optional[str]) -> None: """The logger file. If the logger_file is None, then add stream handler and remove file @@ -395,7 +537,7 @@ conf = {{{packageName}}}.Configuration( logger.addHandler(self.logger_file_handler) @property - def debug(self): + def debug(self) -> bool: """Debug status :param value: The debug status, True or False. @@ -404,7 +546,7 @@ conf = {{{packageName}}}.Configuration( return self.__debug @debug.setter - def debug(self, value): + def debug(self, value: bool) -> None: """Debug status :param value: The debug status, True or False. @@ -426,7 +568,7 @@ conf = {{{packageName}}}.Configuration( httplib.HTTPConnection.debuglevel = 0 @property - def logger_format(self): + def logger_format(self) -> str: """The logger format. The logger_formatter will be updated when sets logger_format. @@ -437,7 +579,7 @@ conf = {{{packageName}}}.Configuration( return self.__logger_format @logger_format.setter - def logger_format(self, value): + def logger_format(self, value: str) -> None: """The logger format. The logger_formatter will be updated when sets logger_format. @@ -448,7 +590,7 @@ conf = {{{packageName}}}.Configuration( self.__logger_format = value self.logger_formatter = logging.Formatter(self.__logger_format) - def get_api_key_with_prefix(self, identifier, alias=None): + def get_api_key_with_prefix(self, identifier: str, alias: Optional[str]=None) -> Optional[str]: """Gets API key (with prefix if set). :param identifier: The identifier of apiKey. @@ -465,7 +607,9 @@ conf = {{{packageName}}}.Configuration( else: return key - def get_basic_auth_token(self): + return None + + def get_basic_auth_token(self) -> Optional[str]: """Gets HTTP basic authentication header (string). :return: The token for basic HTTP authentication. @@ -480,12 +624,12 @@ conf = {{{packageName}}}.Configuration( basic_auth=username + ':' + password ).get('authorization') - def auth_settings(self): + def auth_settings(self)-> AuthSettings: """Gets Auth Settings dict for api client. :return: The Auth Settings information dict. """ - auth = {} + auth: AuthSettings = {} {{#authMethods}} {{#isApiKey}} if '{{name}}' in self.api_key{{#vendorExtensions.x-auth-id-alias}} or '{{.}}' in self.api_key{{/vendorExtensions.x-auth-id-alias}}: @@ -548,7 +692,7 @@ conf = {{{packageName}}}.Configuration( {{/authMethods}} return auth - def to_debug_report(self): + def to_debug_report(self) -> str: """Gets the essential information for debugging. :return: The report for debugging. @@ -557,15 +701,10 @@ conf = {{{packageName}}}.Configuration( "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: {{version}}\n"\ -{{^useCustomTemplateCode}} "SDK Package Version: {{packageVersion}}".\ -{{/useCustomTemplateCode}} -{{#useCustomTemplateCode}} - "SDK Version: {{packageVersion}}".\ -{{/useCustomTemplateCode}} format(env=sys.platform, pyversion=sys.version) - def get_host_settings(self): + def get_host_settings(self) -> List[HostSetting]: """Gets an array of host settings :return: An array of host settings @@ -600,7 +739,12 @@ conf = {{{packageName}}}.Configuration( {{/servers}} ] - def get_host_from_settings(self, index, variables=None, servers=None): + def get_host_from_settings( + self, + index: Optional[int], + variables: Optional[ServerVariablesT]=None, + servers: Optional[List[HostSetting]]=None, + ) -> str: """Gets host URL based on the index and variables :param index: array index of the host settings :param variables: hash of variable and the corresponding value @@ -640,12 +784,12 @@ conf = {{{packageName}}}.Configuration( return url @property - def host(self): + def host(self) -> str: """Return generated host.""" return self.get_host_from_settings(self.server_index, variables=self.server_variables) @host.setter - def host(self, value): + def host(self, value: str) -> None: """Fix base path.""" self._base_path = value self.server_index = None diff --git a/templates/exceptions.mustache b/templates/exceptions.mustache index 65781d4..00157e3 100644 --- a/templates/exceptions.mustache +++ b/templates/exceptions.mustache @@ -148,6 +148,13 @@ class ApiException(OpenApiException): if http_resp.status == 404: raise NotFoundException(http_resp=http_resp, body=body, data=data) + # Added new conditions for 409 and 422 + if http_resp.status == 409: + raise ConflictException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 422: + raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data) + if 500 <= http_resp.status <= 599: raise ServiceException(http_resp=http_resp, body=body, data=data) raise ApiException(http_resp=http_resp, body=body, data=data) @@ -186,6 +193,16 @@ class ServiceException(ApiException): pass +class ConflictException(ApiException): + """Exception for HTTP 409 Conflict.""" + pass + + +class UnprocessableEntityException(ApiException): + """Exception for HTTP 422 Unprocessable Entity.""" + pass + + def render_path(path_to_item): """Returns a string representation of a path""" result = "" diff --git a/templates/github-workflow.mustache b/templates/github-workflow.mustache index 868124c..82ff5e8 100644 --- a/templates/github-workflow.mustache +++ b/templates/github-workflow.mustache @@ -14,10 +14,10 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"] + python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v4 with: @@ -25,15 +25,8 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install flake8 pytest - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - if [ -f test-requirements.txt ]; then pip install -r test-requirements.txt; fi - - name: Lint with flake8 - run: | - # stop the build if there are Python syntax errors or undefined names - flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics - # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide - flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + pip install -r requirements.txt + pip install -r test-requirements.txt - name: Test with pytest run: | - pytest + pytest --cov=<%packageName%> diff --git a/templates/gitlab-ci.mustache b/templates/gitlab-ci.mustache index 8a6130a..10c70f6 100644 --- a/templates/gitlab-ci.mustache +++ b/templates/gitlab-ci.mustache @@ -14,9 +14,6 @@ stages: - pip install -r test-requirements.txt - pytest --cov={{{packageName}}} -pytest-3.7: - extends: .pytest - image: python:3.7-alpine pytest-3.8: extends: .pytest image: python:3.8-alpine @@ -29,3 +26,6 @@ pytest-3.10: pytest-3.11: extends: .pytest image: python:3.11-alpine +pytest-3.12: + extends: .pytest + image: python:3.12-alpine diff --git a/templates/model_doc.mustache b/templates/model_doc.mustache index a63aea6..5b130c2 100644 --- a/templates/model_doc.mustache +++ b/templates/model_doc.mustache @@ -53,4 +53,4 @@ Name | Type | Description | Notes [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) {{/useCustomTemplateCode}} -{{/model}}{{/models}} \ No newline at end of file +{{/model}}{{/models}} diff --git a/templates/model_generic.mustache b/templates/model_generic.mustache index 6ffec53..919bcd1 100644 --- a/templates/model_generic.mustache +++ b/templates/model_generic.mustache @@ -9,17 +9,12 @@ import json {{#vendorExtensions.x-py-model-imports}} {{{.}}} {{/vendorExtensions.x-py-model-imports}} -{{^useCustomTemplateCode}} from typing import Optional, Set -{{/useCustomTemplateCode}} -{{#useCustomTemplateCode}} -from typing import Optional, Set, Tuple -{{/useCustomTemplateCode}} from typing_extensions import Self {{#useCustomTemplateCode}} +from typing import Tuple, Union import io from pydantic import StrictBool -from typing import Union {{/useCustomTemplateCode}} {{#hasChildren}} @@ -28,7 +23,7 @@ from typing import Union from typing import TYPE_CHECKING if TYPE_CHECKING: {{#mappedModels}} - from {{packageName}}.models.{{model.classVarName}} import {{modelName}} + from {{packageName}}.models.{{model.classFilename}} import {{modelName}} {{/mappedModels}} {{/discriminator}} @@ -88,15 +83,22 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}} {{/isNullable}} {{/required}} + {{#isContainer}} {{#isArray}} for i in value: if i not in set([{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]): raise ValueError("each list item must be one of ({{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}})") {{/isArray}} - {{^isArray}} + {{#isMap}} + for i in value.values(): + if i not in set([{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]): + raise ValueError("dict values must be one of enum values ({{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}})") + {{/isMap}} + {{/isContainer}} + {{^isContainer}} if value not in set([{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]): raise ValueError("must be one of enum values ({{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}})") - {{/isArray}} + {{/isContainer}} return value {{/isEnum}} {{/vars}} @@ -159,12 +161,7 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}} """Create an instance of {{{classname}}} from a JSON string""" return cls.from_dict(json.loads(json_str)) -{{^useCustomTemplateCode}} - def to_dict(self) -> Dict[str, Any]: -{{/useCustomTemplateCode}} -{{#useCustomTemplateCode}} - def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: -{{/useCustomTemplateCode}} + def to_dict(self{{#useCustomTemplateCode}}, excluded_fields: Set[str] = None{{/useCustomTemplateCode}}) -> Dict[str, Any]: """Return the dictionary representation of the model using alias. This has the following differences from calling pydantic's @@ -294,7 +291,7 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}} object_type = cls.get_discriminator_value(obj) {{#mappedModels}} if object_type == '{{{modelName}}}': - return import_module("{{packageName}}.models.{{model.classVarName}}").{{modelName}}.from_dict(obj) + return import_module("{{packageName}}.models.{{model.classFilename}}").{{modelName}}.from_dict(obj) {{/mappedModels}} raise ValueError("{{{classname}}} failed to lookup discriminator value from " + @@ -389,7 +386,7 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}} {{/items.isContainer}} {{/items.isEnumOrRef}} {{#items.isEnumOrRef}} - "{{{baseName}}}": dict((_k, _v) for _k, _v in obj.get("{{{baseName}}}").items()){{^-last}},{{/-last}} + "{{{baseName}}}": dict((_k, _v) for _k, _v in obj.get("{{{baseName}}}").items()) if obj.get("{{{baseName}}}") is not None else None{{^-last}},{{/-last}} {{/items.isEnumOrRef}} {{/items.isPrimitiveType}} {{#items.isPrimitiveType}} diff --git a/templates/pyproject.mustache b/templates/pyproject.mustache index 24030f9..8dab7de 100644 --- a/templates/pyproject.mustache +++ b/templates/pyproject.mustache @@ -5,35 +5,36 @@ description = "{{{appName}}}" authors = ["{{infoName}}{{^infoName}}OpenAPI Generator Community{{/infoName}} <{{infoEmail}}{{^infoEmail}}team@openapitools.org{{/infoEmail}}>"] license = "{{{licenseInfo}}}{{^licenseInfo}}NoLicense{{/licenseInfo}}" readme = "README.md" -repository = "https://github.com/{{{gitUserId}}}/{{{gitRepoId}}}" +repository = "https://{{{gitHost}}}/{{{gitUserId}}}/{{{gitRepoId}}}" keywords = ["OpenAPI", "OpenAPI-Generator", "{{{appName}}}"] include = ["{{packageName}}/py.typed"] [tool.poetry.dependencies] -python = "^3.7" +python = "^3.8" -urllib3 = ">= 1.25.3" -python-dateutil = ">=2.8.2" +urllib3 = ">= 1.25.3, < 3.0.0" +python-dateutil = ">= 2.8.2" {{#asyncio}} aiohttp = ">= 3.8.4" aiohttp-retry = ">= 2.8.3" {{/asyncio}} {{#tornado}} -tornado = ">=4.2,<5" +tornado = ">=4.2, <5" {{/tornado}} {{#hasHttpSignatureMethods}} pem = ">= 19.3.0" pycryptodome = ">= 3.9.0" {{/hasHttpSignatureMethods}} -pydantic = ">=2" -typing-extensions = ">=4.7.1" +pydantic = ">= 2" +typing-extensions = ">= 4.7.1" [tool.poetry.dev-dependencies] -pytest = ">=7.2.1" -tox = ">=3.9.0" -flake8 = ">=4.0.0" -types-python-dateutil = ">=2.8.19.14" -mypy = "1.4.1" +pytest = ">= 7.2.1" +pytest-cov = ">= 2.8.1" +tox = ">= 3.9.0" +flake8 = ">= 4.0.0" +types-python-dateutil = ">= 2.8.19.14" +mypy = ">= 1.5" [build-system] @@ -59,7 +60,7 @@ warn_unused_ignores = true ## Getting these passing should be easy strict_equality = true -strict_concatenate = true +extra_checks = true ## Strongly recommend enabling this one as soon as you can check_untyped_defs = true @@ -80,3 +81,20 @@ disallow_any_generics = true # ### This one can be tricky to get passing if you use a lot of untyped libraries #warn_return_any = true + +[[tool.mypy.overrides]] +module = [ + "{{{packageName}}}.configuration", +] +warn_unused_ignores = true +strict_equality = true +extra_checks = true +check_untyped_defs = true +disallow_subclassing_any = true +disallow_untyped_decorators = true +disallow_any_generics = true +disallow_untyped_calls = true +disallow_incomplete_defs = true +disallow_untyped_defs = true +no_implicit_reexport = true +warn_return_any = true diff --git a/templates/requirements.mustache b/templates/requirements.mustache index 5412515..82746ec 100644 --- a/templates/requirements.mustache +++ b/templates/requirements.mustache @@ -1,12 +1,15 @@ -python_dateutil >= 2.5.3 -setuptools >= 21.0.0 -urllib3 >= 1.25.3, < 2.1.0 -pydantic >= 2 -typing-extensions >= 4.7.1 +urllib3 >= 1.25.3, < 3.0.0 +python_dateutil >= 2.8.2 {{#asyncio}} -aiohttp >= 3.0.0 +aiohttp >= 3.8.4 aiohttp-retry >= 2.8.3 {{/asyncio}} +{{#tornado}} +tornado = ">= 4.2, < 5" +{{/tornado}} {{#hasHttpSignatureMethods}} +pem >= 19.3.0 pycryptodome >= 3.9.0 {{/hasHttpSignatureMethods}} +pydantic >= 2 +typing-extensions >= 4.7.1 diff --git a/templates/rest.mustache b/templates/rest.mustache index 07aa7ee..f545066 100644 --- a/templates/rest.mustache +++ b/templates/rest.mustache @@ -66,6 +66,7 @@ class RESTClientObject: "ca_certs": configuration.ssl_ca_cert, "cert_file": configuration.cert_file, "key_file": configuration.key_file, + "ca_cert_data": configuration.ca_cert_data, } if configuration.assert_hostname is not None: pool_args['assert_hostname'] = ( @@ -215,7 +216,7 @@ class RESTClientObject: headers=headers, preload_content=False ) - elif headers['Content-Type'] == 'text/plain' and isinstance(body, bool): + elif headers['Content-Type'].startswith('text/') and isinstance(body, bool): request_body = "true" if body else "false" r = self.pool_manager.request( method, diff --git a/templates/setup.mustache b/templates/setup.mustache index ec5a2ef..be7880b 100644 --- a/templates/setup.mustache +++ b/templates/setup.mustache @@ -15,23 +15,20 @@ from pathlib import Path # http://pypi.python.org/pypi/setuptools NAME = "{{{projectName}}}" VERSION = "{{packageVersion}}" -PYTHON_REQUIRES = ">=3.7" -{{#apiInfo}} -{{#apis}} -{{#-last}} +PYTHON_REQUIRES = ">= 3.8" REQUIRES = [ - "urllib3 >= 1.25.3, < 2.1.0", - "python-dateutil", + "urllib3 >= 1.25.3, < 3.0.0", + "python-dateutil >= 2.8.2", {{#asyncio}} - "aiohttp >= 3.0.0", + "aiohttp >= 3.8.4", "aiohttp-retry >= 2.8.3", {{/asyncio}} {{#tornado}} - "tornado>=4.2,<5", + "tornado>=4.2, < 5", {{/tornado}} {{#hasHttpSignatureMethods}} - "pem>=19.3.0", - "pycryptodome>=3.9.0", + "pem >= 19.3.0", + "pycryptodome >= 3.9.0", {{/hasHttpSignatureMethods}} "pydantic >= 2", "typing-extensions >= 4.7.1", @@ -60,9 +57,10 @@ setup( include_package_data=True, {{^useCustomTemplateCode}} {{#licenseInfo}}license="{{.}}", - {{/licenseInfo}}long_description="""\ - {{appDescription}} # noqa: E501 - """ + {{/licenseInfo}}long_description_content_type='text/markdown', + long_description="""\ + {{appDescription}} + """, # noqa: E501 {{/useCustomTemplateCode}} {{#useCustomTemplateCode}} {{#licenseInfo}}license="{{.}}", @@ -71,6 +69,3 @@ setup( {{/useCustomTemplateCode}} package_data={"{{{packageName}}}": ["py.typed"]}, ) -{{/-last}} -{{/apis}} -{{/apiInfo}} diff --git a/templates/test-requirements.mustache b/templates/test-requirements.mustache index cbff657..9453a41 100644 --- a/templates/test-requirements.mustache +++ b/templates/test-requirements.mustache @@ -1,6 +1,9 @@ -pytest~=7.1.3 -pytest-cov>=2.8.1 -pytest-randomly>=3.12.0 -mypy>=1.4.1 -types-python-dateutil>=2.8.19 +pytest >= 7.2.1 +pytest-cov >= 2.8.1 +tox >= 3.9.0 +flake8 >= 4.0.0 +types-python-dateutil >= 2.8.19.14 +mypy >= 1.5 +{{#useCustomTemplateCode}} black>=24.8.0 +{{/useCustomTemplateCode}} diff --git a/templates/travis.mustache b/templates/travis.mustache index 53cb57e..155d9a7 100644 --- a/templates/travis.mustache +++ b/templates/travis.mustache @@ -1,13 +1,13 @@ # ref: https://docs.travis-ci.com/user/languages/python language: python python: - - "3.7" - "3.8" - "3.9" - "3.10" - "3.11" + - "3.12" # uncomment the following if needed - #- "3.11-dev" # 3.11 development branch + #- "3.12-dev" # 3.12 development branch #- "nightly" # nightly build # command to install dependencies install: diff --git a/test-requirements.txt b/test-requirements.txt index cbff657..6658973 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,6 +1,7 @@ -pytest~=7.1.3 -pytest-cov>=2.8.1 -pytest-randomly>=3.12.0 -mypy>=1.4.1 -types-python-dateutil>=2.8.19 +pytest >= 7.2.1 +pytest-cov >= 2.8.1 +tox >= 3.9.0 +flake8 >= 4.0.0 +types-python-dateutil >= 2.8.19.14 +mypy >= 1.5 black>=24.8.0