diff --git a/CHANGELOG.md b/CHANGELOG.md index 28945233..74fb6e2a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,12 @@ 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. +## [3.13.0rc1] - ESignature API v2.1-21.3.02.00 - 2021-11-03 +### Changed +- Added support for version v2.1-21.3.02.00 of the DocuSign ESignature API. +- Updated the SDK release version. + + ## [3.12.0] - ESignature API v2.1-21.3.00.00 - 2021-09-20 ### Changed - Added support for version v2.1-21.3.00.00 of the DocuSign ESignature API. diff --git a/docusign_esign/__init__.py b/docusign_esign/__init__.py index 1b1dcc89..f5842aa9 100644 --- a/docusign_esign/__init__.py +++ b/docusign_esign/__init__.py @@ -179,6 +179,7 @@ from docusign_esign.models.connect_config_results import ConnectConfigResults from docusign_esign.models.connect_custom_configuration import ConnectCustomConfiguration from docusign_esign.models.connect_debug_log import ConnectDebugLog +from docusign_esign.models.connect_delete_failure_result import ConnectDeleteFailureResult from docusign_esign.models.connect_event_data import ConnectEventData from docusign_esign.models.connect_failure_filter import ConnectFailureFilter from docusign_esign.models.connect_failure_result import ConnectFailureResult @@ -187,6 +188,7 @@ from docusign_esign.models.connect_logs import ConnectLogs from docusign_esign.models.connect_salesforce_field import ConnectSalesforceField from docusign_esign.models.connect_salesforce_object import ConnectSalesforceObject +from docusign_esign.models.connect_user_info import ConnectUserInfo from docusign_esign.models.connect_user_object import ConnectUserObject from docusign_esign.models.console_view_request import ConsoleViewRequest from docusign_esign.models.consumer_disclosure import ConsumerDisclosure @@ -228,6 +230,7 @@ from docusign_esign.models.downgrad_request_billing_info_response import DowngradRequestBillingInfoResponse from docusign_esign.models.downgrade_billing_plan_information import DowngradeBillingPlanInformation from docusign_esign.models.downgrade_plan_update_response import DowngradePlanUpdateResponse +from docusign_esign.models.downgrade_request_information import DowngradeRequestInformation from docusign_esign.models.draw import Draw from docusign_esign.models.e_note_configuration import ENoteConfiguration from docusign_esign.models.editor import Editor @@ -288,7 +291,6 @@ from docusign_esign.models.full_name import FullName from docusign_esign.models.graphics_context import GraphicsContext from docusign_esign.models.group import Group -from docusign_esign.models.group_brands import GroupBrands from docusign_esign.models.group_information import GroupInformation from docusign_esign.models.id_check_configuration import IdCheckConfiguration from docusign_esign.models.id_check_information_input import IdCheckInformationInput @@ -296,6 +298,7 @@ from docusign_esign.models.in_person_signer import InPersonSigner from docusign_esign.models.initial_here import InitialHere from docusign_esign.models.inline_template import InlineTemplate +from docusign_esign.models.integrated_connect_user_info_list import IntegratedConnectUserInfoList from docusign_esign.models.integrated_user_info_list import IntegratedUserInfoList from docusign_esign.models.intermediary import Intermediary from docusign_esign.models.jurisdiction import Jurisdiction diff --git a/docusign_esign/apis/accounts_api.py b/docusign_esign/apis/accounts_api.py index 9cd3511f..02b15ed0 100644 --- a/docusign_esign/apis/accounts_api.py +++ b/docusign_esign/apis/accounts_api.py @@ -3328,7 +3328,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), 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. @@ -3355,7 +3355,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), 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. @@ -6401,7 +6401,7 @@ def update_brand_logo_by_type(self, account_id, brand_id, logo_type, logo_file_b :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 brand_id: The id of the brand. (required) + :param str brand_id: The ID of the brand. (required) :param str logo_type: The type of logo. Valid values are: - `primary` - `secondary` - `email` (required) :param str logo_file_bytes: Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places (required) :return: None @@ -6429,7 +6429,7 @@ def update_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_ty :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 brand_id: The id of the brand. (required) + :param str brand_id: The ID of the brand. (required) :param str logo_type: The type of logo. Valid values are: - `primary` - `secondary` - `email` (required) :param str logo_file_bytes: Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places (required) :return: None @@ -6527,7 +6527,7 @@ def update_brand_resources_by_content_type(self, account_id, brand_id, resource_ :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 brand_id: The id of the brand. (required) + :param str brand_id: The ID of the brand. (required) :param str resource_content_type: The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive` (required) :param file file_xml: Brand resource XML file. (required) :return: BrandResources @@ -6555,7 +6555,7 @@ def update_brand_resources_by_content_type_with_http_info(self, account_id, bran :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 brand_id: The id of the brand. (required) + :param str brand_id: The ID of the brand. (required) :param str resource_content_type: The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive` (required) :param file file_xml: Brand resource XML file. (required) :return: BrandResources @@ -6653,7 +6653,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), 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 @@ -6681,7 +6681,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), 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/billing_api.py b/docusign_esign/apis/billing_api.py index 4d96e811..eedf3025 100644 --- a/docusign_esign/apis/billing_api.py +++ b/docusign_esign/apis/billing_api.py @@ -348,7 +348,7 @@ def get_downgrade_request_billing_info_with_http_info(self, account_id, **kwargs def get_invoice(self, account_id, invoice_id, **kwargs): """ Retrieves a billing invoice. - Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | + Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -375,7 +375,7 @@ def get_invoice(self, account_id, invoice_id, **kwargs): def get_invoice_with_http_info(self, account_id, invoice_id, **kwargs): """ Retrieves a billing invoice. - Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | + Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -581,6 +581,7 @@ def get_plan(self, account_id, **kwargs): for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str include_credit_card_information: When set to **true**, excludes credit card information from the response. + :param str include_downgrade_information: :param str include_metadata: When set to **true**, the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` property is added to the `billingAddress` information. :param str include_successor_plans: When set to **true**, excludes successor information from the response. :return: AccountBillingPlanResponse @@ -610,6 +611,7 @@ def get_plan_with_http_info(self, account_id, **kwargs): for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str include_credit_card_information: When set to **true**, excludes credit card information from the response. + :param str include_downgrade_information: :param str include_metadata: When set to **true**, the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` property is added to the `billingAddress` information. :param str include_successor_plans: When set to **true**, excludes successor information from the response. :return: AccountBillingPlanResponse @@ -617,7 +619,7 @@ def get_plan_with_http_info(self, account_id, **kwargs): returns the request thread. """ - all_params = ['account_id', 'include_credit_card_information', 'include_metadata', 'include_successor_plans'] + all_params = ['account_id', 'include_credit_card_information', 'include_downgrade_information', 'include_metadata', 'include_successor_plans'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -647,6 +649,8 @@ def get_plan_with_http_info(self, account_id, **kwargs): query_params = {} if 'include_credit_card_information' in params: query_params['include_credit_card_information'] = params['include_credit_card_information'] + if 'include_downgrade_information' in params: + query_params['include_downgrade_information'] = params['include_downgrade_information'] if 'include_metadata' in params: query_params['include_metadata'] = params['include_metadata'] if 'include_successor_plans' in params: diff --git a/docusign_esign/apis/connect_api.py b/docusign_esign/apis/connect_api.py index f1dc774f..8e44f47e 100644 --- a/docusign_esign/apis/connect_api.py +++ b/docusign_esign/apis/connect_api.py @@ -273,7 +273,7 @@ def delete_event_failure_log(self, account_id, failure_id, **kwargs): for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str failure_id: The ID of the failed connect log entry. (required) - :return: None + :return: ConnectDeleteFailureResult If the method is called asynchronously, returns the request thread. """ @@ -300,7 +300,7 @@ def delete_event_failure_log_with_http_info(self, account_id, failure_id, **kwar for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str failure_id: The ID of the failed connect log entry. (required) - :return: None + :return: ConnectDeleteFailureResult If the method is called asynchronously, returns the request thread. """ @@ -359,7 +359,7 @@ def delete_event_failure_log_with_http_info(self, account_id, failure_id, **kwar body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='ConnectDeleteFailureResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -797,6 +797,138 @@ def get_configuration_with_http_info(self, account_id, connect_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_connect_all_users(self, account_id, connect_id, **kwargs): + """ + Returns all users from the configured Connect service. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_connect_all_users(account_id, connect_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: (required) + :param str connect_id: (required) + :param str count: + :param str email_substring: + :param str is_recipient_connect_config: + :param str start_position: + :param str status: + :param str user_name_substring: + :return: IntegratedConnectUserInfoList + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_connect_all_users_with_http_info(account_id, connect_id, **kwargs) + else: + (data) = self.get_connect_all_users_with_http_info(account_id, connect_id, **kwargs) + return data + + def get_connect_all_users_with_http_info(self, account_id, connect_id, **kwargs): + """ + Returns all users from the configured Connect service. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_connect_all_users_with_http_info(account_id, connect_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: (required) + :param str connect_id: (required) + :param str count: + :param str email_substring: + :param str is_recipient_connect_config: + :param str start_position: + :param str status: + :param str user_name_substring: + :return: IntegratedConnectUserInfoList + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'connect_id', 'count', 'email_substring', 'is_recipient_connect_config', 'start_position', 'status', 'user_name_substring'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_connect_all_users" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_connect_all_users`") + # verify the required parameter 'connect_id' is set + if ('connect_id' not in params) or (params['connect_id'] is None): + raise ValueError("Missing the required parameter `connect_id` when calling `get_connect_all_users`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/connect/{connectId}/all/users'.replace('{format}', 'json') + path_params = {} + if 'account_id' in params: + path_params['accountId'] = params['account_id'] + if 'connect_id' in params: + path_params['connectId'] = params['connect_id'] + + query_params = {} + if 'count' in params: + query_params['count'] = params['count'] + if 'email_substring' in params: + query_params['email_substring'] = params['email_substring'] + if 'is_recipient_connect_config' in params: + query_params['is_recipient_connect_config'] = params['is_recipient_connect_config'] + if 'start_position' in params: + query_params['start_position'] = params['start_position'] + if 'status' in params: + query_params['status'] = params['status'] + if 'user_name_substring' in params: + query_params['user_name_substring'] = params['user_name_substring'] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(resource_path, 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='IntegratedConnectUserInfoList', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_event_log(self, account_id, log_id, **kwargs): """ Get the specified Connect log entry. diff --git a/docusign_esign/apis/envelopes_api.py b/docusign_esign/apis/envelopes_api.py index 2a32150d..b22f54b0 100644 --- a/docusign_esign/apis/envelopes_api.py +++ b/docusign_esign/apis/envelopes_api.py @@ -5330,9 +5330,9 @@ 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), 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: + :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 If the method is called asynchronously, returns the request thread. @@ -5360,9 +5360,9 @@ 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), 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: + :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 If the method is called asynchronously, returns the request thread. @@ -5856,6 +5856,125 @@ def get_document_page_image_with_http_info(self, account_id, document_id, envelo _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_document_responsive_html(self, account_id, document_id, envelope_id, **kwargs): + """ + Get Responsive HTML for a document in an envelope. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_document_responsive_html(account_id, document_id, envelope_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: (required) + :param str document_id: (required) + :param str envelope_id: (required) + :param str include_anchor_tab_locations: + :return: DocumentHtmlDefinitionOriginals + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_document_responsive_html_with_http_info(account_id, document_id, envelope_id, **kwargs) + else: + (data) = self.get_document_responsive_html_with_http_info(account_id, document_id, envelope_id, **kwargs) + return data + + def get_document_responsive_html_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + """ + Get Responsive HTML for a document in an envelope. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_document_responsive_html_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: (required) + :param str document_id: (required) + :param str envelope_id: (required) + :param str include_anchor_tab_locations: + :return: DocumentHtmlDefinitionOriginals + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'document_id', 'envelope_id', 'include_anchor_tab_locations'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_document_responsive_html" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_document_responsive_html`") + # verify the required parameter 'document_id' is set + if ('document_id' not in params) or (params['document_id'] is None): + raise ValueError("Missing the required parameter `document_id` when calling `get_document_responsive_html`") + # verify the required parameter 'envelope_id' is set + if ('envelope_id' not in params) or (params['envelope_id'] is None): + raise ValueError("Missing the required parameter `envelope_id` when calling `get_document_responsive_html`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html'.replace('{format}', 'json') + path_params = {} + if 'account_id' in params: + path_params['accountId'] = params['account_id'] + if 'document_id' in params: + path_params['documentId'] = params['document_id'] + if 'envelope_id' in params: + path_params['envelopeId'] = params['envelope_id'] + + query_params = {} + if 'include_anchor_tab_locations' in params: + query_params['include_anchor_tab_locations'] = params['include_anchor_tab_locations'] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(resource_path, 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='DocumentHtmlDefinitionOriginals', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_document_tabs(self, account_id, document_id, envelope_id, **kwargs): """ Returns tabs on the document. @@ -7714,6 +7833,118 @@ def get_recipient_signature_image_with_http_info(self, account_id, envelope_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_responsive_html(self, account_id, envelope_id, **kwargs): + """ + Get Responsive HTML for all documents in an envelope. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_responsive_html(account_id, envelope_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: (required) + :param str envelope_id: (required) + :param str include_anchor_tab_locations: + :return: DocumentHtmlDefinitionOriginals + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_responsive_html_with_http_info(account_id, envelope_id, **kwargs) + else: + (data) = self.get_responsive_html_with_http_info(account_id, envelope_id, **kwargs) + return data + + def get_responsive_html_with_http_info(self, account_id, envelope_id, **kwargs): + """ + Get Responsive HTML for all documents in an envelope. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_responsive_html_with_http_info(account_id, envelope_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: (required) + :param str envelope_id: (required) + :param str include_anchor_tab_locations: + :return: DocumentHtmlDefinitionOriginals + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'envelope_id', 'include_anchor_tab_locations'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_responsive_html" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_responsive_html`") + # verify the required parameter 'envelope_id' is set + if ('envelope_id' not in params) or (params['envelope_id'] is None): + raise ValueError("Missing the required parameter `envelope_id` when calling `get_responsive_html`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html'.replace('{format}', 'json') + path_params = {} + if 'account_id' in params: + path_params['accountId'] = params['account_id'] + if 'envelope_id' in params: + path_params['envelopeId'] = params['envelope_id'] + + query_params = {} + if 'include_anchor_tab_locations' in params: + query_params['include_anchor_tab_locations'] = params['include_anchor_tab_locations'] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(resource_path, 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='DocumentHtmlDefinitionOriginals', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_tabs_blob(self, account_id, envelope_id, **kwargs): """ Get encrypted tabs for envelope. diff --git a/docusign_esign/models/__init__.py b/docusign_esign/models/__init__.py index be17e494..80f6b8d0 100644 --- a/docusign_esign/models/__init__.py +++ b/docusign_esign/models/__init__.py @@ -144,6 +144,7 @@ from docusign_esign.models.connect_config_results import ConnectConfigResults from docusign_esign.models.connect_custom_configuration import ConnectCustomConfiguration from docusign_esign.models.connect_debug_log import ConnectDebugLog +from docusign_esign.models.connect_delete_failure_result import ConnectDeleteFailureResult from docusign_esign.models.connect_event_data import ConnectEventData from docusign_esign.models.connect_failure_filter import ConnectFailureFilter from docusign_esign.models.connect_failure_result import ConnectFailureResult @@ -152,6 +153,7 @@ from docusign_esign.models.connect_logs import ConnectLogs from docusign_esign.models.connect_salesforce_field import ConnectSalesforceField from docusign_esign.models.connect_salesforce_object import ConnectSalesforceObject +from docusign_esign.models.connect_user_info import ConnectUserInfo from docusign_esign.models.connect_user_object import ConnectUserObject from docusign_esign.models.console_view_request import ConsoleViewRequest from docusign_esign.models.consumer_disclosure import ConsumerDisclosure @@ -193,6 +195,7 @@ from docusign_esign.models.downgrad_request_billing_info_response import DowngradRequestBillingInfoResponse from docusign_esign.models.downgrade_billing_plan_information import DowngradeBillingPlanInformation from docusign_esign.models.downgrade_plan_update_response import DowngradePlanUpdateResponse +from docusign_esign.models.downgrade_request_information import DowngradeRequestInformation from docusign_esign.models.draw import Draw from docusign_esign.models.e_note_configuration import ENoteConfiguration from docusign_esign.models.editor import Editor @@ -253,7 +256,6 @@ from docusign_esign.models.full_name import FullName from docusign_esign.models.graphics_context import GraphicsContext from docusign_esign.models.group import Group -from docusign_esign.models.group_brands import GroupBrands from docusign_esign.models.group_information import GroupInformation from docusign_esign.models.id_check_configuration import IdCheckConfiguration from docusign_esign.models.id_check_information_input import IdCheckInformationInput @@ -261,6 +263,7 @@ from docusign_esign.models.in_person_signer import InPersonSigner from docusign_esign.models.initial_here import InitialHere from docusign_esign.models.inline_template import InlineTemplate +from docusign_esign.models.integrated_connect_user_info_list import IntegratedConnectUserInfoList from docusign_esign.models.integrated_user_info_list import IntegratedUserInfoList from docusign_esign.models.intermediary import Intermediary from docusign_esign.models.jurisdiction import Jurisdiction diff --git a/docusign_esign/models/account_settings_information.py b/docusign_esign/models/account_settings_information.py index 3edf9529..5d6c362c 100644 --- a/docusign_esign/models/account_settings_information.py +++ b/docusign_esign/models/account_settings_information.py @@ -134,8 +134,16 @@ class AccountSettingsInformation(object): 'allow_offline_signing_metadata': 'SettingsMetadata', 'allow_open_trust_signer_certificate': 'str', 'allow_open_trust_signer_certificate_metadata': 'SettingsMetadata', + 'allow_organization_docusign_monitor': 'str', + 'allow_organization_docusign_monitor_metadata': 'SettingsMetadata', + 'allow_organization_domain_user_management': 'str', + 'allow_organization_domain_user_management_metadata': 'SettingsMetadata', 'allow_organizations': 'str', 'allow_organizations_metadata': 'SettingsMetadata', + 'allow_organization_sso_management': 'str', + 'allow_organization_sso_management_metadata': 'SettingsMetadata', + 'allow_organization_to_use_remote_notary': 'str', + 'allow_organization_to_use_remote_notary_metadata': 'SettingsMetadata', 'allow_payment_processing': 'str', 'allow_payment_processing_metadata': 'SettingsMetadata', 'allow_personal_signer_certificate': 'str', @@ -397,6 +405,7 @@ class AccountSettingsInformation(object): 'fax_out_enabled_metadata': 'SettingsMetadata', 'guided_forms_html_allowed': 'str', 'guided_forms_html_allowed_metadata': 'SettingsMetadata', + 'has_recipient_connect_claimed_domain': 'str', 'hide_account_address_in_co_c': 'str', 'hide_account_address_in_co_c_metadata': 'SettingsMetadata', 'hide_pricing': 'str', @@ -443,6 +452,8 @@ class AccountSettingsInformation(object): 'phone_auth_recipient_may_provide_phone_number_metadata': 'SettingsMetadata', 'pki_sign_downloaded_pdf_docs': 'str', 'pki_sign_downloaded_pdf_docs_metadata': 'SettingsMetadata', + 'read_only_mode': 'str', + 'read_only_mode_metadata': 'SettingsMetadata', 'recipients_can_sign_offline': 'str', 'recipients_can_sign_offline_metadata': 'SettingsMetadata', 'recipient_signing_auto_navigation_control': 'str', @@ -695,8 +706,16 @@ class AccountSettingsInformation(object): 'allow_offline_signing_metadata': 'allowOfflineSigningMetadata', 'allow_open_trust_signer_certificate': 'allowOpenTrustSignerCertificate', 'allow_open_trust_signer_certificate_metadata': 'allowOpenTrustSignerCertificateMetadata', + 'allow_organization_docusign_monitor': 'allowOrganizationDocusignMonitor', + 'allow_organization_docusign_monitor_metadata': 'allowOrganizationDocusignMonitorMetadata', + 'allow_organization_domain_user_management': 'allowOrganizationDomainUserManagement', + 'allow_organization_domain_user_management_metadata': 'allowOrganizationDomainUserManagementMetadata', 'allow_organizations': 'allowOrganizations', 'allow_organizations_metadata': 'allowOrganizationsMetadata', + 'allow_organization_sso_management': 'allowOrganizationSsoManagement', + 'allow_organization_sso_management_metadata': 'allowOrganizationSsoManagementMetadata', + 'allow_organization_to_use_remote_notary': 'allowOrganizationToUseRemoteNotary', + 'allow_organization_to_use_remote_notary_metadata': 'allowOrganizationToUseRemoteNotaryMetadata', 'allow_payment_processing': 'allowPaymentProcessing', 'allow_payment_processing_metadata': 'allowPaymentProcessingMetadata', 'allow_personal_signer_certificate': 'allowPersonalSignerCertificate', @@ -958,6 +977,7 @@ class AccountSettingsInformation(object): 'fax_out_enabled_metadata': 'faxOutEnabledMetadata', 'guided_forms_html_allowed': 'guidedFormsHtmlAllowed', 'guided_forms_html_allowed_metadata': 'guidedFormsHtmlAllowedMetadata', + 'has_recipient_connect_claimed_domain': 'hasRecipientConnectClaimedDomain', 'hide_account_address_in_co_c': 'hideAccountAddressInCoC', 'hide_account_address_in_co_c_metadata': 'hideAccountAddressInCoCMetadata', 'hide_pricing': 'hidePricing', @@ -1004,6 +1024,8 @@ class AccountSettingsInformation(object): 'phone_auth_recipient_may_provide_phone_number_metadata': 'phoneAuthRecipientMayProvidePhoneNumberMetadata', 'pki_sign_downloaded_pdf_docs': 'pkiSignDownloadedPDFDocs', 'pki_sign_downloaded_pdf_docs_metadata': 'pkiSignDownloadedPDFDocsMetadata', + 'read_only_mode': 'readOnlyMode', + 'read_only_mode_metadata': 'readOnlyModeMetadata', 'recipients_can_sign_offline': 'recipientsCanSignOffline', 'recipients_can_sign_offline_metadata': 'recipientsCanSignOfflineMetadata', 'recipient_signing_auto_navigation_control': 'recipientSigningAutoNavigationControl', @@ -1261,8 +1283,16 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 self._allow_offline_signing_metadata = None self._allow_open_trust_signer_certificate = None self._allow_open_trust_signer_certificate_metadata = None + self._allow_organization_docusign_monitor = None + self._allow_organization_docusign_monitor_metadata = None + self._allow_organization_domain_user_management = None + self._allow_organization_domain_user_management_metadata = None self._allow_organizations = None self._allow_organizations_metadata = None + self._allow_organization_sso_management = None + self._allow_organization_sso_management_metadata = None + self._allow_organization_to_use_remote_notary = None + self._allow_organization_to_use_remote_notary_metadata = None self._allow_payment_processing = None self._allow_payment_processing_metadata = None self._allow_personal_signer_certificate = None @@ -1524,6 +1554,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 self._fax_out_enabled_metadata = None self._guided_forms_html_allowed = None self._guided_forms_html_allowed_metadata = None + self._has_recipient_connect_claimed_domain = None self._hide_account_address_in_co_c = None self._hide_account_address_in_co_c_metadata = None self._hide_pricing = None @@ -1570,6 +1601,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 self._phone_auth_recipient_may_provide_phone_number_metadata = None self._pki_sign_downloaded_pdf_docs = None self._pki_sign_downloaded_pdf_docs_metadata = None + self._read_only_mode = None + self._read_only_mode_metadata = None self._recipients_can_sign_offline = None self._recipients_can_sign_offline_metadata = None self._recipient_signing_auto_navigation_control = None @@ -1821,8 +1854,16 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 setattr(self, "_{}".format('allow_offline_signing_metadata'), kwargs.get('allow_offline_signing_metadata', None)) setattr(self, "_{}".format('allow_open_trust_signer_certificate'), kwargs.get('allow_open_trust_signer_certificate', None)) setattr(self, "_{}".format('allow_open_trust_signer_certificate_metadata'), kwargs.get('allow_open_trust_signer_certificate_metadata', None)) + setattr(self, "_{}".format('allow_organization_docusign_monitor'), kwargs.get('allow_organization_docusign_monitor', None)) + setattr(self, "_{}".format('allow_organization_docusign_monitor_metadata'), kwargs.get('allow_organization_docusign_monitor_metadata', None)) + setattr(self, "_{}".format('allow_organization_domain_user_management'), kwargs.get('allow_organization_domain_user_management', None)) + setattr(self, "_{}".format('allow_organization_domain_user_management_metadata'), kwargs.get('allow_organization_domain_user_management_metadata', None)) setattr(self, "_{}".format('allow_organizations'), kwargs.get('allow_organizations', None)) setattr(self, "_{}".format('allow_organizations_metadata'), kwargs.get('allow_organizations_metadata', None)) + setattr(self, "_{}".format('allow_organization_sso_management'), kwargs.get('allow_organization_sso_management', None)) + setattr(self, "_{}".format('allow_organization_sso_management_metadata'), kwargs.get('allow_organization_sso_management_metadata', None)) + setattr(self, "_{}".format('allow_organization_to_use_remote_notary'), kwargs.get('allow_organization_to_use_remote_notary', None)) + setattr(self, "_{}".format('allow_organization_to_use_remote_notary_metadata'), kwargs.get('allow_organization_to_use_remote_notary_metadata', None)) setattr(self, "_{}".format('allow_payment_processing'), kwargs.get('allow_payment_processing', None)) setattr(self, "_{}".format('allow_payment_processing_metadata'), kwargs.get('allow_payment_processing_metadata', None)) setattr(self, "_{}".format('allow_personal_signer_certificate'), kwargs.get('allow_personal_signer_certificate', None)) @@ -2084,6 +2125,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 setattr(self, "_{}".format('fax_out_enabled_metadata'), kwargs.get('fax_out_enabled_metadata', None)) setattr(self, "_{}".format('guided_forms_html_allowed'), kwargs.get('guided_forms_html_allowed', None)) setattr(self, "_{}".format('guided_forms_html_allowed_metadata'), kwargs.get('guided_forms_html_allowed_metadata', None)) + setattr(self, "_{}".format('has_recipient_connect_claimed_domain'), kwargs.get('has_recipient_connect_claimed_domain', None)) setattr(self, "_{}".format('hide_account_address_in_co_c'), kwargs.get('hide_account_address_in_co_c', None)) setattr(self, "_{}".format('hide_account_address_in_co_c_metadata'), kwargs.get('hide_account_address_in_co_c_metadata', None)) setattr(self, "_{}".format('hide_pricing'), kwargs.get('hide_pricing', None)) @@ -2130,6 +2172,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501 setattr(self, "_{}".format('phone_auth_recipient_may_provide_phone_number_metadata'), kwargs.get('phone_auth_recipient_may_provide_phone_number_metadata', None)) setattr(self, "_{}".format('pki_sign_downloaded_pdf_docs'), kwargs.get('pki_sign_downloaded_pdf_docs', None)) setattr(self, "_{}".format('pki_sign_downloaded_pdf_docs_metadata'), kwargs.get('pki_sign_downloaded_pdf_docs_metadata', None)) + setattr(self, "_{}".format('read_only_mode'), kwargs.get('read_only_mode', None)) + setattr(self, "_{}".format('read_only_mode_metadata'), kwargs.get('read_only_mode_metadata', None)) setattr(self, "_{}".format('recipients_can_sign_offline'), kwargs.get('recipients_can_sign_offline', None)) setattr(self, "_{}".format('recipients_can_sign_offline_metadata'), kwargs.get('recipients_can_sign_offline_metadata', None)) setattr(self, "_{}".format('recipient_signing_auto_navigation_control'), kwargs.get('recipient_signing_auto_navigation_control', None)) @@ -4500,6 +4544,94 @@ def allow_open_trust_signer_certificate_metadata(self, allow_open_trust_signer_c self._allow_open_trust_signer_certificate_metadata = allow_open_trust_signer_certificate_metadata + @property + def allow_organization_docusign_monitor(self): + """Gets the allow_organization_docusign_monitor of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The allow_organization_docusign_monitor of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._allow_organization_docusign_monitor + + @allow_organization_docusign_monitor.setter + def allow_organization_docusign_monitor(self, allow_organization_docusign_monitor): + """Sets the allow_organization_docusign_monitor of this AccountSettingsInformation. + + # noqa: E501 + + :param allow_organization_docusign_monitor: The allow_organization_docusign_monitor of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._allow_organization_docusign_monitor = allow_organization_docusign_monitor + + @property + def allow_organization_docusign_monitor_metadata(self): + """Gets the allow_organization_docusign_monitor_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The allow_organization_docusign_monitor_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._allow_organization_docusign_monitor_metadata + + @allow_organization_docusign_monitor_metadata.setter + def allow_organization_docusign_monitor_metadata(self, allow_organization_docusign_monitor_metadata): + """Sets the allow_organization_docusign_monitor_metadata of this AccountSettingsInformation. + + + :param allow_organization_docusign_monitor_metadata: The allow_organization_docusign_monitor_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._allow_organization_docusign_monitor_metadata = allow_organization_docusign_monitor_metadata + + @property + def allow_organization_domain_user_management(self): + """Gets the allow_organization_domain_user_management of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The allow_organization_domain_user_management of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._allow_organization_domain_user_management + + @allow_organization_domain_user_management.setter + def allow_organization_domain_user_management(self, allow_organization_domain_user_management): + """Sets the allow_organization_domain_user_management of this AccountSettingsInformation. + + # noqa: E501 + + :param allow_organization_domain_user_management: The allow_organization_domain_user_management of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._allow_organization_domain_user_management = allow_organization_domain_user_management + + @property + def allow_organization_domain_user_management_metadata(self): + """Gets the allow_organization_domain_user_management_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The allow_organization_domain_user_management_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._allow_organization_domain_user_management_metadata + + @allow_organization_domain_user_management_metadata.setter + def allow_organization_domain_user_management_metadata(self, allow_organization_domain_user_management_metadata): + """Sets the allow_organization_domain_user_management_metadata of this AccountSettingsInformation. + + + :param allow_organization_domain_user_management_metadata: The allow_organization_domain_user_management_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._allow_organization_domain_user_management_metadata = allow_organization_domain_user_management_metadata + @property def allow_organizations(self): """Gets the allow_organizations of this AccountSettingsInformation. # noqa: E501 @@ -4544,6 +4676,94 @@ def allow_organizations_metadata(self, allow_organizations_metadata): self._allow_organizations_metadata = allow_organizations_metadata + @property + def allow_organization_sso_management(self): + """Gets the allow_organization_sso_management of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The allow_organization_sso_management of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._allow_organization_sso_management + + @allow_organization_sso_management.setter + def allow_organization_sso_management(self, allow_organization_sso_management): + """Sets the allow_organization_sso_management of this AccountSettingsInformation. + + # noqa: E501 + + :param allow_organization_sso_management: The allow_organization_sso_management of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._allow_organization_sso_management = allow_organization_sso_management + + @property + def allow_organization_sso_management_metadata(self): + """Gets the allow_organization_sso_management_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The allow_organization_sso_management_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._allow_organization_sso_management_metadata + + @allow_organization_sso_management_metadata.setter + def allow_organization_sso_management_metadata(self, allow_organization_sso_management_metadata): + """Sets the allow_organization_sso_management_metadata of this AccountSettingsInformation. + + + :param allow_organization_sso_management_metadata: The allow_organization_sso_management_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._allow_organization_sso_management_metadata = allow_organization_sso_management_metadata + + @property + def allow_organization_to_use_remote_notary(self): + """Gets the allow_organization_to_use_remote_notary of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The allow_organization_to_use_remote_notary of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._allow_organization_to_use_remote_notary + + @allow_organization_to_use_remote_notary.setter + def allow_organization_to_use_remote_notary(self, allow_organization_to_use_remote_notary): + """Sets the allow_organization_to_use_remote_notary of this AccountSettingsInformation. + + # noqa: E501 + + :param allow_organization_to_use_remote_notary: The allow_organization_to_use_remote_notary of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._allow_organization_to_use_remote_notary = allow_organization_to_use_remote_notary + + @property + def allow_organization_to_use_remote_notary_metadata(self): + """Gets the allow_organization_to_use_remote_notary_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The allow_organization_to_use_remote_notary_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._allow_organization_to_use_remote_notary_metadata + + @allow_organization_to_use_remote_notary_metadata.setter + def allow_organization_to_use_remote_notary_metadata(self, allow_organization_to_use_remote_notary_metadata): + """Sets the allow_organization_to_use_remote_notary_metadata of this AccountSettingsInformation. + + + :param allow_organization_to_use_remote_notary_metadata: The allow_organization_to_use_remote_notary_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._allow_organization_to_use_remote_notary_metadata = allow_organization_to_use_remote_notary_metadata + @property def allow_payment_processing(self): """Gets the allow_payment_processing of this AccountSettingsInformation. # noqa: E501 @@ -10287,6 +10507,29 @@ def guided_forms_html_allowed_metadata(self, guided_forms_html_allowed_metadata) self._guided_forms_html_allowed_metadata = guided_forms_html_allowed_metadata + @property + def has_recipient_connect_claimed_domain(self): + """Gets the has_recipient_connect_claimed_domain of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The has_recipient_connect_claimed_domain of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._has_recipient_connect_claimed_domain + + @has_recipient_connect_claimed_domain.setter + def has_recipient_connect_claimed_domain(self, has_recipient_connect_claimed_domain): + """Sets the has_recipient_connect_claimed_domain of this AccountSettingsInformation. + + # noqa: E501 + + :param has_recipient_connect_claimed_domain: The has_recipient_connect_claimed_domain of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._has_recipient_connect_claimed_domain = has_recipient_connect_claimed_domain + @property def hide_account_address_in_co_c(self): """Gets the hide_account_address_in_co_c of this AccountSettingsInformation. # noqa: E501 @@ -11303,6 +11546,50 @@ def pki_sign_downloaded_pdf_docs_metadata(self, pki_sign_downloaded_pdf_docs_met self._pki_sign_downloaded_pdf_docs_metadata = pki_sign_downloaded_pdf_docs_metadata + @property + def read_only_mode(self): + """Gets the read_only_mode of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The read_only_mode of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._read_only_mode + + @read_only_mode.setter + def read_only_mode(self, read_only_mode): + """Sets the read_only_mode of this AccountSettingsInformation. + + # noqa: E501 + + :param read_only_mode: The read_only_mode of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._read_only_mode = read_only_mode + + @property + def read_only_mode_metadata(self): + """Gets the read_only_mode_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The read_only_mode_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._read_only_mode_metadata + + @read_only_mode_metadata.setter + def read_only_mode_metadata(self, read_only_mode_metadata): + """Sets the read_only_mode_metadata of this AccountSettingsInformation. + + + :param read_only_mode_metadata: The read_only_mode_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._read_only_mode_metadata = read_only_mode_metadata + @property def recipients_can_sign_offline(self): """Gets the recipients_can_sign_offline of this AccountSettingsInformation. # noqa: E501 diff --git a/docusign_esign/models/connect_delete_failure_result.py b/docusign_esign/models/connect_delete_failure_result.py new file mode 100644 index 00000000..bd1f65e2 --- /dev/null +++ b/docusign_esign/models/connect_delete_failure_result.py @@ -0,0 +1,95 @@ +# 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 ConnectDeleteFailureResult(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 = { + } + + attribute_map = { + } + + def __init__(self, _configuration=None, **kwargs): # noqa: E501 + """ConnectDeleteFailureResult - a model defined in Swagger""" # noqa: E501 + if _configuration is None: + _configuration = Configuration() + self._configuration = _configuration + self.discriminator = None + + 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(ConnectDeleteFailureResult, 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, ConnectDeleteFailureResult): + 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, ConnectDeleteFailureResult): + return True + + return self.to_dict() != other.to_dict() diff --git a/setup.py b/setup.py index a07c0525..c7bdf266 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.12.0" +VERSION = "3.13.0rc1" # To install the library, run the following # # python setup.py install