diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ff2c6d9..c732ed0f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,12 +3,25 @@ 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.10.0rc1] - eSignature API v2.1-21.1.02.00 - 2021-05-20 +### Breaking +- Removed methods `get_account_settings_export`,`get_seal_providers` from Accounts. +- Removed methods `create_connect_secret`,`delete_connect_secret`,`generate_connect_secret`,`get_connect_secrets` from Connect. +- Removed methods `get_dynamic_system_settings`,`get_template_info`,`get_appliance_info`,`get_account`,`get_custom_fields`,`delete_custom_fields_v2`,`get_document_pages`,`get_image`,`get_locale_policy`,`update_page_info`,`create_page_info`,`delete_page_info`, +`update_pdf`,`get_pdf`,`get_pdf_blob`,`update_pdf_blob`,`create_pdf_blob`,`update_recipient_denied_document_copy`,`delete_recipient_denied_document_copy`,`get_signer_attachment`,`delete_signer_attachment`, from Envelopes. +- Removed methods `complete_sign_hash`,`get_user_info`,`health_check`,`sign_hash_session_info`,`update_transaction` from Trust_Service_Providers. +- Removed methods `get_user_list_export` from Users. +### Added +- Added new methods `get_bulk_send_batch_envelopes` to BulkEnvelopes. +- Description in PyPi taken from Readme file. +### Changed +- Added support for version v2.1-21.1.02.00 of the DocuSign eSignature API. +- Updated the SDK release version. + ## [3.9.0] - eSignature API v2.1-21.1.01.03 - 2021-04-22 ### Added -- Added new methods `deleteCustomFieldsV2`, `deletePageInfoV2`, `getApplianceEnvelopeInfo`, `getTemplateInfo` to envelopes. -- Added new method `deleteConnectSecret` to connect. -### Updated - Added support for version v2.1-21.1.01.03 of the DocuSign eSignature API. +### Updated - Updated the SDK release version. - Updated `user_agent` in configurations. Eg; `'Swagger-Codegen/v2.1/3.9.0rc1/python3'` - Updated test cases to remove printing sensitive info @@ -157,4 +170,4 @@ See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for ## [1.0.0] - 2017-08-08 ### Added -- Initial commit of the new Python SDK for DocuSign API, automatically generated from OpenAPI specification. +- Initial commit of the new Python SDK for DocuSign API, automatically generated from OpenAPI specification. \ No newline at end of file diff --git a/README.md b/README.md index e76ab211..01d43375 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ [![Build status][travis-image]][travis-url] -[PyPI module](https://pypi.python.org/pypi/docusign_esign) that wraps the DocuSign API +[PyPI module](https://pypi.python.org/pypi/docusign_esign) -[Documentation about the DocuSign API](https://developers.docusign.com/) +[Documentation about DocuSign APIs](https://developers.docusign.com/) ## Requirements * Python 2.7 (3.7+ recommended) @@ -60,7 +60,7 @@ This client has the following external dependencies: * py-oauth2 v0.0.10+ ## Code examples -You can find on our GitHub a self-executing package of code examples for the eSignature C# SDK, called a [Launcher](https://github.com/docusign/code-examples-python/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows. +You can find on our GitHub a self-executing package of code examples for the eSignature Python SDK, called a [Launcher](https://github.com/docusign/code-examples-python/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows. ## OAuth implementations For details regarding which type of OAuth grant will work best for your DocuSign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [DocuSign Developer Center](https://developers.docusign.com/). @@ -77,4 +77,11 @@ The DocuSign eSignature Python Client SDK is licensed under the [MIT License](ht * [DocuSign Developer Center](https://developers.docusign.com/) * [DocuSign API on Twitter](https://twitter.com/docusignapi) * [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/) -* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2 \ No newline at end of file +* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2) + +[pypi-image]: https://img.shields.io/pypi/v/docusign_esign.svg?style=flat +[pypi-url]: https://pypi.python.org/pypi/docusign_esign +[downloads-image]: https://img.shields.io/pypi/dm/docusign_esign.svg?style=flat +[downloads-url]: https://pypi.python.org/pypi/docusign_esign +[travis-image]: https://img.shields.io/travis/docusign/docusign-python-client.svg?style=flat +[travis-url]: https://travis-ci.org/docusign/docusign-python-client \ No newline at end of file diff --git a/docusign_esign/__init__.py b/docusign_esign/__init__.py index e3e44ac0..0c7c5ff8 100644 --- a/docusign_esign/__init__.py +++ b/docusign_esign/__init__.py @@ -32,9 +32,9 @@ from .apis.notary_api import NotaryApi from .apis.organizations_api import OrganizationsApi from .apis.power_forms_api import PowerFormsApi -from .apis.signature_api import SignatureApi from .apis.signing_groups_api import SigningGroupsApi from .apis.templates_api import TemplatesApi +from .apis.trust_service_providers_api import TrustServiceProvidersApi from .apis.users_api import UsersApi from .apis.workspaces_api import WorkspacesApi @@ -161,8 +161,6 @@ from docusign_esign.models.commission_number import CommissionNumber from docusign_esign.models.commission_state import CommissionState from docusign_esign.models.company import Company -from docusign_esign.models.complete_sign_hash_response import CompleteSignHashResponse -from docusign_esign.models.complete_sign_request import CompleteSignRequest from docusign_esign.models.composite_template import CompositeTemplate from docusign_esign.models.conditional_recipient_rule import ConditionalRecipientRule from docusign_esign.models.conditional_recipient_rule_condition import ConditionalRecipientRuleCondition @@ -188,7 +186,6 @@ from docusign_esign.models.contact_update_response import ContactUpdateResponse from docusign_esign.models.correct_view_request import CorrectViewRequest from docusign_esign.models.country import Country -from docusign_esign.models.credential import Credential from docusign_esign.models.credit_card_information import CreditCardInformation from docusign_esign.models.credit_card_types import CreditCardTypes from docusign_esign.models.currency import Currency @@ -203,10 +200,7 @@ from docusign_esign.models.decline import Decline from docusign_esign.models.diagnostics_settings_information import DiagnosticsSettingsInformation from docusign_esign.models.direct_debit_processor_information import DirectDebitProcessorInformation -from docusign_esign.models.display_appliance_account import DisplayApplianceAccount from docusign_esign.models.display_appliance_info import DisplayApplianceInfo -from docusign_esign.models.display_appliance_pdf import DisplayAppliancePdf -from docusign_esign.models.display_appliance_signer_attachment import DisplayApplianceSignerAttachment from docusign_esign.models.dob_information_input import DobInformationInput from docusign_esign.models.document import Document from docusign_esign.models.document_fields_information import DocumentFieldsInformation @@ -217,10 +211,8 @@ from docusign_esign.models.document_html_definitions import DocumentHtmlDefinitions from docusign_esign.models.document_html_display_anchor import DocumentHtmlDisplayAnchor from docusign_esign.models.document_html_display_settings import DocumentHtmlDisplaySettings -from docusign_esign.models.document_security_store import DocumentSecurityStore from docusign_esign.models.document_template import DocumentTemplate from docusign_esign.models.document_template_list import DocumentTemplateList -from docusign_esign.models.document_update_info import DocumentUpdateInfo from docusign_esign.models.document_visibility import DocumentVisibility from docusign_esign.models.document_visibility_list import DocumentVisibilityList from docusign_esign.models.downgrad_request_billing_info_response import DowngradRequestBillingInfoResponse @@ -261,7 +253,6 @@ from docusign_esign.models.event_notification import EventNotification from docusign_esign.models.event_result import EventResult from docusign_esign.models.expirations import Expirations -from docusign_esign.models.external_claim import ExternalClaim from docusign_esign.models.external_doc_service_error_details import ExternalDocServiceErrorDetails from docusign_esign.models.external_document_sources import ExternalDocumentSources from docusign_esign.models.external_file import ExternalFile @@ -419,26 +410,18 @@ from docusign_esign.models.report_in_product_sent_by_details import ReportInProductSentByDetails from docusign_esign.models.resource_information import ResourceInformation from docusign_esign.models.return_url_request import ReturnUrlRequest -from docusign_esign.models.revision import Revision -from docusign_esign.models.seal import Seal from docusign_esign.models.seal_identifier import SealIdentifier from docusign_esign.models.seal_sign import SealSign from docusign_esign.models.seat_discount import SeatDiscount -from docusign_esign.models.sender import Sender from docusign_esign.models.sender_email_notifications import SenderEmailNotifications from docusign_esign.models.server_template import ServerTemplate from docusign_esign.models.service_information import ServiceInformation from docusign_esign.models.service_version import ServiceVersion from docusign_esign.models.settings_metadata import SettingsMetadata from docusign_esign.models.shared_item import SharedItem -from docusign_esign.models.sign_hash_document import SignHashDocument -from docusign_esign.models.sign_hash_session_info_response import SignHashSessionInfoResponse from docusign_esign.models.sign_here import SignHere -from docusign_esign.models.sign_session_info_request import SignSessionInfoRequest -from docusign_esign.models.signature_data_info import SignatureDataInfo from docusign_esign.models.signature_group import SignatureGroup from docusign_esign.models.signature_group_def import SignatureGroupDef -from docusign_esign.models.signature_properties import SignatureProperties from docusign_esign.models.signature_provider_required_option import SignatureProviderRequiredOption from docusign_esign.models.signature_type import SignatureType from docusign_esign.models.signature_user import SignatureUser @@ -481,18 +464,11 @@ from docusign_esign.models.template_update_summary import TemplateUpdateSummary from docusign_esign.models.text import Text from docusign_esign.models.text_custom_field import TextCustomField -from docusign_esign.models.time_stamp_field import TimeStampField from docusign_esign.models.title import Title -from docusign_esign.models.tsp_health_check_request import TspHealthCheckRequest -from docusign_esign.models.tsp_health_check_status_description import TspHealthCheckStatusDescription -from docusign_esign.models.update_transaction_request import UpdateTransactionRequest -from docusign_esign.models.update_transaction_response import UpdateTransactionResponse from docusign_esign.models.usage_history import UsageHistory -from docusign_esign.models.user import User from docusign_esign.models.user_account_management_granular_information import UserAccountManagementGranularInformation from docusign_esign.models.user_info import UserInfo from docusign_esign.models.user_info_list import UserInfoList -from docusign_esign.models.user_info_response import UserInfoResponse from docusign_esign.models.user_information import UserInformation from docusign_esign.models.user_information_list import UserInformationList from docusign_esign.models.user_password_information import UserPasswordInformation diff --git a/docusign_esign/apis/__init__.py b/docusign_esign/apis/__init__.py index d2739a23..ceb216d8 100644 --- a/docusign_esign/apis/__init__.py +++ b/docusign_esign/apis/__init__.py @@ -19,8 +19,8 @@ from .notary_api import NotaryApi from .organizations_api import OrganizationsApi from .power_forms_api import PowerFormsApi -from .signature_api import SignatureApi from .signing_groups_api import SigningGroupsApi from .templates_api import TemplatesApi +from .trust_service_providers_api import TrustServiceProvidersApi from .users_api import UsersApi from .workspaces_api import WorkspacesApi diff --git a/docusign_esign/apis/accounts_api.py b/docusign_esign/apis/accounts_api.py index 80def1ce..9cd3511f 100644 --- a/docusign_esign/apis/accounts_api.py +++ b/docusign_esign/apis/accounts_api.py @@ -2094,114 +2094,6 @@ def get_account_information_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_account_settings_export(self, organization_id, result_id, **kwargs): - """ - Retrieves an account settings comparison. - 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_account_settings_export(organization_id, result_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str organization_id: (required) - :param str result_id: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_account_settings_export_with_http_info(organization_id, result_id, **kwargs) - else: - (data) = self.get_account_settings_export_with_http_info(organization_id, result_id, **kwargs) - return data - - def get_account_settings_export_with_http_info(self, organization_id, result_id, **kwargs): - """ - Retrieves an account settings comparison. - 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_account_settings_export_with_http_info(organization_id, result_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str organization_id: (required) - :param str result_id: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organization_id', 'result_id'] - 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_account_settings_export" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'organization_id' is set - if ('organization_id' not in params) or (params['organization_id'] is None): - raise ValueError("Missing the required parameter `organization_id` when calling `get_account_settings_export`") - # verify the required parameter 'result_id' is set - if ('result_id' not in params) or (params['result_id'] is None): - raise ValueError("Missing the required parameter `result_id` when calling `get_account_settings_export`") - - - collection_formats = {} - - resource_path = '/v2.1/organization_exports/{organizationId}/account_settings/{resultId}'.replace('{format}', 'json') - path_params = {} - if 'organization_id' in params: - path_params['organizationId'] = params['organization_id'] - if 'result_id' in params: - path_params['resultId'] = params['result_id'] - - query_params = {} - - 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=None, - 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_account_signature(self, account_id, signature_id, **kwargs): """ Returns information about a single signature by specifed signatureId. @@ -4652,107 +4544,6 @@ def get_report_in_product_list_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_seal_providers(self, account_id, **kwargs): - """ - Returns Account available seals for specified account. - 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_seal_providers(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :return: AccountSeals - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_seal_providers_with_http_info(account_id, **kwargs) - else: - (data) = self.get_seal_providers_with_http_info(account_id, **kwargs) - return data - - def get_seal_providers_with_http_info(self, account_id, **kwargs): - """ - Returns Account available seals for specified account. - 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_seal_providers_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :return: AccountSeals - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id'] - 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_seal_providers" % 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_seal_providers`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/seals'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - - query_params = {} - - 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='AccountSeals', - 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_supported_languages(self, account_id, **kwargs): """ Gets list of supported languages for recipient language setting. diff --git a/docusign_esign/apis/bulk_envelopes_api.py b/docusign_esign/apis/bulk_envelopes_api.py index e4994cfe..9a904bca 100644 --- a/docusign_esign/apis/bulk_envelopes_api.py +++ b/docusign_esign/apis/bulk_envelopes_api.py @@ -477,6 +477,146 @@ def delete_bulk_send_list_with_http_info(self, account_id, bulk_send_list_id, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_bulk_send_batch_envelopes(self, account_id, bulk_send_batch_id, **kwargs): + """ + Gets envelopes from a specific bulk send batch + 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_bulk_send_batch_envelopes(account_id, bulk_send_batch_id, callback=callback_function) + + :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 bulk_send_batch_id: (required) + :param int count: + :param str include: + :param str order: + :param str order_by: + :param str search_text: + :param int start_position: + :param str status: + :param str user_id: + :return: EnvelopesInformation + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_bulk_send_batch_envelopes_with_http_info(account_id, bulk_send_batch_id, **kwargs) + else: + (data) = self.get_bulk_send_batch_envelopes_with_http_info(account_id, bulk_send_batch_id, **kwargs) + return data + + def get_bulk_send_batch_envelopes_with_http_info(self, account_id, bulk_send_batch_id, **kwargs): + """ + Gets envelopes from a specific bulk send batch + 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_bulk_send_batch_envelopes_with_http_info(account_id, bulk_send_batch_id, callback=callback_function) + + :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 bulk_send_batch_id: (required) + :param int count: + :param str include: + :param str order: + :param str order_by: + :param str search_text: + :param int start_position: + :param str status: + :param str user_id: + :return: EnvelopesInformation + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'bulk_send_batch_id', 'count', 'include', 'order', 'order_by', 'search_text', 'start_position', 'status', 'user_id'] + 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_bulk_send_batch_envelopes" % 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_bulk_send_batch_envelopes`") + # verify the required parameter 'bulk_send_batch_id' is set + if ('bulk_send_batch_id' not in params) or (params['bulk_send_batch_id'] is None): + raise ValueError("Missing the required parameter `bulk_send_batch_id` when calling `get_bulk_send_batch_envelopes`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes'.replace('{format}', 'json') + path_params = {} + if 'account_id' in params: + path_params['accountId'] = params['account_id'] + if 'bulk_send_batch_id' in params: + path_params['bulkSendBatchId'] = params['bulk_send_batch_id'] + + query_params = {} + if 'count' in params: + query_params['count'] = params['count'] + if 'include' in params: + query_params['include'] = params['include'] + if 'order' in params: + query_params['order'] = params['order'] + if 'order_by' in params: + query_params['order_by'] = params['order_by'] + if 'search_text' in params: + query_params['search_text'] = params['search_text'] + if 'start_position' in params: + query_params['start_position'] = params['start_position'] + if 'status' in params: + query_params['status'] = params['status'] + if 'user_id' in params: + query_params['user_id'] = params['user_id'] + + 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='EnvelopesInformation', + 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_bulk_send_batch_status(self, account_id, bulk_send_batch_id, **kwargs): """ Gets a specific bulk send batch status diff --git a/docusign_esign/apis/connect_api.py b/docusign_esign/apis/connect_api.py index 483105c0..f1dc774f 100644 --- a/docusign_esign/apis/connect_api.py +++ b/docusign_esign/apis/connect_api.py @@ -147,107 +147,6 @@ def create_configuration_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_connect_secret(self, account_id, **kwargs): - """ - Generates a new connect HMAC Secret. - 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.create_connect_secret(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_connect_secret_with_http_info(account_id, **kwargs) - else: - (data) = self.create_connect_secret_with_http_info(account_id, **kwargs) - return data - - def create_connect_secret_with_http_info(self, account_id, **kwargs): - """ - Generates a new connect HMAC Secret. - 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.create_connect_secret_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id'] - 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 create_connect_secret" % 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 `create_connect_secret`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/connect/secret'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - - query_params = {} - - 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, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, - 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 delete_configuration(self, account_id, connect_id, **kwargs): """ Deletes the specified connect configuration. @@ -358,114 +257,6 @@ def delete_configuration_with_http_info(self, account_id, connect_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_connect_secret(self, account_id, key_id, **kwargs): - """ - Delete the connect HMAC Secret for AccountID - 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.delete_connect_secret(account_id, key_id, callback=callback_function) - - :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 key_id: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_connect_secret_with_http_info(account_id, key_id, **kwargs) - else: - (data) = self.delete_connect_secret_with_http_info(account_id, key_id, **kwargs) - return data - - def delete_connect_secret_with_http_info(self, account_id, key_id, **kwargs): - """ - Delete the connect HMAC Secret for AccountID - 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.delete_connect_secret_with_http_info(account_id, key_id, callback=callback_function) - - :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 key_id: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'key_id'] - 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 delete_connect_secret" % 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 `delete_connect_secret`") - # verify the required parameter 'key_id' is set - if ('key_id' not in params) or (params['key_id'] is None): - raise ValueError("Missing the required parameter `key_id` when calling `delete_connect_secret`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/connect/secret/{keyId}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - if 'key_id' in params: - path_params['keyId'] = params['key_id'] - - query_params = {} - - 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, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, - 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 delete_event_failure_log(self, account_id, failure_id, **kwargs): """ Deletes a Connect failure log entry. @@ -896,107 +687,6 @@ def delete_mobile_notifiers_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def generate_connect_secret(self, account_id, **kwargs): - """ - Generates a new connect HMAC Secret. - 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.generate_connect_secret(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.generate_connect_secret_with_http_info(account_id, **kwargs) - else: - (data) = self.generate_connect_secret_with_http_info(account_id, **kwargs) - return data - - def generate_connect_secret_with_http_info(self, account_id, **kwargs): - """ - Generates a new connect HMAC Secret. - 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.generate_connect_secret_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id'] - 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 generate_connect_secret" % 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 `generate_connect_secret`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/connect/secret'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - - query_params = {} - - 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=None, - 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_configuration(self, account_id, connect_id, **kwargs): """ Get a Connect Configuration Information @@ -1107,107 +797,6 @@ 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_secrets(self, account_id, **kwargs): - """ - Get the connect HMAC Secrets for AccountID - 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_secrets(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_connect_secrets_with_http_info(account_id, **kwargs) - else: - (data) = self.get_connect_secrets_with_http_info(account_id, **kwargs) - return data - - def get_connect_secrets_with_http_info(self, account_id, **kwargs): - """ - Get the connect HMAC Secrets for AccountID - 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_secrets_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id'] - 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_secrets" % 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_secrets`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/connect/secrets'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - - query_params = {} - - 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=None, - 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 e9bb0289..8959882d 100644 --- a/docusign_esign/apis/envelopes_api.py +++ b/docusign_esign/apis/envelopes_api.py @@ -2085,222 +2085,6 @@ def create_lock_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_page_info(self, account_id, envelope_id, **kwargs): - """ - Create page information for Display Appliance - 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.create_page_info(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_page_info_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.create_page_info_with_http_info(account_id, envelope_id, **kwargs) - return data - - def create_page_info_with_http_info(self, account_id, envelope_id, **kwargs): - """ - Create page information for Display Appliance - 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.create_page_info_with_http_info(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id'] - 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 create_page_info" % 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 `create_page_info`") - # 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 `create_page_info`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info'.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 = {} - - 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, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, - 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 create_pdf_blob(self, account_id, envelope_id, **kwargs): - """ - Add pdf blobs for Display Appliance - 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.create_pdf_blob(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayAppliancePdf - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.create_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) - return data - - def create_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): - """ - Add pdf blobs for Display Appliance - 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.create_pdf_blob_with_http_info(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayAppliancePdf - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id'] - 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 create_pdf_blob" % 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 `create_pdf_blob`") - # 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 `create_pdf_blob`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs'.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 = {} - - 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, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DisplayAppliancePdf', - 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 create_recipient(self, account_id, envelope_id, **kwargs): """ Adds one or more recipients to an envelope. @@ -3659,53 +3443,59 @@ def delete_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs) _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_custom_fields_0(self, account_id, envelope_id, **kwargs): + def delete_document_fields(self, account_id, document_id, envelope_id, **kwargs): """ - Delete custom fields information for Display Appliance + Deletes custom document fields from an existing envelope document. + Deletes custom document fields from an existing envelope document. 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.delete_custom_fields_0(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_document_fields(account_id, document_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param DocumentFieldsInformation document_fields_information: + :return: DocumentFieldsInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_custom_fields_0_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.delete_custom_fields_0_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def delete_custom_fields_0_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_document_fields_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Delete custom fields information for Display Appliance + Deletes custom document fields from an existing envelope document. + Deletes custom document fields from an existing envelope document. 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.delete_custom_fields_0_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_document_fields_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: The external account number (int) or account ID Guid. (required) + :param str document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param DocumentFieldsInformation document_fields_information: + :return: DocumentFieldsInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'document_id', 'envelope_id', 'document_fields_information'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3716,24 +3506,29 @@ def delete_custom_fields_0_with_http_info(self, account_id, envelope_id, **kwarg if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_custom_fields_0" % key + " to method delete_document_fields" % 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 `delete_custom_fields_0`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_document_fields`") + # 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 `delete_document_fields`") # 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 `delete_custom_fields_0`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_document_fields`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/custom_fields/delete'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields'.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'] @@ -3745,6 +3540,8 @@ def delete_custom_fields_0_with_http_info(self, account_id, envelope_id, **kwarg local_var_files = {} body_params = None + if 'document_fields_information' in params: + body_params = params['document_fields_information'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -3752,14 +3549,14 @@ def delete_custom_fields_0_with_http_info(self, account_id, envelope_id, **kwarg # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'POST', + return self.api_client.call_api(resource_path, 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='DocumentFieldsInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3767,53 +3564,59 @@ def delete_custom_fields_0_with_http_info(self, account_id, envelope_id, **kwarg _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_custom_fields_v2(self, account_id, envelope_id, **kwargs): + def delete_document_page(self, account_id, document_id, envelope_id, page_number, **kwargs): """ - Delete custom fields information for Display Appliance + Deletes a page from a document in an envelope. + Deletes a page from a document in an envelope based on the page number. 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.delete_custom_fields_v2(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_document_page(account_id, document_id, envelope_id, page_number, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str page_number: The page number being accessed. (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_custom_fields_v2_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) else: - (data) = self.delete_custom_fields_v2_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) return data - def delete_custom_fields_v2_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_document_page_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): """ - Delete custom fields information for Display Appliance + Deletes a page from a document in an envelope. + Deletes a page from a document in an envelope based on the page number. 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.delete_custom_fields_v2_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str page_number: The page number being accessed. (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'document_id', 'envelope_id', 'page_number'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3824,26 +3627,36 @@ def delete_custom_fields_v2_with_http_info(self, account_id, envelope_id, **kwar if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_custom_fields_v2" % key + " to method delete_document_page" % 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 `delete_custom_fields_v2`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_document_page`") + # 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 `delete_document_page`") # 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 `delete_custom_fields_v2`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_document_page`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `delete_document_page`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/custom_fields'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}'.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'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = {} @@ -3875,55 +3688,57 @@ def delete_custom_fields_v2_with_http_info(self, account_id, envelope_id, **kwar _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_document(self, account_id, document_id, envelope_id, **kwargs): + def delete_document_tabs(self, account_id, document_id, envelope_id, **kwargs): """ - Delete document information for Display Appliance + Deletes tabs from an envelope document 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.delete_document(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.delete_document_tabs(account_id, document_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param Tabs tabs: + :return: Tabs If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_document_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.delete_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.delete_document_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.delete_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def delete_document_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def delete_document_tabs_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Delete document information for Display Appliance + Deletes tabs from an envelope document 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.delete_document_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.delete_document_tabs_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: The external account number (int) or account ID Guid. (required) :param str document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param Tabs tabs: + :return: Tabs If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id'] + all_params = ['account_id', 'document_id', 'envelope_id', 'tabs'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3934,24 +3749,24 @@ def delete_document_with_http_info(self, account_id, document_id, envelope_id, * if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_document" % key + " to method delete_document_tabs" % 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 `delete_document`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_document_tabs`") # 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 `delete_document`") + raise ValueError("Missing the required parameter `document_id` when calling `delete_document_tabs`") # 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 `delete_document`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_document_tabs`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document/{documentId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -3968,6 +3783,8 @@ def delete_document_with_http_info(self, account_id, document_id, envelope_id, * local_var_files = {} body_params = None + if 'tabs' in params: + body_params = params['tabs'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -3982,7 +3799,7 @@ def delete_document_with_http_info(self, account_id, document_id, envelope_id, * body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='Tabs', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3990,59 +3807,57 @@ def delete_document_with_http_info(self, account_id, document_id, envelope_id, * _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_document_fields(self, account_id, document_id, envelope_id, **kwargs): + def delete_documents(self, account_id, envelope_id, **kwargs): """ - Deletes custom document fields from an existing envelope document. - Deletes custom document fields from an existing envelope document. + Deletes documents from a draft envelope. + Deletes one or more documents from an existing draft 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.delete_document_fields(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.delete_documents(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param DocumentFieldsInformation document_fields_information: - :return: DocumentFieldsInformation + :param EnvelopeDefinition envelope_definition: + :return: EnvelopeDocumentsResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.delete_documents_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.delete_documents_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_document_fields_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def delete_documents_with_http_info(self, account_id, envelope_id, **kwargs): """ - Deletes custom document fields from an existing envelope document. - Deletes custom document fields from an existing envelope document. + Deletes documents from a draft envelope. + Deletes one or more documents from an existing draft 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.delete_document_fields_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.delete_documents_with_http_info(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param DocumentFieldsInformation document_fields_information: - :return: DocumentFieldsInformation + :param EnvelopeDefinition envelope_definition: + :return: EnvelopeDocumentsResult If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'document_fields_information'] + all_params = ['account_id', 'envelope_id', 'envelope_definition'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4053,29 +3868,24 @@ def delete_document_fields_with_http_info(self, account_id, document_id, envelop if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_document_fields" % key + " to method delete_documents" % 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 `delete_document_fields`") - # 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 `delete_document_fields`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_documents`") # 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 `delete_document_fields`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_documents`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents'.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'] @@ -4087,8 +3897,8 @@ def delete_document_fields_with_http_info(self, account_id, document_id, envelop local_var_files = {} body_params = None - if 'document_fields_information' in params: - body_params = params['document_fields_information'] + if 'envelope_definition' in params: + body_params = params['envelope_definition'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -4103,7 +3913,7 @@ def delete_document_fields_with_http_info(self, account_id, document_id, envelop body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentFieldsInformation', + response_type='EnvelopeDocumentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4111,59 +3921,55 @@ def delete_document_fields_with_http_info(self, account_id, document_id, envelop _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_document_page(self, account_id, document_id, envelope_id, page_number, **kwargs): + def delete_email_settings(self, account_id, envelope_id, **kwargs): """ - Deletes a page from a document in an envelope. - Deletes a page from a document in an envelope based on the page number. + Deletes the email setting overrides for an envelope. + Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications. 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.delete_document_page(account_id, document_id, envelope_id, page_number, callback=callback_function) + >>> thread = api.delete_email_settings(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str page_number: The page number being accessed. (required) - :return: None + :return: EmailSettings If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + return self.delete_email_settings_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + (data) = self.delete_email_settings_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_document_page_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): + def delete_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): """ - Deletes a page from a document in an envelope. - Deletes a page from a document in an envelope based on the page number. + Deletes the email setting overrides for an envelope. + Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications. 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.delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number, callback=callback_function) + >>> thread = api.delete_email_settings_with_http_info(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str page_number: The page number being accessed. (required) - :return: None + :return: EmailSettings If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'page_number'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4174,36 +3980,26 @@ def delete_document_page_with_http_info(self, account_id, document_id, envelope_ if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_document_page" % key + " to method delete_email_settings" % 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 `delete_document_page`") - # 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 `delete_document_page`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_email_settings`") # 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 `delete_document_page`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `delete_document_page`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_email_settings`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings'.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'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = {} @@ -4227,7 +4023,7 @@ def delete_document_page_with_http_info(self, account_id, document_id, envelope_ body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='EmailSettings', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4235,57 +4031,55 @@ def delete_document_page_with_http_info(self, account_id, document_id, envelope_ _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_document_tabs(self, account_id, document_id, envelope_id, **kwargs): + def delete_envelope_correct_view(self, account_id, envelope_id, **kwargs): """ - Deletes tabs from an envelope document + Revokes the correction view URL to the Envelope UI 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.delete_document_tabs(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.delete_envelope_correct_view(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Tabs tabs: - :return: Tabs + :param CorrectViewRequest correct_view_request: + :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.delete_envelope_correct_view_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.delete_envelope_correct_view_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_document_tabs_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def delete_envelope_correct_view_with_http_info(self, account_id, envelope_id, **kwargs): """ - Deletes tabs from an envelope document + Revokes the correction view URL to the Envelope UI 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.delete_document_tabs_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.delete_envelope_correct_view_with_http_info(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Tabs tabs: - :return: Tabs + :param CorrectViewRequest correct_view_request: + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'tabs'] + all_params = ['account_id', 'envelope_id', 'correct_view_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4296,29 +4090,24 @@ def delete_document_tabs_with_http_info(self, account_id, document_id, envelope_ if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_document_tabs" % key + " to method delete_envelope_correct_view" % 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 `delete_document_tabs`") - # 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 `delete_document_tabs`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_envelope_correct_view`") # 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 `delete_document_tabs`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_envelope_correct_view`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct'.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'] @@ -4330,8 +4119,8 @@ def delete_document_tabs_with_http_info(self, account_id, document_id, envelope_ local_var_files = {} body_params = None - if 'tabs' in params: - body_params = params['tabs'] + if 'correct_view_request' in params: + body_params = params['correct_view_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -4346,7 +4135,7 @@ def delete_document_tabs_with_http_info(self, account_id, document_id, envelope_ body=body_params, post_params=form_params, files=local_var_files, - response_type='Tabs', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4354,57 +4143,53 @@ def delete_document_tabs_with_http_info(self, account_id, document_id, envelope_ _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_documents(self, account_id, envelope_id, **kwargs): + def delete_envelope_transfer_rules(self, account_id, envelope_transfer_rule_id, **kwargs): """ - Deletes documents from a draft envelope. - Deletes one or more documents from an existing draft envelope. + Delete envelope transfer rules for an account. 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.delete_documents(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_envelope_transfer_rules(account_id, envelope_transfer_rule_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EnvelopeDefinition envelope_definition: - :return: EnvelopeDocumentsResult + :param str envelope_transfer_rule_id: (required) + :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_documents_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) else: - (data) = self.delete_documents_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) return data - def delete_documents_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_envelope_transfer_rules_with_http_info(self, account_id, envelope_transfer_rule_id, **kwargs): """ - Deletes documents from a draft envelope. - Deletes one or more documents from an existing draft envelope. + Delete envelope transfer rules for an account. 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.delete_documents_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EnvelopeDefinition envelope_definition: - :return: EnvelopeDocumentsResult + :param str envelope_transfer_rule_id: (required) + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'envelope_definition'] + all_params = ['account_id', 'envelope_transfer_rule_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4415,26 +4200,26 @@ def delete_documents_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_documents" % key + " to method delete_envelope_transfer_rules" % 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 `delete_documents`") - # 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 `delete_documents`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_envelope_transfer_rules`") + # verify the required parameter 'envelope_transfer_rule_id' is set + if ('envelope_transfer_rule_id' not in params) or (params['envelope_transfer_rule_id'] is None): + raise ValueError("Missing the required parameter `envelope_transfer_rule_id` when calling `delete_envelope_transfer_rules`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}'.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'] + if 'envelope_transfer_rule_id' in params: + path_params['envelopeTransferRuleId'] = params['envelope_transfer_rule_id'] query_params = {} @@ -4444,8 +4229,6 @@ def delete_documents_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None - if 'envelope_definition' in params: - body_params = params['envelope_definition'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -4460,7 +4243,7 @@ def delete_documents_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeDocumentsResult', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4468,50 +4251,48 @@ def delete_documents_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_email_settings(self, account_id, envelope_id, **kwargs): + def delete_envelope_workflow_definition(self, account_id, envelope_id, **kwargs): """ - Deletes the email setting overrides for an envelope. - Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications. + Delete the workflow definition for 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.delete_email_settings(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_envelope_workflow_definition(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EmailSettings + :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_email_settings_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_email_settings_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_envelope_workflow_definition_with_http_info(self, account_id, envelope_id, **kwargs): """ - Deletes the email setting overrides for an envelope. - Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications. + Delete the workflow definition for 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.delete_email_settings_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_envelope_workflow_definition_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EmailSettings + :return: None If the method is called asynchronously, returns the request thread. """ @@ -4527,21 +4308,21 @@ def delete_email_settings_with_http_info(self, account_id, envelope_id, **kwargs if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_email_settings" % key + " to method delete_envelope_workflow_definition" % 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 `delete_email_settings`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_envelope_workflow_definition`") # 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 `delete_email_settings`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_envelope_workflow_definition`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -4570,7 +4351,7 @@ def delete_email_settings_with_http_info(self, account_id, envelope_id, **kwargs body=body_params, post_params=form_params, files=local_var_files, - response_type='EmailSettings', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4578,55 +4359,55 @@ def delete_email_settings_with_http_info(self, account_id, envelope_id, **kwargs _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_envelope_correct_view(self, account_id, envelope_id, **kwargs): + def delete_lock(self, account_id, envelope_id, **kwargs): """ - Revokes the correction view URL to the Envelope UI + Deletes an envelope lock. + Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request. 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.delete_envelope_correct_view(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_lock(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param CorrectViewRequest correct_view_request: - :return: None + :return: LockInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_envelope_correct_view_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_lock_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_envelope_correct_view_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_lock_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_envelope_correct_view_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_lock_with_http_info(self, account_id, envelope_id, **kwargs): """ - Revokes the correction view URL to the Envelope UI + Deletes an envelope lock. + Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request. 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.delete_envelope_correct_view_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_lock_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param CorrectViewRequest correct_view_request: - :return: None + :return: LockInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'correct_view_request'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4637,21 +4418,21 @@ def delete_envelope_correct_view_with_http_info(self, account_id, envelope_id, * if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_envelope_correct_view" % key + " to method delete_lock" % 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 `delete_envelope_correct_view`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_lock`") # 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 `delete_envelope_correct_view`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_lock`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -4666,8 +4447,6 @@ def delete_envelope_correct_view_with_http_info(self, account_id, envelope_id, * local_var_files = {} body_params = None - if 'correct_view_request' in params: - body_params = params['correct_view_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -4682,7 +4461,7 @@ def delete_envelope_correct_view_with_http_info(self, account_id, envelope_id, * body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='LockInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4690,53 +4469,53 @@ def delete_envelope_correct_view_with_http_info(self, account_id, envelope_id, * _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_envelope_transfer_rules(self, account_id, envelope_transfer_rule_id, **kwargs): + def delete_page_info_v2(self, account_id, envelope_id, **kwargs): """ - Delete envelope transfer rules for an account. + Delete page information for Display Appliance 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.delete_envelope_transfer_rules(account_id, envelope_transfer_rule_id, callback=callback_function) + >>> thread = api.delete_page_info_v2(account_id, envelope_id, callback=callback_function) :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 envelope_transfer_rule_id: (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) + return self.delete_page_info_v2_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) + (data) = self.delete_page_info_v2_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_envelope_transfer_rules_with_http_info(self, account_id, envelope_transfer_rule_id, **kwargs): + def delete_page_info_v2_with_http_info(self, account_id, envelope_id, **kwargs): """ - Delete envelope transfer rules for an account. + Delete page information for Display Appliance 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.delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id, callback=callback_function) + >>> thread = api.delete_page_info_v2_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_transfer_rule_id: (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_transfer_rule_id'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4747,26 +4526,26 @@ def delete_envelope_transfer_rules_with_http_info(self, account_id, envelope_tra if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_envelope_transfer_rules" % key + " to method delete_page_info_v2" % 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 `delete_envelope_transfer_rules`") - # verify the required parameter 'envelope_transfer_rule_id' is set - if ('envelope_transfer_rule_id' not in params) or (params['envelope_transfer_rule_id'] is None): - raise ValueError("Missing the required parameter `envelope_transfer_rule_id` when calling `delete_envelope_transfer_rules`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_page_info_v2`") + # 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 `delete_page_info_v2`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'envelope_transfer_rule_id' in params: - path_params['envelopeTransferRuleId'] = params['envelope_transfer_rule_id'] + if 'envelope_id' in params: + path_params['envelopeId'] = params['envelope_id'] query_params = {} @@ -4798,53 +4577,57 @@ def delete_envelope_transfer_rules_with_http_info(self, account_id, envelope_tra _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_envelope_workflow_definition(self, account_id, envelope_id, **kwargs): + def delete_recipient(self, account_id, envelope_id, recipient_id, **kwargs): """ - Delete the workflow definition for an envelope. + Deletes a recipient from an envelope. + Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent. 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.delete_envelope_workflow_definition(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_recipient(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param str recipient_id: The ID of the recipient being accessed. (required) + :return: Recipients If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_recipient_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.delete_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_recipient_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def delete_envelope_workflow_definition_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_recipient_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Delete the workflow definition for an envelope. + Deletes a recipient from an envelope. + Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent. 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.delete_envelope_workflow_definition_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_recipient_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param str recipient_id: The ID of the recipient being accessed. (required) + :return: Recipients If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'recipient_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4855,26 +4638,31 @@ def delete_envelope_workflow_definition_with_http_info(self, account_id, envelop if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_envelope_workflow_definition" % key + " to method delete_recipient" % 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 `delete_envelope_workflow_definition`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_recipient`") # 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 `delete_envelope_workflow_definition`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_recipient`") + # verify the required parameter 'recipient_id' is set + if ('recipient_id' not in params) or (params['recipient_id'] is None): + raise ValueError("Missing the required parameter `recipient_id` when calling `delete_recipient`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}'.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'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] query_params = {} @@ -4898,7 +4686,7 @@ def delete_envelope_workflow_definition_with_http_info(self, account_id, envelop body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='Recipients', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4906,55 +4694,57 @@ def delete_envelope_workflow_definition_with_http_info(self, account_id, envelop _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_lock(self, account_id, envelope_id, **kwargs): + def delete_recipients(self, account_id, envelope_id, **kwargs): """ - Deletes an envelope lock. - Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request. + Deletes recipients from an envelope. + Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted. 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.delete_lock(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_recipients(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: LockInformation + :param Recipients recipients: + :return: Recipients If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_lock_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_recipients_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_lock_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_recipients_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_lock_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_recipients_with_http_info(self, account_id, envelope_id, **kwargs): """ - Deletes an envelope lock. - Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request. + Deletes recipients from an envelope. + Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted. 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.delete_lock_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_recipients_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: LockInformation + :param Recipients recipients: + :return: Recipients If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'recipients'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4965,21 +4755,21 @@ def delete_lock_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_lock" % key + " to method delete_recipients" % 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 `delete_lock`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_recipients`") # 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 `delete_lock`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_recipients`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -4994,6 +4784,8 @@ def delete_lock_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None + if 'recipients' in params: + body_params = params['recipients'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -5008,7 +4800,7 @@ def delete_lock_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='LockInformation', + response_type='Recipients', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5016,53 +4808,59 @@ def delete_lock_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_page_info(self, account_id, envelope_id, **kwargs): + def delete_tabs(self, account_id, envelope_id, recipient_id, **kwargs): """ - Delete page information for Display Appliance + Deletes the tabs associated with a recipient. + Deletes one or more tabs associated with a recipient in a draft 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.delete_page_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_tabs(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param str recipient_id: The ID of the recipient being accessed. (required) + :param Tabs tabs: + :return: Tabs If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_page_info_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.delete_page_info_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def delete_page_info_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Delete page information for Display Appliance + Deletes the tabs associated with a recipient. + Deletes one or more tabs associated with a recipient in a draft 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.delete_page_info_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_tabs_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param str recipient_id: The ID of the recipient being accessed. (required) + :param Tabs tabs: + :return: Tabs If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'recipient_id', 'tabs'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5073,26 +4871,31 @@ def delete_page_info_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_page_info" % key + " to method delete_tabs" % 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 `delete_page_info`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_tabs`") # 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 `delete_page_info`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_tabs`") + # verify the required parameter 'recipient_id' is set + if ('recipient_id' not in params) or (params['recipient_id'] is None): + raise ValueError("Missing the required parameter `recipient_id` when calling `delete_tabs`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info/delete'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs'.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'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] query_params = {} @@ -5102,6 +4905,8 @@ def delete_page_info_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None + if 'tabs' in params: + body_params = params['tabs'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -5109,14 +4914,14 @@ def delete_page_info_with_http_info(self, account_id, envelope_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'POST', + return self.api_client.call_api(resource_path, 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='Tabs', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5124,53 +4929,53 @@ def delete_page_info_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_page_info_v2(self, account_id, envelope_id, **kwargs): + def delete_template_workflow_definition(self, account_id, template_id, **kwargs): """ - Delete page information for Display Appliance + Delete the workflow definition for a template. 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.delete_page_info_v2(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_template_workflow_definition(account_id, template_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str template_id: The ID of the template being accessed. (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_page_info_v2_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) else: - (data) = self.delete_page_info_v2_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) return data - def delete_page_info_v2_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_template_workflow_definition_with_http_info(self, account_id, template_id, **kwargs): """ - Delete page information for Display Appliance + Delete the workflow definition for a template. 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.delete_page_info_v2_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_template_workflow_definition_with_http_info(account_id, template_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str template_id: The ID of the template being accessed. (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'template_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5181,26 +4986,26 @@ def delete_page_info_v2_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_page_info_v2" % key + " to method delete_template_workflow_definition" % 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 `delete_page_info_v2`") - # 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 `delete_page_info_v2`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_template_workflow_definition`") + # verify the required parameter 'template_id' is set + if ('template_id' not in params) or (params['template_id'] is None): + raise ValueError("Missing the required parameter `template_id` when calling `delete_template_workflow_definition`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/workflow'.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'] + if 'template_id' in params: + path_params['templateId'] = params['template_id'] query_params = {} @@ -5232,57 +5037,59 @@ def delete_page_info_v2_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_recipient(self, account_id, envelope_id, recipient_id, **kwargs): + def delete_templates_from_document(self, account_id, document_id, envelope_id, template_id, **kwargs): """ - Deletes a recipient from an envelope. - Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent. + Deletes a template from a document in an existing envelope. + Deletes the specified template from a document in an existing 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.delete_recipient(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.delete_templates_from_document(account_id, document_id, envelope_id, template_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :return: Recipients + :param str template_id: The ID of the template being accessed. (required) + :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_recipient_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id, **kwargs) else: - (data) = self.delete_recipient_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id, **kwargs) return data - def delete_recipient_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def delete_templates_from_document_with_http_info(self, account_id, document_id, envelope_id, template_id, **kwargs): """ - Deletes a recipient from an envelope. - Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent. + Deletes a template from a document in an existing envelope. + Deletes the specified template from a document in an existing 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.delete_recipient_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :return: Recipients + :param str template_id: The ID of the template being accessed. (required) + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipient_id'] + all_params = ['account_id', 'document_id', 'envelope_id', 'template_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5293,31 +5100,36 @@ def delete_recipient_with_http_info(self, account_id, envelope_id, recipient_id, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_recipient" % key + " to method delete_templates_from_document" % 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 `delete_recipient`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_templates_from_document`") + # 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 `delete_templates_from_document`") # 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 `delete_recipient`") - # verify the required parameter 'recipient_id' is set - if ('recipient_id' not in params) or (params['recipient_id'] is None): - raise ValueError("Missing the required parameter `recipient_id` when calling `delete_recipient`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_templates_from_document`") + # verify the required parameter 'template_id' is set + if ('template_id' not in params) or (params['template_id'] is None): + raise ValueError("Missing the required parameter `template_id` when calling `delete_templates_from_document`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}'.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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] + if 'template_id' in params: + path_params['templateId'] = params['template_id'] query_params = {} @@ -5341,7 +5153,7 @@ def delete_recipient_with_http_info(self, account_id, envelope_id, recipient_id, body=body_params, post_params=form_params, files=local_var_files, - response_type='Recipients', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5349,53 +5161,69 @@ def delete_recipient_with_http_info(self, account_id, envelope_id, recipient_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_recipient_denied_document_copy(self, account_id, envelope_id, **kwargs): + def get_appliance_envelope_info(self, account_id, envelope_id, **kwargs): """ - Delete RecipientDeniedDocumentCopy for Display Appliance + Returns Display Appliance envelope information 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.delete_recipient_denied_document_copy(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_appliance_envelope_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param str before_sign: + :param str document_id: + :param str entity_type: + :param str in_person: + :param str recipient_id: + :param str tab_locale_policy: + :param str tab_type: + :param str use_date_signed_tab_val_exclusively: + :return: DisplayApplianceInfo If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_recipient_denied_document_copy_with_http_info(account_id, envelope_id, **kwargs) + return self.get_appliance_envelope_info_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_recipient_denied_document_copy_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_appliance_envelope_info_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_recipient_denied_document_copy_with_http_info(self, account_id, envelope_id, **kwargs): + def get_appliance_envelope_info_with_http_info(self, account_id, envelope_id, **kwargs): """ - Delete RecipientDeniedDocumentCopy for Display Appliance + Returns Display Appliance envelope information 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.delete_recipient_denied_document_copy_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_appliance_envelope_info_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param str before_sign: + :param str document_id: + :param str entity_type: + :param str in_person: + :param str recipient_id: + :param str tab_locale_policy: + :param str tab_type: + :param str use_date_signed_tab_val_exclusively: + :return: DisplayApplianceInfo If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'before_sign', 'document_id', 'entity_type', 'in_person', 'recipient_id', 'tab_locale_policy', 'tab_type', 'use_date_signed_tab_val_exclusively'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5406,21 +5234,21 @@ def delete_recipient_denied_document_copy_with_http_info(self, account_id, envel if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_recipient_denied_document_copy" % key + " to method get_appliance_envelope_info" % 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 `delete_recipient_denied_document_copy`") + raise ValueError("Missing the required parameter `account_id` when calling `get_appliance_envelope_info`") # 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 `delete_recipient_denied_document_copy`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_appliance_envelope_info`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/recipient_denied_copy'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info_v2'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -5428,6 +5256,22 @@ def delete_recipient_denied_document_copy_with_http_info(self, account_id, envel path_params['envelopeId'] = params['envelope_id'] query_params = {} + if 'before_sign' in params: + query_params['beforeSign'] = params['before_sign'] + if 'document_id' in params: + query_params['document_id'] = params['document_id'] + if 'entity_type' in params: + query_params['entity_type'] = params['entity_type'] + if 'in_person' in params: + query_params['inPerson'] = params['in_person'] + if 'recipient_id' in params: + query_params['recipient_id'] = params['recipient_id'] + if 'tab_locale_policy' in params: + query_params['tabLocalePolicy'] = params['tab_locale_policy'] + if 'tab_type' in params: + query_params['tabType'] = params['tab_type'] + if 'use_date_signed_tab_val_exclusively' in params: + query_params['useDateSignedTabValExclusively'] = params['use_date_signed_tab_val_exclusively'] header_params = {} @@ -5442,14 +5286,14 @@ def delete_recipient_denied_document_copy_with_http_info(self, account_id, envel # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'DELETE', + 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=None, + response_type='DisplayApplianceInfo', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5457,57 +5301,55 @@ def delete_recipient_denied_document_copy_with_http_info(self, account_id, envel _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_recipients(self, account_id, envelope_id, **kwargs): + def get_attachment(self, account_id, attachment_id, envelope_id, **kwargs): """ - Deletes recipients from an envelope. - Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted. + Retrieves an attachment from the 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.delete_recipients(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_attachment(account_id, attachment_id, envelope_id, callback=callback_function) :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 attachment_id: (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Recipients recipients: - :return: Recipients + :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_recipients_with_http_info(account_id, envelope_id, **kwargs) + return self.get_attachment_with_http_info(account_id, attachment_id, envelope_id, **kwargs) else: - (data) = self.delete_recipients_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_attachment_with_http_info(account_id, attachment_id, envelope_id, **kwargs) return data - def delete_recipients_with_http_info(self, account_id, envelope_id, **kwargs): + def get_attachment_with_http_info(self, account_id, attachment_id, envelope_id, **kwargs): """ - Deletes recipients from an envelope. - Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted. + Retrieves an attachment from the 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.delete_recipients_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_attachment_with_http_info(account_id, attachment_id, envelope_id, callback=callback_function) :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 attachment_id: (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Recipients recipients: - :return: Recipients + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipients'] + all_params = ['account_id', 'attachment_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5518,24 +5360,29 @@ def delete_recipients_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_recipients" % key + " to method get_attachment" % 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 `delete_recipients`") + raise ValueError("Missing the required parameter `account_id` when calling `get_attachment`") + # verify the required parameter 'attachment_id' is set + if ('attachment_id' not in params) or (params['attachment_id'] is None): + raise ValueError("Missing the required parameter `attachment_id` when calling `get_attachment`") # 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 `delete_recipients`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_attachment`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] + if 'attachment_id' in params: + path_params['attachmentId'] = params['attachment_id'] if 'envelope_id' in params: path_params['envelopeId'] = params['envelope_id'] @@ -5547,8 +5394,6 @@ def delete_recipients_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None - if 'recipients' in params: - body_params = params['recipients'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -5556,14 +5401,14 @@ def delete_recipients_with_http_info(self, account_id, envelope_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'DELETE', + 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='Recipients', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5571,48 +5416,48 @@ def delete_recipients_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_signer_attachment(self, account_id, envelope_id, **kwargs): + def get_attachments(self, account_id, envelope_id, **kwargs): """ - Delete signer attachment information for Display Appliance + Returns a list of attachments associated with the specified 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.delete_signer_attachment(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_attachments(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :return: EnvelopeAttachmentsResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_signer_attachment_with_http_info(account_id, envelope_id, **kwargs) + return self.get_attachments_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_signer_attachment_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_attachments_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_signer_attachment_with_http_info(self, account_id, envelope_id, **kwargs): + def get_attachments_with_http_info(self, account_id, envelope_id, **kwargs): """ - Delete signer attachment information for Display Appliance + Returns a list of attachments associated with the specified 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.delete_signer_attachment_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_attachments_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :return: EnvelopeAttachmentsResult If the method is called asynchronously, returns the request thread. """ @@ -5628,21 +5473,21 @@ def delete_signer_attachment_with_http_info(self, account_id, envelope_id, **kwa if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_signer_attachment" % key + " to method get_attachments" % 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 `delete_signer_attachment`") + raise ValueError("Missing the required parameter `account_id` when calling `get_attachments`") # 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 `delete_signer_attachment`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_attachments`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/signer_attachment_info'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -5664,14 +5509,14 @@ def delete_signer_attachment_with_http_info(self, account_id, envelope_id, **kwa # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'DELETE', + 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=None, + response_type='EnvelopeAttachmentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5679,59 +5524,55 @@ def delete_signer_attachment_with_http_info(self, account_id, envelope_id, **kwa _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_tabs(self, account_id, envelope_id, recipient_id, **kwargs): + def get_chunked_upload(self, account_id, chunked_upload_id, **kwargs): """ - Deletes the tabs associated with a recipient. - Deletes one or more tabs associated with a recipient in a draft envelope. + Retrieves the current metadata of a ChunkedUpload. 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.delete_tabs(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.get_chunked_upload(account_id, chunked_upload_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param Tabs tabs: - :return: Tabs + :param str chunked_upload_id: (required) + :param str include: + :return: ChunkedUploadResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.get_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) else: - (data) = self.delete_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.get_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) return data - def delete_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def get_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwargs): """ - Deletes the tabs associated with a recipient. - Deletes one or more tabs associated with a recipient in a draft envelope. + Retrieves the current metadata of a ChunkedUpload. 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.delete_tabs_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.get_chunked_upload_with_http_info(account_id, chunked_upload_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param Tabs tabs: - :return: Tabs + :param str chunked_upload_id: (required) + :param str include: + :return: ChunkedUploadResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipient_id', 'tabs'] + all_params = ['account_id', 'chunked_upload_id', 'include'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5742,33 +5583,30 @@ def delete_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kw if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_tabs" % key + " to method get_chunked_upload" % 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 `delete_tabs`") - # 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 `delete_tabs`") - # verify the required parameter 'recipient_id' is set - if ('recipient_id' not in params) or (params['recipient_id'] is None): - raise ValueError("Missing the required parameter `recipient_id` when calling `delete_tabs`") + raise ValueError("Missing the required parameter `account_id` when calling `get_chunked_upload`") + # verify the required parameter 'chunked_upload_id' is set + if ('chunked_upload_id' not in params) or (params['chunked_upload_id'] is None): + raise ValueError("Missing the required parameter `chunked_upload_id` when calling `get_chunked_upload`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}'.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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] + if 'chunked_upload_id' in params: + path_params['chunkedUploadId'] = params['chunked_upload_id'] query_params = {} + if 'include' in params: + query_params['include'] = params['include'] header_params = {} @@ -5776,8 +5614,6 @@ def delete_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kw local_var_files = {} body_params = None - if 'tabs' in params: - body_params = params['tabs'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -5785,14 +5621,14 @@ def delete_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kw # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'DELETE', + 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='Tabs', + response_type='ChunkedUploadResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5800,53 +5636,55 @@ def delete_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kw _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_template_workflow_definition(self, account_id, template_id, **kwargs): + def get_comments_transcript(self, account_id, envelope_id, **kwargs): """ - Delete the workflow definition for a template. + Gets comment transcript for envelope and user 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.delete_template_workflow_definition(account_id, template_id, callback=callback_function) + >>> thread = api.get_comments_transcript(account_id, envelope_id, callback=callback_function) :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 template_id: The ID of the template being accessed. (required) - :return: None + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str encoding: + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) + return self.get_comments_transcript_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) + (data) = self.get_comments_transcript_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_template_workflow_definition_with_http_info(self, account_id, template_id, **kwargs): + def get_comments_transcript_with_http_info(self, account_id, envelope_id, **kwargs): """ - Delete the workflow definition for a template. + Gets comment transcript for envelope and user 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.delete_template_workflow_definition_with_http_info(account_id, template_id, callback=callback_function) + >>> thread = api.get_comments_transcript_with_http_info(account_id, envelope_id, callback=callback_function) :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 template_id: The ID of the template being accessed. (required) - :return: None + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str encoding: + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'template_id'] + all_params = ['account_id', 'envelope_id', 'encoding'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5857,28 +5695,30 @@ def delete_template_workflow_definition_with_http_info(self, account_id, templat if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_template_workflow_definition" % key + " to method get_comments_transcript" % 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 `delete_template_workflow_definition`") - # verify the required parameter 'template_id' is set - if ('template_id' not in params) or (params['template_id'] is None): - raise ValueError("Missing the required parameter `template_id` when calling `delete_template_workflow_definition`") + raise ValueError("Missing the required parameter `account_id` when calling `get_comments_transcript`") + # 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_comments_transcript`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/workflow'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'template_id' in params: - path_params['templateId'] = params['template_id'] + if 'envelope_id' in params: + path_params['envelopeId'] = params['envelope_id'] query_params = {} + if 'encoding' in params: + query_params['encoding'] = params['encoding'] header_params = {} @@ -5888,19 +5728,19 @@ def delete_template_workflow_definition_with_http_info(self, account_id, templat body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['application/pdf']) # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'DELETE', + 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=None, + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5908,59 +5748,61 @@ def delete_template_workflow_definition_with_http_info(self, account_id, templat _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_templates_from_document(self, account_id, document_id, envelope_id, template_id, **kwargs): + def get_consumer_disclosure(self, account_id, envelope_id, lang_code, recipient_id, **kwargs): """ - Deletes a template from a document in an existing envelope. - Deletes the specified template from a document in an existing envelope. + Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. + Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. 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.delete_templates_from_document(account_id, document_id, envelope_id, template_id, callback=callback_function) + >>> thread = api.get_consumer_disclosure(account_id, envelope_id, lang_code, recipient_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str template_id: The ID of the template being accessed. (required) - :return: None + :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: + :return: ConsumerDisclosure If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id, **kwargs) + return self.get_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, **kwargs) else: - (data) = self.delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id, **kwargs) + (data) = self.get_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, **kwargs) return data - def delete_templates_from_document_with_http_info(self, account_id, document_id, envelope_id, template_id, **kwargs): + def get_consumer_disclosure_with_http_info(self, account_id, envelope_id, lang_code, recipient_id, **kwargs): """ - Deletes a template from a document in an existing envelope. - Deletes the specified template from a document in an existing envelope. + Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. + Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. 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.delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id, callback=callback_function) + >>> thread = api.get_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str template_id: The ID of the template being accessed. (required) - :return: None + :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: + :return: ConsumerDisclosure If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'template_id'] + all_params = ['account_id', 'envelope_id', 'lang_code', 'recipient_id', 'lang_code2'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5971,38 +5813,40 @@ def delete_templates_from_document_with_http_info(self, account_id, document_id, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_templates_from_document" % key + " to method get_consumer_disclosure" % 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 `delete_templates_from_document`") - # 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 `delete_templates_from_document`") + raise ValueError("Missing the required parameter `account_id` when calling `get_consumer_disclosure`") # 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 `delete_templates_from_document`") - # verify the required parameter 'template_id' is set - if ('template_id' not in params) or (params['template_id'] is None): - raise ValueError("Missing the required parameter `template_id` when calling `delete_templates_from_document`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_consumer_disclosure`") + # verify the required parameter 'lang_code' is set + if ('lang_code' not in params) or (params['lang_code'] is None): + raise ValueError("Missing the required parameter `lang_code` when calling `get_consumer_disclosure`") + # verify the required parameter 'recipient_id' is set + if ('recipient_id' not in params) or (params['recipient_id'] is None): + raise ValueError("Missing the required parameter `recipient_id` when calling `get_consumer_disclosure`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}'.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'] - if 'template_id' in params: - path_params['templateId'] = params['template_id'] + if 'lang_code' in params: + path_params['langCode'] = params['lang_code'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] query_params = {} + if 'lang_code2' in params: + query_params['langCode'] = params['lang_code2'] header_params = {} @@ -6017,14 +5861,14 @@ def delete_templates_from_document_with_http_info(self, account_id, document_id, # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'DELETE', + 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=None, + response_type='ConsumerDisclosure', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6032,53 +5876,59 @@ def delete_templates_from_document_with_http_info(self, account_id, document_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_account(self, account_id, envelope_id, **kwargs): + def get_consumer_disclosure_default(self, account_id, envelope_id, recipient_id, **kwargs): """ - Returns envelope account information for Display Appliance + Gets the Electronic Record and Signature Disclosure associated with the account. + Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure. 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_account(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_consumer_disclosure_default(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceAccount + :param str recipient_id: The ID of the recipient being accessed. (required) + :param str lang_code: + :return: ConsumerDisclosure If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_account_with_http_info(account_id, envelope_id, **kwargs) + return self.get_consumer_disclosure_default_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.get_account_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_consumer_disclosure_default_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def get_account_with_http_info(self, account_id, envelope_id, **kwargs): + def get_consumer_disclosure_default_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Returns envelope account information for Display Appliance + Gets the Electronic Record and Signature Disclosure associated with the account. + Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure. 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_account_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_consumer_disclosure_default_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceAccount + :param str recipient_id: The ID of the recipient being accessed. (required) + :param str lang_code: + :return: ConsumerDisclosure If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'recipient_id', 'lang_code'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6089,28 +5939,35 @@ def get_account_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_account" % key + " to method get_consumer_disclosure_default" % 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_account`") + raise ValueError("Missing the required parameter `account_id` when calling `get_consumer_disclosure_default`") # 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_account`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_consumer_disclosure_default`") + # verify the required parameter 'recipient_id' is set + if ('recipient_id' not in params) or (params['recipient_id'] is None): + raise ValueError("Missing the required parameter `recipient_id` when calling `get_consumer_disclosure_default`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/account_info'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure'.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'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] query_params = {} + if 'lang_code' in params: + query_params['langCode'] = params['lang_code'] header_params = {} @@ -6132,7 +5989,7 @@ def get_account_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='DisplayApplianceAccount', + response_type='ConsumerDisclosure', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6140,69 +5997,53 @@ def get_account_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_appliance_envelope_info(self, account_id, envelope_id, **kwargs): + def get_date_signed(self, account_id, envelope_id, **kwargs): """ - Returns Display Appliance envelope information + Gets date signed information for Display Appliance 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_appliance_envelope_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_date_signed(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str before_sign: - :param str document_id: - :param str entity_type: - :param str in_person: - :param str recipient_id: - :param str tab_locale_policy: - :param str tab_type: - :param str use_date_signed_tab_val_exclusively: :return: DisplayApplianceInfo If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_appliance_envelope_info_with_http_info(account_id, envelope_id, **kwargs) + return self.get_date_signed_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_appliance_envelope_info_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_date_signed_with_http_info(account_id, envelope_id, **kwargs) return data - def get_appliance_envelope_info_with_http_info(self, account_id, envelope_id, **kwargs): + def get_date_signed_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns Display Appliance envelope information + Gets date signed information for Display Appliance 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_appliance_envelope_info_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_date_signed_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str before_sign: - :param str document_id: - :param str entity_type: - :param str in_person: - :param str recipient_id: - :param str tab_locale_policy: - :param str tab_type: - :param str use_date_signed_tab_val_exclusively: :return: DisplayApplianceInfo If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'before_sign', 'document_id', 'entity_type', 'in_person', 'recipient_id', 'tab_locale_policy', 'tab_type', 'use_date_signed_tab_val_exclusively'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6213,21 +6054,21 @@ def get_appliance_envelope_info_with_http_info(self, account_id, envelope_id, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_appliance_envelope_info" % key + " to method get_date_signed" % 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_appliance_envelope_info`") + raise ValueError("Missing the required parameter `account_id` when calling `get_date_signed`") # 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_appliance_envelope_info`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_date_signed`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info_v2'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/date_signed'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -6235,22 +6076,6 @@ def get_appliance_envelope_info_with_http_info(self, account_id, envelope_id, ** path_params['envelopeId'] = params['envelope_id'] query_params = {} - if 'before_sign' in params: - query_params['beforeSign'] = params['before_sign'] - if 'document_id' in params: - query_params['document_id'] = params['document_id'] - if 'entity_type' in params: - query_params['entity_type'] = params['entity_type'] - if 'in_person' in params: - query_params['inPerson'] = params['in_person'] - if 'recipient_id' in params: - query_params['recipient_id'] = params['recipient_id'] - if 'tab_locale_policy' in params: - query_params['tabLocalePolicy'] = params['tab_locale_policy'] - if 'tab_type' in params: - query_params['tabType'] = params['tab_type'] - if 'use_date_signed_tab_val_exclusively' in params: - query_params['useDateSignedTabValExclusively'] = params['use_date_signed_tab_val_exclusively'] header_params = {} @@ -6280,53 +6105,75 @@ def get_appliance_envelope_info_with_http_info(self, account_id, envelope_id, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_appliance_info(self, account_id, envelope_id, **kwargs): + def get_document(self, account_id, document_id, envelope_id, **kwargs): """ - Returns envelope and recipient information for Display Appliance + Gets a document from an envelope. + Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined 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_appliance_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_document(account_id, document_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceInfo + :param str certificate: When set to **false**, the envelope signing certificate is removed from the download. + :param str documents_by_userid: + :param str encoding: + :param str encrypt: When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API. + :param str language: Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). + :param str recipient_id: + :param str shared_user_id: + :param str show_changes: When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. + :param str watermark: When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_appliance_info_with_http_info(account_id, envelope_id, **kwargs) + return self.get_document_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.get_appliance_info_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_document_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def get_appliance_info_with_http_info(self, account_id, envelope_id, **kwargs): + def get_document_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Returns envelope and recipient information for Display Appliance + Gets a document from an envelope. + Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined 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_appliance_info_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_document_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: The external account number (int) or account ID Guid. (required) + :param str document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceInfo + :param str certificate: When set to **false**, the envelope signing certificate is removed from the download. + :param str documents_by_userid: + :param str encoding: + :param str encrypt: When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API. + :param str language: Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). + :param str recipient_id: + :param str shared_user_id: + :param str show_changes: When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. + :param str watermark: When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'document_id', 'envelope_id', 'certificate', 'documents_by_userid', 'encoding', 'encrypt', 'language', 'recipient_id', 'shared_user_id', 'show_changes', 'watermark'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6337,28 +6184,51 @@ def get_appliance_info_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_appliance_info" % key + " to method get_document" % 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_appliance_info`") + raise ValueError("Missing the required parameter `account_id` when calling `get_document`") + # 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`") # 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_appliance_info`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_document`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}'.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 'certificate' in params: + query_params['certificate'] = params['certificate'] + if 'documents_by_userid' in params: + query_params['documents_by_userid'] = params['documents_by_userid'] + if 'encoding' in params: + query_params['encoding'] = params['encoding'] + if 'encrypt' in params: + query_params['encrypt'] = params['encrypt'] + if 'language' in params: + query_params['language'] = params['language'] + if 'recipient_id' in params: + query_params['recipient_id'] = params['recipient_id'] + if 'shared_user_id' in params: + query_params['shared_user_id'] = params['shared_user_id'] + if 'show_changes' in params: + query_params['show_changes'] = params['show_changes'] + if 'watermark' in params: + query_params['watermark'] = params['watermark'] header_params = {} @@ -6368,7 +6238,7 @@ def get_appliance_info_with_http_info(self, account_id, envelope_id, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['application/pdf']) # Authentication setting auth_settings = [] @@ -6380,7 +6250,7 @@ def get_appliance_info_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='DisplayApplianceInfo', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6388,55 +6258,67 @@ def get_appliance_info_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_attachment(self, account_id, attachment_id, envelope_id, **kwargs): + def get_document_page_image(self, account_id, document_id, envelope_id, page_number, **kwargs): """ - Retrieves an attachment from the envelope. + Gets a page image from an envelope for display. + Retrieves a page image for display from the specified 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_attachment(account_id, attachment_id, envelope_id, callback=callback_function) + >>> thread = api.get_document_page_image(account_id, document_id, envelope_id, page_number, callback=callback_function) :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 attachment_id: (required) + :param str document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param str page_number: The page number being accessed. (required) + :param str dpi: Sets the dpi for the image. + :param str max_height: Sets the maximum height for the page image in pixels. The dpi is recalculated based on this setting. + :param str max_width: Sets the maximum width for the page image in pixels. The dpi is recalculated based on this setting. + :param str show_changes: + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_attachment_with_http_info(account_id, attachment_id, envelope_id, **kwargs) + return self.get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) else: - (data) = self.get_attachment_with_http_info(account_id, attachment_id, envelope_id, **kwargs) + (data) = self.get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) return data - def get_attachment_with_http_info(self, account_id, attachment_id, envelope_id, **kwargs): + def get_document_page_image_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): """ - Retrieves an attachment from the envelope. + Gets a page image from an envelope for display. + Retrieves a page image for display from the specified 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_attachment_with_http_info(account_id, attachment_id, envelope_id, callback=callback_function) + >>> thread = api.get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, callback=callback_function) :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 attachment_id: (required) + :param str document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param str page_number: The page number being accessed. (required) + :param str dpi: Sets the dpi for the image. + :param str max_height: Sets the maximum height for the page image in pixels. The dpi is recalculated based on this setting. + :param str max_width: Sets the maximum width for the page image in pixels. The dpi is recalculated based on this setting. + :param str show_changes: + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'attachment_id', 'envelope_id'] + all_params = ['account_id', 'document_id', 'envelope_id', 'page_number', 'dpi', 'max_height', 'max_width', 'show_changes'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6447,33 +6329,46 @@ def get_attachment_with_http_info(self, account_id, attachment_id, envelope_id, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_attachment" % key + " to method get_document_page_image" % 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_attachment`") - # verify the required parameter 'attachment_id' is set - if ('attachment_id' not in params) or (params['attachment_id'] is None): - raise ValueError("Missing the required parameter `attachment_id` when calling `get_attachment`") + raise ValueError("Missing the required parameter `account_id` when calling `get_document_page_image`") + # 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_page_image`") # 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_attachment`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_document_page_image`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_document_page_image`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'attachment_id' in params: - path_params['attachmentId'] = params['attachment_id'] + if 'document_id' in params: + path_params['documentId'] = params['document_id'] if 'envelope_id' in params: path_params['envelopeId'] = params['envelope_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = {} + if 'dpi' in params: + query_params['dpi'] = params['dpi'] + if 'max_height' in params: + query_params['max_height'] = params['max_height'] + if 'max_width' in params: + query_params['max_width'] = params['max_width'] + if 'show_changes' in params: + query_params['show_changes'] = params['show_changes'] header_params = {} @@ -6483,7 +6378,7 @@ def get_attachment_with_http_info(self, account_id, attachment_id, envelope_id, body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['image/png']) # Authentication setting auth_settings = [] @@ -6495,7 +6390,7 @@ def get_attachment_with_http_info(self, account_id, attachment_id, envelope_id, body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6503,53 +6398,59 @@ def get_attachment_with_http_info(self, account_id, attachment_id, envelope_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_attachments(self, account_id, envelope_id, **kwargs): + def get_document_tabs(self, account_id, document_id, envelope_id, **kwargs): """ - Returns a list of attachments associated with the specified envelope + Returns tabs on the document. 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_attachments(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_document_tabs(account_id, document_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EnvelopeAttachmentsResult + :param str include_metadata: + :param str page_numbers: + :return: Tabs If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_attachments_with_http_info(account_id, envelope_id, **kwargs) + return self.get_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.get_attachments_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def get_attachments_with_http_info(self, account_id, envelope_id, **kwargs): + def get_document_tabs_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Returns a list of attachments associated with the specified envelope + Returns tabs on the document. 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_attachments_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_document_tabs_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: The external account number (int) or account ID Guid. (required) + :param str document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EnvelopeAttachmentsResult + :param str include_metadata: + :param str page_numbers: + :return: Tabs If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'document_id', 'envelope_id', 'include_metadata', 'page_numbers'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6560,28 +6461,37 @@ def get_attachments_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_attachments" % key + " to method get_document_tabs" % 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_attachments`") + raise ValueError("Missing the required parameter `account_id` when calling `get_document_tabs`") + # 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_tabs`") # 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_attachments`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_document_tabs`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs'.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_metadata' in params: + query_params['include_metadata'] = params['include_metadata'] + if 'page_numbers' in params: + query_params['page_numbers'] = params['page_numbers'] header_params = {} @@ -6603,7 +6513,7 @@ def get_attachments_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeAttachmentsResult', + response_type='Tabs', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6611,55 +6521,55 @@ def get_attachments_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_chunked_upload(self, account_id, chunked_upload_id, **kwargs): + def get_email_settings(self, account_id, envelope_id, **kwargs): """ - Retrieves the current metadata of a ChunkedUpload. + Gets the email setting overrides for an envelope. + Retrieves the email override settings for the specified 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_chunked_upload(account_id, chunked_upload_id, callback=callback_function) + >>> thread = api.get_email_settings(account_id, envelope_id, callback=callback_function) :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 chunked_upload_id: (required) - :param str include: - :return: ChunkedUploadResponse + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :return: EmailSettings If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) + return self.get_email_settings_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) + (data) = self.get_email_settings_with_http_info(account_id, envelope_id, **kwargs) return data - def get_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwargs): + def get_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): """ - Retrieves the current metadata of a ChunkedUpload. + Gets the email setting overrides for an envelope. + Retrieves the email override settings for the specified 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_chunked_upload_with_http_info(account_id, chunked_upload_id, callback=callback_function) + >>> thread = api.get_email_settings_with_http_info(account_id, envelope_id, callback=callback_function) :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 chunked_upload_id: (required) - :param str include: - :return: ChunkedUploadResponse + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :return: EmailSettings If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'chunked_upload_id', 'include'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6670,30 +6580,28 @@ def get_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwa if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_chunked_upload" % key + " to method get_email_settings" % 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_chunked_upload`") - # verify the required parameter 'chunked_upload_id' is set - if ('chunked_upload_id' not in params) or (params['chunked_upload_id'] is None): - raise ValueError("Missing the required parameter `chunked_upload_id` when calling `get_chunked_upload`") + raise ValueError("Missing the required parameter `account_id` when calling `get_email_settings`") + # 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_email_settings`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'chunked_upload_id' in params: - path_params['chunkedUploadId'] = params['chunked_upload_id'] + if 'envelope_id' in params: + path_params['envelopeId'] = params['envelope_id'] query_params = {} - if 'include' in params: - query_params['include'] = params['include'] header_params = {} @@ -6715,7 +6623,7 @@ def get_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwa body=body_params, post_params=form_params, files=local_var_files, - response_type='ChunkedUploadResponse', + response_type='EmailSettings', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6723,55 +6631,59 @@ def get_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwa _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_comments_transcript(self, account_id, envelope_id, **kwargs): + def get_envelope(self, account_id, envelope_id, **kwargs): """ - Gets comment transcript for envelope and user + Gets the status of a envelope. + Retrieves the overall status for the specified 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_comments_transcript(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_envelope(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str encoding: - :return: file + :param str advanced_update: When true, envelope information can be added or modified. + :param str include: + :return: Envelope If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_comments_transcript_with_http_info(account_id, envelope_id, **kwargs) + return self.get_envelope_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_comments_transcript_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_envelope_with_http_info(account_id, envelope_id, **kwargs) return data - def get_comments_transcript_with_http_info(self, account_id, envelope_id, **kwargs): + def get_envelope_with_http_info(self, account_id, envelope_id, **kwargs): """ - Gets comment transcript for envelope and user + Gets the status of a envelope. + Retrieves the overall status for the specified 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_comments_transcript_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_envelope_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str encoding: - :return: file + :param str advanced_update: When true, envelope information can be added or modified. + :param str include: + :return: Envelope If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'encoding'] + all_params = ['account_id', 'envelope_id', 'advanced_update', 'include'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6782,21 +6694,21 @@ def get_comments_transcript_with_http_info(self, account_id, envelope_id, **kwar if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_comments_transcript" % key + " to method get_envelope" % 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_comments_transcript`") + raise ValueError("Missing the required parameter `account_id` when calling `get_envelope`") # 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_comments_transcript`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelope`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -6804,8 +6716,10 @@ def get_comments_transcript_with_http_info(self, account_id, envelope_id, **kwar path_params['envelopeId'] = params['envelope_id'] query_params = {} - if 'encoding' in params: - query_params['encoding'] = params['encoding'] + if 'advanced_update' in params: + query_params['advanced_update'] = params['advanced_update'] + if 'include' in params: + query_params['include'] = params['include'] header_params = {} @@ -6815,7 +6729,7 @@ def get_comments_transcript_with_http_info(self, account_id, envelope_id, **kwar body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/pdf']) + select_header_accept(['application/json']) # Authentication setting auth_settings = [] @@ -6827,7 +6741,7 @@ def get_comments_transcript_with_http_info(self, account_id, envelope_id, **kwar body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='Envelope', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6835,61 +6749,55 @@ def get_comments_transcript_with_http_info(self, account_id, envelope_id, **kwar _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_consumer_disclosure(self, account_id, envelope_id, lang_code, recipient_id, **kwargs): + def get_envelope_document_html_definitions(self, account_id, document_id, envelope_id, **kwargs): """ - Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. - Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. + Get the Original HTML Definition used to generate the Responsive HTML for a given document. 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_consumer_disclosure(account_id, envelope_id, lang_code, recipient_id, callback=callback_function) + >>> thread = api.get_envelope_document_html_definitions(account_id, document_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (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 recipient_id: The ID of the recipient being accessed. (required) - :param str lang_code2: - :return: ConsumerDisclosure + :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_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, **kwargs) + return self.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.get_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, **kwargs) + (data) = self.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def get_consumer_disclosure_with_http_info(self, account_id, envelope_id, lang_code, recipient_id, **kwargs): + def get_envelope_document_html_definitions_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. - Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. + Get the Original HTML Definition used to generate the Responsive HTML for a given document. 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_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, callback=callback_function) + >>> thread = api.get_envelope_document_html_definitions_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: The external account number (int) or account ID Guid. (required) + :param str document_id: The ID of the document being accessed. (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 recipient_id: The ID of the recipient being accessed. (required) - :param str lang_code2: - :return: ConsumerDisclosure + :return: DocumentHtmlDefinitionOriginals If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'lang_code', 'recipient_id', 'lang_code2'] + all_params = ['account_id', 'document_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6900,40 +6808,33 @@ def get_consumer_disclosure_with_http_info(self, account_id, envelope_id, lang_c if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_consumer_disclosure" % key + " to method get_envelope_document_html_definitions" % 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_consumer_disclosure`") + raise ValueError("Missing the required parameter `account_id` when calling `get_envelope_document_html_definitions`") + # 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_envelope_document_html_definitions`") # 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_consumer_disclosure`") - # verify the required parameter 'lang_code' is set - if ('lang_code' not in params) or (params['lang_code'] is None): - raise ValueError("Missing the required parameter `lang_code` when calling `get_consumer_disclosure`") - # verify the required parameter 'recipient_id' is set - if ('recipient_id' not in params) or (params['recipient_id'] is None): - raise ValueError("Missing the required parameter `recipient_id` when calling `get_consumer_disclosure`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelope_document_html_definitions`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions'.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'] - if 'lang_code' in params: - path_params['langCode'] = params['lang_code'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] query_params = {} - if 'lang_code2' in params: - query_params['langCode'] = params['lang_code2'] header_params = {} @@ -6955,7 +6856,7 @@ def get_consumer_disclosure_with_http_info(self, account_id, envelope_id, lang_c body=body_params, post_params=form_params, files=local_var_files, - response_type='ConsumerDisclosure', + response_type='DocumentHtmlDefinitionOriginals', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6963,59 +6864,53 @@ def get_consumer_disclosure_with_http_info(self, account_id, envelope_id, lang_c _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_consumer_disclosure_default(self, account_id, envelope_id, recipient_id, **kwargs): + def get_envelope_html_definitions(self, account_id, envelope_id, **kwargs): """ - Gets the Electronic Record and Signature Disclosure associated with the account. - Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure. + Get the Original HTML Definition used to generate the Responsive HTML for the 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_consumer_disclosure_default(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.get_envelope_html_definitions(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str lang_code: - :return: ConsumerDisclosure + :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_consumer_disclosure_default_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.get_envelope_html_definitions_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_consumer_disclosure_default_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.get_envelope_html_definitions_with_http_info(account_id, envelope_id, **kwargs) return data - def get_consumer_disclosure_default_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def get_envelope_html_definitions_with_http_info(self, account_id, envelope_id, **kwargs): """ - Gets the Electronic Record and Signature Disclosure associated with the account. - Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure. + Get the Original HTML Definition used to generate the Responsive HTML for the 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_consumer_disclosure_default_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.get_envelope_html_definitions_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str lang_code: - :return: ConsumerDisclosure + :return: DocumentHtmlDefinitionOriginals If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipient_id', 'lang_code'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7026,35 +6921,28 @@ def get_consumer_disclosure_default_with_http_info(self, account_id, envelope_id if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_consumer_disclosure_default" % key + " to method get_envelope_html_definitions" % 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_consumer_disclosure_default`") + raise ValueError("Missing the required parameter `account_id` when calling `get_envelope_html_definitions`") # 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_consumer_disclosure_default`") - # verify the required parameter 'recipient_id' is set - if ('recipient_id' not in params) or (params['recipient_id'] is None): - raise ValueError("Missing the required parameter `recipient_id` when calling `get_consumer_disclosure_default`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelope_html_definitions`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions'.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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] query_params = {} - if 'lang_code' in params: - query_params['langCode'] = params['lang_code'] header_params = {} @@ -7076,7 +6964,7 @@ def get_consumer_disclosure_default_with_http_info(self, account_id, envelope_id body=body_params, post_params=form_params, files=local_var_files, - response_type='ConsumerDisclosure', + response_type='DocumentHtmlDefinitionOriginals', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7084,53 +6972,55 @@ def get_consumer_disclosure_default_with_http_info(self, account_id, envelope_id _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_custom_fields(self, account_id, envelope_id, **kwargs): + def get_envelope_transfer_rules(self, account_id, **kwargs): """ - Return custom fields information for Display Appliance + Returns a list of envelope transfer rules in the specified account. 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_custom_fields(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_envelope_transfer_rules(account_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceInfo + :param str count: + :param str start_position: + :return: EnvelopeTransferRuleInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_custom_fields_with_http_info(account_id, envelope_id, **kwargs) + return self.get_envelope_transfer_rules_with_http_info(account_id, **kwargs) else: - (data) = self.get_custom_fields_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_envelope_transfer_rules_with_http_info(account_id, **kwargs) return data - def get_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): + def get_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): """ - Return custom fields information for Display Appliance + Returns a list of envelope transfer rules in the specified account. 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_custom_fields_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_envelope_transfer_rules_with_http_info(account_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceInfo + :param str count: + :param str start_position: + :return: EnvelopeTransferRuleInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'count', 'start_position'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7141,28 +7031,27 @@ def get_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_custom_fields" % key + " to method get_envelope_transfer_rules" % 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_custom_fields`") - # 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_custom_fields`") + raise ValueError("Missing the required parameter `account_id` when calling `get_envelope_transfer_rules`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/custom_fields'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/transfer_rules'.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 'count' in params: + query_params['count'] = params['count'] + if 'start_position' in params: + query_params['start_position'] = params['start_position'] header_params = {} @@ -7184,7 +7073,7 @@ def get_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='DisplayApplianceInfo', + response_type='EnvelopeTransferRuleInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7192,48 +7081,48 @@ def get_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_date_signed(self, account_id, envelope_id, **kwargs): + def get_envelope_workflow_definition(self, account_id, envelope_id, **kwargs): """ - Gets date signed information for Display Appliance + Returns the workflow definition for 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_date_signed(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_envelope_workflow_definition(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceInfo + :return: Workflow If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_date_signed_with_http_info(account_id, envelope_id, **kwargs) + return self.get_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_date_signed_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) return data - def get_date_signed_with_http_info(self, account_id, envelope_id, **kwargs): + def get_envelope_workflow_definition_with_http_info(self, account_id, envelope_id, **kwargs): """ - Gets date signed information for Display Appliance + Returns the workflow definition for 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_date_signed_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_envelope_workflow_definition_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceInfo + :return: Workflow If the method is called asynchronously, returns the request thread. """ @@ -7249,21 +7138,21 @@ def get_date_signed_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_date_signed" % key + " to method get_envelope_workflow_definition" % 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_date_signed`") + raise ValueError("Missing the required parameter `account_id` when calling `get_envelope_workflow_definition`") # 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_date_signed`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelope_workflow_definition`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/date_signed'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -7292,7 +7181,7 @@ def get_date_signed_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='DisplayApplianceInfo', + response_type='Workflow', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7300,75 +7189,53 @@ def get_date_signed_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document(self, account_id, document_id, envelope_id, **kwargs): + def get_form_data(self, account_id, envelope_id, **kwargs): """ - Gets a document from an envelope. - Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined + Returns envelope form data for an existing 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(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.get_form_data(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str certificate: When set to **false**, the envelope signing certificate is removed from the download. - :param str documents_by_userid: - :param str encoding: - :param str encrypt: When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API. - :param str language: Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). - :param str recipient_id: - :param str shared_user_id: - :param str show_changes: When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. - :param str watermark: When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark. - :return: file + :return: EnvelopeFormData If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.get_form_data_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_document_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.get_form_data_with_http_info(account_id, envelope_id, **kwargs) return data - def get_document_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def get_form_data_with_http_info(self, account_id, envelope_id, **kwargs): """ - Gets a document from an envelope. - Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined + Returns envelope form data for an existing 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_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.get_form_data_with_http_info(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str certificate: When set to **false**, the envelope signing certificate is removed from the download. - :param str documents_by_userid: - :param str encoding: - :param str encrypt: When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API. - :param str language: Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). - :param str recipient_id: - :param str shared_user_id: - :param str show_changes: When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. - :param str watermark: When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark. - :return: file + :return: EnvelopeFormData If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'certificate', 'documents_by_userid', 'encoding', 'encrypt', 'language', 'recipient_id', 'shared_user_id', 'show_changes', 'watermark'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7379,51 +7246,28 @@ def get_document_with_http_info(self, account_id, document_id, envelope_id, **kw if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document" % key + " to method get_form_data" % 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`") - # 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`") + raise ValueError("Missing the required parameter `account_id` when calling `get_form_data`") # 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`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_form_data`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data'.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 'certificate' in params: - query_params['certificate'] = params['certificate'] - if 'documents_by_userid' in params: - query_params['documents_by_userid'] = params['documents_by_userid'] - if 'encoding' in params: - query_params['encoding'] = params['encoding'] - if 'encrypt' in params: - query_params['encrypt'] = params['encrypt'] - if 'language' in params: - query_params['language'] = params['language'] - if 'recipient_id' in params: - query_params['recipient_id'] = params['recipient_id'] - if 'shared_user_id' in params: - query_params['shared_user_id'] = params['shared_user_id'] - if 'show_changes' in params: - query_params['show_changes'] = params['show_changes'] - if 'watermark' in params: - query_params['watermark'] = params['watermark'] header_params = {} @@ -7433,7 +7277,7 @@ def get_document_with_http_info(self, account_id, document_id, envelope_id, **kw body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/pdf']) + select_header_accept(['application/json']) # Authentication setting auth_settings = [] @@ -7445,7 +7289,7 @@ def get_document_with_http_info(self, account_id, document_id, envelope_id, **kw body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='EnvelopeFormData', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7453,67 +7297,55 @@ def get_document_with_http_info(self, account_id, document_id, envelope_id, **kw _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_page_image(self, account_id, document_id, envelope_id, page_number, **kwargs): + def get_lock(self, account_id, envelope_id, **kwargs): """ - Gets a page image from an envelope for display. - Retrieves a page image for display from the specified envelope. + Gets envelope lock information. + Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header. 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_page_image(account_id, document_id, envelope_id, page_number, callback=callback_function) + >>> thread = api.get_lock(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str page_number: The page number being accessed. (required) - :param str dpi: Sets the dpi for the image. - :param str max_height: Sets the maximum height for the page image in pixels. The dpi is recalculated based on this setting. - :param str max_width: Sets the maximum width for the page image in pixels. The dpi is recalculated based on this setting. - :param str show_changes: - :return: file + :return: LockInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + return self.get_lock_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + (data) = self.get_lock_with_http_info(account_id, envelope_id, **kwargs) return data - def get_document_page_image_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): + def get_lock_with_http_info(self, account_id, envelope_id, **kwargs): """ - Gets a page image from an envelope for display. - Retrieves a page image for display from the specified envelope. + Gets envelope lock information. + Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header. 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_page_image_with_http_info(account_id, document_id, envelope_id, page_number, callback=callback_function) + >>> thread = api.get_lock_with_http_info(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str page_number: The page number being accessed. (required) - :param str dpi: Sets the dpi for the image. - :param str max_height: Sets the maximum height for the page image in pixels. The dpi is recalculated based on this setting. - :param str max_width: Sets the maximum width for the page image in pixels. The dpi is recalculated based on this setting. - :param str show_changes: - :return: file + :return: LockInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'page_number', 'dpi', 'max_height', 'max_width', 'show_changes'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7524,46 +7356,28 @@ def get_document_page_image_with_http_info(self, account_id, document_id, envelo if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_page_image" % key + " to method get_lock" % 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_page_image`") - # 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_page_image`") + raise ValueError("Missing the required parameter `account_id` when calling `get_lock`") # 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_page_image`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_document_page_image`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_lock`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock'.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'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = {} - if 'dpi' in params: - query_params['dpi'] = params['dpi'] - if 'max_height' in params: - query_params['max_height'] = params['max_height'] - if 'max_width' in params: - query_params['max_width'] = params['max_width'] - if 'show_changes' in params: - query_params['show_changes'] = params['show_changes'] header_params = {} @@ -7573,7 +7387,7 @@ def get_document_page_image_with_http_info(self, account_id, document_id, envelo body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['image/png']) + select_header_accept(['application/json']) # Authentication setting auth_settings = [] @@ -7585,7 +7399,7 @@ def get_document_page_image_with_http_info(self, account_id, document_id, envelo body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='LockInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7593,48 +7407,50 @@ 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_pages(self, account_id, envelope_id, **kwargs): + def get_notification_settings(self, account_id, envelope_id, **kwargs): """ - Return document pages for Display Appliance + Gets envelope notification information. + Retrieves the envelope notification, reminders and expirations, information for an existing 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_pages(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_notification_settings(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceInfo + :return: Notification If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_pages_with_http_info(account_id, envelope_id, **kwargs) + return self.get_notification_settings_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_document_pages_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_notification_settings_with_http_info(account_id, envelope_id, **kwargs) return data - def get_document_pages_with_http_info(self, account_id, envelope_id, **kwargs): + def get_notification_settings_with_http_info(self, account_id, envelope_id, **kwargs): """ - Return document pages for Display Appliance + Gets envelope notification information. + Retrieves the envelope notification, reminders and expirations, information for an existing 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_pages_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_notification_settings_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceInfo + :return: Notification If the method is called asynchronously, returns the request thread. """ @@ -7650,21 +7466,21 @@ def get_document_pages_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_pages" % key + " to method get_notification_settings" % 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_pages`") + raise ValueError("Missing the required parameter `account_id` when calling `get_notification_settings`") # 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_pages`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_notification_settings`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document_page_list'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -7693,7 +7509,7 @@ def get_document_pages_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='DisplayApplianceInfo', + response_type='Notification', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7701,59 +7517,57 @@ def get_document_pages_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_tabs(self, account_id, document_id, envelope_id, **kwargs): + def get_page_tabs(self, account_id, document_id, envelope_id, page_number, **kwargs): """ - Returns tabs on the document. + Returns tabs on the specified page. 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_tabs(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.get_page_tabs(account_id, document_id, envelope_id, page_number, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str include_metadata: - :param str page_numbers: + :param str page_number: The page number being accessed. (required) :return: Tabs If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.get_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) else: - (data) = self.get_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.get_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) return data - def get_document_tabs_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def get_page_tabs_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): """ - Returns tabs on the document. + Returns tabs on the specified page. 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_tabs_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.get_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str include_metadata: - :param str page_numbers: + :param str page_number: The page number being accessed. (required) :return: Tabs If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'include_metadata', 'page_numbers'] + all_params = ['account_id', 'document_id', 'envelope_id', 'page_number'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7764,24 +7578,27 @@ def get_document_tabs_with_http_info(self, account_id, document_id, envelope_id, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_tabs" % key + " to method get_page_tabs" % 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_tabs`") + raise ValueError("Missing the required parameter `account_id` when calling `get_page_tabs`") # 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_tabs`") + raise ValueError("Missing the required parameter `document_id` when calling `get_page_tabs`") # 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_tabs`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_page_tabs`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_tabs`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -7789,12 +7606,10 @@ def get_document_tabs_with_http_info(self, account_id, document_id, envelope_id, path_params['documentId'] = params['document_id'] if 'envelope_id' in params: path_params['envelopeId'] = params['envelope_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = {} - if 'include_metadata' in params: - query_params['include_metadata'] = params['include_metadata'] - if 'page_numbers' in params: - query_params['page_numbers'] = params['page_numbers'] header_params = {} @@ -7824,51 +7639,69 @@ def get_document_tabs_with_http_info(self, account_id, document_id, envelope_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_dynamic_system_settings(self, account_id, **kwargs): + def get_pages(self, account_id, document_id, envelope_id, **kwargs): """ - Return document pages for Display Appliance + Returns document page image(s) based on input. 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_dynamic_system_settings(account_id, callback=callback_function) + >>> thread = api.get_pages(account_id, document_id, envelope_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :return: DisplayApplianceInfo + :param str document_id: The ID of the document being accessed. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str count: + :param str dpi: + :param str max_height: + :param str max_width: + :param str nocache: + :param str show_changes: + :param str start_position: + :return: PageImages If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_dynamic_system_settings_with_http_info(account_id, **kwargs) + return self.get_pages_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.get_dynamic_system_settings_with_http_info(account_id, **kwargs) + (data) = self.get_pages_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def get_dynamic_system_settings_with_http_info(self, account_id, **kwargs): + def get_pages_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Return document pages for Display Appliance + Returns document page image(s) based on input. 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_dynamic_system_settings_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_pages_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: The external account number (int) or account ID Guid. (required) - :return: DisplayApplianceInfo + :param str document_id: The ID of the document being accessed. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str count: + :param str dpi: + :param str max_height: + :param str max_width: + :param str nocache: + :param str show_changes: + :param str start_position: + :return: PageImages If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id'] + all_params = ['account_id', 'document_id', 'envelope_id', 'count', 'dpi', 'max_height', 'max_width', 'nocache', 'show_changes', 'start_position'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7879,23 +7712,47 @@ def get_dynamic_system_settings_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_dynamic_system_settings" % key + " to method get_pages" % 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_dynamic_system_settings`") + raise ValueError("Missing the required parameter `account_id` when calling `get_pages`") + # 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_pages`") + # 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_pages`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/display_appliance_info/dynamicsystemsettings'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages'.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 'count' in params: + query_params['count'] = params['count'] + if 'dpi' in params: + query_params['dpi'] = params['dpi'] + if 'max_height' in params: + query_params['max_height'] = params['max_height'] + if 'max_width' in params: + query_params['max_width'] = params['max_width'] + if 'nocache' in params: + query_params['nocache'] = params['nocache'] + if 'show_changes' in params: + query_params['show_changes'] = params['show_changes'] + if 'start_position' in params: + query_params['start_position'] = params['start_position'] header_params = {} @@ -7917,7 +7774,7 @@ def get_dynamic_system_settings_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='DisplayApplianceInfo', + response_type='PageImages', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7925,55 +7782,55 @@ def get_dynamic_system_settings_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_email_settings(self, account_id, envelope_id, **kwargs): + def get_recipient_document_visibility(self, account_id, envelope_id, recipient_id, **kwargs): """ - Gets the email setting overrides for an envelope. - Retrieves the email override settings for the specified envelope. + Returns document visibility for the recipients 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_email_settings(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_recipient_document_visibility(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EmailSettings + :param str recipient_id: The ID of the recipient being accessed. (required) + :return: DocumentVisibilityList If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_email_settings_with_http_info(account_id, envelope_id, **kwargs) + return self.get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.get_email_settings_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def get_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): + def get_recipient_document_visibility_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Gets the email setting overrides for an envelope. - Retrieves the email override settings for the specified envelope. + Returns document visibility for the recipients 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_email_settings_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EmailSettings + :param str recipient_id: The ID of the recipient being accessed. (required) + :return: DocumentVisibilityList If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'recipient_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7984,26 +7841,31 @@ def get_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_email_settings" % key + " to method get_recipient_document_visibility" % 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_email_settings`") + raise ValueError("Missing the required parameter `account_id` when calling `get_recipient_document_visibility`") # 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_email_settings`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_recipient_document_visibility`") + # verify the required parameter 'recipient_id' is set + if ('recipient_id' not in params) or (params['recipient_id'] is None): + raise ValueError("Missing the required parameter `recipient_id` when calling `get_recipient_document_visibility`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility'.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'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] query_params = {} @@ -8027,7 +7889,7 @@ def get_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='EmailSettings', + response_type='DocumentVisibilityList', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8035,59 +7897,59 @@ def get_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_envelope(self, account_id, envelope_id, **kwargs): + def get_recipient_initials_image(self, account_id, envelope_id, recipient_id, **kwargs): """ - Gets the status of a envelope. - Retrieves the overall status for the specified envelope. + Gets the initials image for a user. + Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image. 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_envelope(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_recipient_initials_image(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str advanced_update: When true, envelope information can be added or modified. - :param str include: - :return: Envelope + :param str recipient_id: The ID of the recipient being accessed. (required) + :param str include_chrome: The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_envelope_with_http_info(account_id, envelope_id, **kwargs) + return self.get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.get_envelope_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def get_envelope_with_http_info(self, account_id, envelope_id, **kwargs): + def get_recipient_initials_image_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Gets the status of a envelope. - Retrieves the overall status for the specified envelope. + Gets the initials image for a user. + Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image. 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_envelope_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str advanced_update: When true, envelope information can be added or modified. - :param str include: - :return: Envelope + :param str recipient_id: The ID of the recipient being accessed. (required) + :param str include_chrome: The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'advanced_update', 'include'] + all_params = ['account_id', 'envelope_id', 'recipient_id', 'include_chrome'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8098,32 +7960,35 @@ def get_envelope_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_envelope" % key + " to method get_recipient_initials_image" % 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_envelope`") + raise ValueError("Missing the required parameter `account_id` when calling `get_recipient_initials_image`") # 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_envelope`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_recipient_initials_image`") + # verify the required parameter 'recipient_id' is set + if ('recipient_id' not in params) or (params['recipient_id'] is None): + raise ValueError("Missing the required parameter `recipient_id` when calling `get_recipient_initials_image`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image'.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'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] query_params = {} - if 'advanced_update' in params: - query_params['advanced_update'] = params['advanced_update'] - if 'include' in params: - query_params['include'] = params['include'] + if 'include_chrome' in params: + query_params['include_chrome'] = params['include_chrome'] header_params = {} @@ -8133,7 +7998,7 @@ def get_envelope_with_http_info(self, account_id, envelope_id, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['image/gif']) # Authentication setting auth_settings = [] @@ -8145,7 +8010,7 @@ def get_envelope_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='Envelope', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8153,55 +8018,57 @@ def get_envelope_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_envelope_document_html_definitions(self, account_id, document_id, envelope_id, **kwargs): + def get_recipient_signature(self, account_id, envelope_id, recipient_id, **kwargs): """ - Get the Original HTML Definition used to generate the Responsive HTML for a given document. + Gets signature information for a signer or sign-in-person recipient. + Retrieves signature information for a signer or sign-in-person recipient. 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_envelope_document_html_definitions(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.get_recipient_signature(account_id, envelope_id, recipient_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DocumentHtmlDefinitionOriginals + :param str recipient_id: The ID of the recipient being accessed. (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.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.get_recipient_signature_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.get_recipient_signature_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def get_envelope_document_html_definitions_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def get_recipient_signature_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Get the Original HTML Definition used to generate the Responsive HTML for a given document. + Gets signature information for a signer or sign-in-person recipient. + Retrieves signature information for a signer or sign-in-person recipient. 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_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.get_recipient_signature_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DocumentHtmlDefinitionOriginals + :param str recipient_id: The ID of the recipient being accessed. (required) + :return: UserSignature If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'recipient_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8212,31 +8079,31 @@ def get_envelope_document_html_definitions_with_http_info(self, account_id, docu if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_envelope_document_html_definitions" % key + " to method get_recipient_signature" % 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_envelope_document_html_definitions`") - # 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_envelope_document_html_definitions`") + raise ValueError("Missing the required parameter `account_id` when calling `get_recipient_signature`") # 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_envelope_document_html_definitions`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_recipient_signature`") + # verify the required parameter 'recipient_id' is set + if ('recipient_id' not in params) or (params['recipient_id'] is None): + raise ValueError("Missing the required parameter `recipient_id` when calling `get_recipient_signature`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature'.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'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] query_params = {} @@ -8260,7 +8127,7 @@ def get_envelope_document_html_definitions_with_http_info(self, account_id, docu body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentHtmlDefinitionOriginals', + response_type='UserSignature', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8268,53 +8135,59 @@ def get_envelope_document_html_definitions_with_http_info(self, account_id, docu _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_envelope_html_definitions(self, account_id, envelope_id, **kwargs): + def get_recipient_signature_image(self, account_id, envelope_id, recipient_id, **kwargs): """ - Get the Original HTML Definition used to generate the Responsive HTML for the envelope. + Retrieve signature image information for a signer/sign-in-person recipient. + Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. 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_envelope_html_definitions(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_recipient_signature_image(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DocumentHtmlDefinitionOriginals + :param str recipient_id: The ID of the recipient being accessed. (required) + :param str include_chrome: When set to **true**, indicates the chromed version of the signature image should be retrieved. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_envelope_html_definitions_with_http_info(account_id, envelope_id, **kwargs) + return self.get_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.get_envelope_html_definitions_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def get_envelope_html_definitions_with_http_info(self, account_id, envelope_id, **kwargs): + def get_recipient_signature_image_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Get the Original HTML Definition used to generate the Responsive HTML for the envelope. + Retrieve signature image information for a signer/sign-in-person recipient. + Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. 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_envelope_html_definitions_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DocumentHtmlDefinitionOriginals + :param str recipient_id: The ID of the recipient being accessed. (required) + :param str include_chrome: When set to **true**, indicates the chromed version of the signature image should be retrieved. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'recipient_id', 'include_chrome'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8325,28 +8198,35 @@ def get_envelope_html_definitions_with_http_info(self, account_id, envelope_id, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_envelope_html_definitions" % key + " to method get_recipient_signature_image" % 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_envelope_html_definitions`") + raise ValueError("Missing the required parameter `account_id` when calling `get_recipient_signature_image`") # 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_envelope_html_definitions`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_recipient_signature_image`") + # verify the required parameter 'recipient_id' is set + if ('recipient_id' not in params) or (params['recipient_id'] is None): + raise ValueError("Missing the required parameter `recipient_id` when calling `get_recipient_signature_image`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image'.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'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] query_params = {} + if 'include_chrome' in params: + query_params['include_chrome'] = params['include_chrome'] header_params = {} @@ -8356,7 +8236,7 @@ def get_envelope_html_definitions_with_http_info(self, account_id, envelope_id, body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['image/gif']) # Authentication setting auth_settings = [] @@ -8368,7 +8248,7 @@ def get_envelope_html_definitions_with_http_info(self, account_id, envelope_id, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentHtmlDefinitionOriginals', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8376,55 +8256,53 @@ def get_envelope_html_definitions_with_http_info(self, account_id, envelope_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_envelope_transfer_rules(self, account_id, **kwargs): + def get_tabs_blob(self, account_id, envelope_id, **kwargs): """ - Returns a list of envelope transfer rules in the specified account. + Get encrypted tabs for 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_envelope_transfer_rules(account_id, callback=callback_function) + >>> thread = api.get_tabs_blob(account_id, envelope_id, callback=callback_function) :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 count: - :param str start_position: - :return: EnvelopeTransferRuleInformation + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_envelope_transfer_rules_with_http_info(account_id, **kwargs) + return self.get_tabs_blob_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_envelope_transfer_rules_with_http_info(account_id, **kwargs) + (data) = self.get_tabs_blob_with_http_info(account_id, envelope_id, **kwargs) return data - def get_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): + def get_tabs_blob_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns a list of envelope transfer rules in the specified account. + Get encrypted tabs for 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_envelope_transfer_rules_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_tabs_blob_with_http_info(account_id, envelope_id, callback=callback_function) :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 count: - :param str start_position: - :return: EnvelopeTransferRuleInformation + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'count', 'start_position'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8435,27 +8313,28 @@ def get_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_envelope_transfer_rules" % key + " to method get_tabs_blob" % 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_envelope_transfer_rules`") + raise ValueError("Missing the required parameter `account_id` when calling `get_tabs_blob`") + # 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_tabs_blob`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/transfer_rules'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob'.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 'count' in params: - query_params['count'] = params['count'] - if 'start_position' in params: - query_params['start_position'] = params['start_position'] header_params = {} @@ -8477,7 +8356,7 @@ def get_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeTransferRuleInformation', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8485,53 +8364,55 @@ def get_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_envelope_workflow_definition(self, account_id, envelope_id, **kwargs): + def get_template_recipient_document_visibility(self, account_id, recipient_id, template_id, **kwargs): """ - Returns the workflow definition for an envelope. + Returns document visibility for the recipients 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_envelope_workflow_definition(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_template_recipient_document_visibility(account_id, recipient_id, template_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: Workflow + :param str recipient_id: The ID of the recipient being accessed. (required) + :param str template_id: The ID of the template being accessed. (required) + :return: DocumentVisibilityList If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + return self.get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, **kwargs) else: - (data) = self.get_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, **kwargs) return data - def get_envelope_workflow_definition_with_http_info(self, account_id, envelope_id, **kwargs): + def get_template_recipient_document_visibility_with_http_info(self, account_id, recipient_id, template_id, **kwargs): """ - Returns the workflow definition for an envelope. + Returns document visibility for the recipients 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_envelope_workflow_definition_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: Workflow + :param str recipient_id: The ID of the recipient being accessed. (required) + :param str template_id: The ID of the template being accessed. (required) + :return: DocumentVisibilityList If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'recipient_id', 'template_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8542,26 +8423,31 @@ def get_envelope_workflow_definition_with_http_info(self, account_id, envelope_i if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_envelope_workflow_definition" % key + " to method get_template_recipient_document_visibility" % 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_envelope_workflow_definition`") - # 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_envelope_workflow_definition`") + raise ValueError("Missing the required parameter `account_id` when calling `get_template_recipient_document_visibility`") + # verify the required parameter 'recipient_id' is set + if ('recipient_id' not in params) or (params['recipient_id'] is None): + raise ValueError("Missing the required parameter `recipient_id` when calling `get_template_recipient_document_visibility`") + # verify the required parameter 'template_id' is set + if ('template_id' not in params) or (params['template_id'] is None): + raise ValueError("Missing the required parameter `template_id` when calling `get_template_recipient_document_visibility`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility'.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'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] + if 'template_id' in params: + path_params['templateId'] = params['template_id'] query_params = {} @@ -8585,7 +8471,7 @@ def get_envelope_workflow_definition_with_http_info(self, account_id, envelope_i body=body_params, post_params=form_params, files=local_var_files, - response_type='Workflow', + response_type='DocumentVisibilityList', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8593,53 +8479,53 @@ def get_envelope_workflow_definition_with_http_info(self, account_id, envelope_i _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_form_data(self, account_id, envelope_id, **kwargs): + def get_template_workflow_definition(self, account_id, template_id, **kwargs): """ - Returns envelope form data for an existing envelope. + Returns the workflow definition for a template. 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_form_data(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_template_workflow_definition(account_id, template_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EnvelopeFormData + :param str template_id: The ID of the template being accessed. (required) + :return: Workflow If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_form_data_with_http_info(account_id, envelope_id, **kwargs) + return self.get_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) else: - (data) = self.get_form_data_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) return data - def get_form_data_with_http_info(self, account_id, envelope_id, **kwargs): + def get_template_workflow_definition_with_http_info(self, account_id, template_id, **kwargs): """ - Returns envelope form data for an existing envelope. + Returns the workflow definition for a template. 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_form_data_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_template_workflow_definition_with_http_info(account_id, template_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EnvelopeFormData + :param str template_id: The ID of the template being accessed. (required) + :return: Workflow If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'template_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8650,26 +8536,26 @@ def get_form_data_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_form_data" % key + " to method get_template_workflow_definition" % 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_form_data`") - # 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_form_data`") + raise ValueError("Missing the required parameter `account_id` when calling `get_template_workflow_definition`") + # verify the required parameter 'template_id' is set + if ('template_id' not in params) or (params['template_id'] is None): + raise ValueError("Missing the required parameter `template_id` when calling `get_template_workflow_definition`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/workflow'.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'] + if 'template_id' in params: + path_params['templateId'] = params['template_id'] query_params = {} @@ -8693,7 +8579,7 @@ def get_form_data_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeFormData', + response_type='Workflow', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8701,48 +8587,50 @@ def get_form_data_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_image(self, account_id, envelope_id, **kwargs): + def list_audit_events(self, account_id, envelope_id, **kwargs): """ - Returns images for Display Appliance + Gets the envelope audit events for an envelope. + Gets the envelope audit events for the specified 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_image(account_id, envelope_id, callback=callback_function) + >>> thread = api.list_audit_events(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceInfo + :return: EnvelopeAuditEventResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_image_with_http_info(account_id, envelope_id, **kwargs) + return self.list_audit_events_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_image_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.list_audit_events_with_http_info(account_id, envelope_id, **kwargs) return data - def get_image_with_http_info(self, account_id, envelope_id, **kwargs): + def list_audit_events_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns images for Display Appliance + Gets the envelope audit events for an envelope. + Gets the envelope audit events for the specified 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_image_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.list_audit_events_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceInfo + :return: EnvelopeAuditEventResponse If the method is called asynchronously, returns the request thread. """ @@ -8758,21 +8646,21 @@ def get_image_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_image" % key + " to method list_audit_events" % 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_image`") + raise ValueError("Missing the required parameter `account_id` when calling `list_audit_events`") # 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_image`") + raise ValueError("Missing the required parameter `envelope_id` when calling `list_audit_events`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/image'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -8794,14 +8682,14 @@ def get_image_with_http_info(self, account_id, envelope_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'POST', + 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='DisplayApplianceInfo', + response_type='EnvelopeAuditEventResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8809,55 +8697,55 @@ def get_image_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_locale_policy(self, account_id, envelope_id, user_id, **kwargs): + def list_custom_fields(self, account_id, envelope_id, **kwargs): """ - Returns locale policy information for Display Appliance + Gets the custom field information for the specified envelope. + Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list. 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_locale_policy(account_id, envelope_id, user_id, callback=callback_function) + >>> thread = api.list_custom_fields(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope 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) - :return: DisplayApplianceInfo + :return: CustomFieldsEnvelope If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_locale_policy_with_http_info(account_id, envelope_id, user_id, **kwargs) + return self.list_custom_fields_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_locale_policy_with_http_info(account_id, envelope_id, user_id, **kwargs) + (data) = self.list_custom_fields_with_http_info(account_id, envelope_id, **kwargs) return data - def get_locale_policy_with_http_info(self, account_id, envelope_id, user_id, **kwargs): + def list_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns locale policy information for Display Appliance + Gets the custom field information for the specified envelope. + Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list. 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_locale_policy_with_http_info(account_id, envelope_id, user_id, callback=callback_function) + >>> thread = api.list_custom_fields_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope 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) - :return: DisplayApplianceInfo + :return: CustomFieldsEnvelope If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'user_id'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8868,31 +8756,26 @@ def get_locale_policy_with_http_info(self, account_id, envelope_id, user_id, **k if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_locale_policy" % key + " to method list_custom_fields" % 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_locale_policy`") + raise ValueError("Missing the required parameter `account_id` when calling `list_custom_fields`") # 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_locale_policy`") - # 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 `get_locale_policy`") + raise ValueError("Missing the required parameter `envelope_id` when calling `list_custom_fields`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/localepolicy/{userId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields'.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'] - if 'user_id' in params: - path_params['userId'] = params['user_id'] query_params = {} @@ -8909,14 +8792,14 @@ def get_locale_policy_with_http_info(self, account_id, envelope_id, user_id, **k # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'POST', + 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='DisplayApplianceInfo', + response_type='CustomFieldsEnvelope', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8924,55 +8807,57 @@ def get_locale_policy_with_http_info(self, account_id, envelope_id, user_id, **k _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_lock(self, account_id, envelope_id, **kwargs): + def list_document_fields(self, account_id, document_id, envelope_id, **kwargs): """ - Gets envelope lock information. - Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header. + Gets the custom document fields from an existing envelope document. + Retrieves the custom document field information from an existing envelope document. 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_lock(account_id, envelope_id, callback=callback_function) + >>> thread = api.list_document_fields(account_id, document_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: LockInformation + :return: DocumentFieldsInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_lock_with_http_info(account_id, envelope_id, **kwargs) + return self.list_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.get_lock_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.list_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def get_lock_with_http_info(self, account_id, envelope_id, **kwargs): + def list_document_fields_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Gets envelope lock information. - Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header. + Gets the custom document fields from an existing envelope document. + Retrieves the custom document field information from an existing envelope document. 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_lock_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.list_document_fields_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: The external account number (int) or account ID Guid. (required) + :param str document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: LockInformation + :return: DocumentFieldsInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'document_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8983,24 +8868,29 @@ def get_lock_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_lock" % key + " to method list_document_fields" % 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_lock`") + raise ValueError("Missing the required parameter `account_id` when calling `list_document_fields`") + # 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 `list_document_fields`") # 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_lock`") + raise ValueError("Missing the required parameter `envelope_id` when calling `list_document_fields`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields'.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'] @@ -9026,7 +8916,7 @@ def get_lock_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='LockInformation', + response_type='DocumentFieldsInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9034,55 +8924,67 @@ def get_lock_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_notification_settings(self, account_id, envelope_id, **kwargs): + def list_documents(self, account_id, envelope_id, **kwargs): """ - Gets envelope notification information. - Retrieves the envelope notification, reminders and expirations, information for an existing envelope. + Gets a list of envelope documents. + Retrieves a list of documents associated with the specified 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_notification_settings(account_id, envelope_id, callback=callback_function) + >>> thread = api.list_documents(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: Notification + :param str documents_by_userid: + :param str include_document_size: + :param str include_metadata: + :param str include_tabs: + :param str recipient_id: + :param str shared_user_id: + :return: EnvelopeDocumentsResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_notification_settings_with_http_info(account_id, envelope_id, **kwargs) + return self.list_documents_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_notification_settings_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.list_documents_with_http_info(account_id, envelope_id, **kwargs) return data - def get_notification_settings_with_http_info(self, account_id, envelope_id, **kwargs): + def list_documents_with_http_info(self, account_id, envelope_id, **kwargs): """ - Gets envelope notification information. - Retrieves the envelope notification, reminders and expirations, information for an existing envelope. + Gets a list of envelope documents. + Retrieves a list of documents associated with the specified 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_notification_settings_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.list_documents_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: Notification + :param str documents_by_userid: + :param str include_document_size: + :param str include_metadata: + :param str include_tabs: + :param str recipient_id: + :param str shared_user_id: + :return: EnvelopeDocumentsResult If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'documents_by_userid', 'include_document_size', 'include_metadata', 'include_tabs', 'recipient_id', 'shared_user_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9093,21 +8995,21 @@ def get_notification_settings_with_http_info(self, account_id, envelope_id, **kw if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_notification_settings" % key + " to method list_documents" % 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_notification_settings`") + raise ValueError("Missing the required parameter `account_id` when calling `list_documents`") # 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_notification_settings`") + raise ValueError("Missing the required parameter `envelope_id` when calling `list_documents`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -9115,6 +9017,18 @@ def get_notification_settings_with_http_info(self, account_id, envelope_id, **kw path_params['envelopeId'] = params['envelope_id'] query_params = {} + if 'documents_by_userid' in params: + query_params['documents_by_userid'] = params['documents_by_userid'] + if 'include_document_size' in params: + query_params['include_document_size'] = params['include_document_size'] + if 'include_metadata' in params: + query_params['include_metadata'] = params['include_metadata'] + if 'include_tabs' in params: + query_params['include_tabs'] = params['include_tabs'] + if 'recipient_id' in params: + query_params['recipient_id'] = params['recipient_id'] + if 'shared_user_id' in params: + query_params['shared_user_id'] = params['shared_user_id'] header_params = {} @@ -9136,7 +9050,7 @@ def get_notification_settings_with_http_info(self, account_id, envelope_id, **kw body=body_params, post_params=form_params, files=local_var_files, - response_type='Notification', + response_type='EnvelopeDocumentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9144,57 +9058,63 @@ def get_notification_settings_with_http_info(self, account_id, envelope_id, **kw _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_tabs(self, account_id, document_id, envelope_id, page_number, **kwargs): + def list_recipients(self, account_id, envelope_id, **kwargs): """ - Returns tabs on the specified page. + Gets the status of recipients for an envelope. + Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. 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_page_tabs(account_id, document_id, envelope_id, page_number, callback=callback_function) + >>> thread = api.list_recipients(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str page_number: The page number being accessed. (required) - :return: Tabs + :param str include_anchor_tab_locations: When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. + :param str include_extended: When set to **true**, the extended properties are included in the response. + :param str include_metadata: + :param str include_tabs: When set to **true**, the tab information associated with the recipient is included in the response. + :return: Recipients If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + return self.list_recipients_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + (data) = self.list_recipients_with_http_info(account_id, envelope_id, **kwargs) return data - def get_page_tabs_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): + def list_recipients_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns tabs on the specified page. + Gets the status of recipients for an envelope. + Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. 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_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number, callback=callback_function) + >>> thread = api.list_recipients_with_http_info(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str page_number: The page number being accessed. (required) - :return: Tabs + :param str include_anchor_tab_locations: When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. + :param str include_extended: When set to **true**, the extended properties are included in the response. + :param str include_metadata: + :param str include_tabs: When set to **true**, the tab information associated with the recipient is included in the response. + :return: Recipients If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'page_number'] + all_params = ['account_id', 'envelope_id', 'include_anchor_tab_locations', 'include_extended', 'include_metadata', 'include_tabs'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9205,38 +9125,36 @@ def get_page_tabs_with_http_info(self, account_id, document_id, envelope_id, pag if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_tabs" % key + " to method list_recipients" % 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_page_tabs`") - # 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_page_tabs`") + raise ValueError("Missing the required parameter `account_id` when calling `list_recipients`") # 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_page_tabs`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_tabs`") + raise ValueError("Missing the required parameter `envelope_id` when calling `list_recipients`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients'.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'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = {} + if 'include_anchor_tab_locations' in params: + query_params['include_anchor_tab_locations'] = params['include_anchor_tab_locations'] + if 'include_extended' in params: + query_params['include_extended'] = params['include_extended'] + if 'include_metadata' in params: + query_params['include_metadata'] = params['include_metadata'] + if 'include_tabs' in params: + query_params['include_tabs'] = params['include_tabs'] header_params = {} @@ -9258,7 +9176,7 @@ def get_page_tabs_with_http_info(self, account_id, document_id, envelope_id, pag body=body_params, post_params=form_params, files=local_var_files, - response_type='Tabs', + response_type='Recipients', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9266,69 +9184,79 @@ def get_page_tabs_with_http_info(self, account_id, document_id, envelope_id, pag _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pages(self, account_id, document_id, envelope_id, **kwargs): + def list_status(self, account_id, **kwargs): """ - Returns document page image(s) based on input. + Gets the envelope status for the specified envelopes. + Retrieves the envelope status for the specified envelopes. 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_pages(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.list_status(account_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str ac_status: + :param str block: :param str count: - :param str dpi: - :param str max_height: - :param str max_width: - :param str nocache: - :param str show_changes: + :param str email: + :param str envelope_ids: + :param str from_date: + :param str from_to_status: :param str start_position: - :return: PageImages + :param str status: + :param str to_date: + :param str transaction_ids: + :param str user_name: + :param EnvelopeIdsRequest envelope_ids_request: + :return: EnvelopesInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pages_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.list_status_with_http_info(account_id, **kwargs) else: - (data) = self.get_pages_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.list_status_with_http_info(account_id, **kwargs) return data - def get_pages_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def list_status_with_http_info(self, account_id, **kwargs): """ - Returns document page image(s) based on input. + Gets the envelope status for the specified envelopes. + Retrieves the envelope status for the specified envelopes. 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_pages_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.list_status_with_http_info(account_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str ac_status: + :param str block: :param str count: - :param str dpi: - :param str max_height: - :param str max_width: - :param str nocache: - :param str show_changes: + :param str email: + :param str envelope_ids: + :param str from_date: + :param str from_to_status: :param str start_position: - :return: PageImages + :param str status: + :param str to_date: + :param str transaction_ids: + :param str user_name: + :param EnvelopeIdsRequest envelope_ids_request: + :return: EnvelopesInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'count', 'dpi', 'max_height', 'max_width', 'nocache', 'show_changes', 'start_position'] + all_params = ['account_id', 'ac_status', 'block', 'count', 'email', 'envelope_ids', 'from_date', 'from_to_status', 'start_position', 'status', 'to_date', 'transaction_ids', 'user_name', 'envelope_ids_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9339,54 +9267,56 @@ def get_pages_with_http_info(self, account_id, document_id, envelope_id, **kwarg if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pages" % key + " to method list_status" % 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_pages`") - # 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_pages`") - # 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_pages`") + raise ValueError("Missing the required parameter `account_id` when calling `list_status`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/status'.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 'ac_status' in params: + query_params['ac_status'] = params['ac_status'] + if 'block' in params: + query_params['block'] = params['block'] if 'count' in params: query_params['count'] = params['count'] - if 'dpi' in params: - query_params['dpi'] = params['dpi'] - if 'max_height' in params: - query_params['max_height'] = params['max_height'] - if 'max_width' in params: - query_params['max_width'] = params['max_width'] - if 'nocache' in params: - query_params['nocache'] = params['nocache'] - if 'show_changes' in params: - query_params['show_changes'] = params['show_changes'] + if 'email' in params: + query_params['email'] = params['email'] + if 'envelope_ids' in params: + query_params['envelope_ids'] = params['envelope_ids'] + if 'from_date' in params: + query_params['from_date'] = params['from_date'] + if 'from_to_status' in params: + query_params['from_to_status'] = params['from_to_status'] if 'start_position' in params: query_params['start_position'] = params['start_position'] - + if 'status' in params: + query_params['status'] = params['status'] + if 'to_date' in params: + query_params['to_date'] = params['to_date'] + if 'transaction_ids' in params: + query_params['transaction_ids'] = params['transaction_ids'] + if 'user_name' in params: + query_params['user_name'] = params['user_name'] + header_params = {} form_params = [] local_var_files = {} body_params = None + if 'envelope_ids_request' in params: + body_params = params['envelope_ids_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -9394,14 +9324,14 @@ def get_pages_with_http_info(self, account_id, document_id, envelope_id, **kwarg # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + return self.api_client.call_api(resource_path, 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PageImages', + response_type='EnvelopesInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9409,55 +9339,113 @@ def get_pages_with_http_info(self, account_id, document_id, envelope_id, **kwarg _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf(self, account_id, envelope_id, pdf_id, **kwargs): + def list_status_changes(self, account_id, **kwargs): """ - Return pdf for Display Appliance + Gets status changes for one or more envelopes. + Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for \"any status change\" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of \"`Created`,`Sent`\", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier. 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_pdf(account_id, envelope_id, pdf_id, callback=callback_function) + >>> thread = api.list_status_changes(account_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str pdf_id: (required) - :return: DisplayAppliancePdf + :param str ac_status: Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed. + :param str block: + :param str cdse_mode: + :param str continuation_token: + :param str count: + :param str custom_field: This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \"Region\" and you want to search for all envelopes where the value is \"West\" you would use the query: `?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of \"DocuSign\" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is \"DocuSign for Salesforce\" or \"DocuSign envelope.\" + :param str email: + :param str envelope_ids: + :param str exclude: + :param str folder_ids: + :param str folder_types: + :param str from_date: The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used. + :param str from_to_status: This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. + :param str include: + :param str include_purge_information: + :param str intersecting_folder_ids: + :param str last_queried_date: + :param str order: + :param str order_by: + :param str powerformids: + :param str query_budget: + :param str requester_date_format: + :param str search_text: + :param str start_position: + :param str status: The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. + :param str to_date: Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the `to_date`. + :param str transaction_ids: If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days. + :param str user_filter: + :param str user_id: + :param str user_name: + :return: EnvelopesInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_with_http_info(account_id, envelope_id, pdf_id, **kwargs) + return self.list_status_changes_with_http_info(account_id, **kwargs) else: - (data) = self.get_pdf_with_http_info(account_id, envelope_id, pdf_id, **kwargs) + (data) = self.list_status_changes_with_http_info(account_id, **kwargs) return data - def get_pdf_with_http_info(self, account_id, envelope_id, pdf_id, **kwargs): + def list_status_changes_with_http_info(self, account_id, **kwargs): """ - Return pdf for Display Appliance + Gets status changes for one or more envelopes. + Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for \"any status change\" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of \"`Created`,`Sent`\", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier. 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_pdf_with_http_info(account_id, envelope_id, pdf_id, callback=callback_function) + >>> thread = api.list_status_changes_with_http_info(account_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str pdf_id: (required) - :return: DisplayAppliancePdf + :param str ac_status: Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed. + :param str block: + :param str cdse_mode: + :param str continuation_token: + :param str count: + :param str custom_field: This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \"Region\" and you want to search for all envelopes where the value is \"West\" you would use the query: `?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of \"DocuSign\" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is \"DocuSign for Salesforce\" or \"DocuSign envelope.\" + :param str email: + :param str envelope_ids: + :param str exclude: + :param str folder_ids: + :param str folder_types: + :param str from_date: The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used. + :param str from_to_status: This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. + :param str include: + :param str include_purge_information: + :param str intersecting_folder_ids: + :param str last_queried_date: + :param str order: + :param str order_by: + :param str powerformids: + :param str query_budget: + :param str requester_date_format: + :param str search_text: + :param str start_position: + :param str status: The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. + :param str to_date: Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the `to_date`. + :param str transaction_ids: If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days. + :param str user_filter: + :param str user_id: + :param str user_name: + :return: EnvelopesInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'pdf_id'] + all_params = ['account_id', 'ac_status', 'block', 'cdse_mode', 'continuation_token', 'count', 'custom_field', 'email', 'envelope_ids', 'exclude', 'folder_ids', 'folder_types', 'from_date', 'from_to_status', 'include', 'include_purge_information', 'intersecting_folder_ids', 'last_queried_date', 'order', 'order_by', 'powerformids', 'query_budget', 'requester_date_format', 'search_text', 'start_position', 'status', 'to_date', 'transaction_ids', 'user_filter', 'user_id', 'user_name'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9468,33 +9456,83 @@ def get_pdf_with_http_info(self, account_id, envelope_id, pdf_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf" % key + " to method list_status_changes" % 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_pdf`") - # 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_pdf`") - # verify the required parameter 'pdf_id' is set - if ('pdf_id' not in params) or (params['pdf_id'] is None): - raise ValueError("Missing the required parameter `pdf_id` when calling `get_pdf`") + raise ValueError("Missing the required parameter `account_id` when calling `list_status_changes`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf/{pdfId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes'.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'] - if 'pdf_id' in params: - path_params['pdfId'] = params['pdf_id'] query_params = {} + if 'ac_status' in params: + query_params['ac_status'] = params['ac_status'] + if 'block' in params: + query_params['block'] = params['block'] + if 'cdse_mode' in params: + query_params['cdse_mode'] = params['cdse_mode'] + if 'continuation_token' in params: + query_params['continuation_token'] = params['continuation_token'] + if 'count' in params: + query_params['count'] = params['count'] + if 'custom_field' in params: + query_params['custom_field'] = params['custom_field'] + if 'email' in params: + query_params['email'] = params['email'] + if 'envelope_ids' in params: + query_params['envelope_ids'] = params['envelope_ids'] + if 'exclude' in params: + query_params['exclude'] = params['exclude'] + if 'folder_ids' in params: + query_params['folder_ids'] = params['folder_ids'] + if 'folder_types' in params: + query_params['folder_types'] = params['folder_types'] + if 'from_date' in params: + query_params['from_date'] = params['from_date'] + if 'from_to_status' in params: + query_params['from_to_status'] = params['from_to_status'] + if 'include' in params: + query_params['include'] = params['include'] + if 'include_purge_information' in params: + query_params['include_purge_information'] = params['include_purge_information'] + if 'intersecting_folder_ids' in params: + query_params['intersecting_folder_ids'] = params['intersecting_folder_ids'] + if 'last_queried_date' in params: + query_params['last_queried_date'] = params['last_queried_date'] + if 'order' in params: + query_params['order'] = params['order'] + if 'order_by' in params: + query_params['order_by'] = params['order_by'] + if 'powerformids' in params: + query_params['powerformids'] = params['powerformids'] + if 'query_budget' in params: + query_params['query_budget'] = params['query_budget'] + if 'requester_date_format' in params: + query_params['requester_date_format'] = params['requester_date_format'] + if 'search_text' in params: + query_params['search_text'] = params['search_text'] + if 'start_position' in params: + query_params['start_position'] = params['start_position'] + if 'status' in params: + query_params['status'] = params['status'] + if 'to_date' in params: + query_params['to_date'] = params['to_date'] + if 'transaction_ids' in params: + query_params['transaction_ids'] = params['transaction_ids'] + if 'user_filter' in params: + query_params['user_filter'] = params['user_filter'] + if 'user_id' in params: + query_params['user_id'] = params['user_id'] + if 'user_name' in params: + query_params['user_name'] = params['user_name'] header_params = {} @@ -9516,7 +9554,7 @@ def get_pdf_with_http_info(self, account_id, envelope_id, pdf_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='DisplayAppliancePdf', + response_type='EnvelopesInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9524,53 +9562,61 @@ def get_pdf_with_http_info(self, account_id, envelope_id, pdf_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_blob(self, account_id, envelope_id, **kwargs): + def list_tabs(self, account_id, envelope_id, recipient_id, **kwargs): """ - Return pdf blobs for Display Appliance + Gets the tabs information for a signer or sign-in-person recipient in an envelope. + Retrieves information about the tabs associated with a recipient in a draft 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_pdf_blob(account_id, envelope_id, callback=callback_function) + >>> thread = api.list_tabs(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayAppliancePdf + :param str recipient_id: The ID of the recipient being accessed. (required) + :param str include_anchor_tab_locations: When set to **true**, all tabs with anchor tab properties are included in the response. + :param str include_metadata: + :return: Tabs If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) + return self.list_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.get_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.list_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def get_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): + def list_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Return pdf blobs for Display Appliance + Gets the tabs information for a signer or sign-in-person recipient in an envelope. + Retrieves information about the tabs associated with a recipient in a draft 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_pdf_blob_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.list_tabs_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayAppliancePdf + :param str recipient_id: The ID of the recipient being accessed. (required) + :param str include_anchor_tab_locations: When set to **true**, all tabs with anchor tab properties are included in the response. + :param str include_metadata: + :return: Tabs If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'recipient_id', 'include_anchor_tab_locations', 'include_metadata'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9581,28 +9627,37 @@ def get_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_blob" % key + " to method list_tabs" % 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_pdf_blob`") + raise ValueError("Missing the required parameter `account_id` when calling `list_tabs`") # 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_pdf_blob`") + raise ValueError("Missing the required parameter `envelope_id` when calling `list_tabs`") + # verify the required parameter 'recipient_id' is set + if ('recipient_id' not in params) or (params['recipient_id'] is None): + raise ValueError("Missing the required parameter `recipient_id` when calling `list_tabs`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs'.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'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] query_params = {} + if 'include_anchor_tab_locations' in params: + query_params['include_anchor_tab_locations'] = params['include_anchor_tab_locations'] + if 'include_metadata' in params: + query_params['include_metadata'] = params['include_metadata'] header_params = {} @@ -9624,7 +9679,7 @@ def get_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='DisplayAppliancePdf', + response_type='Tabs', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9632,55 +9687,57 @@ def get_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_recipient_document_visibility(self, account_id, envelope_id, recipient_id, **kwargs): + def list_templates(self, account_id, envelope_id, **kwargs): """ - Returns document visibility for the recipients + Get List of Templates used in an Envelope + This returns a list of the server-side templates, their name and ID, used 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_recipient_document_visibility(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.list_templates(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :return: DocumentVisibilityList + :param str include: The possible values are: matching_applied - This returns template matching information for the template. + :return: TemplateInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.list_templates_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.list_templates_with_http_info(account_id, envelope_id, **kwargs) return data - def get_recipient_document_visibility_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def list_templates_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns document visibility for the recipients + Get List of Templates used in an Envelope + This returns a list of the server-side templates, their name and ID, used 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_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.list_templates_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :return: DocumentVisibilityList + :param str include: The possible values are: matching_applied - This returns template matching information for the template. + :return: TemplateInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipient_id'] + all_params = ['account_id', 'envelope_id', 'include'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9691,33 +9748,30 @@ def get_recipient_document_visibility_with_http_info(self, account_id, envelope_ if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_recipient_document_visibility" % key + " to method list_templates" % 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_recipient_document_visibility`") + raise ValueError("Missing the required parameter `account_id` when calling `list_templates`") # 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_recipient_document_visibility`") - # verify the required parameter 'recipient_id' is set - if ('recipient_id' not in params) or (params['recipient_id'] is None): - raise ValueError("Missing the required parameter `recipient_id` when calling `get_recipient_document_visibility`") + raise ValueError("Missing the required parameter `envelope_id` when calling `list_templates`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates'.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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] query_params = {} + if 'include' in params: + query_params['include'] = params['include'] header_params = {} @@ -9739,7 +9793,7 @@ def get_recipient_document_visibility_with_http_info(self, account_id, envelope_ body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentVisibilityList', + response_type='TemplateInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9747,2654 +9801,59 @@ def get_recipient_document_visibility_with_http_info(self, account_id, envelope_ _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_recipient_initials_image(self, account_id, envelope_id, recipient_id, **kwargs): + def list_templates_for_document(self, account_id, document_id, envelope_id, **kwargs): """ - Gets the initials image for a user. - Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image. + Gets the templates associated with a document in an existing envelope. + Retrieves the templates associated with a document in the specified 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_recipient_initials_image(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.list_templates_for_document(account_id, document_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str include_chrome: The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. - :return: file + :param str include: + :return: TemplateInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.list_templates_for_document_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.list_templates_for_document_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def get_recipient_initials_image_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): - """ - Gets the initials image for a user. - Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image. - 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_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str include_chrome: The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. - :return: file - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'recipient_id', 'include_chrome'] - 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_recipient_initials_image" % 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_recipient_initials_image`") - # 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_recipient_initials_image`") - # verify the required parameter 'recipient_id' is set - if ('recipient_id' not in params) or (params['recipient_id'] is None): - raise ValueError("Missing the required parameter `recipient_id` when calling `get_recipient_initials_image`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image'.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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] - - query_params = {} - if 'include_chrome' in params: - query_params['include_chrome'] = params['include_chrome'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['image/gif']) - - # 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='file', - 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_recipient_signature(self, account_id, envelope_id, recipient_id, **kwargs): - """ - Gets signature information for a signer or sign-in-person recipient. - Retrieves signature information for a signer or sign-in-person recipient. - 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_recipient_signature(account_id, envelope_id, recipient_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (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.get_recipient_signature_with_http_info(account_id, envelope_id, recipient_id, **kwargs) - else: - (data) = self.get_recipient_signature_with_http_info(account_id, envelope_id, recipient_id, **kwargs) - return data - - def get_recipient_signature_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): - """ - Gets signature information for a signer or sign-in-person recipient. - Retrieves signature information for a signer or sign-in-person recipient. - 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_recipient_signature_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :return: UserSignature - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'recipient_id'] - 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_recipient_signature" % 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_recipient_signature`") - # 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_recipient_signature`") - # verify the required parameter 'recipient_id' is set - if ('recipient_id' not in params) or (params['recipient_id'] is None): - raise ValueError("Missing the required parameter `recipient_id` when calling `get_recipient_signature`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature'.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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] - - query_params = {} - - 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='UserSignature', - 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_recipient_signature_image(self, account_id, envelope_id, recipient_id, **kwargs): - """ - Retrieve signature image information for a signer/sign-in-person recipient. - Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. - 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_recipient_signature_image(account_id, envelope_id, recipient_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str include_chrome: When set to **true**, indicates the chromed version of the signature image should be retrieved. - :return: file - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) - else: - (data) = self.get_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) - return data - - def get_recipient_signature_image_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): - """ - Retrieve signature image information for a signer/sign-in-person recipient. - Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. - 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_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str include_chrome: When set to **true**, indicates the chromed version of the signature image should be retrieved. - :return: file - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'recipient_id', 'include_chrome'] - 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_recipient_signature_image" % 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_recipient_signature_image`") - # 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_recipient_signature_image`") - # verify the required parameter 'recipient_id' is set - if ('recipient_id' not in params) or (params['recipient_id'] is None): - raise ValueError("Missing the required parameter `recipient_id` when calling `get_recipient_signature_image`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image'.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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] - - query_params = {} - if 'include_chrome' in params: - query_params['include_chrome'] = params['include_chrome'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['image/gif']) - - # 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='file', - 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_signer_attachment(self, account_id, envelope_id, **kwargs): - """ - Return signer attachment information for Display Appliance - 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_signer_attachment(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceSignerAttachment - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_signer_attachment_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.get_signer_attachment_with_http_info(account_id, envelope_id, **kwargs) - return data - - def get_signer_attachment_with_http_info(self, account_id, envelope_id, **kwargs): - """ - Return signer attachment information for Display Appliance - 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_signer_attachment_with_http_info(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayApplianceSignerAttachment - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id'] - 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_signer_attachment" % 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_signer_attachment`") - # 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_signer_attachment`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/signer_attachment_info'.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 = {} - - 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='DisplayApplianceSignerAttachment', - 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. - 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_tabs_blob(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_tabs_blob_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.get_tabs_blob_with_http_info(account_id, envelope_id, **kwargs) - return data - - def get_tabs_blob_with_http_info(self, account_id, envelope_id, **kwargs): - """ - Get encrypted tabs for 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_tabs_blob_with_http_info(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id'] - 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_tabs_blob" % 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_tabs_blob`") - # 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_tabs_blob`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob'.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 = {} - - 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=None, - 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_template_info(self, account_id, **kwargs): - """ - Returns if template was encrypted by Display Appliance - 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_template_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :return: DisplayApplianceInfo - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_template_info_with_http_info(account_id, **kwargs) - else: - (data) = self.get_template_info_with_http_info(account_id, **kwargs) - return data - - def get_template_info_with_http_info(self, account_id, **kwargs): - """ - Returns if template was encrypted by Display Appliance - 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_template_info_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :return: DisplayApplianceInfo - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id'] - 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_template_info" % 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_template_info`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/display_appliance_info/templateInfo'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - - query_params = {} - - 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, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DisplayApplianceInfo', - 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_template_recipient_document_visibility(self, account_id, recipient_id, template_id, **kwargs): - """ - Returns document visibility for the recipients - 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_template_recipient_document_visibility(account_id, recipient_id, template_id, callback=callback_function) - - :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 recipient_id: The ID of the recipient being accessed. (required) - :param str template_id: The ID of the template being accessed. (required) - :return: DocumentVisibilityList - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, **kwargs) - else: - (data) = self.get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, **kwargs) - return data - - def get_template_recipient_document_visibility_with_http_info(self, account_id, recipient_id, template_id, **kwargs): - """ - Returns document visibility for the recipients - 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_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, callback=callback_function) - - :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 recipient_id: The ID of the recipient being accessed. (required) - :param str template_id: The ID of the template being accessed. (required) - :return: DocumentVisibilityList - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'recipient_id', 'template_id'] - 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_template_recipient_document_visibility" % 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_template_recipient_document_visibility`") - # verify the required parameter 'recipient_id' is set - if ('recipient_id' not in params) or (params['recipient_id'] is None): - raise ValueError("Missing the required parameter `recipient_id` when calling `get_template_recipient_document_visibility`") - # verify the required parameter 'template_id' is set - if ('template_id' not in params) or (params['template_id'] is None): - raise ValueError("Missing the required parameter `template_id` when calling `get_template_recipient_document_visibility`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] - if 'template_id' in params: - path_params['templateId'] = params['template_id'] - - query_params = {} - - 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='DocumentVisibilityList', - 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_template_workflow_definition(self, account_id, template_id, **kwargs): - """ - Returns the workflow definition for a template. - 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_template_workflow_definition(account_id, template_id, callback=callback_function) - - :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 template_id: The ID of the template being accessed. (required) - :return: Workflow - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) - else: - (data) = self.get_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) - return data - - def get_template_workflow_definition_with_http_info(self, account_id, template_id, **kwargs): - """ - Returns the workflow definition for a template. - 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_template_workflow_definition_with_http_info(account_id, template_id, callback=callback_function) - - :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 template_id: The ID of the template being accessed. (required) - :return: Workflow - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'template_id'] - 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_template_workflow_definition" % 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_template_workflow_definition`") - # verify the required parameter 'template_id' is set - if ('template_id' not in params) or (params['template_id'] is None): - raise ValueError("Missing the required parameter `template_id` when calling `get_template_workflow_definition`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/workflow'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - if 'template_id' in params: - path_params['templateId'] = params['template_id'] - - query_params = {} - - 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='Workflow', - 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 list_audit_events(self, account_id, envelope_id, **kwargs): - """ - Gets the envelope audit events for an envelope. - Gets the envelope audit events for the specified 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.list_audit_events(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EnvelopeAuditEventResponse - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.list_audit_events_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.list_audit_events_with_http_info(account_id, envelope_id, **kwargs) - return data - - def list_audit_events_with_http_info(self, account_id, envelope_id, **kwargs): - """ - Gets the envelope audit events for an envelope. - Gets the envelope audit events for the specified 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.list_audit_events_with_http_info(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EnvelopeAuditEventResponse - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id'] - 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 list_audit_events" % 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 `list_audit_events`") - # 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 `list_audit_events`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events'.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 = {} - - 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='EnvelopeAuditEventResponse', - 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 list_custom_fields(self, account_id, envelope_id, **kwargs): - """ - Gets the custom field information for the specified envelope. - Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list. - 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.list_custom_fields(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: CustomFieldsEnvelope - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.list_custom_fields_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.list_custom_fields_with_http_info(account_id, envelope_id, **kwargs) - return data - - def list_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): - """ - Gets the custom field information for the specified envelope. - Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list. - 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.list_custom_fields_with_http_info(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: CustomFieldsEnvelope - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id'] - 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 list_custom_fields" % 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 `list_custom_fields`") - # 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 `list_custom_fields`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields'.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 = {} - - 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='CustomFieldsEnvelope', - 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 list_document_fields(self, account_id, document_id, envelope_id, **kwargs): - """ - Gets the custom document fields from an existing envelope document. - Retrieves the custom document field information from an existing envelope document. - 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.list_document_fields(account_id, document_id, envelope_id, callback=callback_function) - - :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 document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DocumentFieldsInformation - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.list_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) - else: - (data) = self.list_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) - return data - - def list_document_fields_with_http_info(self, account_id, document_id, envelope_id, **kwargs): - """ - Gets the custom document fields from an existing envelope document. - Retrieves the custom document field information from an existing envelope document. - 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.list_document_fields_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: The external account number (int) or account ID Guid. (required) - :param str document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DocumentFieldsInformation - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'document_id', 'envelope_id'] - 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 list_document_fields" % 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 `list_document_fields`") - # 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 `list_document_fields`") - # 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 `list_document_fields`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields'.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 = {} - - 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='DocumentFieldsInformation', - 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 list_documents(self, account_id, envelope_id, **kwargs): - """ - Gets a list of envelope documents. - Retrieves a list of documents associated with the specified 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.list_documents(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str documents_by_userid: - :param str include_document_size: - :param str include_metadata: - :param str include_tabs: - :param str recipient_id: - :param str shared_user_id: - :return: EnvelopeDocumentsResult - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.list_documents_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.list_documents_with_http_info(account_id, envelope_id, **kwargs) - return data - - def list_documents_with_http_info(self, account_id, envelope_id, **kwargs): - """ - Gets a list of envelope documents. - Retrieves a list of documents associated with the specified 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.list_documents_with_http_info(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str documents_by_userid: - :param str include_document_size: - :param str include_metadata: - :param str include_tabs: - :param str recipient_id: - :param str shared_user_id: - :return: EnvelopeDocumentsResult - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'documents_by_userid', 'include_document_size', 'include_metadata', 'include_tabs', 'recipient_id', 'shared_user_id'] - 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 list_documents" % 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 `list_documents`") - # 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 `list_documents`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents'.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 'documents_by_userid' in params: - query_params['documents_by_userid'] = params['documents_by_userid'] - if 'include_document_size' in params: - query_params['include_document_size'] = params['include_document_size'] - if 'include_metadata' in params: - query_params['include_metadata'] = params['include_metadata'] - if 'include_tabs' in params: - query_params['include_tabs'] = params['include_tabs'] - if 'recipient_id' in params: - query_params['recipient_id'] = params['recipient_id'] - if 'shared_user_id' in params: - query_params['shared_user_id'] = params['shared_user_id'] - - 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='EnvelopeDocumentsResult', - 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 list_recipients(self, account_id, envelope_id, **kwargs): - """ - Gets the status of recipients for an envelope. - Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. - 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.list_recipients(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str include_anchor_tab_locations: When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. - :param str include_extended: When set to **true**, the extended properties are included in the response. - :param str include_metadata: - :param str include_tabs: When set to **true**, the tab information associated with the recipient is included in the response. - :return: Recipients - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.list_recipients_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.list_recipients_with_http_info(account_id, envelope_id, **kwargs) - return data - - def list_recipients_with_http_info(self, account_id, envelope_id, **kwargs): - """ - Gets the status of recipients for an envelope. - Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. - 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.list_recipients_with_http_info(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str include_anchor_tab_locations: When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. - :param str include_extended: When set to **true**, the extended properties are included in the response. - :param str include_metadata: - :param str include_tabs: When set to **true**, the tab information associated with the recipient is included in the response. - :return: Recipients - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'include_anchor_tab_locations', 'include_extended', 'include_metadata', 'include_tabs'] - 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 list_recipients" % 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 `list_recipients`") - # 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 `list_recipients`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients'.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'] - if 'include_extended' in params: - query_params['include_extended'] = params['include_extended'] - if 'include_metadata' in params: - query_params['include_metadata'] = params['include_metadata'] - if 'include_tabs' in params: - query_params['include_tabs'] = params['include_tabs'] - - 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='Recipients', - 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 list_status(self, account_id, **kwargs): - """ - Gets the envelope status for the specified envelopes. - Retrieves the envelope status for the specified envelopes. - 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.list_status(account_id, callback=callback_function) - - :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 ac_status: - :param str block: - :param str count: - :param str email: - :param str envelope_ids: - :param str from_date: - :param str from_to_status: - :param str start_position: - :param str status: - :param str to_date: - :param str transaction_ids: - :param str user_name: - :param EnvelopeIdsRequest envelope_ids_request: - :return: EnvelopesInformation - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.list_status_with_http_info(account_id, **kwargs) - else: - (data) = self.list_status_with_http_info(account_id, **kwargs) - return data - - def list_status_with_http_info(self, account_id, **kwargs): - """ - Gets the envelope status for the specified envelopes. - Retrieves the envelope status for the specified envelopes. - 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.list_status_with_http_info(account_id, callback=callback_function) - - :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 ac_status: - :param str block: - :param str count: - :param str email: - :param str envelope_ids: - :param str from_date: - :param str from_to_status: - :param str start_position: - :param str status: - :param str to_date: - :param str transaction_ids: - :param str user_name: - :param EnvelopeIdsRequest envelope_ids_request: - :return: EnvelopesInformation - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'ac_status', 'block', 'count', 'email', 'envelope_ids', 'from_date', 'from_to_status', 'start_position', 'status', 'to_date', 'transaction_ids', 'user_name', 'envelope_ids_request'] - 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 list_status" % 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 `list_status`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/status'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - - query_params = {} - if 'ac_status' in params: - query_params['ac_status'] = params['ac_status'] - if 'block' in params: - query_params['block'] = params['block'] - if 'count' in params: - query_params['count'] = params['count'] - if 'email' in params: - query_params['email'] = params['email'] - if 'envelope_ids' in params: - query_params['envelope_ids'] = params['envelope_ids'] - if 'from_date' in params: - query_params['from_date'] = params['from_date'] - if 'from_to_status' in params: - query_params['from_to_status'] = params['from_to_status'] - if 'start_position' in params: - query_params['start_position'] = params['start_position'] - if 'status' in params: - query_params['status'] = params['status'] - if 'to_date' in params: - query_params['to_date'] = params['to_date'] - if 'transaction_ids' in params: - query_params['transaction_ids'] = params['transaction_ids'] - if 'user_name' in params: - query_params['user_name'] = params['user_name'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'envelope_ids_request' in params: - body_params = params['envelope_ids_request'] - # 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, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EnvelopesInformation', - 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 list_status_changes(self, account_id, **kwargs): - """ - Gets status changes for one or more envelopes. - Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for \"any status change\" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of \"`Created`,`Sent`\", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier. - 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.list_status_changes(account_id, callback=callback_function) - - :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 ac_status: Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed. - :param str block: - :param str cdse_mode: - :param str continuation_token: - :param str count: - :param str custom_field: This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \"Region\" and you want to search for all envelopes where the value is \"West\" you would use the query: `?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of \"DocuSign\" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is \"DocuSign for Salesforce\" or \"DocuSign envelope.\" - :param str email: - :param str envelope_ids: - :param str exclude: - :param str folder_ids: - :param str folder_types: - :param str from_date: The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used. - :param str from_to_status: This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. - :param str include: - :param str include_purge_information: - :param str intersecting_folder_ids: - :param str last_queried_date: - :param str order: - :param str order_by: - :param str powerformids: - :param str query_budget: - :param str requester_date_format: - :param str search_text: - :param str start_position: - :param str status: The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. - :param str to_date: Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the `to_date`. - :param str transaction_ids: If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days. - :param str user_filter: - :param str user_id: - :param str user_name: - :return: EnvelopesInformation - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.list_status_changes_with_http_info(account_id, **kwargs) - else: - (data) = self.list_status_changes_with_http_info(account_id, **kwargs) - return data - - def list_status_changes_with_http_info(self, account_id, **kwargs): - """ - Gets status changes for one or more envelopes. - Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for \"any status change\" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of \"`Created`,`Sent`\", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier. - 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.list_status_changes_with_http_info(account_id, callback=callback_function) - - :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 ac_status: Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed. - :param str block: - :param str cdse_mode: - :param str continuation_token: - :param str count: - :param str custom_field: This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \"Region\" and you want to search for all envelopes where the value is \"West\" you would use the query: `?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of \"DocuSign\" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is \"DocuSign for Salesforce\" or \"DocuSign envelope.\" - :param str email: - :param str envelope_ids: - :param str exclude: - :param str folder_ids: - :param str folder_types: - :param str from_date: The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used. - :param str from_to_status: This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. - :param str include: - :param str include_purge_information: - :param str intersecting_folder_ids: - :param str last_queried_date: - :param str order: - :param str order_by: - :param str powerformids: - :param str query_budget: - :param str requester_date_format: - :param str search_text: - :param str start_position: - :param str status: The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. - :param str to_date: Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the `to_date`. - :param str transaction_ids: If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days. - :param str user_filter: - :param str user_id: - :param str user_name: - :return: EnvelopesInformation - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'ac_status', 'block', 'cdse_mode', 'continuation_token', 'count', 'custom_field', 'email', 'envelope_ids', 'exclude', 'folder_ids', 'folder_types', 'from_date', 'from_to_status', 'include', 'include_purge_information', 'intersecting_folder_ids', 'last_queried_date', 'order', 'order_by', 'powerformids', 'query_budget', 'requester_date_format', 'search_text', 'start_position', 'status', 'to_date', 'transaction_ids', 'user_filter', 'user_id', 'user_name'] - 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 list_status_changes" % 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 `list_status_changes`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - - query_params = {} - if 'ac_status' in params: - query_params['ac_status'] = params['ac_status'] - if 'block' in params: - query_params['block'] = params['block'] - if 'cdse_mode' in params: - query_params['cdse_mode'] = params['cdse_mode'] - if 'continuation_token' in params: - query_params['continuation_token'] = params['continuation_token'] - if 'count' in params: - query_params['count'] = params['count'] - if 'custom_field' in params: - query_params['custom_field'] = params['custom_field'] - if 'email' in params: - query_params['email'] = params['email'] - if 'envelope_ids' in params: - query_params['envelope_ids'] = params['envelope_ids'] - if 'exclude' in params: - query_params['exclude'] = params['exclude'] - if 'folder_ids' in params: - query_params['folder_ids'] = params['folder_ids'] - if 'folder_types' in params: - query_params['folder_types'] = params['folder_types'] - if 'from_date' in params: - query_params['from_date'] = params['from_date'] - if 'from_to_status' in params: - query_params['from_to_status'] = params['from_to_status'] - if 'include' in params: - query_params['include'] = params['include'] - if 'include_purge_information' in params: - query_params['include_purge_information'] = params['include_purge_information'] - if 'intersecting_folder_ids' in params: - query_params['intersecting_folder_ids'] = params['intersecting_folder_ids'] - if 'last_queried_date' in params: - query_params['last_queried_date'] = params['last_queried_date'] - if 'order' in params: - query_params['order'] = params['order'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'powerformids' in params: - query_params['powerformids'] = params['powerformids'] - if 'query_budget' in params: - query_params['query_budget'] = params['query_budget'] - if 'requester_date_format' in params: - query_params['requester_date_format'] = params['requester_date_format'] - if 'search_text' in params: - query_params['search_text'] = params['search_text'] - if 'start_position' in params: - query_params['start_position'] = params['start_position'] - if 'status' in params: - query_params['status'] = params['status'] - if 'to_date' in params: - query_params['to_date'] = params['to_date'] - if 'transaction_ids' in params: - query_params['transaction_ids'] = params['transaction_ids'] - if 'user_filter' in params: - query_params['user_filter'] = params['user_filter'] - if 'user_id' in params: - query_params['user_id'] = params['user_id'] - if 'user_name' in params: - query_params['user_name'] = params['user_name'] - - 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='EnvelopesInformation', - 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 list_tabs(self, account_id, envelope_id, recipient_id, **kwargs): - """ - Gets the tabs information for a signer or sign-in-person recipient in an envelope. - Retrieves information about the tabs associated with a recipient in a draft 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.list_tabs(account_id, envelope_id, recipient_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str include_anchor_tab_locations: When set to **true**, all tabs with anchor tab properties are included in the response. - :param str include_metadata: - :return: Tabs - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.list_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) - else: - (data) = self.list_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) - return data - - def list_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): - """ - Gets the tabs information for a signer or sign-in-person recipient in an envelope. - Retrieves information about the tabs associated with a recipient in a draft 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.list_tabs_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str include_anchor_tab_locations: When set to **true**, all tabs with anchor tab properties are included in the response. - :param str include_metadata: - :return: Tabs - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'recipient_id', 'include_anchor_tab_locations', 'include_metadata'] - 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 list_tabs" % 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 `list_tabs`") - # 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 `list_tabs`") - # verify the required parameter 'recipient_id' is set - if ('recipient_id' not in params) or (params['recipient_id'] is None): - raise ValueError("Missing the required parameter `recipient_id` when calling `list_tabs`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs'.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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] - - query_params = {} - if 'include_anchor_tab_locations' in params: - query_params['include_anchor_tab_locations'] = params['include_anchor_tab_locations'] - if 'include_metadata' in params: - query_params['include_metadata'] = params['include_metadata'] - - 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='Tabs', - 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 list_templates(self, account_id, envelope_id, **kwargs): - """ - Get List of Templates used in an Envelope - This returns a list of the server-side templates, their name and ID, used 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.list_templates(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str include: The possible values are: matching_applied - This returns template matching information for the template. - :return: TemplateInformation - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.list_templates_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.list_templates_with_http_info(account_id, envelope_id, **kwargs) - return data - - def list_templates_with_http_info(self, account_id, envelope_id, **kwargs): - """ - Get List of Templates used in an Envelope - This returns a list of the server-side templates, their name and ID, used 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.list_templates_with_http_info(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str include: The possible values are: matching_applied - This returns template matching information for the template. - :return: TemplateInformation - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'include'] - 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 list_templates" % 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 `list_templates`") - # 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 `list_templates`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates'.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' in params: - query_params['include'] = params['include'] - - 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='TemplateInformation', - 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 list_templates_for_document(self, account_id, document_id, envelope_id, **kwargs): - """ - Gets the templates associated with a document in an existing envelope. - Retrieves the templates associated with a document in the specified 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.list_templates_for_document(account_id, document_id, envelope_id, callback=callback_function) - - :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 document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str include: - :return: TemplateInformation - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.list_templates_for_document_with_http_info(account_id, document_id, envelope_id, **kwargs) - else: - (data) = self.list_templates_for_document_with_http_info(account_id, document_id, envelope_id, **kwargs) - return data - - def list_templates_for_document_with_http_info(self, account_id, document_id, envelope_id, **kwargs): - """ - Gets the templates associated with a document in an existing envelope. - Retrieves the templates associated with a document in the specified 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.list_templates_for_document_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: The external account number (int) or account ID Guid. (required) - :param str document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str include: - :return: TemplateInformation - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'document_id', 'envelope_id', 'include'] - 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 list_templates_for_document" % 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 `list_templates_for_document`") - # 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 `list_templates_for_document`") - # 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 `list_templates_for_document`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates'.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' in params: - query_params['include'] = params['include'] - - 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='TemplateInformation', - 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 put_attachment(self, account_id, attachment_id, envelope_id, **kwargs): - """ - Add an attachment to a DRAFT or IN-PROCESS 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.put_attachment(account_id, attachment_id, envelope_id, callback=callback_function) - - :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 attachment_id: (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Attachment attachment: - :return: EnvelopeAttachmentsResult - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.put_attachment_with_http_info(account_id, attachment_id, envelope_id, **kwargs) - else: - (data) = self.put_attachment_with_http_info(account_id, attachment_id, envelope_id, **kwargs) - return data - - def put_attachment_with_http_info(self, account_id, attachment_id, envelope_id, **kwargs): - """ - Add an attachment to a DRAFT or IN-PROCESS 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.put_attachment_with_http_info(account_id, attachment_id, envelope_id, callback=callback_function) - - :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 attachment_id: (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Attachment attachment: - :return: EnvelopeAttachmentsResult - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'attachment_id', 'envelope_id', 'attachment'] - 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 put_attachment" % 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 `put_attachment`") - # verify the required parameter 'attachment_id' is set - if ('attachment_id' not in params) or (params['attachment_id'] is None): - raise ValueError("Missing the required parameter `attachment_id` when calling `put_attachment`") - # 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 `put_attachment`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - if 'attachment_id' in params: - path_params['attachmentId'] = params['attachment_id'] - if 'envelope_id' in params: - path_params['envelopeId'] = params['envelope_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'attachment' in params: - body_params = params['attachment'] - # 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, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EnvelopeAttachmentsResult', - 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 put_attachments(self, account_id, envelope_id, **kwargs): - """ - Add one or more attachments to a DRAFT or IN-PROCESS 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.put_attachments(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EnvelopeAttachmentsRequest envelope_attachments_request: - :return: EnvelopeAttachmentsResult - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.put_attachments_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.put_attachments_with_http_info(account_id, envelope_id, **kwargs) - return data - - def put_attachments_with_http_info(self, account_id, envelope_id, **kwargs): - """ - Add one or more attachments to a DRAFT or IN-PROCESS 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.put_attachments_with_http_info(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EnvelopeAttachmentsRequest envelope_attachments_request: - :return: EnvelopeAttachmentsResult - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'envelope_attachments_request'] - 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 put_attachments" % 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 `put_attachments`") - # 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 `put_attachments`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments'.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 = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'envelope_attachments_request' in params: - body_params = params['envelope_attachments_request'] - # 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, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EnvelopeAttachmentsResult', - 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 rotate_document_page(self, account_id, document_id, envelope_id, page_number, **kwargs): - """ - Rotates page image from an envelope for display. - Rotates page image from an envelope for display. The page image can be rotated to the left or right. - 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.rotate_document_page(account_id, document_id, envelope_id, page_number, callback=callback_function) - - :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 document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str page_number: The page number being accessed. (required) - :param PageRequest page_request: - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.rotate_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) - else: - (data) = self.rotate_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) - return data - - def rotate_document_page_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): - """ - Rotates page image from an envelope for display. - Rotates page image from an envelope for display. The page image can be rotated to the left or right. - 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.rotate_document_page_with_http_info(account_id, document_id, envelope_id, page_number, callback=callback_function) - - :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 document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str page_number: The page number being accessed. (required) - :param PageRequest page_request: - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'document_id', 'envelope_id', 'page_number', 'page_request'] - 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 rotate_document_page" % 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 `rotate_document_page`") - # 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 `rotate_document_page`") - # 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 `rotate_document_page`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `rotate_document_page`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image'.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'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'page_request' in params: - body_params = params['page_request'] - # 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, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, - 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 update(self, account_id, envelope_id, **kwargs): - """ - Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft - The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {\"status\":\"sent\"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {\"purgeState\":\"purge type\"} to the request body. *Additional information on purging documents* The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState=\"documents_queued\"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= \"documents_and_metadata_queued\"` is used in the request, then the documents, attachments, and tabs are deleted. - 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.update(account_id, envelope_id, callback=callback_function) - - :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str advanced_update: When set to **true**, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes. - :param str resend_envelope: When set to **true**, sends the specified envelope again. - :param Envelope envelope: - :return: EnvelopeUpdateSummary - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.update_with_http_info(account_id, envelope_id, **kwargs) - return data - - def update_with_http_info(self, account_id, envelope_id, **kwargs): + def list_templates_for_document_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft - The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {\"status\":\"sent\"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {\"purgeState\":\"purge type\"} to the request body. *Additional information on purging documents* The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState=\"documents_queued\"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= \"documents_and_metadata_queued\"` is used in the request, then the documents, attachments, and tabs are deleted. + Gets the templates associated with a document in an existing envelope. + Retrieves the templates associated with a document in the specified 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.update_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.list_templates_for_document_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: The external account number (int) or account ID Guid. (required) + :param str document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str advanced_update: When set to **true**, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes. - :param str resend_envelope: When set to **true**, sends the specified envelope again. - :param Envelope envelope: - :return: EnvelopeUpdateSummary + :param str include: + :return: TemplateInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'advanced_update', 'resend_envelope', 'envelope'] + all_params = ['account_id', 'document_id', 'envelope_id', 'include'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12405,146 +9864,35 @@ def update_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update" % key + " to method list_templates_for_document" % 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 `update`") + raise ValueError("Missing the required parameter `account_id` when calling `list_templates_for_document`") + # 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 `list_templates_for_document`") # 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 `update`") + raise ValueError("Missing the required parameter `envelope_id` when calling `list_templates_for_document`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates'.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 'advanced_update' in params: - query_params['advanced_update'] = params['advanced_update'] - if 'resend_envelope' in params: - query_params['resend_envelope'] = params['resend_envelope'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'envelope' in params: - body_params = params['envelope'] - # 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, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EnvelopeUpdateSummary', - 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 update_chunked_upload(self, account_id, chunked_upload_id, **kwargs): - """ - Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. - 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.update_chunked_upload(account_id, chunked_upload_id, callback=callback_function) - - :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 chunked_upload_id: (required) - :param str action: - :return: ChunkedUploadResponse - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) - else: - (data) = self.update_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) - return data - - def update_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwargs): - """ - Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. - 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.update_chunked_upload_with_http_info(account_id, chunked_upload_id, callback=callback_function) - - :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 chunked_upload_id: (required) - :param str action: - :return: ChunkedUploadResponse - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'chunked_upload_id', 'action'] - 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 update_chunked_upload" % 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 `update_chunked_upload`") - # verify the required parameter 'chunked_upload_id' is set - if ('chunked_upload_id' not in params) or (params['chunked_upload_id'] is None): - raise ValueError("Missing the required parameter `chunked_upload_id` when calling `update_chunked_upload`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - if 'chunked_upload_id' in params: - path_params['chunkedUploadId'] = params['chunked_upload_id'] - - query_params = {} - if 'action' in params: - query_params['action'] = params['action'] + if 'include' in params: + query_params['include'] = params['include'] header_params = {} @@ -12559,14 +9907,14 @@ def update_chunked_upload_with_http_info(self, account_id, chunked_upload_id, ** # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'PUT', + 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='ChunkedUploadResponse', + response_type='TemplateInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12574,57 +9922,57 @@ def update_chunked_upload_with_http_info(self, account_id, chunked_upload_id, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_chunked_upload_part(self, account_id, chunked_upload_id, chunked_upload_part_seq, **kwargs): + def put_attachment(self, account_id, attachment_id, envelope_id, **kwargs): """ - Add a chunk, a chunk 'part', to an existing ChunkedUpload. + Add an attachment to a DRAFT or IN-PROCESS 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.update_chunked_upload_part(account_id, chunked_upload_id, chunked_upload_part_seq, callback=callback_function) + >>> thread = api.put_attachment(account_id, attachment_id, envelope_id, callback=callback_function) :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 chunked_upload_id: (required) - :param str chunked_upload_part_seq: (required) - :param ChunkedUploadRequest chunked_upload_request: - :return: ChunkedUploadResponse + :param str attachment_id: (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param Attachment attachment: + :return: EnvelopeAttachmentsResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_chunked_upload_part_with_http_info(account_id, chunked_upload_id, chunked_upload_part_seq, **kwargs) + return self.put_attachment_with_http_info(account_id, attachment_id, envelope_id, **kwargs) else: - (data) = self.update_chunked_upload_part_with_http_info(account_id, chunked_upload_id, chunked_upload_part_seq, **kwargs) + (data) = self.put_attachment_with_http_info(account_id, attachment_id, envelope_id, **kwargs) return data - def update_chunked_upload_part_with_http_info(self, account_id, chunked_upload_id, chunked_upload_part_seq, **kwargs): + def put_attachment_with_http_info(self, account_id, attachment_id, envelope_id, **kwargs): """ - Add a chunk, a chunk 'part', to an existing ChunkedUpload. + Add an attachment to a DRAFT or IN-PROCESS 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.update_chunked_upload_part_with_http_info(account_id, chunked_upload_id, chunked_upload_part_seq, callback=callback_function) + >>> thread = api.put_attachment_with_http_info(account_id, attachment_id, envelope_id, callback=callback_function) :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 chunked_upload_id: (required) - :param str chunked_upload_part_seq: (required) - :param ChunkedUploadRequest chunked_upload_request: - :return: ChunkedUploadResponse + :param str attachment_id: (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param Attachment attachment: + :return: EnvelopeAttachmentsResult If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'chunked_upload_id', 'chunked_upload_part_seq', 'chunked_upload_request'] + all_params = ['account_id', 'attachment_id', 'envelope_id', 'attachment'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12635,31 +9983,31 @@ def update_chunked_upload_part_with_http_info(self, account_id, chunked_upload_i if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_chunked_upload_part" % key + " to method put_attachment" % 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 `update_chunked_upload_part`") - # verify the required parameter 'chunked_upload_id' is set - if ('chunked_upload_id' not in params) or (params['chunked_upload_id'] is None): - raise ValueError("Missing the required parameter `chunked_upload_id` when calling `update_chunked_upload_part`") - # verify the required parameter 'chunked_upload_part_seq' is set - if ('chunked_upload_part_seq' not in params) or (params['chunked_upload_part_seq'] is None): - raise ValueError("Missing the required parameter `chunked_upload_part_seq` when calling `update_chunked_upload_part`") + raise ValueError("Missing the required parameter `account_id` when calling `put_attachment`") + # verify the required parameter 'attachment_id' is set + if ('attachment_id' not in params) or (params['attachment_id'] is None): + raise ValueError("Missing the required parameter `attachment_id` when calling `put_attachment`") + # 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 `put_attachment`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'chunked_upload_id' in params: - path_params['chunkedUploadId'] = params['chunked_upload_id'] - if 'chunked_upload_part_seq' in params: - path_params['chunkedUploadPartSeq'] = params['chunked_upload_part_seq'] + if 'attachment_id' in params: + path_params['attachmentId'] = params['attachment_id'] + if 'envelope_id' in params: + path_params['envelopeId'] = params['envelope_id'] query_params = {} @@ -12669,8 +10017,8 @@ def update_chunked_upload_part_with_http_info(self, account_id, chunked_upload_i local_var_files = {} body_params = None - if 'chunked_upload_request' in params: - body_params = params['chunked_upload_request'] + if 'attachment' in params: + body_params = params['attachment'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -12685,7 +10033,7 @@ def update_chunked_upload_part_with_http_info(self, account_id, chunked_upload_i body=body_params, post_params=form_params, files=local_var_files, - response_type='ChunkedUploadResponse', + response_type='EnvelopeAttachmentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12693,57 +10041,55 @@ def update_chunked_upload_part_with_http_info(self, account_id, chunked_upload_i _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_custom_fields(self, account_id, envelope_id, **kwargs): + def put_attachments(self, account_id, envelope_id, **kwargs): """ - Updates envelope custom fields in an envelope. - Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name. + Add one or more attachments to a DRAFT or IN-PROCESS 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.update_custom_fields(account_id, envelope_id, callback=callback_function) + >>> thread = api.put_attachments(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param CustomFields custom_fields: - :return: CustomFields + :param EnvelopeAttachmentsRequest envelope_attachments_request: + :return: EnvelopeAttachmentsResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_custom_fields_with_http_info(account_id, envelope_id, **kwargs) + return self.put_attachments_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_custom_fields_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.put_attachments_with_http_info(account_id, envelope_id, **kwargs) return data - def update_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): + def put_attachments_with_http_info(self, account_id, envelope_id, **kwargs): """ - Updates envelope custom fields in an envelope. - Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name. + Add one or more attachments to a DRAFT or IN-PROCESS 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.update_custom_fields_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.put_attachments_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param CustomFields custom_fields: - :return: CustomFields + :param EnvelopeAttachmentsRequest envelope_attachments_request: + :return: EnvelopeAttachmentsResult If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'custom_fields'] + all_params = ['account_id', 'envelope_id', 'envelope_attachments_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12754,21 +10100,21 @@ def update_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs) if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_custom_fields" % key + " to method put_attachments" % 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 `update_custom_fields`") + raise ValueError("Missing the required parameter `account_id` when calling `put_attachments`") # 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 `update_custom_fields`") + raise ValueError("Missing the required parameter `envelope_id` when calling `put_attachments`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -12783,8 +10129,8 @@ def update_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs) local_var_files = {} body_params = None - if 'custom_fields' in params: - body_params = params['custom_fields'] + if 'envelope_attachments_request' in params: + body_params = params['envelope_attachments_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -12799,7 +10145,7 @@ def update_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs) body=body_params, post_params=form_params, files=local_var_files, - response_type='CustomFields', + response_type='EnvelopeAttachmentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12807,55 +10153,61 @@ def update_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs) _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_document(self, account_id, document_id, envelope_id, **kwargs): + def rotate_document_page(self, account_id, document_id, envelope_id, page_number, **kwargs): """ - Update document information for Display Appliance + Rotates page image from an envelope for display. + Rotates page image from an envelope for display. The page image can be rotated to the left or right. 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.update_document(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.rotate_document_page(account_id, document_id, envelope_id, page_number, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str page_number: The page number being accessed. (required) + :param PageRequest page_request: :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_document_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.rotate_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) else: - (data) = self.update_document_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.rotate_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) return data - def update_document_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def rotate_document_page_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): """ - Update document information for Display Appliance + Rotates page image from an envelope for display. + Rotates page image from an envelope for display. The page image can be rotated to the left or right. 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.update_document_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.rotate_document_page_with_http_info(account_id, document_id, envelope_id, page_number, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param str page_number: The page number being accessed. (required) + :param PageRequest page_request: :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id'] + all_params = ['account_id', 'document_id', 'envelope_id', 'page_number', 'page_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12866,24 +10218,27 @@ def update_document_with_http_info(self, account_id, document_id, envelope_id, * if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_document" % key + " to method rotate_document_page" % 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 `update_document`") + raise ValueError("Missing the required parameter `account_id` when calling `rotate_document_page`") # 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 `update_document`") + raise ValueError("Missing the required parameter `document_id` when calling `rotate_document_page`") # 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 `update_document`") + raise ValueError("Missing the required parameter `envelope_id` when calling `rotate_document_page`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `rotate_document_page`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document/{documentId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -12891,6 +10246,8 @@ def update_document_with_http_info(self, account_id, document_id, envelope_id, * path_params['documentId'] = params['document_id'] if 'envelope_id' in params: path_params['envelopeId'] = params['envelope_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = {} @@ -12900,6 +10257,8 @@ def update_document_with_http_info(self, account_id, document_id, envelope_id, * local_var_files = {} body_params = None + if 'page_request' in params: + body_params = params['page_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -12922,57 +10281,61 @@ def update_document_with_http_info(self, account_id, document_id, envelope_id, * _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_document_0(self, account_id, document_id, envelope_id, **kwargs): + def update(self, account_id, envelope_id, **kwargs): """ - Adds a document to an existing draft envelope. - Adds a document to an existing draft envelope. + Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft + The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {\"status\":\"sent\"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {\"purgeState\":\"purge type\"} to the request body. *Additional information on purging documents* The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState=\"documents_queued\"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= \"documents_and_metadata_queued\"` is used in the request, then the documents, attachments, and tabs are deleted. 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.update_document_0(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.update(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EnvelopeDocument + :param str advanced_update: When set to **true**, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes. + :param str resend_envelope: When set to **true**, sends the specified envelope again. + :param Envelope envelope: + :return: EnvelopeUpdateSummary If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_document_0_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.update_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_document_0_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.update_with_http_info(account_id, envelope_id, **kwargs) return data - def update_document_0_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def update_with_http_info(self, account_id, envelope_id, **kwargs): """ - Adds a document to an existing draft envelope. - Adds a document to an existing draft envelope. + Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft + The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {\"status\":\"sent\"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {\"purgeState\":\"purge type\"} to the request body. *Additional information on purging documents* The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState=\"documents_queued\"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= \"documents_and_metadata_queued\"` is used in the request, then the documents, attachments, and tabs are deleted. 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.update_document_0_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.update_with_http_info(account_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EnvelopeDocument + :param str advanced_update: When set to **true**, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes. + :param str resend_envelope: When set to **true**, sends the specified envelope again. + :param Envelope envelope: + :return: EnvelopeUpdateSummary If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'advanced_update', 'resend_envelope', 'envelope'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12983,33 +10346,32 @@ def update_document_0_with_http_info(self, account_id, document_id, envelope_id, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_document_0" % key + " to method update" % 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 `update_document_0`") - # 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 `update_document_0`") + raise ValueError("Missing the required parameter `account_id` when calling `update`") # 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 `update_document_0`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}'.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 'advanced_update' in params: + query_params['advanced_update'] = params['advanced_update'] + if 'resend_envelope' in params: + query_params['resend_envelope'] = params['resend_envelope'] header_params = {} @@ -13017,6 +10379,8 @@ def update_document_0_with_http_info(self, account_id, document_id, envelope_id, local_var_files = {} body_params = None + if 'envelope' in params: + body_params = params['envelope'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13031,7 +10395,7 @@ def update_document_0_with_http_info(self, account_id, document_id, envelope_id, body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeDocument', + response_type='EnvelopeUpdateSummary', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13039,59 +10403,55 @@ def update_document_0_with_http_info(self, account_id, document_id, envelope_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_document_fields(self, account_id, document_id, envelope_id, **kwargs): + def update_chunked_upload(self, account_id, chunked_upload_id, **kwargs): """ - Updates existing custom document fields in an existing envelope document. - Updates existing custom document fields in an existing envelope document. + Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. 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.update_document_fields(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.update_chunked_upload(account_id, chunked_upload_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param DocumentFieldsInformation document_fields_information: - :return: DocumentFieldsInformation + :param str chunked_upload_id: (required) + :param str action: + :return: ChunkedUploadResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.update_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) else: - (data) = self.update_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.update_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) return data - def update_document_fields_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def update_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwargs): """ - Updates existing custom document fields in an existing envelope document. - Updates existing custom document fields in an existing envelope document. + Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. 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.update_document_fields_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.update_chunked_upload_with_http_info(account_id, chunked_upload_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param DocumentFieldsInformation document_fields_information: - :return: DocumentFieldsInformation + :param str chunked_upload_id: (required) + :param str action: + :return: ChunkedUploadResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'document_fields_information'] + all_params = ['account_id', 'chunked_upload_id', 'action'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13102,42 +10462,37 @@ def update_document_fields_with_http_info(self, account_id, document_id, envelop if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_document_fields" % key + " to method update_chunked_upload" % 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 `update_document_fields`") - # 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 `update_document_fields`") - # 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 `update_document_fields`") + raise ValueError("Missing the required parameter `account_id` when calling `update_chunked_upload`") + # verify the required parameter 'chunked_upload_id' is set + if ('chunked_upload_id' not in params) or (params['chunked_upload_id'] is None): + raise ValueError("Missing the required parameter `chunked_upload_id` when calling `update_chunked_upload`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}'.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'] + if 'chunked_upload_id' in params: + path_params['chunkedUploadId'] = params['chunked_upload_id'] query_params = {} + if 'action' in params: + query_params['action'] = params['action'] header_params = {} form_params = [] local_var_files = {} - body_params = None - if 'document_fields_information' in params: - body_params = params['document_fields_information'] + body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13152,7 +10507,7 @@ def update_document_fields_with_http_info(self, account_id, document_id, envelop body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentFieldsInformation', + response_type='ChunkedUploadResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13160,57 +10515,57 @@ def update_document_fields_with_http_info(self, account_id, document_id, envelop _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_document_tabs(self, account_id, document_id, envelope_id, **kwargs): + def update_chunked_upload_part(self, account_id, chunked_upload_id, chunked_upload_part_seq, **kwargs): """ - Updates the tabs for an envelope document + Add a chunk, a chunk 'part', to an existing ChunkedUpload. 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.update_document_tabs(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.update_chunked_upload_part(account_id, chunked_upload_id, chunked_upload_part_seq, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Tabs tabs: - :return: Tabs + :param str chunked_upload_id: (required) + :param str chunked_upload_part_seq: (required) + :param ChunkedUploadRequest chunked_upload_request: + :return: ChunkedUploadResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.update_chunked_upload_part_with_http_info(account_id, chunked_upload_id, chunked_upload_part_seq, **kwargs) else: - (data) = self.update_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.update_chunked_upload_part_with_http_info(account_id, chunked_upload_id, chunked_upload_part_seq, **kwargs) return data - def update_document_tabs_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def update_chunked_upload_part_with_http_info(self, account_id, chunked_upload_id, chunked_upload_part_seq, **kwargs): """ - Updates the tabs for an envelope document + Add a chunk, a chunk 'part', to an existing ChunkedUpload. 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.update_document_tabs_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.update_chunked_upload_part_with_http_info(account_id, chunked_upload_id, chunked_upload_part_seq, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Tabs tabs: - :return: Tabs + :param str chunked_upload_id: (required) + :param str chunked_upload_part_seq: (required) + :param ChunkedUploadRequest chunked_upload_request: + :return: ChunkedUploadResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'tabs'] + all_params = ['account_id', 'chunked_upload_id', 'chunked_upload_part_seq', 'chunked_upload_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13221,31 +10576,31 @@ def update_document_tabs_with_http_info(self, account_id, document_id, envelope_ if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_document_tabs" % key + " to method update_chunked_upload_part" % 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 `update_document_tabs`") - # 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 `update_document_tabs`") - # 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 `update_document_tabs`") + raise ValueError("Missing the required parameter `account_id` when calling `update_chunked_upload_part`") + # verify the required parameter 'chunked_upload_id' is set + if ('chunked_upload_id' not in params) or (params['chunked_upload_id'] is None): + raise ValueError("Missing the required parameter `chunked_upload_id` when calling `update_chunked_upload_part`") + # verify the required parameter 'chunked_upload_part_seq' is set + if ('chunked_upload_part_seq' not in params) or (params['chunked_upload_part_seq'] is None): + raise ValueError("Missing the required parameter `chunked_upload_part_seq` when calling `update_chunked_upload_part`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}'.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'] + if 'chunked_upload_id' in params: + path_params['chunkedUploadId'] = params['chunked_upload_id'] + if 'chunked_upload_part_seq' in params: + path_params['chunkedUploadPartSeq'] = params['chunked_upload_part_seq'] query_params = {} @@ -13255,8 +10610,8 @@ def update_document_tabs_with_http_info(self, account_id, document_id, envelope_ local_var_files = {} body_params = None - if 'tabs' in params: - body_params = params['tabs'] + if 'chunked_upload_request' in params: + body_params = params['chunked_upload_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13271,7 +10626,7 @@ def update_document_tabs_with_http_info(self, account_id, document_id, envelope_ body=body_params, post_params=form_params, files=local_var_files, - response_type='Tabs', + response_type='ChunkedUploadResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13279,57 +10634,57 @@ def update_document_tabs_with_http_info(self, account_id, document_id, envelope_ _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_documents(self, account_id, envelope_id, **kwargs): + def update_custom_fields(self, account_id, envelope_id, **kwargs): """ - Adds one or more documents to an existing envelope document. - Adds one or more documents to an existing envelope document. + Updates envelope custom fields in an envelope. + Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name. 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.update_documents(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_custom_fields(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EnvelopeDefinition envelope_definition: - :return: EnvelopeDocumentsResult + :param CustomFields custom_fields: + :return: CustomFields If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_documents_with_http_info(account_id, envelope_id, **kwargs) + return self.update_custom_fields_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_documents_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_custom_fields_with_http_info(account_id, envelope_id, **kwargs) return data - def update_documents_with_http_info(self, account_id, envelope_id, **kwargs): + def update_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): """ - Adds one or more documents to an existing envelope document. - Adds one or more documents to an existing envelope document. + Updates envelope custom fields in an envelope. + Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name. 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.update_documents_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_custom_fields_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EnvelopeDefinition envelope_definition: - :return: EnvelopeDocumentsResult + :param CustomFields custom_fields: + :return: CustomFields If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'envelope_definition'] + all_params = ['account_id', 'envelope_id', 'custom_fields'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13340,21 +10695,21 @@ def update_documents_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_documents" % key + " to method update_custom_fields" % 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 `update_documents`") + raise ValueError("Missing the required parameter `account_id` when calling `update_custom_fields`") # 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 `update_documents`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_custom_fields`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -13369,8 +10724,8 @@ def update_documents_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None - if 'envelope_definition' in params: - body_params = params['envelope_definition'] + if 'custom_fields' in params: + body_params = params['custom_fields'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13385,7 +10740,7 @@ def update_documents_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeDocumentsResult', + response_type='CustomFields', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13393,57 +10748,57 @@ def update_documents_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_email_settings(self, account_id, envelope_id, **kwargs): + def update_document(self, account_id, document_id, envelope_id, **kwargs): """ - Updates the email setting overrides for an envelope. - Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted. + Adds a document to an existing draft envelope. + Adds a document to an existing draft 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.update_email_settings(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_document(account_id, document_id, envelope_id, callback=callback_function) :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 document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EmailSettings email_settings: - :return: EmailSettings + :return: EnvelopeDocument If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_email_settings_with_http_info(account_id, envelope_id, **kwargs) + return self.update_document_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.update_email_settings_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_document_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def update_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): + def update_document_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Updates the email setting overrides for an envelope. - Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted. + Adds a document to an existing draft envelope. + Adds a document to an existing draft 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.update_email_settings_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_document_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: The external account number (int) or account ID Guid. (required) + :param str document_id: The ID of the document being accessed. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EmailSettings email_settings: - :return: EmailSettings + :return: EnvelopeDocument If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'email_settings'] + all_params = ['account_id', 'document_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13454,24 +10809,29 @@ def update_email_settings_with_http_info(self, account_id, envelope_id, **kwargs if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_email_settings" % key + " to method update_document" % 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 `update_email_settings`") + raise ValueError("Missing the required parameter `account_id` when calling `update_document`") + # 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 `update_document`") # 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 `update_email_settings`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_document`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}'.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'] @@ -13483,8 +10843,6 @@ def update_email_settings_with_http_info(self, account_id, envelope_id, **kwargs local_var_files = {} body_params = None - if 'email_settings' in params: - body_params = params['email_settings'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13499,7 +10857,7 @@ def update_email_settings_with_http_info(self, account_id, envelope_id, **kwargs body=body_params, post_params=form_params, files=local_var_files, - response_type='EmailSettings', + response_type='EnvelopeDocument', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13507,55 +10865,59 @@ def update_email_settings_with_http_info(self, account_id, envelope_id, **kwargs _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_envelope_transfer_rule(self, account_id, envelope_transfer_rule_id, **kwargs): + def update_document_fields(self, account_id, document_id, envelope_id, **kwargs): """ - Update an envelope transfer rule for an account. + Updates existing custom document fields in an existing envelope document. + Updates existing custom document fields in an existing envelope document. 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.update_envelope_transfer_rule(account_id, envelope_transfer_rule_id, callback=callback_function) + >>> thread = api.update_document_fields(account_id, document_id, envelope_id, callback=callback_function) :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 envelope_transfer_rule_id: (required) - :param EnvelopeTransferRule envelope_transfer_rule: - :return: EnvelopeTransferRule + :param str document_id: The ID of the document being accessed. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param DocumentFieldsInformation document_fields_information: + :return: DocumentFieldsInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) + return self.update_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) + (data) = self.update_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def update_envelope_transfer_rule_with_http_info(self, account_id, envelope_transfer_rule_id, **kwargs): + def update_document_fields_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Update an envelope transfer rule for an account. + Updates existing custom document fields in an existing envelope document. + Updates existing custom document fields in an existing envelope document. 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.update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, callback=callback_function) + >>> thread = api.update_document_fields_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: The external account number (int) or account ID Guid. (required) - :param str envelope_transfer_rule_id: (required) - :param EnvelopeTransferRule envelope_transfer_rule: - :return: EnvelopeTransferRule + :param str document_id: The ID of the document being accessed. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param DocumentFieldsInformation document_fields_information: + :return: DocumentFieldsInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_transfer_rule_id', 'envelope_transfer_rule'] + all_params = ['account_id', 'document_id', 'envelope_id', 'document_fields_information'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13566,26 +10928,31 @@ def update_envelope_transfer_rule_with_http_info(self, account_id, envelope_tran if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_envelope_transfer_rule" % key + " to method update_document_fields" % 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 `update_envelope_transfer_rule`") - # verify the required parameter 'envelope_transfer_rule_id' is set - if ('envelope_transfer_rule_id' not in params) or (params['envelope_transfer_rule_id'] is None): - raise ValueError("Missing the required parameter `envelope_transfer_rule_id` when calling `update_envelope_transfer_rule`") + raise ValueError("Missing the required parameter `account_id` when calling `update_document_fields`") + # 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 `update_document_fields`") + # 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 `update_document_fields`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'envelope_transfer_rule_id' in params: - path_params['envelopeTransferRuleId'] = params['envelope_transfer_rule_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 = {} @@ -13595,8 +10962,8 @@ def update_envelope_transfer_rule_with_http_info(self, account_id, envelope_tran local_var_files = {} body_params = None - if 'envelope_transfer_rule' in params: - body_params = params['envelope_transfer_rule'] + if 'document_fields_information' in params: + body_params = params['document_fields_information'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13611,7 +10978,7 @@ def update_envelope_transfer_rule_with_http_info(self, account_id, envelope_tran body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeTransferRule', + response_type='DocumentFieldsInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13619,53 +10986,57 @@ def update_envelope_transfer_rule_with_http_info(self, account_id, envelope_tran _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_envelope_transfer_rules(self, account_id, **kwargs): + def update_document_tabs(self, account_id, document_id, envelope_id, **kwargs): """ - Update envelope transfer rules for an account. + Updates the tabs for an envelope document 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.update_envelope_transfer_rules(account_id, callback=callback_function) + >>> thread = api.update_document_tabs(account_id, document_id, envelope_id, callback=callback_function) :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 EnvelopeTransferRuleInformation envelope_transfer_rule_information: - :return: EnvelopeTransferRuleInformation + :param str document_id: The ID of the document being accessed. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param Tabs tabs: + :return: Tabs If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_envelope_transfer_rules_with_http_info(account_id, **kwargs) + return self.update_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.update_envelope_transfer_rules_with_http_info(account_id, **kwargs) + (data) = self.update_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def update_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): + def update_document_tabs_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Update envelope transfer rules for an account. + Updates the tabs for an envelope document 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.update_envelope_transfer_rules_with_http_info(account_id, callback=callback_function) + >>> thread = api.update_document_tabs_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: The external account number (int) or account ID Guid. (required) - :param EnvelopeTransferRuleInformation envelope_transfer_rule_information: - :return: EnvelopeTransferRuleInformation + :param str document_id: The ID of the document being accessed. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param Tabs tabs: + :return: Tabs If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_transfer_rule_information'] + all_params = ['account_id', 'document_id', 'envelope_id', 'tabs'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13676,21 +11047,31 @@ def update_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_envelope_transfer_rules" % key + " to method update_document_tabs" % 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 `update_envelope_transfer_rules`") + raise ValueError("Missing the required parameter `account_id` when calling `update_document_tabs`") + # 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 `update_document_tabs`") + # 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 `update_document_tabs`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/transfer_rules'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs'.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 = {} @@ -13700,8 +11081,8 @@ def update_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): local_var_files = {} body_params = None - if 'envelope_transfer_rule_information' in params: - body_params = params['envelope_transfer_rule_information'] + if 'tabs' in params: + body_params = params['tabs'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13716,7 +11097,7 @@ def update_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeTransferRuleInformation', + response_type='Tabs', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13724,55 +11105,57 @@ def update_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_envelope_workflow_definition(self, account_id, envelope_id, **kwargs): + def update_documents(self, account_id, envelope_id, **kwargs): """ - Updates the envelope workflow definition for an envelope. + Adds one or more documents to an existing envelope document. + Adds one or more documents to an existing envelope document. 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.update_envelope_workflow_definition(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_documents(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Workflow workflow: - :return: Workflow + :param EnvelopeDefinition envelope_definition: + :return: EnvelopeDocumentsResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + return self.update_documents_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_documents_with_http_info(account_id, envelope_id, **kwargs) return data - def update_envelope_workflow_definition_with_http_info(self, account_id, envelope_id, **kwargs): + def update_documents_with_http_info(self, account_id, envelope_id, **kwargs): """ - Updates the envelope workflow definition for an envelope. + Adds one or more documents to an existing envelope document. + Adds one or more documents to an existing envelope document. 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.update_envelope_workflow_definition_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_documents_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Workflow workflow: - :return: Workflow + :param EnvelopeDefinition envelope_definition: + :return: EnvelopeDocumentsResult If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'workflow'] + all_params = ['account_id', 'envelope_id', 'envelope_definition'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13783,21 +11166,21 @@ def update_envelope_workflow_definition_with_http_info(self, account_id, envelop if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_envelope_workflow_definition" % key + " to method update_documents" % 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 `update_envelope_workflow_definition`") + raise ValueError("Missing the required parameter `account_id` when calling `update_documents`") # 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 `update_envelope_workflow_definition`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_documents`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -13812,8 +11195,8 @@ def update_envelope_workflow_definition_with_http_info(self, account_id, envelop local_var_files = {} body_params = None - if 'workflow' in params: - body_params = params['workflow'] + if 'envelope_definition' in params: + body_params = params['envelope_definition'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13828,7 +11211,7 @@ def update_envelope_workflow_definition_with_http_info(self, account_id, envelop body=body_params, post_params=form_params, files=local_var_files, - response_type='Workflow', + response_type='EnvelopeDocumentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13836,57 +11219,57 @@ def update_envelope_workflow_definition_with_http_info(self, account_id, envelop _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_lock(self, account_id, envelope_id, **kwargs): + def update_email_settings(self, account_id, envelope_id, **kwargs): """ - Updates an envelope lock. - Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated. + Updates the email setting overrides for an envelope. + Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted. 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.update_lock(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_email_settings(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param LockRequest lock_request: - :return: LockInformation + :param EmailSettings email_settings: + :return: EmailSettings If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_lock_with_http_info(account_id, envelope_id, **kwargs) + return self.update_email_settings_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_lock_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_email_settings_with_http_info(account_id, envelope_id, **kwargs) return data - def update_lock_with_http_info(self, account_id, envelope_id, **kwargs): + def update_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): """ - Updates an envelope lock. - Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated. + Updates the email setting overrides for an envelope. + Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted. 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.update_lock_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_email_settings_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param LockRequest lock_request: - :return: LockInformation + :param EmailSettings email_settings: + :return: EmailSettings If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'lock_request'] + all_params = ['account_id', 'envelope_id', 'email_settings'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13897,21 +11280,21 @@ def update_lock_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_lock" % key + " to method update_email_settings" % 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 `update_lock`") + raise ValueError("Missing the required parameter `account_id` when calling `update_email_settings`") # 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 `update_lock`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_email_settings`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -13926,8 +11309,8 @@ def update_lock_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None - if 'lock_request' in params: - body_params = params['lock_request'] + if 'email_settings' in params: + body_params = params['email_settings'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13942,7 +11325,7 @@ def update_lock_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='LockInformation', + response_type='EmailSettings', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13950,55 +11333,55 @@ def update_lock_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_notification_settings(self, account_id, envelope_id, **kwargs): + def update_envelope_transfer_rule(self, account_id, envelope_transfer_rule_id, **kwargs): """ - Sets envelope notification (Reminders/Expirations) structure for an existing envelope. + Update an envelope transfer rule for an account. 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.update_notification_settings(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_envelope_transfer_rule(account_id, envelope_transfer_rule_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EnvelopeNotificationRequest envelope_notification_request: - :return: Notification + :param str envelope_transfer_rule_id: (required) + :param EnvelopeTransferRule envelope_transfer_rule: + :return: EnvelopeTransferRule If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_notification_settings_with_http_info(account_id, envelope_id, **kwargs) + return self.update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) else: - (data) = self.update_notification_settings_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) return data - def update_notification_settings_with_http_info(self, account_id, envelope_id, **kwargs): + def update_envelope_transfer_rule_with_http_info(self, account_id, envelope_transfer_rule_id, **kwargs): """ - Sets envelope notification (Reminders/Expirations) structure for an existing envelope. + Update an envelope transfer rule for an account. 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.update_notification_settings_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EnvelopeNotificationRequest envelope_notification_request: - :return: Notification + :param str envelope_transfer_rule_id: (required) + :param EnvelopeTransferRule envelope_transfer_rule: + :return: EnvelopeTransferRule If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'envelope_notification_request'] + all_params = ['account_id', 'envelope_transfer_rule_id', 'envelope_transfer_rule'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14009,26 +11392,26 @@ def update_notification_settings_with_http_info(self, account_id, envelope_id, * if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_notification_settings" % key + " to method update_envelope_transfer_rule" % 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 `update_notification_settings`") - # 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 `update_notification_settings`") + raise ValueError("Missing the required parameter `account_id` when calling `update_envelope_transfer_rule`") + # verify the required parameter 'envelope_transfer_rule_id' is set + if ('envelope_transfer_rule_id' not in params) or (params['envelope_transfer_rule_id'] is None): + raise ValueError("Missing the required parameter `envelope_transfer_rule_id` when calling `update_envelope_transfer_rule`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}'.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'] + if 'envelope_transfer_rule_id' in params: + path_params['envelopeTransferRuleId'] = params['envelope_transfer_rule_id'] query_params = {} @@ -14038,8 +11421,8 @@ def update_notification_settings_with_http_info(self, account_id, envelope_id, * local_var_files = {} body_params = None - if 'envelope_notification_request' in params: - body_params = params['envelope_notification_request'] + if 'envelope_transfer_rule' in params: + body_params = params['envelope_transfer_rule'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -14054,7 +11437,7 @@ def update_notification_settings_with_http_info(self, account_id, envelope_id, * body=body_params, post_params=form_params, files=local_var_files, - response_type='Notification', + response_type='EnvelopeTransferRule', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -14062,53 +11445,53 @@ def update_notification_settings_with_http_info(self, account_id, envelope_id, * _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_page_info(self, account_id, envelope_id, **kwargs): + def update_envelope_transfer_rules(self, account_id, **kwargs): """ - Update page information for Display Appliance + Update envelope transfer rules for an account. 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.update_page_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_envelope_transfer_rules(account_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param EnvelopeTransferRuleInformation envelope_transfer_rule_information: + :return: EnvelopeTransferRuleInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_page_info_with_http_info(account_id, envelope_id, **kwargs) + return self.update_envelope_transfer_rules_with_http_info(account_id, **kwargs) else: - (data) = self.update_page_info_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_envelope_transfer_rules_with_http_info(account_id, **kwargs) return data - def update_page_info_with_http_info(self, account_id, envelope_id, **kwargs): + def update_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): """ - Update page information for Display Appliance + Update envelope transfer rules for an account. 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.update_page_info_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_envelope_transfer_rules_with_http_info(account_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param EnvelopeTransferRuleInformation envelope_transfer_rule_information: + :return: EnvelopeTransferRuleInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_transfer_rule_information'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14119,26 +11502,21 @@ def update_page_info_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_page_info" % key + " to method update_envelope_transfer_rules" % 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 `update_page_info`") - # 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 `update_page_info`") + raise ValueError("Missing the required parameter `account_id` when calling `update_envelope_transfer_rules`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/transfer_rules'.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 = {} @@ -14148,6 +11526,8 @@ def update_page_info_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None + if 'envelope_transfer_rule_information' in params: + body_params = params['envelope_transfer_rule_information'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -14162,7 +11542,7 @@ def update_page_info_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='EnvelopeTransferRuleInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -14170,53 +11550,55 @@ def update_page_info_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_pdf(self, account_id, envelope_id, **kwargs): + def update_envelope_workflow_definition(self, account_id, envelope_id, **kwargs): """ - Set latest pdf for Display Appliance + Updates the envelope workflow definition for 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.update_pdf(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_envelope_workflow_definition(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayAppliancePdf + :param Workflow workflow: + :return: Workflow If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_pdf_with_http_info(account_id, envelope_id, **kwargs) + return self.update_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_pdf_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) return data - def update_pdf_with_http_info(self, account_id, envelope_id, **kwargs): + def update_envelope_workflow_definition_with_http_info(self, account_id, envelope_id, **kwargs): """ - Set latest pdf for Display Appliance + Updates the envelope workflow definition for 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.update_pdf_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_envelope_workflow_definition_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: DisplayAppliancePdf + :param Workflow workflow: + :return: Workflow If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'workflow'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14227,21 +11609,21 @@ def update_pdf_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_pdf" % key + " to method update_envelope_workflow_definition" % 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 `update_pdf`") + raise ValueError("Missing the required parameter `account_id` when calling `update_envelope_workflow_definition`") # 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 `update_pdf`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_envelope_workflow_definition`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -14256,6 +11638,8 @@ def update_pdf_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None + if 'workflow' in params: + body_params = params['workflow'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -14270,7 +11654,7 @@ def update_pdf_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='DisplayAppliancePdf', + response_type='Workflow', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -14278,53 +11662,57 @@ def update_pdf_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_pdf_blob(self, account_id, envelope_id, **kwargs): + def update_lock(self, account_id, envelope_id, **kwargs): """ - Update pdf blobs for Display Appliance + Updates an envelope lock. + Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated. 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.update_pdf_blob(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_lock(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param LockRequest lock_request: + :return: LockInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) + return self.update_lock_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_lock_with_http_info(account_id, envelope_id, **kwargs) return data - def update_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): + def update_lock_with_http_info(self, account_id, envelope_id, **kwargs): """ - Update pdf blobs for Display Appliance + Updates an envelope lock. + Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated. 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.update_pdf_blob_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_lock_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param LockRequest lock_request: + :return: LockInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'lock_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14335,21 +11723,21 @@ def update_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_pdf_blob" % key + " to method update_lock" % 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 `update_pdf_blob`") + raise ValueError("Missing the required parameter `account_id` when calling `update_lock`") # 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 `update_pdf_blob`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_lock`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -14364,6 +11752,8 @@ def update_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None + if 'lock_request' in params: + body_params = params['lock_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -14378,7 +11768,7 @@ def update_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='LockInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -14386,53 +11776,55 @@ def update_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_recipient_denied_document_copy(self, account_id, envelope_id, **kwargs): + def update_notification_settings(self, account_id, envelope_id, **kwargs): """ - Update RecipientDeniedDocumentCopy for Display Appliance + Sets envelope notification (Reminders/Expirations) structure for an existing 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.update_recipient_denied_document_copy(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_notification_settings(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param EnvelopeNotificationRequest envelope_notification_request: + :return: Notification If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_recipient_denied_document_copy_with_http_info(account_id, envelope_id, **kwargs) + return self.update_notification_settings_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_recipient_denied_document_copy_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_notification_settings_with_http_info(account_id, envelope_id, **kwargs) return data - def update_recipient_denied_document_copy_with_http_info(self, account_id, envelope_id, **kwargs): + def update_notification_settings_with_http_info(self, account_id, envelope_id, **kwargs): """ - Update RecipientDeniedDocumentCopy for Display Appliance + Sets envelope notification (Reminders/Expirations) structure for an existing 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.update_recipient_denied_document_copy_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_notification_settings_with_http_info(account_id, envelope_id, callback=callback_function) :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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param EnvelopeNotificationRequest envelope_notification_request: + :return: Notification If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'envelope_notification_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14443,21 +11835,21 @@ def update_recipient_denied_document_copy_with_http_info(self, account_id, envel if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_recipient_denied_document_copy" % key + " to method update_notification_settings" % 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 `update_recipient_denied_document_copy`") + raise ValueError("Missing the required parameter `account_id` when calling `update_notification_settings`") # 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 `update_recipient_denied_document_copy`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_notification_settings`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/recipient_denied_copy'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -14472,6 +11864,8 @@ def update_recipient_denied_document_copy_with_http_info(self, account_id, envel local_var_files = {} body_params = None + if 'envelope_notification_request' in params: + body_params = params['envelope_notification_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -14486,7 +11880,7 @@ def update_recipient_denied_document_copy_with_http_info(self, account_id, envel body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='Notification', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/docusign_esign/apis/trust_service_providers_api.py b/docusign_esign/apis/trust_service_providers_api.py index 7950e3e5..3c38d87c 100644 --- a/docusign_esign/apis/trust_service_providers_api.py +++ b/docusign_esign/apis/trust_service_providers_api.py @@ -40,104 +40,6 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def complete_sign_hash(self, **kwargs): - """ - Complete Sign Hash - 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.complete_sign_hash(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CompleteSignRequest complete_sign_request: - :return: CompleteSignHashResponse - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.complete_sign_hash_with_http_info(**kwargs) - else: - (data) = self.complete_sign_hash_with_http_info(**kwargs) - return data - - def complete_sign_hash_with_http_info(self, **kwargs): - """ - Complete Sign Hash - 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.complete_sign_hash_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CompleteSignRequest complete_sign_request: - :return: CompleteSignHashResponse - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['complete_sign_request'] - 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 complete_sign_hash" % key - ) - params[key] = val - del params['kwargs'] - - - collection_formats = {} - - resource_path = '/v2.1/signature/completesignhash'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'complete_sign_request' in params: - body_params = params['complete_sign_request'] - # 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, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CompleteSignHashResponse', - 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_seal_providers(self, account_id, **kwargs): """ Returns Account available seals for specified account. @@ -238,390 +140,3 @@ def get_seal_providers_with_http_info(self, account_id, **kwargs): _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - - def get_user_info(self, **kwargs): - """ - Get User Info To Sign Document - 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_user_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: UserInfoResponse - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_user_info_with_http_info(**kwargs) - else: - (data) = self.get_user_info_with_http_info(**kwargs) - return data - - def get_user_info_with_http_info(self, **kwargs): - """ - Get User Info To Sign Document - 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_user_info_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: UserInfoResponse - If the method is called asynchronously, - returns the request thread. - """ - - all_params = [] - 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_user_info" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - resource_path = '/v2.1/signature/userInfo'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - 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='UserInfoResponse', - 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 health_check(self, **kwargs): - """ - Report status from the TSP to DocuSign - 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.health_check(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param TspHealthCheckRequest tsp_health_check_request: - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.health_check_with_http_info(**kwargs) - else: - (data) = self.health_check_with_http_info(**kwargs) - return data - - def health_check_with_http_info(self, **kwargs): - """ - Report status from the TSP to DocuSign - 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.health_check_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param TspHealthCheckRequest tsp_health_check_request: - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['tsp_health_check_request'] - 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 health_check" % key - ) - params[key] = val - del params['kwargs'] - - - collection_formats = {} - - resource_path = '/v2.1/signature/healthcheck'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'tsp_health_check_request' in params: - body_params = params['tsp_health_check_request'] - # 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, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, - 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 sign_hash_session_info(self, **kwargs): - """ - Get Signature Session Info To Sign Document Hash - 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.sign_hash_session_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param SignSessionInfoRequest sign_session_info_request: - :return: SignHashSessionInfoResponse - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.sign_hash_session_info_with_http_info(**kwargs) - else: - (data) = self.sign_hash_session_info_with_http_info(**kwargs) - return data - - def sign_hash_session_info_with_http_info(self, **kwargs): - """ - Get Signature Session Info To Sign Document Hash - 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.sign_hash_session_info_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param SignSessionInfoRequest sign_session_info_request: - :return: SignHashSessionInfoResponse - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['sign_session_info_request'] - 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 sign_hash_session_info" % key - ) - params[key] = val - del params['kwargs'] - - - collection_formats = {} - - resource_path = '/v2.1/signature/signhashsessioninfo'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'sign_session_info_request' in params: - body_params = params['sign_session_info_request'] - # 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, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SignHashSessionInfoResponse', - 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 update_transaction(self, **kwargs): - """ - Report an error from the tsp to docusign - 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.update_transaction(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UpdateTransactionRequest update_transaction_request: - :return: UpdateTransactionResponse - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_transaction_with_http_info(**kwargs) - else: - (data) = self.update_transaction_with_http_info(**kwargs) - return data - - def update_transaction_with_http_info(self, **kwargs): - """ - Report an error from the tsp to docusign - 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.update_transaction_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UpdateTransactionRequest update_transaction_request: - :return: UpdateTransactionResponse - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['update_transaction_request'] - 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 update_transaction" % key - ) - params[key] = val - del params['kwargs'] - - - collection_formats = {} - - resource_path = '/v2.1/signature/updatetransaction'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'update_transaction_request' in params: - body_params = params['update_transaction_request'] - # 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, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UpdateTransactionResponse', - 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) diff --git a/docusign_esign/apis/users_api.py b/docusign_esign/apis/users_api.py index 552b237f..baf3358a 100644 --- a/docusign_esign/apis/users_api.py +++ b/docusign_esign/apis/users_api.py @@ -1859,114 +1859,6 @@ def get_signature_image_with_http_info(self, account_id, image_type, signature_i _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_user_list_export(self, organization_id, result_id, **kwargs): - """ - Retrieves UserList Export Results data. - 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_user_list_export(organization_id, result_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str organization_id: (required) - :param str result_id: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_user_list_export_with_http_info(organization_id, result_id, **kwargs) - else: - (data) = self.get_user_list_export_with_http_info(organization_id, result_id, **kwargs) - return data - - def get_user_list_export_with_http_info(self, organization_id, result_id, **kwargs): - """ - Retrieves UserList Export Results data. - 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_user_list_export_with_http_info(organization_id, result_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str organization_id: (required) - :param str result_id: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organization_id', 'result_id'] - 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_user_list_export" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'organization_id' is set - if ('organization_id' not in params) or (params['organization_id'] is None): - raise ValueError("Missing the required parameter `organization_id` when calling `get_user_list_export`") - # verify the required parameter 'result_id' is set - if ('result_id' not in params) or (params['result_id'] is None): - raise ValueError("Missing the required parameter `result_id` when calling `get_user_list_export`") - - - collection_formats = {} - - resource_path = '/v2.1/organization_exports/{organizationId}/user_list/{resultId}'.replace('{format}', 'json') - path_params = {} - if 'organization_id' in params: - path_params['organizationId'] = params['organization_id'] - if 'result_id' in params: - path_params['resultId'] = params['result_id'] - - query_params = {} - - 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=None, - 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 list(self, account_id, **kwargs): """ Retrieves the list of users for the specified account. diff --git a/docusign_esign/client/configuration.py b/docusign_esign/client/configuration.py index e3a21992..0605405a 100644 --- a/docusign_esign/client/configuration.py +++ b/docusign_esign/client/configuration.py @@ -90,9 +90,9 @@ def __init__(self): self.key_file = None if PY3: - self.user_agent = 'Swagger-Codegen/v2.1/3.9.0rc1/python3' + self.user_agent = 'Swagger-Codegen/v2.1/3.10.0rc1/python3' else: - self.user_agent = 'Swagger-Codegen/v2.1/3.9.0rc1/python2' + self.user_agent = 'Swagger-Codegen/v2.1/3.10.0rc1/python2' @property def logger_file(self): diff --git a/docusign_esign/models/__init__.py b/docusign_esign/models/__init__.py index b9caae77..b9625721 100644 --- a/docusign_esign/models/__init__.py +++ b/docusign_esign/models/__init__.py @@ -137,8 +137,6 @@ from docusign_esign.models.commission_number import CommissionNumber from docusign_esign.models.commission_state import CommissionState from docusign_esign.models.company import Company -from docusign_esign.models.complete_sign_hash_response import CompleteSignHashResponse -from docusign_esign.models.complete_sign_request import CompleteSignRequest from docusign_esign.models.composite_template import CompositeTemplate from docusign_esign.models.conditional_recipient_rule import ConditionalRecipientRule from docusign_esign.models.conditional_recipient_rule_condition import ConditionalRecipientRuleCondition @@ -164,7 +162,6 @@ from docusign_esign.models.contact_update_response import ContactUpdateResponse from docusign_esign.models.correct_view_request import CorrectViewRequest from docusign_esign.models.country import Country -from docusign_esign.models.credential import Credential from docusign_esign.models.credit_card_information import CreditCardInformation from docusign_esign.models.credit_card_types import CreditCardTypes from docusign_esign.models.currency import Currency @@ -179,10 +176,7 @@ from docusign_esign.models.decline import Decline from docusign_esign.models.diagnostics_settings_information import DiagnosticsSettingsInformation from docusign_esign.models.direct_debit_processor_information import DirectDebitProcessorInformation -from docusign_esign.models.display_appliance_account import DisplayApplianceAccount from docusign_esign.models.display_appliance_info import DisplayApplianceInfo -from docusign_esign.models.display_appliance_pdf import DisplayAppliancePdf -from docusign_esign.models.display_appliance_signer_attachment import DisplayApplianceSignerAttachment from docusign_esign.models.dob_information_input import DobInformationInput from docusign_esign.models.document import Document from docusign_esign.models.document_fields_information import DocumentFieldsInformation @@ -193,10 +187,8 @@ from docusign_esign.models.document_html_definitions import DocumentHtmlDefinitions from docusign_esign.models.document_html_display_anchor import DocumentHtmlDisplayAnchor from docusign_esign.models.document_html_display_settings import DocumentHtmlDisplaySettings -from docusign_esign.models.document_security_store import DocumentSecurityStore from docusign_esign.models.document_template import DocumentTemplate from docusign_esign.models.document_template_list import DocumentTemplateList -from docusign_esign.models.document_update_info import DocumentUpdateInfo from docusign_esign.models.document_visibility import DocumentVisibility from docusign_esign.models.document_visibility_list import DocumentVisibilityList from docusign_esign.models.downgrad_request_billing_info_response import DowngradRequestBillingInfoResponse @@ -237,7 +229,6 @@ from docusign_esign.models.event_notification import EventNotification from docusign_esign.models.event_result import EventResult from docusign_esign.models.expirations import Expirations -from docusign_esign.models.external_claim import ExternalClaim from docusign_esign.models.external_doc_service_error_details import ExternalDocServiceErrorDetails from docusign_esign.models.external_document_sources import ExternalDocumentSources from docusign_esign.models.external_file import ExternalFile @@ -395,26 +386,18 @@ from docusign_esign.models.report_in_product_sent_by_details import ReportInProductSentByDetails from docusign_esign.models.resource_information import ResourceInformation from docusign_esign.models.return_url_request import ReturnUrlRequest -from docusign_esign.models.revision import Revision -from docusign_esign.models.seal import Seal from docusign_esign.models.seal_identifier import SealIdentifier from docusign_esign.models.seal_sign import SealSign from docusign_esign.models.seat_discount import SeatDiscount -from docusign_esign.models.sender import Sender from docusign_esign.models.sender_email_notifications import SenderEmailNotifications from docusign_esign.models.server_template import ServerTemplate from docusign_esign.models.service_information import ServiceInformation from docusign_esign.models.service_version import ServiceVersion from docusign_esign.models.settings_metadata import SettingsMetadata from docusign_esign.models.shared_item import SharedItem -from docusign_esign.models.sign_hash_document import SignHashDocument -from docusign_esign.models.sign_hash_session_info_response import SignHashSessionInfoResponse from docusign_esign.models.sign_here import SignHere -from docusign_esign.models.sign_session_info_request import SignSessionInfoRequest -from docusign_esign.models.signature_data_info import SignatureDataInfo from docusign_esign.models.signature_group import SignatureGroup from docusign_esign.models.signature_group_def import SignatureGroupDef -from docusign_esign.models.signature_properties import SignatureProperties from docusign_esign.models.signature_provider_required_option import SignatureProviderRequiredOption from docusign_esign.models.signature_type import SignatureType from docusign_esign.models.signature_user import SignatureUser @@ -457,18 +440,11 @@ from docusign_esign.models.template_update_summary import TemplateUpdateSummary from docusign_esign.models.text import Text from docusign_esign.models.text_custom_field import TextCustomField -from docusign_esign.models.time_stamp_field import TimeStampField from docusign_esign.models.title import Title -from docusign_esign.models.tsp_health_check_request import TspHealthCheckRequest -from docusign_esign.models.tsp_health_check_status_description import TspHealthCheckStatusDescription -from docusign_esign.models.update_transaction_request import UpdateTransactionRequest -from docusign_esign.models.update_transaction_response import UpdateTransactionResponse from docusign_esign.models.usage_history import UsageHistory -from docusign_esign.models.user import User from docusign_esign.models.user_account_management_granular_information import UserAccountManagementGranularInformation from docusign_esign.models.user_info import UserInfo from docusign_esign.models.user_info_list import UserInfoList -from docusign_esign.models.user_info_response import UserInfoResponse from docusign_esign.models.user_information import UserInformation from docusign_esign.models.user_information_list import UserInformationList from docusign_esign.models.user_password_information import UserPasswordInformation diff --git a/docusign_esign/models/account_settings_information.py b/docusign_esign/models/account_settings_information.py index 4cec5cce..6fc60a87 100644 --- a/docusign_esign/models/account_settings_information.py +++ b/docusign_esign/models/account_settings_information.py @@ -286,6 +286,8 @@ class AccountSettingsInformation(object): 'enable_agreement_actions_for_e_sign_metadata': 'SettingsMetadata', 'enable_auto_nav': 'str', 'enable_auto_nav_metadata': 'SettingsMetadata', + 'enable_bcc_dummy_link': 'str', + 'enable_bcc_dummy_link_metadata': 'SettingsMetadata', 'enable_calculated_fields': 'str', 'enable_calculated_fields_metadata': 'SettingsMetadata', 'enable_clickwraps': 'str', @@ -306,12 +308,16 @@ class AccountSettingsInformation(object): 'enable_in_browser_editor_metadata': 'SettingsMetadata', 'enable_payment_processing': 'str', 'enable_payment_processing_metadata': 'SettingsMetadata', + 'enable_pdfa_conversion': 'str', + 'enable_pdfa_conversion_metadata': 'SettingsMetadata', 'enable_power_form': 'str', 'enable_power_form_direct': 'str', 'enable_power_form_direct_metadata': 'SettingsMetadata', 'enable_power_form_metadata': 'SettingsMetadata', 'enable_recipient_domain_validation': 'str', 'enable_recipient_domain_validation_metadata': 'SettingsMetadata', + 'enable_recipient_may_provide_phone_number': 'str', + 'enable_recipient_may_provide_phone_number_metadata': 'SettingsMetadata', 'enable_report_links': 'str', 'enable_report_links_metadata': 'SettingsMetadata', 'enable_require_sign_on_paper': 'str', @@ -837,6 +843,8 @@ class AccountSettingsInformation(object): 'enable_agreement_actions_for_e_sign_metadata': 'enableAgreementActionsForESignMetadata', 'enable_auto_nav': 'enableAutoNav', 'enable_auto_nav_metadata': 'enableAutoNavMetadata', + 'enable_bcc_dummy_link': 'enableBccDummyLink', + 'enable_bcc_dummy_link_metadata': 'enableBccDummyLinkMetadata', 'enable_calculated_fields': 'enableCalculatedFields', 'enable_calculated_fields_metadata': 'enableCalculatedFieldsMetadata', 'enable_clickwraps': 'enableClickwraps', @@ -857,12 +865,16 @@ class AccountSettingsInformation(object): 'enable_in_browser_editor_metadata': 'enableInBrowserEditorMetadata', 'enable_payment_processing': 'enablePaymentProcessing', 'enable_payment_processing_metadata': 'enablePaymentProcessingMetadata', + 'enable_pdfa_conversion': 'enablePDFAConversion', + 'enable_pdfa_conversion_metadata': 'enablePDFAConversionMetadata', 'enable_power_form': 'enablePowerForm', 'enable_power_form_direct': 'enablePowerFormDirect', 'enable_power_form_direct_metadata': 'enablePowerFormDirectMetadata', 'enable_power_form_metadata': 'enablePowerFormMetadata', 'enable_recipient_domain_validation': 'enableRecipientDomainValidation', 'enable_recipient_domain_validation_metadata': 'enableRecipientDomainValidationMetadata', + 'enable_recipient_may_provide_phone_number': 'enableRecipientMayProvidePhoneNumber', + 'enable_recipient_may_provide_phone_number_metadata': 'enableRecipientMayProvidePhoneNumberMetadata', 'enable_report_links': 'enableReportLinks', 'enable_report_links_metadata': 'enableReportLinksMetadata', 'enable_require_sign_on_paper': 'enableRequireSignOnPaper', @@ -1390,6 +1402,8 @@ def __init__(self, **kwargs): self._enable_agreement_actions_for_e_sign_metadata = None self._enable_auto_nav = None self._enable_auto_nav_metadata = None + self._enable_bcc_dummy_link = None + self._enable_bcc_dummy_link_metadata = None self._enable_calculated_fields = None self._enable_calculated_fields_metadata = None self._enable_clickwraps = None @@ -1410,12 +1424,16 @@ def __init__(self, **kwargs): self._enable_in_browser_editor_metadata = None self._enable_payment_processing = None self._enable_payment_processing_metadata = None + self._enable_pdfa_conversion = None + self._enable_pdfa_conversion_metadata = None self._enable_power_form = None self._enable_power_form_direct = None self._enable_power_form_direct_metadata = None self._enable_power_form_metadata = None self._enable_recipient_domain_validation = None self._enable_recipient_domain_validation_metadata = None + self._enable_recipient_may_provide_phone_number = None + self._enable_recipient_may_provide_phone_number_metadata = None self._enable_report_links = None self._enable_report_links_metadata = None self._enable_require_sign_on_paper = None @@ -7300,6 +7318,50 @@ def enable_auto_nav_metadata(self, enable_auto_nav_metadata): self._enable_auto_nav_metadata = enable_auto_nav_metadata + @property + def enable_bcc_dummy_link(self): + """Gets the enable_bcc_dummy_link of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The enable_bcc_dummy_link of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._enable_bcc_dummy_link + + @enable_bcc_dummy_link.setter + def enable_bcc_dummy_link(self, enable_bcc_dummy_link): + """Sets the enable_bcc_dummy_link of this AccountSettingsInformation. + + # noqa: E501 + + :param enable_bcc_dummy_link: The enable_bcc_dummy_link of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._enable_bcc_dummy_link = enable_bcc_dummy_link + + @property + def enable_bcc_dummy_link_metadata(self): + """Gets the enable_bcc_dummy_link_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The enable_bcc_dummy_link_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._enable_bcc_dummy_link_metadata + + @enable_bcc_dummy_link_metadata.setter + def enable_bcc_dummy_link_metadata(self, enable_bcc_dummy_link_metadata): + """Sets the enable_bcc_dummy_link_metadata of this AccountSettingsInformation. + + + :param enable_bcc_dummy_link_metadata: The enable_bcc_dummy_link_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._enable_bcc_dummy_link_metadata = enable_bcc_dummy_link_metadata + @property def enable_calculated_fields(self): """Gets the enable_calculated_fields of this AccountSettingsInformation. # noqa: E501 @@ -7740,6 +7802,50 @@ def enable_payment_processing_metadata(self, enable_payment_processing_metadata) self._enable_payment_processing_metadata = enable_payment_processing_metadata + @property + def enable_pdfa_conversion(self): + """Gets the enable_pdfa_conversion of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The enable_pdfa_conversion of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._enable_pdfa_conversion + + @enable_pdfa_conversion.setter + def enable_pdfa_conversion(self, enable_pdfa_conversion): + """Sets the enable_pdfa_conversion of this AccountSettingsInformation. + + # noqa: E501 + + :param enable_pdfa_conversion: The enable_pdfa_conversion of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._enable_pdfa_conversion = enable_pdfa_conversion + + @property + def enable_pdfa_conversion_metadata(self): + """Gets the enable_pdfa_conversion_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The enable_pdfa_conversion_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._enable_pdfa_conversion_metadata + + @enable_pdfa_conversion_metadata.setter + def enable_pdfa_conversion_metadata(self, enable_pdfa_conversion_metadata): + """Sets the enable_pdfa_conversion_metadata of this AccountSettingsInformation. + + + :param enable_pdfa_conversion_metadata: The enable_pdfa_conversion_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._enable_pdfa_conversion_metadata = enable_pdfa_conversion_metadata + @property def enable_power_form(self): """Gets the enable_power_form of this AccountSettingsInformation. # noqa: E501 @@ -7872,6 +7978,50 @@ def enable_recipient_domain_validation_metadata(self, enable_recipient_domain_va self._enable_recipient_domain_validation_metadata = enable_recipient_domain_validation_metadata + @property + def enable_recipient_may_provide_phone_number(self): + """Gets the enable_recipient_may_provide_phone_number of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The enable_recipient_may_provide_phone_number of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._enable_recipient_may_provide_phone_number + + @enable_recipient_may_provide_phone_number.setter + def enable_recipient_may_provide_phone_number(self, enable_recipient_may_provide_phone_number): + """Sets the enable_recipient_may_provide_phone_number of this AccountSettingsInformation. + + # noqa: E501 + + :param enable_recipient_may_provide_phone_number: The enable_recipient_may_provide_phone_number of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._enable_recipient_may_provide_phone_number = enable_recipient_may_provide_phone_number + + @property + def enable_recipient_may_provide_phone_number_metadata(self): + """Gets the enable_recipient_may_provide_phone_number_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The enable_recipient_may_provide_phone_number_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._enable_recipient_may_provide_phone_number_metadata + + @enable_recipient_may_provide_phone_number_metadata.setter + def enable_recipient_may_provide_phone_number_metadata(self, enable_recipient_may_provide_phone_number_metadata): + """Sets the enable_recipient_may_provide_phone_number_metadata of this AccountSettingsInformation. + + + :param enable_recipient_may_provide_phone_number_metadata: The enable_recipient_may_provide_phone_number_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._enable_recipient_may_provide_phone_number_metadata = enable_recipient_may_provide_phone_number_metadata + @property def enable_report_links(self): """Gets the enable_report_links of this AccountSettingsInformation. # noqa: E501 diff --git a/docusign_esign/models/account_ui_settings.py b/docusign_esign/models/account_ui_settings.py index 482913a6..501ece19 100644 --- a/docusign_esign/models/account_ui_settings.py +++ b/docusign_esign/models/account_ui_settings.py @@ -35,7 +35,6 @@ class AccountUISettings(object): 'ask_an_admin': 'AskAnAdmin', 'enable_admin_message': 'str', 'enable_admin_message_metadata': 'SettingsMetadata', - 'enable_advanced_payments_react_edit': 'str', 'enable_easy_sign_can_use_multi_template_apply': 'str', 'enable_easy_sign_can_use_multi_template_apply_metadata': 'SettingsMetadata', 'enable_easy_sign_template_upload': 'str', @@ -67,7 +66,6 @@ class AccountUISettings(object): 'ask_an_admin': 'askAnAdmin', 'enable_admin_message': 'enableAdminMessage', 'enable_admin_message_metadata': 'enableAdminMessageMetadata', - 'enable_advanced_payments_react_edit': 'enableAdvancedPaymentsReactEdit', 'enable_easy_sign_can_use_multi_template_apply': 'enableEasySignCanUseMultiTemplateApply', 'enable_easy_sign_can_use_multi_template_apply_metadata': 'enableEasySignCanUseMultiTemplateApplyMetadata', 'enable_easy_sign_template_upload': 'enableEasySignTemplateUpload', @@ -94,14 +92,13 @@ class AccountUISettings(object): 'upload_new_image_to_sign_or_initial_metadata': 'uploadNewImageToSignOrInitialMetadata' } - def __init__(self, admin_message=None, ask_an_admin=None, enable_admin_message=None, enable_admin_message_metadata=None, enable_advanced_payments_react_edit=None, enable_easy_sign_can_use_multi_template_apply=None, enable_easy_sign_can_use_multi_template_apply_metadata=None, enable_easy_sign_template_upload=None, enable_easy_sign_template_upload_metadata=None, enable_envelope_copy_with_data=None, enable_envelope_copy_with_data_metadata=None, enable_legacy_homepage_link=None, enable_legacy_homepage_link_metadata=None, has_external_linked_accounts=None, has_external_linked_accounts_metadata=None, hide_send_an_envelope=None, hide_send_an_envelope_metadata=None, hide_use_a_template=None, hide_use_a_template_in_prepare=None, hide_use_a_template_in_prepare_metadata=None, hide_use_a_template_metadata=None, order_based_recipient_id_generation=None, order_based_recipient_id_generation_metadata=None, remove_envelope_forwarding=None, remove_envelope_forwarding_metadata=None, should_redact_access_code=None, should_redact_access_code_metadata=None, upload_new_image_to_sign_or_initial=None, upload_new_image_to_sign_or_initial_metadata=None): # noqa: E501 + def __init__(self, admin_message=None, ask_an_admin=None, enable_admin_message=None, enable_admin_message_metadata=None, enable_easy_sign_can_use_multi_template_apply=None, enable_easy_sign_can_use_multi_template_apply_metadata=None, enable_easy_sign_template_upload=None, enable_easy_sign_template_upload_metadata=None, enable_envelope_copy_with_data=None, enable_envelope_copy_with_data_metadata=None, enable_legacy_homepage_link=None, enable_legacy_homepage_link_metadata=None, has_external_linked_accounts=None, has_external_linked_accounts_metadata=None, hide_send_an_envelope=None, hide_send_an_envelope_metadata=None, hide_use_a_template=None, hide_use_a_template_in_prepare=None, hide_use_a_template_in_prepare_metadata=None, hide_use_a_template_metadata=None, order_based_recipient_id_generation=None, order_based_recipient_id_generation_metadata=None, remove_envelope_forwarding=None, remove_envelope_forwarding_metadata=None, should_redact_access_code=None, should_redact_access_code_metadata=None, upload_new_image_to_sign_or_initial=None, upload_new_image_to_sign_or_initial_metadata=None): # noqa: E501 """AccountUISettings - a model defined in Swagger""" # noqa: E501 self._admin_message = None self._ask_an_admin = None self._enable_admin_message = None self._enable_admin_message_metadata = None - self._enable_advanced_payments_react_edit = None self._enable_easy_sign_can_use_multi_template_apply = None self._enable_easy_sign_can_use_multi_template_apply_metadata = None self._enable_easy_sign_template_upload = None @@ -136,8 +133,6 @@ def __init__(self, admin_message=None, ask_an_admin=None, enable_admin_message=N self.enable_admin_message = enable_admin_message if enable_admin_message_metadata is not None: self.enable_admin_message_metadata = enable_admin_message_metadata - if enable_advanced_payments_react_edit is not None: - self.enable_advanced_payments_react_edit = enable_advanced_payments_react_edit if enable_easy_sign_can_use_multi_template_apply is not None: self.enable_easy_sign_can_use_multi_template_apply = enable_easy_sign_can_use_multi_template_apply if enable_easy_sign_can_use_multi_template_apply_metadata is not None: @@ -273,29 +268,6 @@ def enable_admin_message_metadata(self, enable_admin_message_metadata): self._enable_admin_message_metadata = enable_admin_message_metadata - @property - def enable_advanced_payments_react_edit(self): - """Gets the enable_advanced_payments_react_edit of this AccountUISettings. # noqa: E501 - - # noqa: E501 - - :return: The enable_advanced_payments_react_edit of this AccountUISettings. # noqa: E501 - :rtype: str - """ - return self._enable_advanced_payments_react_edit - - @enable_advanced_payments_react_edit.setter - def enable_advanced_payments_react_edit(self, enable_advanced_payments_react_edit): - """Sets the enable_advanced_payments_react_edit of this AccountUISettings. - - # noqa: E501 - - :param enable_advanced_payments_react_edit: The enable_advanced_payments_react_edit of this AccountUISettings. # noqa: E501 - :type: str - """ - - self._enable_advanced_payments_react_edit = enable_advanced_payments_react_edit - @property def enable_easy_sign_can_use_multi_template_apply(self): """Gets the enable_easy_sign_can_use_multi_template_apply of this AccountUISettings. # noqa: E501 diff --git a/docusign_esign/models/bulk_send_batch_status.py b/docusign_esign/models/bulk_send_batch_status.py index 5e3ed0fa..34b4d33e 100644 --- a/docusign_esign/models/bulk_send_batch_status.py +++ b/docusign_esign/models/bulk_send_batch_status.py @@ -39,6 +39,7 @@ class BulkSendBatchStatus(object): 'envelopes_uri': 'str', 'failed': 'str', 'mailing_list_id': 'str', + 'mailing_list_name': 'str', 'owner_user_id': 'str', 'queued': 'str', 'sender_user_id': 'str', @@ -55,6 +56,7 @@ class BulkSendBatchStatus(object): 'envelopes_uri': 'envelopesUri', 'failed': 'failed', 'mailing_list_id': 'mailingListId', + 'mailing_list_name': 'mailingListName', 'owner_user_id': 'ownerUserId', 'queued': 'queued', 'sender_user_id': 'senderUserId', @@ -62,7 +64,7 @@ class BulkSendBatchStatus(object): 'submitted_date': 'submittedDate' } - def __init__(self, batch_id=None, batch_name=None, batch_size=None, bulk_errors=None, envelope_id_or_template_id=None, envelopes_uri=None, failed=None, mailing_list_id=None, owner_user_id=None, queued=None, sender_user_id=None, sent=None, submitted_date=None): # noqa: E501 + def __init__(self, batch_id=None, batch_name=None, batch_size=None, bulk_errors=None, envelope_id_or_template_id=None, envelopes_uri=None, failed=None, mailing_list_id=None, mailing_list_name=None, owner_user_id=None, queued=None, sender_user_id=None, sent=None, submitted_date=None): # noqa: E501 """BulkSendBatchStatus - a model defined in Swagger""" # noqa: E501 self._batch_id = None @@ -73,6 +75,7 @@ def __init__(self, batch_id=None, batch_name=None, batch_size=None, bulk_errors= self._envelopes_uri = None self._failed = None self._mailing_list_id = None + self._mailing_list_name = None self._owner_user_id = None self._queued = None self._sender_user_id = None @@ -96,6 +99,8 @@ def __init__(self, batch_id=None, batch_name=None, batch_size=None, bulk_errors= self.failed = failed if mailing_list_id is not None: self.mailing_list_id = mailing_list_id + if mailing_list_name is not None: + self.mailing_list_name = mailing_list_name if owner_user_id is not None: self.owner_user_id = owner_user_id if queued is not None: @@ -291,6 +296,29 @@ def mailing_list_id(self, mailing_list_id): self._mailing_list_id = mailing_list_id + @property + def mailing_list_name(self): + """Gets the mailing_list_name of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The mailing_list_name of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._mailing_list_name + + @mailing_list_name.setter + def mailing_list_name(self, mailing_list_name): + """Sets the mailing_list_name of this BulkSendBatchStatus. + + # noqa: E501 + + :param mailing_list_name: The mailing_list_name of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._mailing_list_name = mailing_list_name + @property def owner_user_id(self): """Gets the owner_user_id of this BulkSendBatchStatus. # noqa: E501 diff --git a/docusign_esign/models/conditional_recipient_rule_filter.py b/docusign_esign/models/conditional_recipient_rule_filter.py index 1e91d495..600fcfa3 100644 --- a/docusign_esign/models/conditional_recipient_rule_filter.py +++ b/docusign_esign/models/conditional_recipient_rule_filter.py @@ -36,6 +36,7 @@ class ConditionalRecipientRuleFilter(object): 'scope': 'str', 'tab_id': 'str', 'tab_label': 'str', + 'tab_type': 'str', 'value': 'str' } @@ -45,10 +46,11 @@ class ConditionalRecipientRuleFilter(object): 'scope': 'scope', 'tab_id': 'tabId', 'tab_label': 'tabLabel', + 'tab_type': 'tabType', 'value': 'value' } - def __init__(self, operator=None, recipient_id=None, scope=None, tab_id=None, tab_label=None, value=None): # noqa: E501 + def __init__(self, operator=None, recipient_id=None, scope=None, tab_id=None, tab_label=None, tab_type=None, value=None): # noqa: E501 """ConditionalRecipientRuleFilter - a model defined in Swagger""" # noqa: E501 self._operator = None @@ -56,6 +58,7 @@ def __init__(self, operator=None, recipient_id=None, scope=None, tab_id=None, ta self._scope = None self._tab_id = None self._tab_label = None + self._tab_type = None self._value = None self.discriminator = None @@ -69,6 +72,8 @@ def __init__(self, operator=None, recipient_id=None, scope=None, tab_id=None, ta self.tab_id = tab_id if tab_label is not None: self.tab_label = tab_label + if tab_type is not None: + self.tab_type = tab_type if value is not None: self.value = value @@ -187,6 +192,29 @@ def tab_label(self, tab_label): self._tab_label = tab_label + @property + def tab_type(self): + """Gets the tab_type of this ConditionalRecipientRuleFilter. # noqa: E501 + + # noqa: E501 + + :return: The tab_type of this ConditionalRecipientRuleFilter. # noqa: E501 + :rtype: str + """ + return self._tab_type + + @tab_type.setter + def tab_type(self, tab_type): + """Sets the tab_type of this ConditionalRecipientRuleFilter. + + # noqa: E501 + + :param tab_type: The tab_type of this ConditionalRecipientRuleFilter. # noqa: E501 + :type: str + """ + + self._tab_type = tab_type + @property def value(self): """Gets the value of this ConditionalRecipientRuleFilter. # noqa: E501 diff --git a/docusign_esign/models/envelope.py b/docusign_esign/models/envelope.py index 68507a5c..cef26dc0 100644 --- a/docusign_esign/models/envelope.py +++ b/docusign_esign/models/envelope.py @@ -54,6 +54,7 @@ class Envelope(object): 'deleted_date_time': 'str', 'delivered_date_time': 'str', 'disable_responsive_document': 'str', + 'document_base64': 'str', 'documents_combined_uri': 'str', 'documents_uri': 'str', 'email_blurb': 'str', @@ -133,6 +134,7 @@ class Envelope(object): 'deleted_date_time': 'deletedDateTime', 'delivered_date_time': 'deliveredDateTime', 'disable_responsive_document': 'disableResponsiveDocument', + 'document_base64': 'documentBase64', 'documents_combined_uri': 'documentsCombinedUri', 'documents_uri': 'documentsUri', 'email_blurb': 'emailBlurb', @@ -188,7 +190,7 @@ class Envelope(object): 'workflow': 'workflow' } - def __init__(self, access_control_list_base64=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, copy_recipient_data=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, disable_responsive_document=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified_date_time=None, location=None, lock_information=None, message_lock=None, notification=None, notification_uri=None, power_form=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sender=None, sent_date_time=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, templates_uri=None, transaction_id=None, use_disclosure=None, voided_date_time=None, voided_reason=None, workflow=None): # noqa: E501 + def __init__(self, access_control_list_base64=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, copy_recipient_data=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, disable_responsive_document=None, document_base64=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified_date_time=None, location=None, lock_information=None, message_lock=None, notification=None, notification_uri=None, power_form=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sender=None, sent_date_time=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, templates_uri=None, transaction_id=None, use_disclosure=None, voided_date_time=None, voided_reason=None, workflow=None): # noqa: E501 """Envelope - a model defined in Swagger""" # noqa: E501 self._access_control_list_base64 = None @@ -214,6 +216,7 @@ def __init__(self, access_control_list_base64=None, allow_comments=None, allow_m self._deleted_date_time = None self._delivered_date_time = None self._disable_responsive_document = None + self._document_base64 = None self._documents_combined_uri = None self._documents_uri = None self._email_blurb = None @@ -315,6 +318,8 @@ def __init__(self, access_control_list_base64=None, allow_comments=None, allow_m self.delivered_date_time = delivered_date_time if disable_responsive_document is not None: self.disable_responsive_document = disable_responsive_document + if document_base64 is not None: + self.document_base64 = document_base64 if documents_combined_uri is not None: self.documents_combined_uri = documents_combined_uri if documents_uri is not None: @@ -949,6 +954,29 @@ def disable_responsive_document(self, disable_responsive_document): self._disable_responsive_document = disable_responsive_document + @property + def document_base64(self): + """Gets the document_base64 of this Envelope. # noqa: E501 + + # noqa: E501 + + :return: The document_base64 of this Envelope. # noqa: E501 + :rtype: str + """ + return self._document_base64 + + @document_base64.setter + def document_base64(self, document_base64): + """Sets the document_base64 of this Envelope. + + # noqa: E501 + + :param document_base64: The document_base64 of this Envelope. # noqa: E501 + :type: str + """ + + self._document_base64 = document_base64 + @property def documents_combined_uri(self): """Gets the documents_combined_uri of this Envelope. # noqa: E501 diff --git a/docusign_esign/models/envelope_definition.py b/docusign_esign/models/envelope_definition.py index 6a67204d..9b87cf1d 100644 --- a/docusign_esign/models/envelope_definition.py +++ b/docusign_esign/models/envelope_definition.py @@ -58,6 +58,7 @@ class EnvelopeDefinition(object): 'deleted_date_time': 'str', 'delivered_date_time': 'str', 'disable_responsive_document': 'str', + 'document_base64': 'str', 'documents': 'list[Document]', 'documents_combined_uri': 'str', 'documents_uri': 'str', @@ -102,6 +103,7 @@ class EnvelopeDefinition(object): 'recipients': 'Recipients', 'recipients_lock': 'str', 'recipients_uri': 'str', + 'recipient_view_request': 'RecipientViewRequest', 'sender': 'UserInfo', 'sent_date_time': 'str', 'signer_can_sign_on_mobile': 'str', @@ -147,6 +149,7 @@ class EnvelopeDefinition(object): 'deleted_date_time': 'deletedDateTime', 'delivered_date_time': 'deliveredDateTime', 'disable_responsive_document': 'disableResponsiveDocument', + 'document_base64': 'documentBase64', 'documents': 'documents', 'documents_combined_uri': 'documentsCombinedUri', 'documents_uri': 'documentsUri', @@ -191,6 +194,7 @@ class EnvelopeDefinition(object): 'recipients': 'recipients', 'recipients_lock': 'recipientsLock', 'recipients_uri': 'recipientsUri', + 'recipient_view_request': 'recipientViewRequest', 'sender': 'sender', 'sent_date_time': 'sentDateTime', 'signer_can_sign_on_mobile': 'signerCanSignOnMobile', @@ -208,7 +212,7 @@ class EnvelopeDefinition(object): 'workflow': 'workflow' } - def __init__(self, access_control_list_base64=None, accessibility=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_recipient_recursion=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, composite_templates=None, copy_recipient_data=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, disable_responsive_document=None, documents=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, event_notification=None, event_notifications=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified_date_time=None, location=None, lock_information=None, message_lock=None, notification=None, notification_uri=None, password=None, power_form=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sender=None, sent_date_time=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, template_id=None, template_roles=None, templates_uri=None, transaction_id=None, use_disclosure=None, voided_date_time=None, voided_reason=None, workflow=None): # noqa: E501 + def __init__(self, access_control_list_base64=None, accessibility=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_recipient_recursion=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, composite_templates=None, copy_recipient_data=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, disable_responsive_document=None, document_base64=None, documents=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, event_notification=None, event_notifications=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified_date_time=None, location=None, lock_information=None, message_lock=None, notification=None, notification_uri=None, password=None, power_form=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, recipient_view_request=None, sender=None, sent_date_time=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, template_id=None, template_roles=None, templates_uri=None, transaction_id=None, use_disclosure=None, voided_date_time=None, voided_reason=None, workflow=None): # noqa: E501 """EnvelopeDefinition - a model defined in Swagger""" # noqa: E501 self._access_control_list_base64 = None @@ -238,6 +242,7 @@ def __init__(self, access_control_list_base64=None, accessibility=None, allow_co self._deleted_date_time = None self._delivered_date_time = None self._disable_responsive_document = None + self._document_base64 = None self._documents = None self._documents_combined_uri = None self._documents_uri = None @@ -282,6 +287,7 @@ def __init__(self, access_control_list_base64=None, accessibility=None, allow_co self._recipients = None self._recipients_lock = None self._recipients_uri = None + self._recipient_view_request = None self._sender = None self._sent_date_time = None self._signer_can_sign_on_mobile = None @@ -353,6 +359,8 @@ def __init__(self, access_control_list_base64=None, accessibility=None, allow_co self.delivered_date_time = delivered_date_time if disable_responsive_document is not None: self.disable_responsive_document = disable_responsive_document + if document_base64 is not None: + self.document_base64 = document_base64 if documents is not None: self.documents = documents if documents_combined_uri is not None: @@ -441,6 +449,8 @@ def __init__(self, access_control_list_base64=None, accessibility=None, allow_co self.recipients_lock = recipients_lock if recipients_uri is not None: self.recipients_uri = recipients_uri + if recipient_view_request is not None: + self.recipient_view_request = recipient_view_request if sender is not None: self.sender = sender if sent_date_time is not None: @@ -1091,6 +1101,29 @@ def disable_responsive_document(self, disable_responsive_document): self._disable_responsive_document = disable_responsive_document + @property + def document_base64(self): + """Gets the document_base64 of this EnvelopeDefinition. # noqa: E501 + + # noqa: E501 + + :return: The document_base64 of this EnvelopeDefinition. # noqa: E501 + :rtype: str + """ + return self._document_base64 + + @document_base64.setter + def document_base64(self, document_base64): + """Sets the document_base64 of this EnvelopeDefinition. + + # noqa: E501 + + :param document_base64: The document_base64 of this EnvelopeDefinition. # noqa: E501 + :type: str + """ + + self._document_base64 = document_base64 + @property def documents(self): """Gets the documents of this EnvelopeDefinition. # noqa: E501 @@ -2089,6 +2122,27 @@ def recipients_uri(self, recipients_uri): self._recipients_uri = recipients_uri + @property + def recipient_view_request(self): + """Gets the recipient_view_request of this EnvelopeDefinition. # noqa: E501 + + + :return: The recipient_view_request of this EnvelopeDefinition. # noqa: E501 + :rtype: RecipientViewRequest + """ + return self._recipient_view_request + + @recipient_view_request.setter + def recipient_view_request(self, recipient_view_request): + """Sets the recipient_view_request of this EnvelopeDefinition. + + + :param recipient_view_request: The recipient_view_request of this EnvelopeDefinition. # noqa: E501 + :type: RecipientViewRequest + """ + + self._recipient_view_request = recipient_view_request + @property def sender(self): """Gets the sender of this EnvelopeDefinition. # noqa: E501 diff --git a/docusign_esign/models/envelope_document.py b/docusign_esign/models/envelope_document.py index 6843955e..634919a9 100644 --- a/docusign_esign/models/envelope_document.py +++ b/docusign_esign/models/envelope_document.py @@ -39,6 +39,7 @@ class EnvelopeDocument(object): 'contains_pdf_form_fields': 'str', 'display': 'str', 'display_metadata': 'PropertyMetadata', + 'document_base64': 'str', 'document_fields': 'list[NameValue]', 'document_id': 'str', 'document_id_guid': 'str', @@ -67,6 +68,7 @@ class EnvelopeDocument(object): 'contains_pdf_form_fields': 'containsPdfFormFields', 'display': 'display', 'display_metadata': 'displayMetadata', + 'document_base64': 'documentBase64', 'document_fields': 'documentFields', 'document_id': 'documentId', 'document_id_guid': 'documentIdGuid', @@ -86,7 +88,7 @@ class EnvelopeDocument(object): 'uri': 'uri' } - def __init__(self, added_recipient_ids=None, attachment_tab_id=None, authoritative_copy=None, authoritative_copy_metadata=None, available_document_types=None, contains_pdf_form_fields=None, display=None, display_metadata=None, document_fields=None, document_id=None, document_id_guid=None, error_details=None, include_in_download=None, include_in_download_metadata=None, name=None, name_metadata=None, order=None, pages=None, signer_must_acknowledge=None, signer_must_acknowledge_metadata=None, size_bytes=None, template_locked=None, template_required=None, type=None, uri=None): # noqa: E501 + def __init__(self, added_recipient_ids=None, attachment_tab_id=None, authoritative_copy=None, authoritative_copy_metadata=None, available_document_types=None, contains_pdf_form_fields=None, display=None, display_metadata=None, document_base64=None, document_fields=None, document_id=None, document_id_guid=None, error_details=None, include_in_download=None, include_in_download_metadata=None, name=None, name_metadata=None, order=None, pages=None, signer_must_acknowledge=None, signer_must_acknowledge_metadata=None, size_bytes=None, template_locked=None, template_required=None, type=None, uri=None): # noqa: E501 """EnvelopeDocument - a model defined in Swagger""" # noqa: E501 self._added_recipient_ids = None @@ -97,6 +99,7 @@ def __init__(self, added_recipient_ids=None, attachment_tab_id=None, authoritati self._contains_pdf_form_fields = None self._display = None self._display_metadata = None + self._document_base64 = None self._document_fields = None self._document_id = None self._document_id_guid = None @@ -132,6 +135,8 @@ def __init__(self, added_recipient_ids=None, attachment_tab_id=None, authoritati self.display = display if display_metadata is not None: self.display_metadata = display_metadata + if document_base64 is not None: + self.document_base64 = document_base64 if document_fields is not None: self.document_fields = document_fields if document_id is not None: @@ -347,6 +352,29 @@ def display_metadata(self, display_metadata): self._display_metadata = display_metadata + @property + def document_base64(self): + """Gets the document_base64 of this EnvelopeDocument. # noqa: E501 + + # noqa: E501 + + :return: The document_base64 of this EnvelopeDocument. # noqa: E501 + :rtype: str + """ + return self._document_base64 + + @document_base64.setter + def document_base64(self, document_base64): + """Sets the document_base64 of this EnvelopeDocument. + + # noqa: E501 + + :param document_base64: The document_base64 of this EnvelopeDocument. # noqa: E501 + :type: str + """ + + self._document_base64 = document_base64 + @property def document_fields(self): """Gets the document_fields of this EnvelopeDocument. # noqa: E501 diff --git a/docusign_esign/models/envelope_summary.py b/docusign_esign/models/envelope_summary.py index f0ad55fa..cc8291cc 100644 --- a/docusign_esign/models/envelope_summary.py +++ b/docusign_esign/models/envelope_summary.py @@ -34,6 +34,8 @@ class EnvelopeSummary(object): 'bulk_envelope_status': 'BulkEnvelopeStatus', 'envelope_id': 'str', 'error_details': 'ErrorDetails', + 'recipient_signing_uri': 'str', + 'recipient_signing_uri_error': 'str', 'status': 'str', 'status_date_time': 'str', 'uri': 'str' @@ -43,17 +45,21 @@ class EnvelopeSummary(object): 'bulk_envelope_status': 'bulkEnvelopeStatus', 'envelope_id': 'envelopeId', 'error_details': 'errorDetails', + 'recipient_signing_uri': 'recipientSigningUri', + 'recipient_signing_uri_error': 'recipientSigningUriError', 'status': 'status', 'status_date_time': 'statusDateTime', 'uri': 'uri' } - def __init__(self, bulk_envelope_status=None, envelope_id=None, error_details=None, status=None, status_date_time=None, uri=None): # noqa: E501 + def __init__(self, bulk_envelope_status=None, envelope_id=None, error_details=None, recipient_signing_uri=None, recipient_signing_uri_error=None, status=None, status_date_time=None, uri=None): # noqa: E501 """EnvelopeSummary - a model defined in Swagger""" # noqa: E501 self._bulk_envelope_status = None self._envelope_id = None self._error_details = None + self._recipient_signing_uri = None + self._recipient_signing_uri_error = None self._status = None self._status_date_time = None self._uri = None @@ -65,6 +71,10 @@ def __init__(self, bulk_envelope_status=None, envelope_id=None, error_details=No self.envelope_id = envelope_id if error_details is not None: self.error_details = error_details + if recipient_signing_uri is not None: + self.recipient_signing_uri = recipient_signing_uri + if recipient_signing_uri_error is not None: + self.recipient_signing_uri_error = recipient_signing_uri_error if status is not None: self.status = status if status_date_time is not None: @@ -137,6 +147,52 @@ def error_details(self, error_details): self._error_details = error_details + @property + def recipient_signing_uri(self): + """Gets the recipient_signing_uri of this EnvelopeSummary. # noqa: E501 + + # noqa: E501 + + :return: The recipient_signing_uri of this EnvelopeSummary. # noqa: E501 + :rtype: str + """ + return self._recipient_signing_uri + + @recipient_signing_uri.setter + def recipient_signing_uri(self, recipient_signing_uri): + """Sets the recipient_signing_uri of this EnvelopeSummary. + + # noqa: E501 + + :param recipient_signing_uri: The recipient_signing_uri of this EnvelopeSummary. # noqa: E501 + :type: str + """ + + self._recipient_signing_uri = recipient_signing_uri + + @property + def recipient_signing_uri_error(self): + """Gets the recipient_signing_uri_error of this EnvelopeSummary. # noqa: E501 + + # noqa: E501 + + :return: The recipient_signing_uri_error of this EnvelopeSummary. # noqa: E501 + :rtype: str + """ + return self._recipient_signing_uri_error + + @recipient_signing_uri_error.setter + def recipient_signing_uri_error(self, recipient_signing_uri_error): + """Sets the recipient_signing_uri_error of this EnvelopeSummary. + + # noqa: E501 + + :param recipient_signing_uri_error: The recipient_signing_uri_error of this EnvelopeSummary. # noqa: E501 + :type: str + """ + + self._recipient_signing_uri_error = recipient_signing_uri_error + @property def status(self): """Gets the status of this EnvelopeSummary. # noqa: E501 diff --git a/docusign_esign/models/envelope_template.py b/docusign_esign/models/envelope_template.py index 2f1c8fb4..07d71abe 100644 --- a/docusign_esign/models/envelope_template.py +++ b/docusign_esign/models/envelope_template.py @@ -58,6 +58,7 @@ class EnvelopeTemplate(object): 'delivered_date_time': 'str', 'description': 'str', 'disable_responsive_document': 'str', + 'document_base64': 'str', 'documents': 'list[Document]', 'documents_combined_uri': 'str', 'documents_uri': 'str', @@ -159,6 +160,7 @@ class EnvelopeTemplate(object): 'delivered_date_time': 'deliveredDateTime', 'description': 'description', 'disable_responsive_document': 'disableResponsiveDocument', + 'document_base64': 'documentBase64', 'documents': 'documents', 'documents_combined_uri': 'documentsCombinedUri', 'documents_uri': 'documentsUri', @@ -232,7 +234,7 @@ class EnvelopeTemplate(object): 'workflow': 'workflow' } - def __init__(self, access_control_list_base64=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_match=None, auto_match_specified_by_user=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, copy_recipient_data=None, created=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, description=None, disable_responsive_document=None, documents=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, favorited_by_me=None, folder_id=None, folder_ids=None, folder_name=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified=None, last_modified_by=None, last_modified_date_time=None, last_used=None, location=None, lock_information=None, message_lock=None, name=None, new_password=None, notification=None, notification_uri=None, owner=None, page_count=None, password=None, password_protected=None, power_form=None, power_forms=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sender=None, sent_date_time=None, shared=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, template_id=None, templates_uri=None, transaction_id=None, uri=None, use_disclosure=None, voided_date_time=None, voided_reason=None, workflow=None): # noqa: E501 + def __init__(self, access_control_list_base64=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_match=None, auto_match_specified_by_user=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, copy_recipient_data=None, created=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, description=None, disable_responsive_document=None, document_base64=None, documents=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, favorited_by_me=None, folder_id=None, folder_ids=None, folder_name=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified=None, last_modified_by=None, last_modified_date_time=None, last_used=None, location=None, lock_information=None, message_lock=None, name=None, new_password=None, notification=None, notification_uri=None, owner=None, page_count=None, password=None, password_protected=None, power_form=None, power_forms=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sender=None, sent_date_time=None, shared=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, template_id=None, templates_uri=None, transaction_id=None, uri=None, use_disclosure=None, voided_date_time=None, voided_reason=None, workflow=None): # noqa: E501 """EnvelopeTemplate - a model defined in Swagger""" # noqa: E501 self._access_control_list_base64 = None @@ -262,6 +264,7 @@ def __init__(self, access_control_list_base64=None, allow_comments=None, allow_m self._delivered_date_time = None self._description = None self._disable_responsive_document = None + self._document_base64 = None self._documents = None self._documents_combined_uri = None self._documents_uri = None @@ -389,6 +392,8 @@ def __init__(self, access_control_list_base64=None, allow_comments=None, allow_m self.description = description if disable_responsive_document is not None: self.disable_responsive_document = disable_responsive_document + if document_base64 is not None: + self.document_base64 = document_base64 if documents is not None: self.documents = documents if documents_combined_uri is not None: @@ -1151,6 +1156,29 @@ def disable_responsive_document(self, disable_responsive_document): self._disable_responsive_document = disable_responsive_document + @property + def document_base64(self): + """Gets the document_base64 of this EnvelopeTemplate. # noqa: E501 + + # noqa: E501 + + :return: The document_base64 of this EnvelopeTemplate. # noqa: E501 + :rtype: str + """ + return self._document_base64 + + @document_base64.setter + def document_base64(self, document_base64): + """Sets the document_base64 of this EnvelopeTemplate. + + # noqa: E501 + + :param document_base64: The document_base64 of this EnvelopeTemplate. # noqa: E501 + :type: str + """ + + self._document_base64 = document_base64 + @property def documents(self): """Gets the documents of this EnvelopeTemplate. # noqa: E501 diff --git a/docusign_esign/models/external_file.py b/docusign_esign/models/external_file.py index 2e9d00af..d44c1ed1 100644 --- a/docusign_esign/models/external_file.py +++ b/docusign_esign/models/external_file.py @@ -32,9 +32,11 @@ class ExternalFile(object): """ swagger_types = { '_date': 'str', + 'has_composite_template': 'str', 'id': 'str', 'img': 'str', 'name': 'str', + 'owner_name': 'str', 'size': 'str', 'supported': 'str', 'type': 'str', @@ -43,22 +45,26 @@ class ExternalFile(object): attribute_map = { '_date': 'date', + 'has_composite_template': 'hasCompositeTemplate', 'id': 'id', 'img': 'img', 'name': 'name', + 'owner_name': 'ownerName', 'size': 'size', 'supported': 'supported', 'type': 'type', 'uri': 'uri' } - def __init__(self, _date=None, id=None, img=None, name=None, size=None, supported=None, type=None, uri=None): # noqa: E501 + def __init__(self, _date=None, has_composite_template=None, id=None, img=None, name=None, owner_name=None, size=None, supported=None, type=None, uri=None): # noqa: E501 """ExternalFile - a model defined in Swagger""" # noqa: E501 self.__date = None + self._has_composite_template = None self._id = None self._img = None self._name = None + self._owner_name = None self._size = None self._supported = None self._type = None @@ -67,12 +73,16 @@ def __init__(self, _date=None, id=None, img=None, name=None, size=None, supporte if _date is not None: self._date = _date + if has_composite_template is not None: + self.has_composite_template = has_composite_template if id is not None: self.id = id if img is not None: self.img = img if name is not None: self.name = name + if owner_name is not None: + self.owner_name = owner_name if size is not None: self.size = size if supported is not None: @@ -105,6 +115,29 @@ def _date(self, _date): self.__date = _date + @property + def has_composite_template(self): + """Gets the has_composite_template of this ExternalFile. # noqa: E501 + + # noqa: E501 + + :return: The has_composite_template of this ExternalFile. # noqa: E501 + :rtype: str + """ + return self._has_composite_template + + @has_composite_template.setter + def has_composite_template(self, has_composite_template): + """Sets the has_composite_template of this ExternalFile. + + # noqa: E501 + + :param has_composite_template: The has_composite_template of this ExternalFile. # noqa: E501 + :type: str + """ + + self._has_composite_template = has_composite_template + @property def id(self): """Gets the id of this ExternalFile. # noqa: E501 @@ -174,6 +207,29 @@ def name(self, name): self._name = name + @property + def owner_name(self): + """Gets the owner_name of this ExternalFile. # noqa: E501 + + # noqa: E501 + + :return: The owner_name of this ExternalFile. # noqa: E501 + :rtype: str + """ + return self._owner_name + + @owner_name.setter + def owner_name(self, owner_name): + """Sets the owner_name of this ExternalFile. + + # noqa: E501 + + :param owner_name: The owner_name of this ExternalFile. # noqa: E501 + :type: str + """ + + self._owner_name = owner_name + @property def size(self): """Gets the size of this ExternalFile. # noqa: E501 diff --git a/docusign_esign/models/form_data_item.py b/docusign_esign/models/form_data_item.py index 61061c07..972784d2 100644 --- a/docusign_esign/models/form_data_item.py +++ b/docusign_esign/models/form_data_item.py @@ -34,6 +34,7 @@ class FormDataItem(object): 'error_details': 'ErrorDetails', 'list_selected_value': 'str', 'name': 'str', + 'numerical_value': 'str', 'original_value': 'str', 'value': 'str' } @@ -42,16 +43,18 @@ class FormDataItem(object): 'error_details': 'errorDetails', 'list_selected_value': 'listSelectedValue', 'name': 'name', + 'numerical_value': 'numericalValue', 'original_value': 'originalValue', 'value': 'value' } - def __init__(self, error_details=None, list_selected_value=None, name=None, original_value=None, value=None): # noqa: E501 + def __init__(self, error_details=None, list_selected_value=None, name=None, numerical_value=None, original_value=None, value=None): # noqa: E501 """FormDataItem - a model defined in Swagger""" # noqa: E501 self._error_details = None self._list_selected_value = None self._name = None + self._numerical_value = None self._original_value = None self._value = None self.discriminator = None @@ -62,6 +65,8 @@ def __init__(self, error_details=None, list_selected_value=None, name=None, orig self.list_selected_value = list_selected_value if name is not None: self.name = name + if numerical_value is not None: + self.numerical_value = numerical_value if original_value is not None: self.original_value = original_value if value is not None: @@ -134,6 +139,29 @@ def name(self, name): self._name = name + @property + def numerical_value(self): + """Gets the numerical_value of this FormDataItem. # noqa: E501 + + # noqa: E501 + + :return: The numerical_value of this FormDataItem. # noqa: E501 + :rtype: str + """ + return self._numerical_value + + @numerical_value.setter + def numerical_value(self, numerical_value): + """Sets the numerical_value of this FormDataItem. + + # noqa: E501 + + :param numerical_value: The numerical_value of this FormDataItem. # noqa: E501 + :type: str + """ + + self._numerical_value = numerical_value + @property def original_value(self): """Gets the original_value of this FormDataItem. # noqa: E501 diff --git a/docusign_esign/models/report_in_product_csv_run_request.py b/docusign_esign/models/report_in_product_csv_run_request.py index 49075d6d..73608ced 100644 --- a/docusign_esign/models/report_in_product_csv_run_request.py +++ b/docusign_esign/models/report_in_product_csv_run_request.py @@ -31,6 +31,7 @@ class ReportInProductCsvRunRequest(object): and the value is json key in definition. """ swagger_types = { + 'authentication_success_filter': 'str', 'custom_field_filter': 'str', 'date_range_custom_from_date': 'str', 'date_range_custom_to_date': 'str', @@ -56,10 +57,12 @@ class ReportInProductCsvRunRequest(object): 'separator': 'str', 'sort_direction': 'str', 'sort_field': 'str', - 'start_position': 'str' + 'start_position': 'str', + 'verification_status_filter': 'str' } attribute_map = { + 'authentication_success_filter': 'authenticationSuccessFilter', 'custom_field_filter': 'customFieldFilter', 'date_range_custom_from_date': 'dateRangeCustomFromDate', 'date_range_custom_to_date': 'dateRangeCustomToDate', @@ -85,12 +88,14 @@ class ReportInProductCsvRunRequest(object): 'separator': 'separator', 'sort_direction': 'sortDirection', 'sort_field': 'sortField', - 'start_position': 'startPosition' + 'start_position': 'startPosition', + 'verification_status_filter': 'verificationStatusFilter' } - def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, date_range_custom_to_date=None, date_range_filter=None, envelope_date_type_filter=None, envelope_recipient_name_contains_filter=None, envelope_status_filter=None, envelope_subject_contains_filter=None, fields=None, for_download=None, is_dashboard=None, new_line=None, override_timezone_key=None, period_length_filter=None, quote=None, report_customized_id=None, report_description=None, report_id=None, report_invocation_type=None, report_name=None, sent_by_filter=None, sent_by_ids=None, separator=None, sort_direction=None, sort_field=None, start_position=None): # noqa: E501 + def __init__(self, authentication_success_filter=None, custom_field_filter=None, date_range_custom_from_date=None, date_range_custom_to_date=None, date_range_filter=None, envelope_date_type_filter=None, envelope_recipient_name_contains_filter=None, envelope_status_filter=None, envelope_subject_contains_filter=None, fields=None, for_download=None, is_dashboard=None, new_line=None, override_timezone_key=None, period_length_filter=None, quote=None, report_customized_id=None, report_description=None, report_id=None, report_invocation_type=None, report_name=None, sent_by_filter=None, sent_by_ids=None, separator=None, sort_direction=None, sort_field=None, start_position=None, verification_status_filter=None): # noqa: E501 """ReportInProductCsvRunRequest - a model defined in Swagger""" # noqa: E501 + self._authentication_success_filter = None self._custom_field_filter = None self._date_range_custom_from_date = None self._date_range_custom_to_date = None @@ -117,8 +122,11 @@ def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, d self._sort_direction = None self._sort_field = None self._start_position = None + self._verification_status_filter = None self.discriminator = None + if authentication_success_filter is not None: + self.authentication_success_filter = authentication_success_filter if custom_field_filter is not None: self.custom_field_filter = custom_field_filter if date_range_custom_from_date is not None: @@ -171,6 +179,31 @@ def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, d self.sort_field = sort_field if start_position is not None: self.start_position = start_position + if verification_status_filter is not None: + self.verification_status_filter = verification_status_filter + + @property + def authentication_success_filter(self): + """Gets the authentication_success_filter of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The authentication_success_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._authentication_success_filter + + @authentication_success_filter.setter + def authentication_success_filter(self, authentication_success_filter): + """Sets the authentication_success_filter of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param authentication_success_filter: The authentication_success_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._authentication_success_filter = authentication_success_filter @property def custom_field_filter(self): @@ -770,6 +803,29 @@ def start_position(self, start_position): self._start_position = start_position + @property + def verification_status_filter(self): + """Gets the verification_status_filter of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The verification_status_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._verification_status_filter + + @verification_status_filter.setter + def verification_status_filter(self, verification_status_filter): + """Sets the verification_status_filter of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param verification_status_filter: The verification_status_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._verification_status_filter = verification_status_filter + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/docusign_esign/models/report_in_product_get.py b/docusign_esign/models/report_in_product_get.py index 4e4e3050..601e8f78 100644 --- a/docusign_esign/models/report_in_product_get.py +++ b/docusign_esign/models/report_in_product_get.py @@ -31,6 +31,7 @@ class ReportInProductGet(object): and the value is json key in definition. """ swagger_types = { + 'authentication_success_filter': 'str', 'custom_field_filter': 'str', 'date_range_custom_from_date': 'str', 'date_range_custom_to_date': 'str', @@ -59,10 +60,12 @@ class ReportInProductGet(object): 'sent_by_filter': 'str', 'sent_by_ids': 'str', 'sort_field_direction': 'str', - 'sort_field_name': 'str' + 'sort_field_name': 'str', + 'verification_status_filter': 'str' } attribute_map = { + 'authentication_success_filter': 'authenticationSuccessFilter', 'custom_field_filter': 'customFieldFilter', 'date_range_custom_from_date': 'dateRangeCustomFromDate', 'date_range_custom_to_date': 'dateRangeCustomToDate', @@ -91,12 +94,14 @@ class ReportInProductGet(object): 'sent_by_filter': 'sentByFilter', 'sent_by_ids': 'sentByIds', 'sort_field_direction': 'sortFieldDirection', - 'sort_field_name': 'sortFieldName' + 'sort_field_name': 'sortFieldName', + 'verification_status_filter': 'verificationStatusFilter' } - def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, date_range_custom_to_date=None, date_range_filter=None, display_order=None, envelope_date_type_filter=None, envelope_recipient_name_contains_filter=None, envelope_status_filter=None, envelope_subject_contains_filter=None, fields=None, last_scheduled_execution_date=None, last_scheduled_execution_success_date=None, max_download_rows=None, max_grid_rows=None, max_scheduled_rows=None, period_length_filter=None, report_customized_id=None, report_description=None, report_id=None, report_name=None, report_type=None, run_uri=None, save_uri=None, schedule_id=None, sent_by_details=None, sent_by_filter=None, sent_by_ids=None, sort_field_direction=None, sort_field_name=None): # noqa: E501 + def __init__(self, authentication_success_filter=None, custom_field_filter=None, date_range_custom_from_date=None, date_range_custom_to_date=None, date_range_filter=None, display_order=None, envelope_date_type_filter=None, envelope_recipient_name_contains_filter=None, envelope_status_filter=None, envelope_subject_contains_filter=None, fields=None, last_scheduled_execution_date=None, last_scheduled_execution_success_date=None, max_download_rows=None, max_grid_rows=None, max_scheduled_rows=None, period_length_filter=None, report_customized_id=None, report_description=None, report_id=None, report_name=None, report_type=None, run_uri=None, save_uri=None, schedule_id=None, sent_by_details=None, sent_by_filter=None, sent_by_ids=None, sort_field_direction=None, sort_field_name=None, verification_status_filter=None): # noqa: E501 """ReportInProductGet - a model defined in Swagger""" # noqa: E501 + self._authentication_success_filter = None self._custom_field_filter = None self._date_range_custom_from_date = None self._date_range_custom_to_date = None @@ -126,8 +131,11 @@ def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, d self._sent_by_ids = None self._sort_field_direction = None self._sort_field_name = None + self._verification_status_filter = None self.discriminator = None + if authentication_success_filter is not None: + self.authentication_success_filter = authentication_success_filter if custom_field_filter is not None: self.custom_field_filter = custom_field_filter if date_range_custom_from_date is not None: @@ -186,6 +194,31 @@ def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, d self.sort_field_direction = sort_field_direction if sort_field_name is not None: self.sort_field_name = sort_field_name + if verification_status_filter is not None: + self.verification_status_filter = verification_status_filter + + @property + def authentication_success_filter(self): + """Gets the authentication_success_filter of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The authentication_success_filter of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._authentication_success_filter + + @authentication_success_filter.setter + def authentication_success_filter(self, authentication_success_filter): + """Sets the authentication_success_filter of this ReportInProductGet. + + # noqa: E501 + + :param authentication_success_filter: The authentication_success_filter of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._authentication_success_filter = authentication_success_filter @property def custom_field_filter(self): @@ -852,6 +885,29 @@ def sort_field_name(self, sort_field_name): self._sort_field_name = sort_field_name + @property + def verification_status_filter(self): + """Gets the verification_status_filter of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The verification_status_filter of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._verification_status_filter + + @verification_status_filter.setter + def verification_status_filter(self, verification_status_filter): + """Sets the verification_status_filter of this ReportInProductGet. + + # noqa: E501 + + :param verification_status_filter: The verification_status_filter of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._verification_status_filter = verification_status_filter + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/docusign_esign/models/report_in_product_run_request.py b/docusign_esign/models/report_in_product_run_request.py index 754bad42..ced315d5 100644 --- a/docusign_esign/models/report_in_product_run_request.py +++ b/docusign_esign/models/report_in_product_run_request.py @@ -31,6 +31,7 @@ class ReportInProductRunRequest(object): and the value is json key in definition. """ swagger_types = { + 'authentication_success_filter': 'str', 'custom_field_filter': 'str', 'date_range_custom_from_date': 'str', 'date_range_custom_to_date': 'str', @@ -52,10 +53,12 @@ class ReportInProductRunRequest(object): 'sent_by_ids': 'str', 'sort_direction': 'str', 'sort_field': 'str', - 'start_position': 'str' + 'start_position': 'str', + 'verification_status_filter': 'str' } attribute_map = { + 'authentication_success_filter': 'authenticationSuccessFilter', 'custom_field_filter': 'customFieldFilter', 'date_range_custom_from_date': 'dateRangeCustomFromDate', 'date_range_custom_to_date': 'dateRangeCustomToDate', @@ -77,12 +80,14 @@ class ReportInProductRunRequest(object): 'sent_by_ids': 'sentByIds', 'sort_direction': 'sortDirection', 'sort_field': 'sortField', - 'start_position': 'startPosition' + 'start_position': 'startPosition', + 'verification_status_filter': 'verificationStatusFilter' } - def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, date_range_custom_to_date=None, date_range_filter=None, envelope_date_type_filter=None, envelope_recipient_name_contains_filter=None, envelope_status_filter=None, envelope_subject_contains_filter=None, fields=None, for_download=None, is_dashboard=None, period_length_filter=None, report_customized_id=None, report_description=None, report_id=None, report_invocation_type=None, report_name=None, sent_by_filter=None, sent_by_ids=None, sort_direction=None, sort_field=None, start_position=None): # noqa: E501 + def __init__(self, authentication_success_filter=None, custom_field_filter=None, date_range_custom_from_date=None, date_range_custom_to_date=None, date_range_filter=None, envelope_date_type_filter=None, envelope_recipient_name_contains_filter=None, envelope_status_filter=None, envelope_subject_contains_filter=None, fields=None, for_download=None, is_dashboard=None, period_length_filter=None, report_customized_id=None, report_description=None, report_id=None, report_invocation_type=None, report_name=None, sent_by_filter=None, sent_by_ids=None, sort_direction=None, sort_field=None, start_position=None, verification_status_filter=None): # noqa: E501 """ReportInProductRunRequest - a model defined in Swagger""" # noqa: E501 + self._authentication_success_filter = None self._custom_field_filter = None self._date_range_custom_from_date = None self._date_range_custom_to_date = None @@ -105,8 +110,11 @@ def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, d self._sort_direction = None self._sort_field = None self._start_position = None + self._verification_status_filter = None self.discriminator = None + if authentication_success_filter is not None: + self.authentication_success_filter = authentication_success_filter if custom_field_filter is not None: self.custom_field_filter = custom_field_filter if date_range_custom_from_date is not None: @@ -151,6 +159,31 @@ def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, d self.sort_field = sort_field if start_position is not None: self.start_position = start_position + if verification_status_filter is not None: + self.verification_status_filter = verification_status_filter + + @property + def authentication_success_filter(self): + """Gets the authentication_success_filter of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The authentication_success_filter of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._authentication_success_filter + + @authentication_success_filter.setter + def authentication_success_filter(self, authentication_success_filter): + """Sets the authentication_success_filter of this ReportInProductRunRequest. + + # noqa: E501 + + :param authentication_success_filter: The authentication_success_filter of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._authentication_success_filter = authentication_success_filter @property def custom_field_filter(self): @@ -658,6 +691,29 @@ def start_position(self, start_position): self._start_position = start_position + @property + def verification_status_filter(self): + """Gets the verification_status_filter of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The verification_status_filter of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._verification_status_filter + + @verification_status_filter.setter + def verification_status_filter(self, verification_status_filter): + """Sets the verification_status_filter of this ReportInProductRunRequest. + + # noqa: E501 + + :param verification_status_filter: The verification_status_filter of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._verification_status_filter = verification_status_filter + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/docusign_esign/models/report_in_product_run_response_row_fields.py b/docusign_esign/models/report_in_product_run_response_row_fields.py index 38800a12..23ddcc1b 100644 --- a/docusign_esign/models/report_in_product_run_response_row_fields.py +++ b/docusign_esign/models/report_in_product_run_response_row_fields.py @@ -40,6 +40,7 @@ class ReportInProductRunResponseRowFields(object): 'authentication_type': 'str', 'average_time_to_complete_seconds': 'str', 'avg_complete_seconds': 'str', + 'capture_method': 'str', 'completed': 'str', 'completed_ts': 'str', 'created_date': 'str', @@ -78,11 +79,14 @@ class ReportInProductRunResponseRowFields(object): 'hours_to_complete_start': 'str', 'id_checks_attempted': 'str', 'id_checks_failed': 'str', + 'id_country': 'str', + 'id_method': 'str', 'initial_send_ts': 'str', 'ip_address': 'str', 'last_activity': 'str', 'last_activity_date': 'str', 'last_sent_date': 'str', + 'metadata_removed': 'str', 'not_signed': 'str', 'number_of_authenticated_recipients': 'str', 'number_of_completed_signatures': 'str', @@ -100,6 +104,8 @@ class ReportInProductRunResponseRowFields(object): 'period_start': 'str', 'phone_calls_attempted': 'str', 'phone_calls_failed': 'str', + 'pii_redacted': 'str', + 'purge_date': 'str', 'reason_for_declining': 'str', 'reason_for_voiding': 'str', 'reassign_reason': 'str', @@ -134,6 +140,7 @@ class ReportInProductRunResponseRowFields(object): 'status': 'str', 'status_changed_date': 'str', 'status_changed_ts': 'str', + 'status_comment': 'str', 'subject': 'str', 'successes': 'str', 'templates_created': 'str', @@ -168,6 +175,7 @@ class ReportInProductRunResponseRowFields(object): 'authentication_type': 'authenticationType', 'average_time_to_complete_seconds': 'averageTimeToCompleteSeconds', 'avg_complete_seconds': 'avgCompleteSeconds', + 'capture_method': 'captureMethod', 'completed': 'completed', 'completed_ts': 'completedTs', 'created_date': 'createdDate', @@ -206,11 +214,14 @@ class ReportInProductRunResponseRowFields(object): 'hours_to_complete_start': 'hoursToCompleteStart', 'id_checks_attempted': 'idChecksAttempted', 'id_checks_failed': 'idChecksFailed', + 'id_country': 'idCountry', + 'id_method': 'idMethod', 'initial_send_ts': 'initialSendTs', 'ip_address': 'ipAddress', 'last_activity': 'lastActivity', 'last_activity_date': 'lastActivityDate', 'last_sent_date': 'lastSentDate', + 'metadata_removed': 'metadataRemoved', 'not_signed': 'notSigned', 'number_of_authenticated_recipients': 'numberOfAuthenticatedRecipients', 'number_of_completed_signatures': 'numberOfCompletedSignatures', @@ -228,6 +239,8 @@ class ReportInProductRunResponseRowFields(object): 'period_start': 'periodStart', 'phone_calls_attempted': 'phoneCallsAttempted', 'phone_calls_failed': 'phoneCallsFailed', + 'pii_redacted': 'piiRedacted', + 'purge_date': 'purgeDate', 'reason_for_declining': 'reasonForDeclining', 'reason_for_voiding': 'reasonForVoiding', 'reassign_reason': 'reassignReason', @@ -262,6 +275,7 @@ class ReportInProductRunResponseRowFields(object): 'status': 'status', 'status_changed_date': 'statusChangedDate', 'status_changed_ts': 'statusChangedTs', + 'status_comment': 'statusComment', 'subject': 'subject', 'successes': 'successes', 'templates_created': 'templatesCreated', @@ -286,7 +300,7 @@ class ReportInProductRunResponseRowFields(object): 'voided_ts': 'voidedTs' } - def __init__(self, access_code_required=None, access_codes_attempted=None, access_codes_failed=None, account_id=None, authentication_category=None, authentication_success=None, authentication_type=None, average_time_to_complete_seconds=None, avg_complete_seconds=None, completed=None, completed_ts=None, created_date=None, custom_field=None, declined_date=None, declined_reason=None, delivered_date=None, envelope_count=None, envelope_creator=None, envelope_id=None, envelope_initial_send_ts=None, envelopes_billed=None, envelopes_completed=None, envelopes_completed_count=None, envelopes_declined=None, envelopes_sent=None, envelopes_sent_count=None, envelopes_voided=None, envelope_voided_reason=None, eod_document_description=None, eod_document_name=None, eod_document_profile_id=None, eod_transaction_id=None, eod_transaction_name=None, event_date=None, expiration_date=None, expired_ts=None, failure_reason=None, failures=None, failure_vendor_code=None, failure_vendor_reason=None, first_send_ts=None, group_id=None, group_name=None, hours_to_complete_end=None, hours_to_complete_start=None, id_checks_attempted=None, id_checks_failed=None, initial_send_ts=None, ip_address=None, last_activity=None, last_activity_date=None, last_sent_date=None, not_signed=None, number_of_authenticated_recipients=None, number_of_completed_signatures=None, number_of_documents=None, number_of_pages=None, number_of_recipients=None, number_of_sends=None, number_of_signers=None, number_of_total_documents=None, number_of_total_pages=None, number_of_total_signers=None, number_of_unique_senders=None, number_total_recipients=None, period_end=None, period_start=None, phone_calls_attempted=None, phone_calls_failed=None, reason_for_declining=None, reason_for_voiding=None, reassign_reason=None, received=None, recipient=None, recipient_action=None, recipient_company_name=None, recipient_country=None, recipient_email=None, recipient_id=None, recipient_name=None, recipient_template_role_name=None, recipient_title=None, recipient_type=None, recipient_user_id=None, remaining_signatures=None, routing_order=None, sender_account_id=None, sender_company_name=None, sender_country=None, sender_email=None, sender_ip_address=None, sender_job_title=None, sender_name=None, sender_user_id=None, sign_date=None, signed=None, signed_date=None, signed_on_mobile=None, signed_on_paper=None, signer_list=None, status=None, status_changed_date=None, status_changed_ts=None, subject=None, successes=None, templates_created=None, templates_created_count=None, terminal_status_date=None, time_to_complete_seconds=None, time_to_deliver=None, total_documents=None, total_envelopes=None, total_pages=None, total_recipients=None, total_signers=None, unique_senders=None, user_account_email=None, user_account_name=None, user_account_status=None, user_count=None, user_id=None, verification_status=None, verification_type=None, view_date=None, voided_ts=None): # noqa: E501 + def __init__(self, access_code_required=None, access_codes_attempted=None, access_codes_failed=None, account_id=None, authentication_category=None, authentication_success=None, authentication_type=None, average_time_to_complete_seconds=None, avg_complete_seconds=None, capture_method=None, completed=None, completed_ts=None, created_date=None, custom_field=None, declined_date=None, declined_reason=None, delivered_date=None, envelope_count=None, envelope_creator=None, envelope_id=None, envelope_initial_send_ts=None, envelopes_billed=None, envelopes_completed=None, envelopes_completed_count=None, envelopes_declined=None, envelopes_sent=None, envelopes_sent_count=None, envelopes_voided=None, envelope_voided_reason=None, eod_document_description=None, eod_document_name=None, eod_document_profile_id=None, eod_transaction_id=None, eod_transaction_name=None, event_date=None, expiration_date=None, expired_ts=None, failure_reason=None, failures=None, failure_vendor_code=None, failure_vendor_reason=None, first_send_ts=None, group_id=None, group_name=None, hours_to_complete_end=None, hours_to_complete_start=None, id_checks_attempted=None, id_checks_failed=None, id_country=None, id_method=None, initial_send_ts=None, ip_address=None, last_activity=None, last_activity_date=None, last_sent_date=None, metadata_removed=None, not_signed=None, number_of_authenticated_recipients=None, number_of_completed_signatures=None, number_of_documents=None, number_of_pages=None, number_of_recipients=None, number_of_sends=None, number_of_signers=None, number_of_total_documents=None, number_of_total_pages=None, number_of_total_signers=None, number_of_unique_senders=None, number_total_recipients=None, period_end=None, period_start=None, phone_calls_attempted=None, phone_calls_failed=None, pii_redacted=None, purge_date=None, reason_for_declining=None, reason_for_voiding=None, reassign_reason=None, received=None, recipient=None, recipient_action=None, recipient_company_name=None, recipient_country=None, recipient_email=None, recipient_id=None, recipient_name=None, recipient_template_role_name=None, recipient_title=None, recipient_type=None, recipient_user_id=None, remaining_signatures=None, routing_order=None, sender_account_id=None, sender_company_name=None, sender_country=None, sender_email=None, sender_ip_address=None, sender_job_title=None, sender_name=None, sender_user_id=None, sign_date=None, signed=None, signed_date=None, signed_on_mobile=None, signed_on_paper=None, signer_list=None, status=None, status_changed_date=None, status_changed_ts=None, status_comment=None, subject=None, successes=None, templates_created=None, templates_created_count=None, terminal_status_date=None, time_to_complete_seconds=None, time_to_deliver=None, total_documents=None, total_envelopes=None, total_pages=None, total_recipients=None, total_signers=None, unique_senders=None, user_account_email=None, user_account_name=None, user_account_status=None, user_count=None, user_id=None, verification_status=None, verification_type=None, view_date=None, voided_ts=None): # noqa: E501 """ReportInProductRunResponseRowFields - a model defined in Swagger""" # noqa: E501 self._access_code_required = None @@ -298,6 +312,7 @@ def __init__(self, access_code_required=None, access_codes_attempted=None, acces self._authentication_type = None self._average_time_to_complete_seconds = None self._avg_complete_seconds = None + self._capture_method = None self._completed = None self._completed_ts = None self._created_date = None @@ -336,11 +351,14 @@ def __init__(self, access_code_required=None, access_codes_attempted=None, acces self._hours_to_complete_start = None self._id_checks_attempted = None self._id_checks_failed = None + self._id_country = None + self._id_method = None self._initial_send_ts = None self._ip_address = None self._last_activity = None self._last_activity_date = None self._last_sent_date = None + self._metadata_removed = None self._not_signed = None self._number_of_authenticated_recipients = None self._number_of_completed_signatures = None @@ -358,6 +376,8 @@ def __init__(self, access_code_required=None, access_codes_attempted=None, acces self._period_start = None self._phone_calls_attempted = None self._phone_calls_failed = None + self._pii_redacted = None + self._purge_date = None self._reason_for_declining = None self._reason_for_voiding = None self._reassign_reason = None @@ -392,6 +412,7 @@ def __init__(self, access_code_required=None, access_codes_attempted=None, acces self._status = None self._status_changed_date = None self._status_changed_ts = None + self._status_comment = None self._subject = None self._successes = None self._templates_created = None @@ -434,6 +455,8 @@ def __init__(self, access_code_required=None, access_codes_attempted=None, acces self.average_time_to_complete_seconds = average_time_to_complete_seconds if avg_complete_seconds is not None: self.avg_complete_seconds = avg_complete_seconds + if capture_method is not None: + self.capture_method = capture_method if completed is not None: self.completed = completed if completed_ts is not None: @@ -510,6 +533,10 @@ def __init__(self, access_code_required=None, access_codes_attempted=None, acces self.id_checks_attempted = id_checks_attempted if id_checks_failed is not None: self.id_checks_failed = id_checks_failed + if id_country is not None: + self.id_country = id_country + if id_method is not None: + self.id_method = id_method if initial_send_ts is not None: self.initial_send_ts = initial_send_ts if ip_address is not None: @@ -520,6 +547,8 @@ def __init__(self, access_code_required=None, access_codes_attempted=None, acces self.last_activity_date = last_activity_date if last_sent_date is not None: self.last_sent_date = last_sent_date + if metadata_removed is not None: + self.metadata_removed = metadata_removed if not_signed is not None: self.not_signed = not_signed if number_of_authenticated_recipients is not None: @@ -554,6 +583,10 @@ def __init__(self, access_code_required=None, access_codes_attempted=None, acces self.phone_calls_attempted = phone_calls_attempted if phone_calls_failed is not None: self.phone_calls_failed = phone_calls_failed + if pii_redacted is not None: + self.pii_redacted = pii_redacted + if purge_date is not None: + self.purge_date = purge_date if reason_for_declining is not None: self.reason_for_declining = reason_for_declining if reason_for_voiding is not None: @@ -622,6 +655,8 @@ def __init__(self, access_code_required=None, access_codes_attempted=None, acces self.status_changed_date = status_changed_date if status_changed_ts is not None: self.status_changed_ts = status_changed_ts + if status_comment is not None: + self.status_comment = status_comment if subject is not None: self.subject = subject if successes is not None: @@ -874,6 +909,29 @@ def avg_complete_seconds(self, avg_complete_seconds): self._avg_complete_seconds = avg_complete_seconds + @property + def capture_method(self): + """Gets the capture_method of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The capture_method of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._capture_method + + @capture_method.setter + def capture_method(self, capture_method): + """Sets the capture_method of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param capture_method: The capture_method of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._capture_method = capture_method + @property def completed(self): """Gets the completed of this ReportInProductRunResponseRowFields. # noqa: E501 @@ -1748,6 +1806,52 @@ def id_checks_failed(self, id_checks_failed): self._id_checks_failed = id_checks_failed + @property + def id_country(self): + """Gets the id_country of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The id_country of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._id_country + + @id_country.setter + def id_country(self, id_country): + """Sets the id_country of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param id_country: The id_country of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._id_country = id_country + + @property + def id_method(self): + """Gets the id_method of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The id_method of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._id_method + + @id_method.setter + def id_method(self, id_method): + """Sets the id_method of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param id_method: The id_method of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._id_method = id_method + @property def initial_send_ts(self): """Gets the initial_send_ts of this ReportInProductRunResponseRowFields. # noqa: E501 @@ -1863,6 +1967,29 @@ def last_sent_date(self, last_sent_date): self._last_sent_date = last_sent_date + @property + def metadata_removed(self): + """Gets the metadata_removed of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The metadata_removed of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._metadata_removed + + @metadata_removed.setter + def metadata_removed(self, metadata_removed): + """Sets the metadata_removed of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param metadata_removed: The metadata_removed of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._metadata_removed = metadata_removed + @property def not_signed(self): """Gets the not_signed of this ReportInProductRunResponseRowFields. # noqa: E501 @@ -2254,6 +2381,52 @@ def phone_calls_failed(self, phone_calls_failed): self._phone_calls_failed = phone_calls_failed + @property + def pii_redacted(self): + """Gets the pii_redacted of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The pii_redacted of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._pii_redacted + + @pii_redacted.setter + def pii_redacted(self, pii_redacted): + """Sets the pii_redacted of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param pii_redacted: The pii_redacted of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._pii_redacted = pii_redacted + + @property + def purge_date(self): + """Gets the purge_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The purge_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._purge_date + + @purge_date.setter + def purge_date(self, purge_date): + """Sets the purge_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param purge_date: The purge_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._purge_date = purge_date + @property def reason_for_declining(self): """Gets the reason_for_declining of this ReportInProductRunResponseRowFields. # noqa: E501 @@ -3036,6 +3209,29 @@ def status_changed_ts(self, status_changed_ts): self._status_changed_ts = status_changed_ts + @property + def status_comment(self): + """Gets the status_comment of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The status_comment of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._status_comment + + @status_comment.setter + def status_comment(self, status_comment): + """Sets the status_comment of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param status_comment: The status_comment of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._status_comment = status_comment + @property def subject(self): """Gets the subject of this ReportInProductRunResponseRowFields. # noqa: E501 diff --git a/setup.py b/setup.py index 12c0f754..3cfd9a4d 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.9.0" +VERSION = "3.10.0rc1" # To install the library, run the following # # python setup.py install @@ -34,6 +34,10 @@ def finalize_options(self): def run(self): os.system('rm -vrf ./build ./dist ./*.pyc ./*.tgz ./*.egg-info') +this_directory = os.path.abspath(os.path.dirname(__file__)) +with open(os.path.join(this_directory, 'README.md'), encoding='utf-8') as f: + long_description = f.read() + setup( name=NAME, version=VERSION, @@ -47,7 +51,6 @@ def run(self): cmdclass={ 'clean': CleanCommand, }, - long_description="""\ - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 - """ + long_description=long_description, + long_description_content_type='text/markdown' )