From 80b251cc5073a04e82a469553faa761ad0e05be6 Mon Sep 17 00:00:00 2001 From: Paige Rossi <70241979+paigesrossi@users.noreply.github.com> Date: Wed, 25 Oct 2023 13:15:44 -0700 Subject: [PATCH] Version 3.25.0-v2.1-23.3.01.01 release (#174) Co-authored-by: root --- CHANGELOG.md | 5 + docusign_esign/__init__.py | 3 +- docusign_esign/apis/accounts_api.py | 8 +- docusign_esign/apis/envelopes_api.py | 4 +- docusign_esign/apis/users_api.py | 21 +- docusign_esign/models/__init__.py | 3 + .../models/account_settings_information.py | 81 +++++++ .../models/bulk_send_batch_error.py | 4 +- docusign_esign/models/delayed_routing.py | 4 +- docusign_esign/models/doc_gen_form_field.py | 108 +++++++++ .../models/doc_gen_form_field_option.py | 205 ++++++++++++++++++ .../models/doc_gen_form_field_validation.py | 151 +++++++++++++ docusign_esign/models/document.py | 27 +++ docusign_esign/models/initial_here.py | 4 +- docusign_esign/models/scheduled_sending.py | 4 +- setup.py | 2 +- 16 files changed, 611 insertions(+), 23 deletions(-) create mode 100644 docusign_esign/models/doc_gen_form_field_option.py create mode 100644 docusign_esign/models/doc_gen_form_field_validation.py diff --git a/CHANGELOG.md b/CHANGELOG.md index 80899be4..93e1f7d9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file. See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes. +## [v3.25.0] - eSignature API v2.1-23.3.01.01 - 2023-10-25 +### Changed +- Added support for version v2.1-23.3.01.01 of the DocuSign ESignature API. +- Updated the SDK release version. + ## [v3.24.0] - eSignature API v2.1-23.3.00.01 - 2023-08-30 ### Changed - Added support for version v2.1-23.3.00.01 of the DocuSign ESignature API. diff --git a/docusign_esign/__init__.py b/docusign_esign/__init__.py index 91389f80..de8ce6e2 100644 --- a/docusign_esign/__init__.py +++ b/docusign_esign/__init__.py @@ -225,8 +225,10 @@ from docusign_esign.models.direct_debit_processor_information import DirectDebitProcessorInformation from docusign_esign.models.dob_information_input import DobInformationInput from docusign_esign.models.doc_gen_form_field import DocGenFormField +from docusign_esign.models.doc_gen_form_field_option import DocGenFormFieldOption from docusign_esign.models.doc_gen_form_field_request import DocGenFormFieldRequest from docusign_esign.models.doc_gen_form_field_response import DocGenFormFieldResponse +from docusign_esign.models.doc_gen_form_field_validation import DocGenFormFieldValidation from docusign_esign.models.doc_gen_form_fields import DocGenFormFields from docusign_esign.models.doc_gen_syntax_error import DocGenSyntaxError from docusign_esign.models.document import Document @@ -540,5 +542,4 @@ from docusign_esign.models.zip import Zip from docusign_esign.models.date import Date - configuration = Configuration() diff --git a/docusign_esign/apis/accounts_api.py b/docusign_esign/apis/accounts_api.py index b5537a5c..d2f8959e 100644 --- a/docusign_esign/apis/accounts_api.py +++ b/docusign_esign/apis/accounts_api.py @@ -3752,7 +3752,7 @@ def get_consumer_disclosure(self, account_id, lang_code, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) :return: ConsumerDisclosure If the method is called asynchronously, returns the request thread. @@ -3779,7 +3779,7 @@ def get_consumer_disclosure_with_http_info(self, account_id, lang_code, **kwargs :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) :return: ConsumerDisclosure If the method is called asynchronously, returns the request thread. @@ -7162,7 +7162,7 @@ def update_consumer_disclosure(self, account_id, lang_code, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) :param str include_metadata: :param ConsumerDisclosure consumer_disclosure: :return: ConsumerDisclosure @@ -7191,7 +7191,7 @@ def update_consumer_disclosure_with_http_info(self, account_id, lang_code, **kwa :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) :param str include_metadata: :param ConsumerDisclosure consumer_disclosure: :return: ConsumerDisclosure diff --git a/docusign_esign/apis/envelopes_api.py b/docusign_esign/apis/envelopes_api.py index 1b9022fe..8e67b888 100644 --- a/docusign_esign/apis/envelopes_api.py +++ b/docusign_esign/apis/envelopes_api.py @@ -6379,7 +6379,7 @@ def get_consumer_disclosure(self, account_id, envelope_id, lang_code, recipient_ for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) :param str recipient_id: The ID of the recipient being accessed. (required) :param str lang_code2: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. :return: ConsumerDisclosure @@ -6409,7 +6409,7 @@ def get_consumer_disclosure_with_http_info(self, account_id, envelope_id, lang_c for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) :param str recipient_id: The ID of the recipient being accessed. (required) :param str lang_code2: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. :return: ConsumerDisclosure diff --git a/docusign_esign/apis/users_api.py b/docusign_esign/apis/users_api.py index 24bb6178..28d41f59 100644 --- a/docusign_esign/apis/users_api.py +++ b/docusign_esign/apis/users_api.py @@ -3043,7 +3043,7 @@ def update_signature_with_http_info(self, account_id, signature_id, user_id, **k _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_signature_image(self, account_id, image_type, signature_id, user_id, **kwargs): + def update_signature_image(self, account_id, image_type, signature_id, user_id, image_bytes, **kwargs): """ Updates the user signature image or user initials image for the specified user. Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\". @@ -3053,7 +3053,7 @@ def update_signature_image(self, account_id, image_type, signature_id, user_id, >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.update_signature_image(account_id, image_type, signature_id, user_id, callback=callback_function) + >>> thread = api.update_signature_image(account_id, image_type, signature_id, user_id, image_bytes, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -3062,18 +3062,19 @@ def update_signature_image(self, account_id, image_type, signature_id, user_id, :param str signature_id: The ID of the signature being accessed. (required) :param str user_id: The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required) :param str transparent_png: + :param str image_bytes: Image content. (required) :return: UserSignature If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_signature_image_with_http_info(account_id, image_type, signature_id, user_id, **kwargs) + return self.update_signature_image_with_http_info(account_id, image_type, signature_id, user_id, image_bytes, **kwargs) else: - (data) = self.update_signature_image_with_http_info(account_id, image_type, signature_id, user_id, **kwargs) + (data) = self.update_signature_image_with_http_info(account_id, image_type, signature_id, user_id, image_bytes, **kwargs) return data - def update_signature_image_with_http_info(self, account_id, image_type, signature_id, user_id, **kwargs): + def update_signature_image_with_http_info(self, account_id, image_type, signature_id, user_id, image_bytes, **kwargs): """ Updates the user signature image or user initials image for the specified user. Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\". @@ -3083,7 +3084,7 @@ def update_signature_image_with_http_info(self, account_id, image_type, signatur >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.update_signature_image_with_http_info(account_id, image_type, signature_id, user_id, callback=callback_function) + >>> thread = api.update_signature_image_with_http_info(account_id, image_type, signature_id, user_id, image_bytes, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -3092,12 +3093,13 @@ def update_signature_image_with_http_info(self, account_id, image_type, signatur :param str signature_id: The ID of the signature being accessed. (required) :param str user_id: The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required) :param str transparent_png: + :param str image_bytes: Image content. (required) :return: UserSignature If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'image_type', 'signature_id', 'user_id', 'transparent_png'] + all_params = ['account_id', 'image_type', 'signature_id', 'user_id', 'transparent_png', 'image_bytes'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3124,6 +3126,9 @@ def update_signature_image_with_http_info(self, account_id, image_type, signatur # verify the required parameter 'user_id' is set if ('user_id' not in params) or (params['user_id'] is None): raise ValueError("Missing the required parameter `user_id` when calling `update_signature_image`") + # verify the required parameter 'image_bytes' is set + if ('image_bytes' not in params) or (params['image_bytes'] is None): + raise ValueError("Missing the required parameter `image_bytes` when calling `update_signature_image`") collection_formats = {} @@ -3149,6 +3154,8 @@ def update_signature_image_with_http_info(self, account_id, image_type, signatur local_var_files = {} body_params = None + if 'image_bytes' in params: + body_params = params['image_bytes'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) diff --git a/docusign_esign/models/__init__.py b/docusign_esign/models/__init__.py index e1229a76..b3b1b831 100644 --- a/docusign_esign/models/__init__.py +++ b/docusign_esign/models/__init__.py @@ -189,8 +189,10 @@ from docusign_esign.models.direct_debit_processor_information import DirectDebitProcessorInformation from docusign_esign.models.dob_information_input import DobInformationInput from docusign_esign.models.doc_gen_form_field import DocGenFormField +from docusign_esign.models.doc_gen_form_field_option import DocGenFormFieldOption from docusign_esign.models.doc_gen_form_field_request import DocGenFormFieldRequest from docusign_esign.models.doc_gen_form_field_response import DocGenFormFieldResponse +from docusign_esign.models.doc_gen_form_field_validation import DocGenFormFieldValidation from docusign_esign.models.doc_gen_form_fields import DocGenFormFields from docusign_esign.models.doc_gen_syntax_error import DocGenSyntaxError from docusign_esign.models.document import Document @@ -502,3 +504,4 @@ from docusign_esign.models.workspace_user import WorkspaceUser from docusign_esign.models.workspace_user_authorization import WorkspaceUserAuthorization from docusign_esign.models.zip import Zip +from docusign_esign.models.date import Date diff --git a/docusign_esign/models/account_settings_information.py b/docusign_esign/models/account_settings_information.py index 5c7a70b9..967e9555 100644 --- a/docusign_esign/models/account_settings_information.py +++ b/docusign_esign/models/account_settings_information.py @@ -340,6 +340,7 @@ class AccountSettingsInformation(object): 'draft_envelope_retention': 'str', 'draft_envelope_retention_metadata': 'SettingsMetadata', 'dss_enable_provisioning_pen_configuration_radmin_option': 'str', + 'dss_enable_signature_type_custom_tag_radmin_radmin_option': 'str', 'dss_sign_28411_enable_leave_page_prompt_radmin_option': 'str', 'dss_sign_29182_slide_up_bar_radmin_option': 'str', 'email_template_version': 'str', @@ -428,6 +429,8 @@ class AccountSettingsInformation(object): 'enable_in_browser_editor_metadata': 'SettingsMetadata', 'enable_key_terms_suggestions_by_document_type': 'str', 'enable_key_terms_suggestions_by_document_type_metadata': 'SettingsMetadata', + 'enable_large_file_support': 'str', + 'enable_large_file_support_metadata': 'SettingsMetadata', 'enable_participant_recipient_setting_metadata': 'SettingsMetadata', 'enable_payment_processing': 'str', 'enable_payment_processing_metadata': 'SettingsMetadata', @@ -1068,6 +1071,7 @@ class AccountSettingsInformation(object): 'draft_envelope_retention': 'draftEnvelopeRetention', 'draft_envelope_retention_metadata': 'draftEnvelopeRetentionMetadata', 'dss_enable_provisioning_pen_configuration_radmin_option': 'dss_EnableProvisioningPenConfiguration_RadminOption', + 'dss_enable_signature_type_custom_tag_radmin_radmin_option': 'dss_EnableSignatureTypeCustomTagRadmin_RadminOption', 'dss_sign_28411_enable_leave_page_prompt_radmin_option': 'dss_SIGN_28411_EnableLeavePagePrompt_RadminOption', 'dss_sign_29182_slide_up_bar_radmin_option': 'dss_SIGN_29182_SlideUpBar_RadminOption', 'email_template_version': 'emailTemplateVersion', @@ -1156,6 +1160,8 @@ class AccountSettingsInformation(object): 'enable_in_browser_editor_metadata': 'enableInBrowserEditorMetadata', 'enable_key_terms_suggestions_by_document_type': 'enableKeyTermsSuggestionsByDocumentType', 'enable_key_terms_suggestions_by_document_type_metadata': 'enableKeyTermsSuggestionsByDocumentTypeMetadata', + 'enable_large_file_support': 'enableLargeFileSupport', + 'enable_large_file_support_metadata': 'enableLargeFileSupportMetadata', 'enable_participant_recipient_setting_metadata': 'enableParticipantRecipientSettingMetadata', 'enable_payment_processing': 'enablePaymentProcessing', 'enable_payment_processing_metadata': 'enablePaymentProcessingMetadata', @@ -1801,6 +1807,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 self._draft_envelope_retention = None self._draft_envelope_retention_metadata = None self._dss_enable_provisioning_pen_configuration_radmin_option = None + self._dss_enable_signature_type_custom_tag_radmin_radmin_option = None self._dss_sign_28411_enable_leave_page_prompt_radmin_option = None self._dss_sign_29182_slide_up_bar_radmin_option = None self._email_template_version = None @@ -1889,6 +1896,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 self._enable_in_browser_editor_metadata = None self._enable_key_terms_suggestions_by_document_type = None self._enable_key_terms_suggestions_by_document_type_metadata = None + self._enable_large_file_support = None + self._enable_large_file_support_metadata = None self._enable_participant_recipient_setting_metadata = None self._enable_payment_processing = None self._enable_payment_processing_metadata = None @@ -2528,6 +2537,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 setattr(self, "_{}".format('draft_envelope_retention'), kwargs.get('draft_envelope_retention', None)) setattr(self, "_{}".format('draft_envelope_retention_metadata'), kwargs.get('draft_envelope_retention_metadata', None)) setattr(self, "_{}".format('dss_enable_provisioning_pen_configuration_radmin_option'), kwargs.get('dss_enable_provisioning_pen_configuration_radmin_option', None)) + setattr(self, "_{}".format('dss_enable_signature_type_custom_tag_radmin_radmin_option'), kwargs.get('dss_enable_signature_type_custom_tag_radmin_radmin_option', None)) setattr(self, "_{}".format('dss_sign_28411_enable_leave_page_prompt_radmin_option'), kwargs.get('dss_sign_28411_enable_leave_page_prompt_radmin_option', None)) setattr(self, "_{}".format('dss_sign_29182_slide_up_bar_radmin_option'), kwargs.get('dss_sign_29182_slide_up_bar_radmin_option', None)) setattr(self, "_{}".format('email_template_version'), kwargs.get('email_template_version', None)) @@ -2616,6 +2626,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 setattr(self, "_{}".format('enable_in_browser_editor_metadata'), kwargs.get('enable_in_browser_editor_metadata', None)) setattr(self, "_{}".format('enable_key_terms_suggestions_by_document_type'), kwargs.get('enable_key_terms_suggestions_by_document_type', None)) setattr(self, "_{}".format('enable_key_terms_suggestions_by_document_type_metadata'), kwargs.get('enable_key_terms_suggestions_by_document_type_metadata', None)) + setattr(self, "_{}".format('enable_large_file_support'), kwargs.get('enable_large_file_support', None)) + setattr(self, "_{}".format('enable_large_file_support_metadata'), kwargs.get('enable_large_file_support_metadata', None)) setattr(self, "_{}".format('enable_participant_recipient_setting_metadata'), kwargs.get('enable_participant_recipient_setting_metadata', None)) setattr(self, "_{}".format('enable_payment_processing'), kwargs.get('enable_payment_processing', None)) setattr(self, "_{}".format('enable_payment_processing_metadata'), kwargs.get('enable_payment_processing_metadata', None)) @@ -10008,6 +10020,29 @@ def dss_enable_provisioning_pen_configuration_radmin_option(self, dss_enable_pro self._dss_enable_provisioning_pen_configuration_radmin_option = dss_enable_provisioning_pen_configuration_radmin_option + @property + def dss_enable_signature_type_custom_tag_radmin_radmin_option(self): + """Gets the dss_enable_signature_type_custom_tag_radmin_radmin_option of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The dss_enable_signature_type_custom_tag_radmin_radmin_option of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._dss_enable_signature_type_custom_tag_radmin_radmin_option + + @dss_enable_signature_type_custom_tag_radmin_radmin_option.setter + def dss_enable_signature_type_custom_tag_radmin_radmin_option(self, dss_enable_signature_type_custom_tag_radmin_radmin_option): + """Sets the dss_enable_signature_type_custom_tag_radmin_radmin_option of this AccountSettingsInformation. + + # noqa: E501 + + :param dss_enable_signature_type_custom_tag_radmin_radmin_option: The dss_enable_signature_type_custom_tag_radmin_radmin_option of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._dss_enable_signature_type_custom_tag_radmin_radmin_option = dss_enable_signature_type_custom_tag_radmin_radmin_option + @property def dss_sign_28411_enable_leave_page_prompt_radmin_option(self): """Gets the dss_sign_28411_enable_leave_page_prompt_radmin_option of this AccountSettingsInformation. # noqa: E501 @@ -12032,6 +12067,52 @@ def enable_key_terms_suggestions_by_document_type_metadata(self, enable_key_term self._enable_key_terms_suggestions_by_document_type_metadata = enable_key_terms_suggestions_by_document_type_metadata + @property + def enable_large_file_support(self): + """Gets the enable_large_file_support of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The enable_large_file_support of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._enable_large_file_support + + @enable_large_file_support.setter + def enable_large_file_support(self, enable_large_file_support): + """Sets the enable_large_file_support of this AccountSettingsInformation. + + # noqa: E501 + + :param enable_large_file_support: The enable_large_file_support of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._enable_large_file_support = enable_large_file_support + + @property + def enable_large_file_support_metadata(self): + """Gets the enable_large_file_support_metadata of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The enable_large_file_support_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._enable_large_file_support_metadata + + @enable_large_file_support_metadata.setter + def enable_large_file_support_metadata(self, enable_large_file_support_metadata): + """Sets the enable_large_file_support_metadata of this AccountSettingsInformation. + + # noqa: E501 + + :param enable_large_file_support_metadata: The enable_large_file_support_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._enable_large_file_support_metadata = enable_large_file_support_metadata + @property def enable_participant_recipient_setting_metadata(self): """Gets the enable_participant_recipient_setting_metadata of this AccountSettingsInformation. # noqa: E501 diff --git a/docusign_esign/models/bulk_send_batch_error.py b/docusign_esign/models/bulk_send_batch_error.py index 67086d9c..a8f92dde 100644 --- a/docusign_esign/models/bulk_send_batch_error.py +++ b/docusign_esign/models/bulk_send_batch_error.py @@ -38,8 +38,8 @@ class BulkSendBatchError(object): } attribute_map = { - 'error': 'error', - 'error_detail': 'errorDetail' + 'error': 'Error', + 'error_detail': 'ErrorDetail' } def __init__(self, _configuration=None, **kwargs): # noqa: E501 diff --git a/docusign_esign/models/delayed_routing.py b/docusign_esign/models/delayed_routing.py index 7350b6b1..603806da 100644 --- a/docusign_esign/models/delayed_routing.py +++ b/docusign_esign/models/delayed_routing.py @@ -109,7 +109,7 @@ def rules(self, rules): def status(self): """Gets the status of this DelayedRouting. # noqa: E501 - Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 + \\\"pending\\\" if the current workflow step has not been reached and the delay has not yet started. \\\"started\\\" if the delay is in progress. \\\"completed\\\" if the delay has elapsed and the envelope has been sent to the current workflow step's recipients. # noqa: E501 :return: The status of this DelayedRouting. # noqa: E501 :rtype: str @@ -120,7 +120,7 @@ def status(self): def status(self, status): """Sets the status of this DelayedRouting. - Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 + \\\"pending\\\" if the current workflow step has not been reached and the delay has not yet started. \\\"started\\\" if the delay is in progress. \\\"completed\\\" if the delay has elapsed and the envelope has been sent to the current workflow step's recipients. # noqa: E501 :param status: The status of this DelayedRouting. # noqa: E501 :type: str diff --git a/docusign_esign/models/doc_gen_form_field.py b/docusign_esign/models/doc_gen_form_field.py index 3a1af4ba..d51d21a2 100644 --- a/docusign_esign/models/doc_gen_form_field.py +++ b/docusign_esign/models/doc_gen_form_field.py @@ -33,18 +33,26 @@ class DocGenFormField(object): and the value is json key in definition. """ swagger_types = { + 'description': 'str', 'label': 'str', 'name': 'str', + 'options': 'list[DocGenFormFieldOption]', + 'predefined_validation': 'str', 'required': 'str', 'type': 'str', + 'validation': 'DocGenFormFieldValidation', 'value': 'str' } attribute_map = { + 'description': 'description', 'label': 'label', 'name': 'name', + 'options': 'options', + 'predefined_validation': 'predefinedValidation', 'required': 'required', 'type': 'type', + 'validation': 'validation', 'value': 'value' } @@ -54,19 +62,50 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 _configuration = Configuration() self._configuration = _configuration + self._description = None self._label = None self._name = None + self._options = None + self._predefined_validation = None self._required = None self._type = None + self._validation = None self._value = None self.discriminator = None + setattr(self, "_{}".format('description'), kwargs.get('description', None)) setattr(self, "_{}".format('label'), kwargs.get('label', None)) setattr(self, "_{}".format('name'), kwargs.get('name', None)) + setattr(self, "_{}".format('options'), kwargs.get('options', None)) + setattr(self, "_{}".format('predefined_validation'), kwargs.get('predefined_validation', None)) setattr(self, "_{}".format('required'), kwargs.get('required', None)) setattr(self, "_{}".format('type'), kwargs.get('type', None)) + setattr(self, "_{}".format('validation'), kwargs.get('validation', None)) setattr(self, "_{}".format('value'), kwargs.get('value', None)) + @property + def description(self): + """Gets the description of this DocGenFormField. # noqa: E501 + + # noqa: E501 + + :return: The description of this DocGenFormField. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this DocGenFormField. + + # noqa: E501 + + :param description: The description of this DocGenFormField. # noqa: E501 + :type: str + """ + + self._description = description + @property def label(self): """Gets the label of this DocGenFormField. # noqa: E501 @@ -113,6 +152,52 @@ def name(self, name): self._name = name + @property + def options(self): + """Gets the options of this DocGenFormField. # noqa: E501 + + # noqa: E501 + + :return: The options of this DocGenFormField. # noqa: E501 + :rtype: list[DocGenFormFieldOption] + """ + return self._options + + @options.setter + def options(self, options): + """Sets the options of this DocGenFormField. + + # noqa: E501 + + :param options: The options of this DocGenFormField. # noqa: E501 + :type: list[DocGenFormFieldOption] + """ + + self._options = options + + @property + def predefined_validation(self): + """Gets the predefined_validation of this DocGenFormField. # noqa: E501 + + # noqa: E501 + + :return: The predefined_validation of this DocGenFormField. # noqa: E501 + :rtype: str + """ + return self._predefined_validation + + @predefined_validation.setter + def predefined_validation(self, predefined_validation): + """Sets the predefined_validation of this DocGenFormField. + + # noqa: E501 + + :param predefined_validation: The predefined_validation of this DocGenFormField. # noqa: E501 + :type: str + """ + + self._predefined_validation = predefined_validation + @property def required(self): """Gets the required of this DocGenFormField. # noqa: E501 @@ -159,6 +244,29 @@ def type(self, type): self._type = type + @property + def validation(self): + """Gets the validation of this DocGenFormField. # noqa: E501 + + # noqa: E501 + + :return: The validation of this DocGenFormField. # noqa: E501 + :rtype: DocGenFormFieldValidation + """ + return self._validation + + @validation.setter + def validation(self, validation): + """Sets the validation of this DocGenFormField. + + # noqa: E501 + + :param validation: The validation of this DocGenFormField. # noqa: E501 + :type: DocGenFormFieldValidation + """ + + self._validation = validation + @property def value(self): """Gets the value of this DocGenFormField. # noqa: E501 diff --git a/docusign_esign/models/doc_gen_form_field_option.py b/docusign_esign/models/doc_gen_form_field_option.py new file mode 100644 index 00000000..272ffc3e --- /dev/null +++ b/docusign_esign/models/doc_gen_form_field_option.py @@ -0,0 +1,205 @@ +# coding: utf-8 + +""" + DocuSign REST API + + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 + + OpenAPI spec version: v2.1 + Contact: devcenter@docusign.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + +from docusign_esign.client.configuration import Configuration + + +class DocGenFormFieldOption(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'description': 'str', + 'label': 'str', + 'selected': 'str', + 'value': 'str' + } + + attribute_map = { + 'description': 'description', + 'label': 'label', + 'selected': 'selected', + 'value': 'value' + } + + def __init__(self, _configuration=None, **kwargs): # noqa: E501 + """DocGenFormFieldOption - a model defined in Swagger""" # noqa: E501 + if _configuration is None: + _configuration = Configuration() + self._configuration = _configuration + + self._description = None + self._label = None + self._selected = None + self._value = None + self.discriminator = None + + setattr(self, "_{}".format('description'), kwargs.get('description', None)) + setattr(self, "_{}".format('label'), kwargs.get('label', None)) + setattr(self, "_{}".format('selected'), kwargs.get('selected', None)) + setattr(self, "_{}".format('value'), kwargs.get('value', None)) + + @property + def description(self): + """Gets the description of this DocGenFormFieldOption. # noqa: E501 + + # noqa: E501 + + :return: The description of this DocGenFormFieldOption. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this DocGenFormFieldOption. + + # noqa: E501 + + :param description: The description of this DocGenFormFieldOption. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def label(self): + """Gets the label of this DocGenFormFieldOption. # noqa: E501 + + # noqa: E501 + + :return: The label of this DocGenFormFieldOption. # noqa: E501 + :rtype: str + """ + return self._label + + @label.setter + def label(self, label): + """Sets the label of this DocGenFormFieldOption. + + # noqa: E501 + + :param label: The label of this DocGenFormFieldOption. # noqa: E501 + :type: str + """ + + self._label = label + + @property + def selected(self): + """Gets the selected of this DocGenFormFieldOption. # noqa: E501 + + # noqa: E501 + + :return: The selected of this DocGenFormFieldOption. # noqa: E501 + :rtype: str + """ + return self._selected + + @selected.setter + def selected(self, selected): + """Sets the selected of this DocGenFormFieldOption. + + # noqa: E501 + + :param selected: The selected of this DocGenFormFieldOption. # noqa: E501 + :type: str + """ + + self._selected = selected + + @property + def value(self): + """Gets the value of this DocGenFormFieldOption. # noqa: E501 + + Specifies the value of the tab. # noqa: E501 + + :return: The value of this DocGenFormFieldOption. # noqa: E501 + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """Sets the value of this DocGenFormFieldOption. + + Specifies the value of the tab. # noqa: E501 + + :param value: The value of this DocGenFormFieldOption. # noqa: E501 + :type: str + """ + + self._value = value + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(DocGenFormFieldOption, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, DocGenFormFieldOption): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, DocGenFormFieldOption): + return True + + return self.to_dict() != other.to_dict() diff --git a/docusign_esign/models/doc_gen_form_field_validation.py b/docusign_esign/models/doc_gen_form_field_validation.py new file mode 100644 index 00000000..3627fd15 --- /dev/null +++ b/docusign_esign/models/doc_gen_form_field_validation.py @@ -0,0 +1,151 @@ +# coding: utf-8 + +""" + DocuSign REST API + + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 + + OpenAPI spec version: v2.1 + Contact: devcenter@docusign.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + +from docusign_esign.client.configuration import Configuration + + +class DocGenFormFieldValidation(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'error_message': 'str', + 'expression': 'str' + } + + attribute_map = { + 'error_message': 'errorMessage', + 'expression': 'expression' + } + + def __init__(self, _configuration=None, **kwargs): # noqa: E501 + """DocGenFormFieldValidation - a model defined in Swagger""" # noqa: E501 + if _configuration is None: + _configuration = Configuration() + self._configuration = _configuration + + self._error_message = None + self._expression = None + self.discriminator = None + + setattr(self, "_{}".format('error_message'), kwargs.get('error_message', None)) + setattr(self, "_{}".format('expression'), kwargs.get('expression', None)) + + @property + def error_message(self): + """Gets the error_message of this DocGenFormFieldValidation. # noqa: E501 + + # noqa: E501 + + :return: The error_message of this DocGenFormFieldValidation. # noqa: E501 + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """Sets the error_message of this DocGenFormFieldValidation. + + # noqa: E501 + + :param error_message: The error_message of this DocGenFormFieldValidation. # noqa: E501 + :type: str + """ + + self._error_message = error_message + + @property + def expression(self): + """Gets the expression of this DocGenFormFieldValidation. # noqa: E501 + + # noqa: E501 + + :return: The expression of this DocGenFormFieldValidation. # noqa: E501 + :rtype: str + """ + return self._expression + + @expression.setter + def expression(self, expression): + """Sets the expression of this DocGenFormFieldValidation. + + # noqa: E501 + + :param expression: The expression of this DocGenFormFieldValidation. # noqa: E501 + :type: str + """ + + self._expression = expression + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(DocGenFormFieldValidation, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, DocGenFormFieldValidation): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, DocGenFormFieldValidation): + return True + + return self.to_dict() != other.to_dict() diff --git a/docusign_esign/models/document.py b/docusign_esign/models/document.py index 56ab1858..eaf05af3 100644 --- a/docusign_esign/models/document.py +++ b/docusign_esign/models/document.py @@ -35,6 +35,7 @@ class Document(object): swagger_types = { 'apply_anchor_tabs': 'str', 'assign_tabs_to_recipient_id': 'str', + 'authoritative_copy': 'bool', 'display': 'str', 'doc_gen_form_fields': 'list[DocGenFormField]', 'document_base64': 'str', @@ -65,6 +66,7 @@ class Document(object): attribute_map = { 'apply_anchor_tabs': 'applyAnchorTabs', 'assign_tabs_to_recipient_id': 'assignTabsToRecipientId', + 'authoritative_copy': 'authoritativeCopy', 'display': 'display', 'doc_gen_form_fields': 'docGenFormFields', 'document_base64': 'documentBase64', @@ -100,6 +102,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 self._apply_anchor_tabs = None self._assign_tabs_to_recipient_id = None + self._authoritative_copy = None self._display = None self._doc_gen_form_fields = None self._document_base64 = None @@ -129,6 +132,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 setattr(self, "_{}".format('apply_anchor_tabs'), kwargs.get('apply_anchor_tabs', None)) setattr(self, "_{}".format('assign_tabs_to_recipient_id'), kwargs.get('assign_tabs_to_recipient_id', None)) + setattr(self, "_{}".format('authoritative_copy'), kwargs.get('authoritative_copy', None)) setattr(self, "_{}".format('display'), kwargs.get('display', None)) setattr(self, "_{}".format('doc_gen_form_fields'), kwargs.get('doc_gen_form_fields', None)) setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None)) @@ -201,6 +205,29 @@ def assign_tabs_to_recipient_id(self, assign_tabs_to_recipient_id): self._assign_tabs_to_recipient_id = assign_tabs_to_recipient_id + @property + def authoritative_copy(self): + """Gets the authoritative_copy of this Document. # noqa: E501 + + Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501 + + :return: The authoritative_copy of this Document. # noqa: E501 + :rtype: bool + """ + return self._authoritative_copy + + @authoritative_copy.setter + def authoritative_copy(self, authoritative_copy): + """Sets the authoritative_copy of this Document. + + Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501 + + :param authoritative_copy: The authoritative_copy of this Document. # noqa: E501 + :type: bool + """ + + self._authoritative_copy = authoritative_copy + @property def display(self): """Gets the display of this Document. # noqa: E501 diff --git a/docusign_esign/models/initial_here.py b/docusign_esign/models/initial_here.py index b2114a74..fbbb40dd 100644 --- a/docusign_esign/models/initial_here.py +++ b/docusign_esign/models/initial_here.py @@ -1567,7 +1567,7 @@ def recipient_id_metadata(self, recipient_id_metadata): def scale_value(self): """Gets the scale_value of this InitialHere. # noqa: E501 - Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. # noqa: E501 + Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. # noqa: E501 :return: The scale_value of this InitialHere. # noqa: E501 :rtype: str @@ -1578,7 +1578,7 @@ def scale_value(self): def scale_value(self, scale_value): """Sets the scale_value of this InitialHere. - Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. # noqa: E501 + Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. # noqa: E501 :param scale_value: The scale_value of this InitialHere. # noqa: E501 :type: str diff --git a/docusign_esign/models/scheduled_sending.py b/docusign_esign/models/scheduled_sending.py index f46150a7..5754ca35 100644 --- a/docusign_esign/models/scheduled_sending.py +++ b/docusign_esign/models/scheduled_sending.py @@ -136,7 +136,7 @@ def rules(self, rules): def status(self): """Gets the status of this ScheduledSending. # noqa: E501 - Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 + \\\"pending\\\" if the envelope has not yet been sent and the scheduled sending delay has not iniaited. \\\"started\\\" if the scheduled sending delay is in progress. \\\"completed\\\" if the scheduled sending delay has elapsed and the envelope has been sent. # noqa: E501 :return: The status of this ScheduledSending. # noqa: E501 :rtype: str @@ -147,7 +147,7 @@ def status(self): def status(self, status): """Sets the status of this ScheduledSending. - Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 + \\\"pending\\\" if the envelope has not yet been sent and the scheduled sending delay has not iniaited. \\\"started\\\" if the scheduled sending delay is in progress. \\\"completed\\\" if the scheduled sending delay has elapsed and the envelope has been sent. # noqa: E501 :param status: The status of this ScheduledSending. # noqa: E501 :type: str diff --git a/setup.py b/setup.py index 3fdb11a8..69447257 100644 --- a/setup.py +++ b/setup.py @@ -14,7 +14,7 @@ from setuptools import setup, find_packages, Command, os # noqa: H301 NAME = "docusign-esign" -VERSION = "3.24.0" +VERSION = "3.25.0" # To install the library, run the following # # python setup.py install