From 4322b7fadc49348f8b9be3db45a384a4972a540f Mon Sep 17 00:00:00 2001 From: Harsha Rahul Boggaram Date: Mon, 25 Jan 2021 12:51:31 -0800 Subject: [PATCH] Version 3.8.0rc1 release (#96) * Version 3.8.0rc1-v2.1-20.4.01 release * Update .travis.yml * Update README.md Co-authored-by: DevCenter-DocuSign --- docusign_esign/apis/accounts_api.py | 108 + docusign_esign/apis/bulk_envelopes_api.py | 545 +- docusign_esign/apis/connect_api.py | 411 + docusign_esign/apis/envelopes_api.py | 7390 ++++++++++++----- docusign_esign/apis/groups_api.py | 18 +- .../apis/trust_service_providers_api.py | 485 ++ docusign_esign/apis/users_api.py | 108 + docusign_esign/models/__init__.py | 30 +- docusign_esign/models/account_billing_plan.py | 30 +- docusign_esign/models/account_information.py | 90 +- .../models/account_settings_information.py | 1401 +--- docusign_esign/models/account_ui_settings.py | 56 +- .../models/bulk_send_batch_request.py | 117 + .../models/bulk_send_batch_status.py | 58 +- .../models/complete_sign_hash_response.py | 147 +- .../models/complete_sign_request.py | 219 +- docusign_esign/models/credential.py | 147 +- .../models/display_appliance_account.py | 195 +- .../models/display_appliance_info.py | 431 +- .../models/display_appliance_pdf.py | 353 +- .../display_appliance_signer_attachment.py | 251 +- docusign_esign/models/document.py | 30 +- .../models/document_security_store.py | 147 +- docusign_esign/models/document_update_info.py | 235 +- docusign_esign/models/envelope_document.py | 4 +- docusign_esign/models/envelope_form_data.py | 30 +- docusign_esign/models/external_claim.py | 171 +- docusign_esign/models/group_brands.py | 173 + docusign_esign/models/payment_details.py | 28 +- .../models/payment_signer_values.py | 117 + docusign_esign/models/prefill_tabs.py | 201 + docusign_esign/models/revision.py | 215 +- docusign_esign/models/seal.py | 119 +- docusign_esign/models/sender.py | 119 +- docusign_esign/models/sign_hash_document.py | 263 +- .../models/sign_hash_session_info_response.py | 255 +- .../models/sign_session_info_request.py | 171 +- docusign_esign/models/signature_data_info.py | 143 +- docusign_esign/models/signature_properties.py | 119 +- docusign_esign/models/tab_account_settings.py | 56 +- docusign_esign/models/tabs.py | 28 +- docusign_esign/models/template_tabs.py | 28 +- docusign_esign/models/time_stamp_field.py | 143 +- .../models/tsp_health_check_request.py | 195 +- .../tsp_health_check_status_description.py | 219 +- .../models/update_transaction_request.py | 147 +- .../models/update_transaction_response.py | 95 +- docusign_esign/models/user.py | 219 +- docusign_esign/models/user_info_response.py | 183 +- docusign_esign/models/user_information.py | 30 +- requirements.txt | 2 +- setup.py | 5 +- 52 files changed, 9891 insertions(+), 6589 deletions(-) create mode 100644 docusign_esign/models/bulk_send_batch_request.py create mode 100644 docusign_esign/models/group_brands.py create mode 100644 docusign_esign/models/payment_signer_values.py create mode 100644 docusign_esign/models/prefill_tabs.py diff --git a/docusign_esign/apis/accounts_api.py b/docusign_esign/apis/accounts_api.py index 9cd3511f..cdf217f5 100644 --- a/docusign_esign/apis/accounts_api.py +++ b/docusign_esign/apis/accounts_api.py @@ -2094,6 +2094,114 @@ 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. diff --git a/docusign_esign/apis/bulk_envelopes_api.py b/docusign_esign/apis/bulk_envelopes_api.py index 342f4f02..8ef8e052 100644 --- a/docusign_esign/apis/bulk_envelopes_api.py +++ b/docusign_esign/apis/bulk_envelopes_api.py @@ -477,245 +477,6 @@ 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 delete_recipients(self, account_id, envelope_id, recipient_id, **kwargs): - """ - Deletes the bulk recipient file from an envelope. - Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the `bulkRecipientsUri` property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk 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.delete_recipients(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: BulkRecipientsUpdateResponse - 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, recipient_id, **kwargs) - else: - (data) = self.delete_recipients_with_http_info(account_id, envelope_id, recipient_id, **kwargs) - return data - - def delete_recipients_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): - """ - Deletes the bulk recipient file from an envelope. - Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the `bulkRecipientsUri` property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk 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.delete_recipients_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: BulkRecipientsUpdateResponse - 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 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_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_recipients`") - # 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_recipients`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_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'] - 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, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BulkRecipientsUpdateResponse', - 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(self, account_id, batch_id, **kwargs): - """ - Gets the status of a specified bulk send operation. - Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. - 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_id, 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 batch_id: (required) - :param str count: Specifies the number of entries to return. - :param str include: Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=\"failed,queued\") Valid values are: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - This only returns entries with a failed status. * queued - This only returns entries with a queued status. * sent - This only returns entries with a sent status. - :param str start_position: Specifies the location in the list of envelopes from which to start. - :return: BulkEnvelopeStatus - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_with_http_info(account_id, batch_id, **kwargs) - else: - (data) = self.get_with_http_info(account_id, batch_id, **kwargs) - return data - - def get_with_http_info(self, account_id, batch_id, **kwargs): - """ - Gets the status of a specified bulk send operation. - Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. - 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_with_http_info(account_id, 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 batch_id: (required) - :param str count: Specifies the number of entries to return. - :param str include: Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=\"failed,queued\") Valid values are: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - This only returns entries with a failed status. * queued - This only returns entries with a queued status. * sent - This only returns entries with a sent status. - :param str start_position: Specifies the location in the list of envelopes from which to start. - :return: BulkEnvelopeStatus - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'batch_id', 'count', 'include', 'start_position'] - 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" % 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`") - # verify the required parameter 'batch_id' is set - if ('batch_id' not in params) or (params['batch_id'] is None): - raise ValueError("Missing the required parameter `batch_id` when calling `get`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/bulk_envelopes/{batchId}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - if 'batch_id' in params: - path_params['batchId'] = params['batch_id'] - - query_params = {} - if 'count' in params: - query_params['count'] = params['count'] - if 'include' in params: - query_params['include'] = params['include'] - if 'start_position' in params: - query_params['start_position'] = params['start_position'] - - 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='BulkEnvelopeStatus', - 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 @@ -1150,182 +911,55 @@ def get_bulk_send_lists_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_recipients(self, account_id, envelope_id, recipient_id, **kwargs): + def update_bulk_send_batch_status(self, account_id, bulk_send_batch_id, **kwargs): """ - Gets the bulk recipient file from an envelope. - Retrieves the bulk recipient file information from an envelope that has a bulk recipient. + Put/Update a specific bulk send batch status 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_recipients(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.update_bulk_send_batch_status(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 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_tabs: - :param str start_position: - :return: BulkRecipientsResponse - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_recipients_with_http_info(account_id, envelope_id, recipient_id, **kwargs) - else: - (data) = self.get_recipients_with_http_info(account_id, envelope_id, recipient_id, **kwargs) - return data - - def get_recipients_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): - """ - Gets the bulk recipient file from an envelope. - Retrieves the bulk recipient file information from an envelope that has a bulk 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_recipients_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_tabs: - :param str start_position: - :return: BulkRecipientsResponse - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'recipient_id', 'include_tabs', 'start_position'] - 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_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_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_recipients`") - # 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_recipients`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] - - query_params = {} - if 'include_tabs' in params: - query_params['include_tabs'] = params['include_tabs'] - if 'start_position' in params: - query_params['start_position'] = params['start_position'] - - 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='BulkRecipientsResponse', - 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): - """ - Gets status information about bulk recipient batches. - Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the `batchId` property, which can be used to retrieve a more detailed status of individual bulk recipient batches. - 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(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 count: The number of results to return. This can be 1 to 20. - :param str start_position: The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0. - :return: BulkEnvelopesResponse + :param str bulk_send_batch_id: (required) + :param BulkSendBatchRequest bulk_send_batch_request: + :return: BulkSendBatchStatus If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.list_with_http_info(account_id, **kwargs) + return self.update_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id, **kwargs) else: - (data) = self.list_with_http_info(account_id, **kwargs) + (data) = self.update_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id, **kwargs) return data - def list_with_http_info(self, account_id, **kwargs): + def update_bulk_send_batch_status_with_http_info(self, account_id, bulk_send_batch_id, **kwargs): """ - Gets status information about bulk recipient batches. - Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the `batchId` property, which can be used to retrieve a more detailed status of individual bulk recipient batches. + Put/Update a specific bulk send batch status 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_with_http_info(account_id, callback=callback_function) + >>> thread = api.update_bulk_send_batch_status_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 count: The number of results to return. This can be 1 to 20. - :param str start_position: The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0. - :return: BulkEnvelopesResponse + :param str bulk_send_batch_id: (required) + :param BulkSendBatchRequest bulk_send_batch_request: + :return: BulkSendBatchStatus If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'count', 'start_position'] + all_params = ['account_id', 'bulk_send_batch_id', 'bulk_send_batch_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1336,27 +970,28 @@ def list_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list" % key + " to method update_bulk_send_batch_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`") + raise ValueError("Missing the required parameter `account_id` when calling `update_bulk_send_batch_status`") + # 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 `update_bulk_send_batch_status`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/bulk_envelopes'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}'.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 'start_position' in params: - query_params['start_position'] = params['start_position'] header_params = {} @@ -1364,6 +999,8 @@ def list_with_http_info(self, account_id, **kwargs): local_var_files = {} body_params = None + if 'bulk_send_batch_request' in params: + body_params = params['bulk_send_batch_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -1371,14 +1008,14 @@ def list_with_http_info(self, account_id, **kwargs): # 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='BulkEnvelopesResponse', + response_type='BulkSendBatchStatus', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1497,131 +1134,3 @@ def update_bulk_send_list_with_http_info(self, account_id, bulk_send_list_id, ** _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - - def update_recipients(self, account_id, envelope_id, recipient_id, bulk_recipients_request, **kwargs): - """ - Adds or replaces envelope bulk recipients. - Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file. - 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_recipients(account_id, envelope_id, recipient_id, bulk_recipients_request, 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 envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` (required) - :param str recipient_id: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. (required) - :param str bulk_recipients_request: (required) - :return: BulkRecipientsSummaryResponse - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request, **kwargs) - else: - (data) = self.update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request, **kwargs) - return data - - def update_recipients_with_http_info(self, account_id, envelope_id, recipient_id, bulk_recipients_request, **kwargs): - """ - Adds or replaces envelope bulk recipients. - Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file. - 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_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request, 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 envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` (required) - :param str recipient_id: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. (required) - :param str bulk_recipients_request: (required) - :return: BulkRecipientsSummaryResponse - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'recipient_id', 'bulk_recipients_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_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 `update_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 `update_recipients`") - # 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 `update_recipients`") - # verify the required parameter 'bulk_recipients_request' is set - if ('bulk_recipients_request' not in params) or (params['bulk_recipients_request'] is None): - raise ValueError("Missing the required parameter `bulk_recipients_request` when calling `update_recipients`") - - - collection_formats = {} - - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'bulk_recipients_request' in params: - body_params = params['bulk_recipients_request'] - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/csv']) - - # 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='BulkRecipientsSummaryResponse', - 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/connect_api.py b/docusign_esign/apis/connect_api.py index fa5f45fc..adf40de8 100644 --- a/docusign_esign/apis/connect_api.py +++ b/docusign_esign/apis/connect_api.py @@ -147,6 +147,107 @@ 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. @@ -257,6 +358,114 @@ 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}/delete'.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. @@ -687,6 +896,107 @@ 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 @@ -797,6 +1107,107 @@ 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 4d7b5f9d..136f2cb1 100644 --- a/docusign_esign/apis/envelopes_api.py +++ b/docusign_esign/apis/envelopes_api.py @@ -1878,57 +1878,49 @@ def create_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_lock(self, account_id, envelope_id, **kwargs): + def create_error(self, **kwargs): """ - Lock an envelope. - Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user). + Uploads Kazmon error 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_lock(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_error(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 + :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_lock_with_http_info(account_id, envelope_id, **kwargs) + return self.create_error_with_http_info(**kwargs) else: - (data) = self.create_lock_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.create_error_with_http_info(**kwargs) return data - def create_lock_with_http_info(self, account_id, envelope_id, **kwargs): + def create_error_with_http_info(self, **kwargs): """ - Lock an envelope. - Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user). + Uploads Kazmon error 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_lock_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_error_with_http_info(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 + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'lock_request'] + all_params = [] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1939,26 +1931,15 @@ def create_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 create_lock" % key + " to method create_error" % 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_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 `create_lock`") - collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock'.replace('{format}', 'json') + resource_path = '/v2.1/display_appliance_info/error'.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 = {} @@ -1968,8 +1949,6 @@ def create_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'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -1984,7 +1963,7 @@ def create_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=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1992,59 +1971,57 @@ def create_lock_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_recipient(self, account_id, envelope_id, **kwargs): + def create_lock(self, account_id, envelope_id, **kwargs): """ - Adds one or more recipients to an envelope. - Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**. + Lock an envelope. + Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the 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.create_recipient(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_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 str resend_envelope: When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. - :param Recipients recipients: - :return: Recipients + :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.create_recipient_with_http_info(account_id, envelope_id, **kwargs) + return self.create_lock_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.create_recipient_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.create_lock_with_http_info(account_id, envelope_id, **kwargs) return data - def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs): + def create_lock_with_http_info(self, account_id, envelope_id, **kwargs): """ - Adds one or more recipients to an envelope. - Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**. + Lock an envelope. + Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the 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.create_recipient_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_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 str resend_envelope: When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. - :param Recipients recipients: - :return: Recipients + :param LockRequest lock_request: + :return: LockInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'resend_envelope', 'recipients'] + all_params = ['account_id', 'envelope_id', 'lock_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2055,21 +2032,21 @@ def create_recipient_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 create_recipient" % key + " to method create_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 `create_recipient`") + raise ValueError("Missing the required parameter `account_id` when calling `create_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 `create_recipient`") + raise ValueError("Missing the required parameter `envelope_id` when calling `create_lock`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients'.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'] @@ -2077,8 +2054,6 @@ def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs): path_params['envelopeId'] = params['envelope_id'] query_params = {} - if 'resend_envelope' in params: - query_params['resend_envelope'] = params['resend_envelope'] header_params = {} @@ -2086,8 +2061,8 @@ def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None - if 'recipients' in params: - body_params = params['recipients'] + if 'lock_request' in params: + body_params = params['lock_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -2102,7 +2077,7 @@ def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='Recipients', + response_type='LockInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2110,55 +2085,53 @@ def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_recipient_proof_file_link(self, account_id, envelope_id, recipient_id, **kwargs): + def create_page_info(self, account_id, envelope_id, **kwargs): """ - Returns a link to access to the identity events stored in the proof service related to this recipient. + 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_recipient_proof_file_link(account_id, envelope_id, recipient_id, callback=callback_function) + >>> 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) - :param str recipient_id: The ID of the recipient being accessed. (required) - :return: ProofServiceViewLink + :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_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.create_page_info_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.create_page_info_with_http_info(account_id, envelope_id, **kwargs) return data - def create_recipient_proof_file_link_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def create_page_info_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns a link to access to the identity events stored in the proof service related to this recipient. + 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_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) + >>> 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) - :param str recipient_id: The ID of the recipient being accessed. (required) - :return: ProofServiceViewLink + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipient_id'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2169,31 +2142,26 @@ def create_recipient_proof_file_link_with_http_info(self, account_id, envelope_i if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method create_recipient_proof_file_link" % key + " 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_recipient_proof_file_link`") + 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_recipient_proof_file_link`") - # 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 `create_recipient_proof_file_link`") + raise ValueError("Missing the required parameter `envelope_id` when calling `create_page_info`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof'.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_id' in params: path_params['envelopeId'] = params['envelope_id'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] query_params = {} @@ -2217,7 +2185,7 @@ def create_recipient_proof_file_link_with_http_info(self, account_id, envelope_i body=body_params, post_params=form_params, files=local_var_files, - response_type='ProofServiceViewLink', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2225,57 +2193,53 @@ def create_recipient_proof_file_link_with_http_info(self, account_id, envelope_i _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_recipient_proof_file_resource_token(self, account_id, envelope_id, recipient_id, token_scopes, **kwargs): + def create_pdf_blob(self, account_id, envelope_id, **kwargs): """ - Returns a resource token to get access to the identity events stored in the proof service related to this recipient. + 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_recipient_proof_file_resource_token(account_id, envelope_id, recipient_id, token_scopes, callback=callback_function) + >>> 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) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str token_scopes: (required) - :return: ProofServiceResourceToken + :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_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes, **kwargs) + return self.create_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes, **kwargs) + (data) = self.create_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) return data - def create_recipient_proof_file_resource_token_with_http_info(self, account_id, envelope_id, recipient_id, token_scopes, **kwargs): + def create_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns a resource token to get access to the identity events stored in the proof service related to this recipient. + 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_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes, callback=callback_function) + >>> 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) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str token_scopes: (required) - :return: ProofServiceResourceToken + :return: DisplayAppliancePdf If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipient_id', 'token_scopes'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2286,36 +2250,26 @@ def create_recipient_proof_file_resource_token_with_http_info(self, account_id, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method create_recipient_proof_file_resource_token" % key + " 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_recipient_proof_file_resource_token`") + 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_recipient_proof_file_resource_token`") - # 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 `create_recipient_proof_file_resource_token`") - # verify the required parameter 'token_scopes' is set - if ('token_scopes' not in params) or (params['token_scopes'] is None): - raise ValueError("Missing the required parameter `token_scopes` when calling `create_recipient_proof_file_resource_token`") + raise ValueError("Missing the required parameter `envelope_id` when calling `create_pdf_blob`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token'.replace('{format}', 'json') + 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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] - if 'token_scopes' in params: - path_params['token_scopes'] = params['token_scopes'] query_params = {} @@ -2339,7 +2293,7 @@ def create_recipient_proof_file_resource_token_with_http_info(self, account_id, body=body_params, post_params=form_params, files=local_var_files, - response_type='ProofServiceResourceToken', + response_type='DisplayAppliancePdf', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2347,57 +2301,59 @@ def create_recipient_proof_file_resource_token_with_http_info(self, account_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_recipient_view(self, account_id, envelope_id, **kwargs): + def create_recipient(self, account_id, envelope_id, **kwargs): """ - Returns a URL to the recipient view UI. - Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity. + Adds one or more recipients to an envelope. + Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**. 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_recipient_view(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_recipient(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 RecipientViewRequest recipient_view_request: - :return: ViewUrl + :param str resend_envelope: When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. + :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.create_recipient_view_with_http_info(account_id, envelope_id, **kwargs) + return self.create_recipient_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.create_recipient_view_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.create_recipient_with_http_info(account_id, envelope_id, **kwargs) return data - def create_recipient_view_with_http_info(self, account_id, envelope_id, **kwargs): + def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns a URL to the recipient view UI. - Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity. + Adds one or more recipients to an envelope. + Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**. 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_recipient_view_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_recipient_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 RecipientViewRequest recipient_view_request: - :return: ViewUrl + :param str resend_envelope: When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. + :param Recipients recipients: + :return: Recipients If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipient_view_request'] + all_params = ['account_id', 'envelope_id', 'resend_envelope', 'recipients'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2408,21 +2364,21 @@ def create_recipient_view_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 create_recipient_view" % key + " to method create_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 `create_recipient_view`") + raise ValueError("Missing the required parameter `account_id` when calling `create_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 `create_recipient_view`") + raise ValueError("Missing the required parameter `envelope_id` when calling `create_recipient`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient'.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'] @@ -2430,6 +2386,8 @@ def create_recipient_view_with_http_info(self, account_id, envelope_id, **kwargs path_params['envelopeId'] = params['envelope_id'] query_params = {} + if 'resend_envelope' in params: + query_params['resend_envelope'] = params['resend_envelope'] header_params = {} @@ -2437,8 +2395,8 @@ def create_recipient_view_with_http_info(self, account_id, envelope_id, **kwargs local_var_files = {} body_params = None - if 'recipient_view_request' in params: - body_params = params['recipient_view_request'] + if 'recipients' in params: + body_params = params['recipients'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -2453,7 +2411,7 @@ def create_recipient_view_with_http_info(self, account_id, envelope_id, **kwargs body=body_params, post_params=form_params, files=local_var_files, - response_type='ViewUrl', + response_type='Recipients', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2461,55 +2419,55 @@ def create_recipient_view_with_http_info(self, account_id, envelope_id, **kwargs _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_responsive_html_preview(self, account_id, envelope_id, **kwargs): + def create_recipient_manual_review_view(self, account_id, envelope_id, recipient_id, **kwargs): """ - Get Responsive HTML Preview for all documents in an envelope. + Provides a link to access the Identity manual review related to a 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.create_responsive_html_preview(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_recipient_manual_review_view(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 DocumentHtmlDefinition document_html_definition: - :return: DocumentHtmlDefinitions + :param str recipient_id: The ID of the recipient being accessed. (required) + :return: ViewUrl If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_responsive_html_preview_with_http_info(account_id, envelope_id, **kwargs) + return self.create_recipient_manual_review_view_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.create_responsive_html_preview_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.create_recipient_manual_review_view_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def create_responsive_html_preview_with_http_info(self, account_id, envelope_id, **kwargs): + def create_recipient_manual_review_view_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Get Responsive HTML Preview for all documents in an envelope. + Provides a link to access the Identity manual review related to a 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.create_responsive_html_preview_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_recipient_manual_review_view_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 DocumentHtmlDefinition document_html_definition: - :return: DocumentHtmlDefinitions + :param str recipient_id: The ID of the recipient being accessed. (required) + :return: ViewUrl If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'document_html_definition'] + all_params = ['account_id', 'envelope_id', 'recipient_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2520,26 +2478,31 @@ def create_responsive_html_preview_with_http_info(self, account_id, envelope_id, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method create_responsive_html_preview" % key + " to method create_recipient_manual_review_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 `create_responsive_html_preview`") + raise ValueError("Missing the required parameter `account_id` when calling `create_recipient_manual_review_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 `create_responsive_html_preview`") + raise ValueError("Missing the required parameter `envelope_id` when calling `create_recipient_manual_review_view`") + # 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 `create_recipient_manual_review_view`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review'.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 = {} @@ -2549,8 +2512,6 @@ def create_responsive_html_preview_with_http_info(self, account_id, envelope_id, local_var_files = {} body_params = None - if 'document_html_definition' in params: - body_params = params['document_html_definition'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -2565,7 +2526,7 @@ def create_responsive_html_preview_with_http_info(self, account_id, envelope_id, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentHtmlDefinitions', + response_type='ViewUrl', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2573,57 +2534,55 @@ def create_responsive_html_preview_with_http_info(self, account_id, envelope_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_sender_view(self, account_id, envelope_id, **kwargs): + def create_recipient_proof_file_link(self, account_id, envelope_id, recipient_id, **kwargs): """ - Returns a URL to the sender view UI. - Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. + Returns a link to access to the identity events stored in the proof service related to this 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.create_sender_view(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_recipient_proof_file_link(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 ReturnUrlRequest return_url_request: - :return: ViewUrl + :param str recipient_id: The ID of the recipient being accessed. (required) + :return: ProofServiceViewLink If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_sender_view_with_http_info(account_id, envelope_id, **kwargs) + return self.create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.create_sender_view_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def create_sender_view_with_http_info(self, account_id, envelope_id, **kwargs): + def create_recipient_proof_file_link_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Returns a URL to the sender view UI. - Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. + Returns a link to access to the identity events stored in the proof service related to this 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.create_sender_view_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_recipient_proof_file_link_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 ReturnUrlRequest return_url_request: - :return: ViewUrl + :param str recipient_id: The ID of the recipient being accessed. (required) + :return: ProofServiceViewLink If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'return_url_request'] + all_params = ['account_id', 'envelope_id', 'recipient_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2634,26 +2593,31 @@ def create_sender_view_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 create_sender_view" % key + " to method create_recipient_proof_file_link" % 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_sender_view`") + raise ValueError("Missing the required parameter `account_id` when calling `create_recipient_proof_file_link`") # 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_sender_view`") - + raise ValueError("Missing the required parameter `envelope_id` when calling `create_recipient_proof_file_link`") + # 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 `create_recipient_proof_file_link`") + collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof'.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 = {} @@ -2663,8 +2627,6 @@ def create_sender_view_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None - if 'return_url_request' in params: - body_params = params['return_url_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -2679,7 +2641,7 @@ def create_sender_view_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='ViewUrl', + response_type='ProofServiceViewLink', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2687,59 +2649,57 @@ def create_sender_view_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_tabs(self, account_id, envelope_id, recipient_id, **kwargs): + def create_recipient_proof_file_resource_token(self, account_id, envelope_id, recipient_id, token_scopes, **kwargs): """ - Adds tabs for a recipient. - Adds one or more tabs for a recipient. + Returns a resource token to get access to the identity events stored in the proof service related to this 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.create_tabs(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.create_recipient_proof_file_resource_token(account_id, envelope_id, recipient_id, token_scopes, 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 token_scopes: (required) + :return: ProofServiceResourceToken If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes, **kwargs) else: - (data) = self.create_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes, **kwargs) return data - def create_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def create_recipient_proof_file_resource_token_with_http_info(self, account_id, envelope_id, recipient_id, token_scopes, **kwargs): """ - Adds tabs for a recipient. - Adds one or more tabs for a recipient. + Returns a resource token to get access to the identity events stored in the proof service related to this 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.create_tabs_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes, 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 token_scopes: (required) + :return: ProofServiceResourceToken If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipient_id', 'tabs'] + all_params = ['account_id', 'envelope_id', 'recipient_id', 'token_scopes'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2750,24 +2710,27 @@ def create_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 create_tabs" % key + " to method create_recipient_proof_file_resource_token" % 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_tabs`") + raise ValueError("Missing the required parameter `account_id` when calling `create_recipient_proof_file_resource_token`") # 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_tabs`") + raise ValueError("Missing the required parameter `envelope_id` when calling `create_recipient_proof_file_resource_token`") # 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 `create_tabs`") + raise ValueError("Missing the required parameter `recipient_id` when calling `create_recipient_proof_file_resource_token`") + # verify the required parameter 'token_scopes' is set + if ('token_scopes' not in params) or (params['token_scopes'] is None): + raise ValueError("Missing the required parameter `token_scopes` when calling `create_recipient_proof_file_resource_token`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -2775,6 +2738,8 @@ def create_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kw path_params['envelopeId'] = params['envelope_id'] if 'recipient_id' in params: path_params['recipientId'] = params['recipient_id'] + if 'token_scopes' in params: + path_params['token_scopes'] = params['token_scopes'] query_params = {} @@ -2784,8 +2749,6 @@ def create_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']) @@ -2800,7 +2763,7 @@ def create_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kw body=body_params, post_params=form_params, files=local_var_files, - response_type='Tabs', + response_type='ProofServiceResourceToken', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2808,55 +2771,57 @@ def create_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kw _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_attachments(self, account_id, envelope_id, **kwargs): + def create_recipient_view(self, account_id, envelope_id, **kwargs): """ - Delete one or more attachments from a DRAFT envelope. + Returns a URL to the recipient view UI. + Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity. 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_attachments(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_recipient_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EnvelopeAttachmentsRequest envelope_attachments_request: - :return: EnvelopeAttachmentsResult + :param RecipientViewRequest recipient_view_request: + :return: ViewUrl If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_attachments_with_http_info(account_id, envelope_id, **kwargs) + return self.create_recipient_view_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_attachments_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.create_recipient_view_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_attachments_with_http_info(self, account_id, envelope_id, **kwargs): + def create_recipient_view_with_http_info(self, account_id, envelope_id, **kwargs): """ - Delete one or more attachments from a DRAFT envelope. + Returns a URL to the recipient view UI. + Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity. 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_attachments_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_recipient_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param EnvelopeAttachmentsRequest envelope_attachments_request: - :return: EnvelopeAttachmentsResult + :param RecipientViewRequest recipient_view_request: + :return: ViewUrl If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'envelope_attachments_request'] + all_params = ['account_id', 'envelope_id', 'recipient_view_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2867,21 +2832,21 @@ def delete_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 delete_attachments" % key + " to method create_recipient_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_attachments`") + raise ValueError("Missing the required parameter `account_id` when calling `create_recipient_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_attachments`") + raise ValueError("Missing the required parameter `envelope_id` when calling `create_recipient_view`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -2896,8 +2861,8 @@ def delete_attachments_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None - if 'envelope_attachments_request' in params: - body_params = params['envelope_attachments_request'] + if 'recipient_view_request' in params: + body_params = params['recipient_view_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -2905,14 +2870,14 @@ def delete_attachments_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, 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeAttachmentsResult', + response_type='ViewUrl', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2920,53 +2885,49 @@ def delete_attachments_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_chunked_upload(self, account_id, chunked_upload_id, **kwargs): + def create_redeem(self, **kwargs): """ - Delete an existing ChunkedUpload. + Returns signing url 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_chunked_upload(account_id, chunked_upload_id, callback=callback_function) + >>> thread = api.create_redeem(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) - :return: ChunkedUploadResponse + :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_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) + return self.create_redeem_with_http_info(**kwargs) else: - (data) = self.delete_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) + (data) = self.create_redeem_with_http_info(**kwargs) return data - def delete_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwargs): + def create_redeem_with_http_info(self, **kwargs): """ - Delete an existing ChunkedUpload. + Returns signing url 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_chunked_upload_with_http_info(account_id, chunked_upload_id, callback=callback_function) + >>> thread = api.create_redeem_with_http_info(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) - :return: ChunkedUploadResponse + :return: DisplayApplianceInfo If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'chunked_upload_id'] + all_params = [] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2977,26 +2938,15 @@ def delete_chunked_upload_with_http_info(self, account_id, chunked_upload_id, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_chunked_upload" % key + " to method create_redeem" % 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_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 `delete_chunked_upload`") - collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}'.replace('{format}', 'json') + resource_path = '/v2.1/display_appliance_info/redeem'.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 = {} @@ -3013,14 +2963,14 @@ def delete_chunked_upload_with_http_info(self, account_id, chunked_upload_id, ** # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'DELETE', + 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='ChunkedUploadResponse', + response_type='DisplayApplianceInfo', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3028,57 +2978,55 @@ def delete_chunked_upload_with_http_info(self, account_id, chunked_upload_id, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_custom_fields(self, account_id, envelope_id, **kwargs): + def create_responsive_html_preview(self, account_id, envelope_id, **kwargs): """ - Deletes envelope custom fields for draft and in-process envelopes. - Deletes envelope custom fields for draft and in-process envelopes. + Get Responsive HTML Preview for all documents in an envelope. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.delete_custom_fields(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_responsive_html_preview(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 DocumentHtmlDefinition document_html_definition: + :return: DocumentHtmlDefinitions 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_with_http_info(account_id, envelope_id, **kwargs) + return self.create_responsive_html_preview_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_custom_fields_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.create_responsive_html_preview_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): + def create_responsive_html_preview_with_http_info(self, account_id, envelope_id, **kwargs): """ - Deletes envelope custom fields for draft and in-process envelopes. - Deletes envelope custom fields for draft and in-process envelopes. + Get Responsive HTML Preview for all documents in an envelope. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.delete_custom_fields_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.create_responsive_html_preview_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 DocumentHtmlDefinition document_html_definition: + :return: DocumentHtmlDefinitions If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'custom_fields'] + all_params = ['account_id', 'envelope_id', 'document_html_definition'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3089,21 +3037,21 @@ def delete_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 delete_custom_fields" % key + " to method create_responsive_html_preview" % 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`") + raise ValueError("Missing the required parameter `account_id` when calling `create_responsive_html_preview`") # 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`") + raise ValueError("Missing the required parameter `envelope_id` when calling `create_responsive_html_preview`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -3118,8 +3066,8 @@ def delete_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 'document_html_definition' in params: + body_params = params['document_html_definition'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -3127,14 +3075,14 @@ def delete_custom_fields_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, 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='CustomFields', + response_type='DocumentHtmlDefinitions', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3142,59 +3090,57 @@ 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_document_fields(self, account_id, document_id, envelope_id, **kwargs): + def create_sender_view(self, account_id, envelope_id, **kwargs): """ - Deletes custom document fields from an existing envelope document. - Deletes custom document fields from an existing envelope document. + Returns a URL to the sender view UI. + Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. 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.create_sender_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 DocumentFieldsInformation document_fields_information: - :return: DocumentFieldsInformation + :param ReturnUrlRequest return_url_request: + :return: ViewUrl 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.create_sender_view_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.create_sender_view_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 create_sender_view_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. + Returns a URL to the sender view UI. + Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. 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.create_sender_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 DocumentFieldsInformation document_fields_information: - :return: DocumentFieldsInformation + :param ReturnUrlRequest return_url_request: + :return: ViewUrl 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', 'return_url_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3205,29 +3151,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 create_sender_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_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 `create_sender_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_fields`") + raise ValueError("Missing the required parameter `envelope_id` when calling `create_sender_view`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender'.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'] @@ -3239,8 +3180,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 'return_url_request' in params: + body_params = params['return_url_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -3248,14 +3189,14 @@ def delete_document_fields_with_http_info(self, account_id, document_id, envelop # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'DELETE', + 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='DocumentFieldsInformation', + response_type='ViewUrl', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3263,59 +3204,59 @@ 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 create_tabs(self, account_id, envelope_id, recipient_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. + Adds tabs for a recipient. + Adds one or more tabs for a 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.delete_document_page(account_id, document_id, envelope_id, page_number, callback=callback_function) + >>> thread = api.create_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 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 + :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_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + return self.create_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + (data) = self.create_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def delete_document_page_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): + def create_tabs_with_http_info(self, account_id, envelope_id, recipient_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. + Adds tabs for a recipient. + Adds one or more tabs for a 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.delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number, callback=callback_function) + >>> thread = api.create_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 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 + :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', 'document_id', 'envelope_id', 'page_number'] + 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') @@ -3326,36 +3267,31 @@ 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 create_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_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 `create_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_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 `create_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 `create_tabs`") 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}/recipients/{recipientId}/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'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] query_params = {} @@ -3365,6 +3301,8 @@ def delete_document_page_with_http_info(self, account_id, document_id, envelope_ 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']) @@ -3372,14 +3310,14 @@ def delete_document_page_with_http_info(self, account_id, document_id, envelope_ # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'DELETE', + 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, + response_type='Tabs', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3387,57 +3325,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_attachments(self, account_id, envelope_id, **kwargs): """ - Deletes tabs from an envelope document + Delete one or more attachments from 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_document_tabs(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.delete_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 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 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.delete_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.delete_attachments_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_attachments_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_attachments_with_http_info(self, account_id, envelope_id, **kwargs): """ - Deletes tabs from an envelope document + Delete one or more attachments from 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_document_tabs_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.delete_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 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 EnvelopeAttachmentsRequest envelope_attachments_request: + :return: EnvelopeAttachmentsResult 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', 'envelope_attachments_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3448,29 +3384,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_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_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_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_document_tabs`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_attachments`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs'.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'] - if 'document_id' in params: - path_params['documentId'] = params['document_id'] if 'envelope_id' in params: path_params['envelopeId'] = params['envelope_id'] @@ -3482,8 +3413,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 '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']) @@ -3498,7 +3429,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='EnvelopeAttachmentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3506,57 +3437,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_chunked_upload(self, account_id, chunked_upload_id, **kwargs): """ - Deletes documents from a draft envelope. - Deletes one or more documents from an existing draft envelope. + Delete 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.delete_documents(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_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 EnvelopeDefinition envelope_definition: - :return: EnvelopeDocumentsResult + :param str chunked_upload_id: (required) + :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_documents_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) else: - (data) = self.delete_documents_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) return data - def delete_documents_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwargs): """ - Deletes documents from a draft envelope. - Deletes one or more documents from an existing draft envelope. + Delete 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.delete_documents_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_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 EnvelopeDefinition envelope_definition: - :return: EnvelopeDocumentsResult + :param str chunked_upload_id: (required) + :return: ChunkedUploadResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'envelope_definition'] + all_params = ['account_id', 'chunked_upload_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3567,26 +3494,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_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_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_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 `delete_chunked_upload`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents'.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 'chunked_upload_id' in params: + path_params['chunkedUploadId'] = params['chunked_upload_id'] query_params = {} @@ -3596,8 +3523,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']) @@ -3612,7 +3537,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='ChunkedUploadResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3620,55 +3545,57 @@ 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_custom_fields(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. + Deletes envelope custom fields for draft and in-process envelopes. + Deletes envelope custom fields for draft and in-process 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.delete_email_settings(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_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: EmailSettings + :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.delete_email_settings_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_custom_fields_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_custom_fields_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_custom_fields_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. + Deletes envelope custom fields for draft and in-process envelopes. + Deletes envelope custom fields for draft and in-process 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.delete_email_settings_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_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: EmailSettings + :param CustomFields custom_fields: + :return: CustomFields If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'custom_fields'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3679,21 +3606,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_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 `delete_email_settings`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_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 `delete_email_settings`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_custom_fields`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings'.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'] @@ -3708,6 +3635,8 @@ def delete_email_settings_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'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -3722,7 +3651,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='CustomFields', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3730,55 +3659,53 @@ 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_custom_fields_0(self, account_id, envelope_id, **kwargs): """ - Revokes the correction view URL to the Envelope UI + Delete custom fields 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_correct_view(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_custom_fields_0(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 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_custom_fields_0_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_custom_fields_0_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_custom_fields_0_with_http_info(self, account_id, envelope_id, **kwargs): """ - Revokes the correction view URL to the Envelope UI + Delete custom fields 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_correct_view_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.delete_custom_fields_0_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 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') @@ -3789,21 +3716,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_custom_fields_0" % 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_custom_fields_0`") # 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_custom_fields_0`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/custom_fields/delete'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -3818,8 +3745,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']) @@ -3827,7 +3752,7 @@ def delete_envelope_correct_view_with_http_info(self, account_id, envelope_id, * # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'DELETE', + return self.api_client.call_api(resource_path, 'POST', path_params, query_params, header_params, @@ -3842,53 +3767,55 @@ 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_document(self, account_id, document_id, envelope_id, **kwargs): """ - Delete envelope transfer rules for an account. + Delete document 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_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 envelope_transfer_rule_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 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_document_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) + (data) = self.delete_document_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def delete_envelope_transfer_rules_with_http_info(self, account_id, envelope_transfer_rule_id, **kwargs): + def delete_document_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Delete envelope transfer rules for an account. + Delete document 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_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 envelope_transfer_rule_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 If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_transfer_rule_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') @@ -3899,26 +3826,31 @@ 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_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_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_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_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_document`") 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/document/{documentId}'.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 = {} @@ -3950,53 +3882,59 @@ 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_document_fields(self, account_id, document_id, envelope_id, **kwargs): """ - Delete the workflow definition for an envelope. + 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_envelope_workflow_definition(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_envelope_workflow_definition_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_envelope_workflow_definition_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_envelope_workflow_definition_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 the workflow definition for an envelope. + 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_envelope_workflow_definition_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') @@ -4007,24 +3945,29 @@ 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_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_envelope_workflow_definition`") + 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_envelope_workflow_definition`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_document_fields`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow'.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'] @@ -4036,6 +3979,8 @@ def delete_envelope_workflow_definition_with_http_info(self, account_id, envelop 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']) @@ -4050,7 +3995,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='DocumentFieldsInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4058,55 +4003,59 @@ 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_document_page(self, account_id, document_id, envelope_id, page_number, **kwargs): """ - Deletes an envelope lock. - Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request. + 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_lock(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) - :return: LockInformation + :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_lock_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_lock_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_lock_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): """ - Deletes an envelope lock. - Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request. + 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_lock_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) - :return: LockInformation + :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') @@ -4117,26 +4066,36 @@ 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_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_lock`") + 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_lock`") + 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}/lock'.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 = {} @@ -4160,7 +4119,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=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4168,57 +4127,57 @@ def delete_lock_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_document_tabs(self, account_id, document_id, envelope_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 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_recipient(account_id, envelope_id, recipient_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) - :param str recipient_id: The ID of the recipient being accessed. (required) - :return: Recipients + :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_recipient_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.delete_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.delete_recipient_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.delete_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def delete_recipient_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def delete_document_tabs_with_http_info(self, account_id, document_id, envelope_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 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_recipient_with_http_info(account_id, envelope_id, recipient_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) - :param str recipient_id: The ID of the recipient being accessed. (required) - :return: Recipients + :param Tabs tabs: + :return: Tabs 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', 'tabs'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4229,31 +4188,31 @@ 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_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_recipient`") + 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`") # 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_document_tabs`") 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}/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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] query_params = {} @@ -4263,6 +4222,8 @@ def delete_recipient_with_http_info(self, account_id, envelope_id, recipient_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']) @@ -4277,7 +4238,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='Tabs', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4285,57 +4246,57 @@ 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_recipients(self, account_id, envelope_id, **kwargs): + def delete_documents(self, account_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. + 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_recipients(account_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Recipients recipients: - :return: Recipients + :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_recipients_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_documents_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_recipients_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_documents_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_recipients_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_documents_with_http_info(self, account_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. + 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_recipients_with_http_info(account_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Recipients recipients: - :return: Recipients + :param EnvelopeDefinition envelope_definition: + :return: EnvelopeDocumentsResult If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipients'] + all_params = ['account_id', 'envelope_id', 'envelope_definition'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4346,21 +4307,21 @@ 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 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_recipients`") + 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_recipients`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_documents`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients'.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'] @@ -4375,8 +4336,8 @@ 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'] + if 'envelope_definition' in params: + body_params = params['envelope_definition'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -4391,7 +4352,7 @@ def delete_recipients_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='Recipients', + response_type='EnvelopeDocumentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4399,59 +4360,55 @@ def delete_recipients_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_tabs(self, account_id, envelope_id, recipient_id, **kwargs): + def delete_email_settings(self, account_id, envelope_id, **kwargs): """ - Deletes the tabs associated with a recipient. - Deletes one or more tabs associated with a recipient in a draft envelope. + 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_tabs(account_id, envelope_id, recipient_id, 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 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 + :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_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.delete_email_settings_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.delete_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.delete_email_settings_with_http_info(account_id, envelope_id, **kwargs) return data - def delete_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def delete_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): """ - Deletes the tabs associated with a recipient. - Deletes one or more tabs associated with a recipient in a draft envelope. + 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_tabs_with_http_info(account_id, envelope_id, recipient_id, 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 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 + :return: EmailSettings If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipient_id', 'tabs'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4462,31 +4419,26 @@ 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 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_tabs`") + 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_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 `envelope_id` when calling `delete_email_settings`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs'.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 'envelope_id' in params: path_params['envelopeId'] = params['envelope_id'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] query_params = {} @@ -4496,8 +4448,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']) @@ -4512,7 +4462,7 @@ def delete_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kw body=body_params, post_params=form_params, files=local_var_files, - response_type='Tabs', + response_type='EmailSettings', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4520,53 +4470,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 delete_envelope_correct_view(self, account_id, envelope_id, **kwargs): """ - Delete the workflow definition for a template. + 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_template_workflow_definition(account_id, template_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 template_id: The ID of the template being accessed. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :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_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) + return self.delete_envelope_correct_view_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.delete_envelope_correct_view_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 delete_envelope_correct_view_with_http_info(self, account_id, envelope_id, **kwargs): """ - Delete the workflow definition for a template. + 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_template_workflow_definition_with_http_info(account_id, template_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 template_id: The ID of the template being accessed. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param CorrectViewRequest correct_view_request: :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'template_id'] + 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') @@ -4577,26 +4529,26 @@ 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 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_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 `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_envelope_correct_view`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/workflow'.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 'template_id' in params: - path_params['templateId'] = params['template_id'] + if 'envelope_id' in params: + path_params['envelopeId'] = params['envelope_id'] query_params = {} @@ -4606,6 +4558,8 @@ def delete_template_workflow_definition_with_http_info(self, account_id, templat 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']) @@ -4628,59 +4582,53 @@ 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 delete_envelope_transfer_rules(self, account_id, envelope_transfer_rule_id, **kwargs): """ - Deletes a template from a document in an existing envelope. - Deletes the specified template from a document in an existing 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_templates_from_document(account_id, document_id, envelope_id, template_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 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) + :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_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id, **kwargs) + return self.delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) else: - (data) = self.delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id, **kwargs) + (data) = self.delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) return data - def delete_templates_from_document_with_http_info(self, account_id, document_id, envelope_id, template_id, **kwargs): + def delete_envelope_transfer_rules_with_http_info(self, account_id, envelope_transfer_rule_id, **kwargs): """ - Deletes a template from a document in an existing envelope. - Deletes the specified template from a document in an existing 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_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_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 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) + :param str envelope_transfer_rule_id: (required) :return: None 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_transfer_rule_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4691,36 +4639,26 @@ 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 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_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_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 `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/{documentId}/templates/{templateId}'.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 '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 'envelope_transfer_rule_id' in params: + path_params['envelopeTransferRuleId'] = params['envelope_transfer_rule_id'] query_params = {} @@ -4752,21 +4690,20 @@ 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_attachment(self, account_id, attachment_id, envelope_id, **kwargs): + def delete_envelope_workflow_definition(self, account_id, envelope_id, **kwargs): """ - Retrieves an attachment from the envelope. + 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.get_attachment(account_id, attachment_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 attachment_id: (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) :return: None If the method is called asynchronously, @@ -4774,33 +4711,32 @@ def get_attachment(self, account_id, attachment_id, envelope_id, **kwargs): """ 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.delete_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_attachment_with_http_info(account_id, attachment_id, envelope_id, **kwargs) + (data) = self.delete_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) return data - def get_attachment_with_http_info(self, account_id, attachment_id, envelope_id, **kwargs): + def delete_envelope_workflow_definition_with_http_info(self, account_id, envelope_id, **kwargs): """ - Retrieves an attachment from the envelope. + 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.get_attachment_with_http_info(account_id, attachment_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 attachment_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', 'attachment_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4811,29 +4747,24 @@ 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 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 `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 `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 `get_attachment`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_envelope_workflow_definition`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}'.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'] - if 'attachment_id' in params: - path_params['attachmentId'] = params['attachment_id'] if 'envelope_id' in params: path_params['envelopeId'] = params['envelope_id'] @@ -4852,7 +4783,7 @@ def get_attachment_with_http_info(self, account_id, attachment_id, envelope_id, # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + return self.api_client.call_api(resource_path, 'DELETE', path_params, query_params, header_params, @@ -4867,48 +4798,50 @@ 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 delete_lock(self, account_id, envelope_id, **kwargs): """ - Returns a list of attachments associated with the specified envelope + 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.get_attachments(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) - :return: EnvelopeAttachmentsResult + :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_attachments_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_lock_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_attachments_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_lock_with_http_info(account_id, envelope_id, **kwargs) return data - def get_attachments_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_lock_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns a list of attachments associated with the specified envelope + 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.get_attachments_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) - :return: EnvelopeAttachmentsResult + :return: LockInformation If the method is called asynchronously, returns the request thread. """ @@ -4924,21 +4857,21 @@ 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 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 `get_attachments`") + 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 `get_attachments`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_lock`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments'.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'] @@ -4960,14 +4893,14 @@ def get_attachments_with_http_info(self, account_id, envelope_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + 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='EnvelopeAttachmentsResult', + response_type='LockInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4975,55 +4908,53 @@ 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 delete_page_info(self, account_id, envelope_id, **kwargs): """ - Retrieves the current metadata of a ChunkedUpload. + 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.get_chunked_upload(account_id, chunked_upload_id, callback=callback_function) + >>> thread = api.delete_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 chunked_upload_id: (required) - :param str include: - :return: ChunkedUploadResponse + :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_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) + return self.delete_page_info_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.delete_page_info_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 delete_page_info_with_http_info(self, account_id, envelope_id, **kwargs): """ - Retrieves the current metadata of a ChunkedUpload. + 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.get_chunked_upload_with_http_info(account_id, chunked_upload_id, callback=callback_function) + >>> thread = api.delete_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 chunked_upload_id: (required) - :param str include: - :return: ChunkedUploadResponse + :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', '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') @@ -5034,30 +4965,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 delete_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 `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 `delete_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 `delete_page_info`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info/delete'.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 = {} @@ -5072,14 +5001,14 @@ def get_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwa # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + 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='ChunkedUploadResponse', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5087,55 +5016,57 @@ 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 delete_recipient(self, account_id, envelope_id, recipient_id, **kwargs): """ - Gets comment transcript for envelope and user + 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.get_comments_transcript(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) - :param str encoding: - :return: file + :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.get_comments_transcript_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.get_comments_transcript_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 get_comments_transcript_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_recipient_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Gets comment transcript for envelope and user + 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.get_comments_transcript_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) - :param str encoding: - :return: file + :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', 'encoding'] + all_params = ['account_id', 'envelope_id', 'recipient_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5146,30 +5077,33 @@ 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 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 `get_comments_transcript`") + 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 `get_comments_transcript`") + 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}/comments/transcript'.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 = {} - if 'encoding' in params: - query_params['encoding'] = params['encoding'] header_params = {} @@ -5179,19 +5113,19 @@ 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 = [] - return self.api_client.call_api(resource_path, 'GET', + 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='file', + response_type='Recipients', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5199,61 +5133,53 @@ 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 delete_recipient_denied_document_copy(self, account_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. + Delete RecipientDeniedDocumentCopy 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_consumer_disclosure(account_id, envelope_id, lang_code, recipient_id, callback=callback_function) + >>> thread = api.delete_recipient_denied_document_copy(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 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: None 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.delete_recipient_denied_document_copy_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, **kwargs) + (data) = self.delete_recipient_denied_document_copy_with_http_info(account_id, envelope_id, **kwargs) return data - def get_consumer_disclosure_with_http_info(self, account_id, envelope_id, lang_code, recipient_id, **kwargs): + def delete_recipient_denied_document_copy_with_http_info(self, account_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. + Delete RecipientDeniedDocumentCopy 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_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, callback=callback_function) + >>> thread = api.delete_recipient_denied_document_copy_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 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: None 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', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5264,40 +5190,28 @@ 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 delete_recipient_denied_document_copy" % 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 `delete_recipient_denied_document_copy`") # 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 `delete_recipient_denied_document_copy`") 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}/display_appliance_info/recipient_denied_copy'.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 '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 = {} @@ -5312,14 +5226,14 @@ def get_consumer_disclosure_with_http_info(self, account_id, envelope_id, lang_c # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + 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='ConsumerDisclosure', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5327,59 +5241,57 @@ 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 delete_recipients(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. + 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.get_consumer_disclosure_default(account_id, envelope_id, recipient_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) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str lang_code: - :return: ConsumerDisclosure + :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.get_consumer_disclosure_default_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.delete_recipients_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.delete_recipients_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 delete_recipients_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. + 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.get_consumer_disclosure_default_with_http_info(account_id, envelope_id, recipient_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) - :param str recipient_id: The ID of the recipient being accessed. (required) - :param str lang_code: - :return: ConsumerDisclosure + :param Recipients recipients: + :return: Recipients 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', 'recipients'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5390,35 +5302,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 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 `get_consumer_disclosure_default`") + 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 `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 `delete_recipients`") 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}/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'] - 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 = {} @@ -5426,6 +5331,8 @@ def get_consumer_disclosure_default_with_http_info(self, account_id, envelope_id 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']) @@ -5433,14 +5340,14 @@ def get_consumer_disclosure_default_with_http_info(self, account_id, envelope_id # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + 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='ConsumerDisclosure', + response_type='Recipients', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5448,75 +5355,53 @@ 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_document(self, account_id, document_id, envelope_id, **kwargs): + def delete_signer_attachment(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 + Delete 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_document(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.delete_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 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: None 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.delete_signer_attachment_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.delete_signer_attachment_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 delete_signer_attachment_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 + Delete 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_document_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.delete_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 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: None 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') @@ -5527,51 +5412,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 delete_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_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 `delete_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_document`") + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_signer_attachment`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}'.replace('{format}', 'json') + 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 '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 = {} @@ -5581,19 +5443,19 @@ 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 = [] - return self.api_client.call_api(resource_path, 'GET', + 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='file', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5601,67 +5463,59 @@ 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 delete_tabs(self, account_id, envelope_id, recipient_id, **kwargs): """ - Gets a page image from an envelope for display. - Retrieves a page image for display from the specified envelope. + 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.get_document_page_image(account_id, document_id, envelope_id, page_number, 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 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 + :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.get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + return self.delete_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) else: - (data) = self.get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + (data) = self.delete_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) return data - def get_document_page_image_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): + def delete_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): """ - Gets a page image from an envelope for display. - Retrieves a page image for display from the specified envelope. + 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.get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, 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 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 + :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', 'document_id', 'envelope_id', 'page_number', 'dpi', 'max_height', 'max_width', 'show_changes'] + 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') @@ -5672,46 +5526,33 @@ 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 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 `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 `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 `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 `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}/documents/{documentId}/pages/{pageNumber}/page_image'.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 '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'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] 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 = {} @@ -5719,21 +5560,23 @@ def get_document_page_image_with_http_info(self, account_id, document_id, envelo 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(['image/png']) + select_header_accept(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + 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='file', + response_type='Tabs', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5741,57 +5584,53 @@ 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_tabs(self, account_id, document_id, envelope_id, **kwargs): + def delete_template_workflow_definition(self, account_id, template_id, **kwargs): """ - Returns tabs on the document. + 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.get_document_tabs(account_id, document_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 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_numbers: - :return: Tabs + :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.get_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.delete_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) else: - (data) = self.get_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.delete_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) return data - def get_document_tabs_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def delete_template_workflow_definition_with_http_info(self, account_id, template_id, **kwargs): """ - Returns tabs on the document. + 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.get_document_tabs_with_http_info(account_id, document_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 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_numbers: - :return: Tabs + :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', 'document_id', 'envelope_id', 'page_numbers'] + all_params = ['account_id', 'template_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5802,35 +5641,28 @@ 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 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 `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_document_tabs`") + 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}/documents/{documentId}/tabs'.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 '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'] query_params = {} - if 'page_numbers' in params: - query_params['page_numbers'] = params['page_numbers'] header_params = {} @@ -5845,14 +5677,14 @@ def get_document_tabs_with_http_info(self, account_id, document_id, envelope_id, # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + 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='Tabs', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5860,55 +5692,59 @@ 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_email_settings(self, account_id, envelope_id, **kwargs): + def delete_templates_from_document(self, account_id, document_id, envelope_id, template_id, **kwargs): """ - 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 + 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.get_email_settings(account_id, envelope_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) - :return: EmailSettings + :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.get_email_settings_with_http_info(account_id, envelope_id, **kwargs) + return self.delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id, **kwargs) else: - (data) = self.get_email_settings_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id, **kwargs) return data - def get_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): + def delete_templates_from_document_with_http_info(self, account_id, document_id, envelope_id, template_id, **kwargs): """ - Gets the email setting overrides for an envelope. - Retrieves the email override settings for the specified envelope. + 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.get_email_settings_with_http_info(account_id, envelope_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) - :return: EmailSettings + :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', 'document_id', 'envelope_id', 'template_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5919,26 +5755,36 @@ 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 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 `get_email_settings`") + 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 `get_email_settings`") + 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}/email_settings'.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 'template_id' in params: + path_params['templateId'] = params['template_id'] query_params = {} @@ -5955,14 +5801,14 @@ def get_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + 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='EmailSettings', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5970,59 +5816,53 @@ 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_account(self, account_id, envelope_id, **kwargs): """ - Gets the status of a envelope. - Retrieves the overall status for the specified envelope. + Returns envelope account 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_envelope(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_account(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 true, envelope information can be added or modified. - :param str include: - :return: Envelope + :return: DisplayApplianceAccount 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_account_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_envelope_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_account_with_http_info(account_id, envelope_id, **kwargs) return data - def get_envelope_with_http_info(self, account_id, envelope_id, **kwargs): + def get_account_with_http_info(self, account_id, envelope_id, **kwargs): """ - Gets the status of a envelope. - Retrieves the overall status for the specified envelope. + Returns envelope account 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_envelope_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_account_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 advanced_update: When true, envelope information can be added or modified. - :param str include: - :return: Envelope + :return: DisplayApplianceAccount 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'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6033,21 +5873,21 @@ 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_account" % 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_account`") # 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_account`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/account_info'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -6055,10 +5895,6 @@ def get_envelope_with_http_info(self, account_id, envelope_id, **kwargs): path_params['envelopeId'] = params['envelope_id'] query_params = {} - if 'advanced_update' in params: - query_params['advanced_update'] = params['advanced_update'] - if 'include' in params: - query_params['include'] = params['include'] header_params = {} @@ -6080,7 +5916,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='DisplayApplianceAccount', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6088,55 +5924,53 @@ 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_appliance_info(self, account_id, envelope_id, **kwargs): """ - Get the Original HTML Definition used to generate the Responsive HTML for a given document. + Returns envelope and recipient 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_envelope_document_html_definitions(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.get_appliance_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: DocumentHtmlDefinitionOriginals + :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_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.get_appliance_info_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.get_appliance_info_with_http_info(account_id, envelope_id, **kwargs) return data - def get_envelope_document_html_definitions_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def get_appliance_info_with_http_info(self, account_id, envelope_id, **kwargs): """ - Get the Original HTML Definition used to generate the Responsive HTML for a given document. + Returns envelope and recipient 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_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, callback=callback_function) + >>> thread = api.get_appliance_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 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 + :return: DisplayApplianceInfo If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6147,29 +5981,24 @@ 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_appliance_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_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_appliance_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 `get_envelope_document_html_definitions`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_appliance_info`") 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}/display_appliance_info'.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'] @@ -6195,7 +6024,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='DisplayApplianceInfo', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6203,53 +6032,55 @@ 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_attachment(self, account_id, attachment_id, envelope_id, **kwargs): """ - Get the Original HTML Definition used to generate the Responsive HTML for the envelope. + 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.get_envelope_html_definitions(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) - :return: DocumentHtmlDefinitionOriginals + :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_html_definitions_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.get_envelope_html_definitions_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 get_envelope_html_definitions_with_http_info(self, account_id, envelope_id, **kwargs): + def get_attachment_with_http_info(self, account_id, attachment_id, envelope_id, **kwargs): """ - Get the Original HTML Definition used to generate the Responsive HTML for the envelope. + 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.get_envelope_html_definitions_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) - :return: DocumentHtmlDefinitionOriginals + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'attachment_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6260,24 +6091,29 @@ 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_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_envelope_html_definitions`") + 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 `get_envelope_html_definitions`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_attachment`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions'.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'] @@ -6303,7 +6139,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=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6311,55 +6147,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_attachments(self, account_id, envelope_id, **kwargs): """ - Returns a list of envelope transfer rules in the specified account. + 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.get_envelope_transfer_rules(account_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 count: - :param str start_position: - :return: EnvelopeTransferRuleInformation + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :return: EnvelopeAttachmentsResult 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_attachments_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_envelope_transfer_rules_with_http_info(account_id, **kwargs) + (data) = self.get_attachments_with_http_info(account_id, envelope_id, **kwargs) return data - def get_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): + def get_attachments_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns a list of envelope transfer rules in the specified account. + 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.get_envelope_transfer_rules_with_http_info(account_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 count: - :param str start_position: - :return: EnvelopeTransferRuleInformation + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :return: EnvelopeAttachmentsResult 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') @@ -6370,27 +6204,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_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 `get_envelope_transfer_rules`") + 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 `get_attachments`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/transfer_rules'.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'] + 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 = {} @@ -6412,7 +6247,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='EnvelopeAttachmentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6420,53 +6255,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_chunked_upload(self, account_id, chunked_upload_id, **kwargs): """ - Returns the workflow definition for an 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.get_envelope_workflow_definition(account_id, envelope_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) - :return: Workflow + :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.get_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + return self.get_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) else: - (data) = self.get_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) return data - def get_envelope_workflow_definition_with_http_info(self, account_id, envelope_id, **kwargs): + def get_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwargs): """ - Returns the workflow definition for an 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.get_envelope_workflow_definition_with_http_info(account_id, envelope_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) - :return: Workflow + :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'] + all_params = ['account_id', 'chunked_upload_id', 'include'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6477,28 +6314,30 @@ 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_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 `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_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}/workflow'.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 '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 = {} @@ -6520,7 +6359,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='ChunkedUploadResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6528,53 +6367,55 @@ 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_comments_transcript(self, account_id, envelope_id, **kwargs): """ - Returns envelope form data for an existing envelope. + 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.get_form_data(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EnvelopeFormData + :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.get_form_data_with_http_info(account_id, envelope_id, **kwargs) + return self.get_comments_transcript_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_form_data_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_comments_transcript_with_http_info(account_id, envelope_id, **kwargs) return data - def get_form_data_with_http_info(self, account_id, envelope_id, **kwargs): + def get_comments_transcript_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns envelope form data for an existing envelope. + 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.get_form_data_with_http_info(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: EnvelopeFormData + :param str encoding: + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'encoding'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6585,21 +6426,21 @@ 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_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 `get_form_data`") + 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_form_data`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_comments_transcript`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data'.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'] @@ -6607,6 +6448,8 @@ def get_form_data_with_http_info(self, account_id, envelope_id, **kwargs): path_params['envelopeId'] = params['envelope_id'] query_params = {} + if 'encoding' in params: + query_params['encoding'] = params['encoding'] header_params = {} @@ -6616,7 +6459,7 @@ def get_form_data_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 = [] @@ -6628,7 +6471,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='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6636,55 +6479,61 @@ 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_lock(self, account_id, envelope_id, **kwargs): + def get_consumer_disclosure(self, account_id, envelope_id, lang_code, recipient_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. + 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.get_lock(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: LockInformation + :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.get_lock_with_http_info(account_id, envelope_id, **kwargs) + return self.get_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, **kwargs) else: - (data) = self.get_lock_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, **kwargs) return data - def get_lock_with_http_info(self, account_id, envelope_id, **kwargs): + def get_consumer_disclosure_with_http_info(self, account_id, envelope_id, lang_code, recipient_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. + 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.get_lock_with_http_info(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: LockInformation + :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', 'envelope_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') @@ -6695,28 +6544,40 @@ 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 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 `get_lock`") + 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 `get_lock`") + 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}/lock'.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 '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 = {} @@ -6738,7 +6599,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='ConsumerDisclosure', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6746,55 +6607,59 @@ 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 get_consumer_disclosure_default(self, account_id, envelope_id, recipient_id, **kwargs): """ - Gets envelope notification information. - Retrieves the envelope notification, reminders and expirations, information for an existing envelope. + 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_notification_settings(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: Notification + :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_notification_settings_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_notification_settings_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_notification_settings_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): """ - Gets envelope notification information. - Retrieves the envelope notification, reminders and expirations, information for an existing envelope. + 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_notification_settings_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: Notification + :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') @@ -6805,28 +6670,35 @@ 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 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_notification_settings`") + 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_notification_settings`") + 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}/notification'.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 = {} @@ -6848,7 +6720,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='ConsumerDisclosure', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6856,57 +6728,53 @@ 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 get_custom_fields(self, account_id, envelope_id, **kwargs): """ - Returns tabs on the specified page. + Return custom fields 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_page_tabs(account_id, document_id, envelope_id, page_number, callback=callback_function) + >>> thread = api.get_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 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 + :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_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + return self.get_custom_fields_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.get_custom_fields_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 get_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns tabs on the specified page. + Return custom fields 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_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number, callback=callback_function) + >>> thread = api.get_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 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 + :return: DisplayApplianceInfo 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') @@ -6917,36 +6785,26 @@ 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 get_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_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 `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_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 `get_custom_fields`") 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}/display_appliance_info/custom_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'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = {} @@ -6970,7 +6828,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='DisplayApplianceInfo', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6978,69 +6836,53 @@ 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 get_date_signed(self, account_id, envelope_id, **kwargs): """ - Returns document page image(s) based on input. + 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_pages(account_id, document_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 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 + :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_pages_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.get_date_signed_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_pages_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.get_date_signed_with_http_info(account_id, envelope_id, **kwargs) return data - def get_pages_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def get_date_signed_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns document page image(s) based on input. + 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_pages_with_http_info(account_id, document_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 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 + :return: DisplayApplianceInfo 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', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7051,47 +6893,28 @@ 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 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_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`") + 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_pages`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_date_signed`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages'.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'] - 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 = {} @@ -7113,7 +6936,7 @@ def get_pages_with_http_info(self, account_id, document_id, envelope_id, **kwarg body=body_params, post_params=form_params, files=local_var_files, - response_type='PageImages', + response_type='DisplayApplianceInfo', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7121,55 +6944,75 @@ 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_recipient_document_visibility(self, account_id, envelope_id, recipient_id, **kwargs): + def get_document(self, account_id, document_id, envelope_id, **kwargs): """ - Returns document visibility for the recipients + 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_recipient_document_visibility(account_id, envelope_id, recipient_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) - :param str recipient_id: The ID of the recipient being accessed. (required) - :return: DocumentVisibilityList + :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_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.get_document_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.get_document_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def get_recipient_document_visibility_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def get_document_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Returns document visibility for the recipients + 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_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_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) - :param str recipient_id: The ID of the recipient being accessed. (required) - :return: DocumentVisibilityList + :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', 'recipient_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') @@ -7180,33 +7023,51 @@ 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 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_recipient_document_visibility`") + 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_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 `get_document`") 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}/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'] - if 'recipient_id' in params: - path_params['recipientId'] = params['recipient_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 = {} @@ -7216,7 +7077,7 @@ def get_recipient_document_visibility_with_http_info(self, account_id, envelope_ 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 = [] @@ -7228,7 +7089,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='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7236,59 +7097,67 @@ 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 get_document_page_image(self, account_id, document_id, envelope_id, page_number, **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 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_recipient_initials_image(account_id, envelope_id, recipient_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 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. + :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_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) else: - (data) = self.get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) return data - def get_recipient_initials_image_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def get_document_page_image_with_http_info(self, account_id, document_id, envelope_id, page_number, **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 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_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_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 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. + :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', 'envelope_id', 'recipient_id', 'include_chrome'] + 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') @@ -7299,35 +7168,46 @@ def get_recipient_initials_image_with_http_info(self, account_id, envelope_id, r if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_recipient_initials_image" % 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_recipient_initials_image`") + 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_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`") + 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}/recipients/{recipientId}/initials_image'.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 '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 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = {} - if 'include_chrome' in params: - query_params['include_chrome'] = params['include_chrome'] + 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 = {} @@ -7337,7 +7217,7 @@ def get_recipient_initials_image_with_http_info(self, account_id, envelope_id, r body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['image/gif']) + select_header_accept(['image/png']) # Authentication setting auth_settings = [] @@ -7357,57 +7237,53 @@ def get_recipient_initials_image_with_http_info(self, account_id, envelope_id, r _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_recipient_signature(self, account_id, envelope_id, recipient_id, **kwargs): + def get_document_pages(self, account_id, envelope_id, **kwargs): """ - Gets signature information for a signer or sign-in-person recipient. - Retrieves signature information for a signer or sign-in-person recipient. + Return document pages 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_recipient_signature(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.get_document_pages(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: UserSignature + :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_recipient_signature_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.get_document_pages_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_recipient_signature_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.get_document_pages_with_http_info(account_id, envelope_id, **kwargs) return data - def get_recipient_signature_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def get_document_pages_with_http_info(self, account_id, envelope_id, **kwargs): """ - Gets signature information for a signer or sign-in-person recipient. - Retrieves signature information for a signer or sign-in-person recipient. + Return document pages 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_recipient_signature_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function) + >>> thread = api.get_document_pages_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: UserSignature + :return: DisplayApplianceInfo If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'recipient_id'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7418,31 +7294,26 @@ def get_recipient_signature_with_http_info(self, account_id, envelope_id, recipi if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_recipient_signature" % key + " to method get_document_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_recipient_signature`") + raise ValueError("Missing the required parameter `account_id` when calling `get_document_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_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`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_document_pages`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document_page_list'.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 = {} @@ -7466,7 +7337,7 @@ def get_recipient_signature_with_http_info(self, account_id, envelope_id, recipi body=body_params, post_params=form_params, files=local_var_files, - response_type='UserSignature', + response_type='DisplayApplianceInfo', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7474,59 +7345,59 @@ def get_recipient_signature_with_http_info(self, account_id, envelope_id, recipi _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_recipient_signature_image(self, account_id, envelope_id, recipient_id, **kwargs): + def get_document_tabs(self, account_id, document_id, envelope_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. + 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_recipient_signature_image(account_id, envelope_id, recipient_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) - :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 + :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_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.get_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.get_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.get_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def get_recipient_signature_image_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def get_document_tabs_with_http_info(self, account_id, document_id, envelope_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. + 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_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_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) - :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 + :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', 'recipient_id', 'include_chrome'] + 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') @@ -7537,35 +7408,37 @@ def get_recipient_signature_image_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_recipient_signature_image" % 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_recipient_signature_image`") + 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_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`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_document_tabs`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image'.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'] - 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'] + 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 = {} @@ -7575,7 +7448,7 @@ def get_recipient_signature_image_with_http_info(self, account_id, envelope_id, body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['image/gif']) + select_header_accept(['application/json']) # Authentication setting auth_settings = [] @@ -7587,7 +7460,7 @@ def get_recipient_signature_image_with_http_info(self, account_id, envelope_id, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='Tabs', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7595,53 +7468,51 @@ def get_recipient_signature_image_with_http_info(self, account_id, envelope_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_tabs_blob(self, account_id, envelope_id, **kwargs): + def get_dynamic_system_settings(self, account_id, **kwargs): """ - Get encrypted tabs for envelope. + Return document pages 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_tabs_blob(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_dynamic_system_settings(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 + :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_tabs_blob_with_http_info(account_id, envelope_id, **kwargs) + return self.get_dynamic_system_settings_with_http_info(account_id, **kwargs) else: - (data) = self.get_tabs_blob_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_dynamic_system_settings_with_http_info(account_id, **kwargs) return data - def get_tabs_blob_with_http_info(self, account_id, envelope_id, **kwargs): + def get_dynamic_system_settings_with_http_info(self, account_id, **kwargs): """ - Get encrypted tabs for envelope. + Return document pages 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_tabs_blob_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_dynamic_system_settings_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 + :return: DisplayApplianceInfo If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7652,26 +7523,21 @@ def get_tabs_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_tabs_blob" % key + " to method get_dynamic_system_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_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`") + raise ValueError("Missing the required parameter `account_id` when calling `get_dynamic_system_settings`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/display_appliance_info/dynamicsystemsettings'.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 = {} @@ -7695,7 +7561,7 @@ def get_tabs_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='DisplayApplianceInfo', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7703,55 +7569,55 @@ def get_tabs_blob_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_template_recipient_document_visibility(self, account_id, recipient_id, template_id, **kwargs): + def get_email_settings(self, account_id, envelope_id, **kwargs): """ - Returns document visibility for the recipients + 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_template_recipient_document_visibility(account_id, recipient_id, template_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 recipient_id: The ID of the recipient being accessed. (required) - :param str template_id: The ID of the template being accessed. (required) - :return: DocumentVisibilityList + :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_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, **kwargs) + return self.get_email_settings_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, **kwargs) + (data) = self.get_email_settings_with_http_info(account_id, envelope_id, **kwargs) return data - def get_template_recipient_document_visibility_with_http_info(self, account_id, recipient_id, template_id, **kwargs): + def get_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns document visibility for the recipients + 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_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_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 recipient_id: The ID of the recipient being accessed. (required) - :param str template_id: The ID of the template being accessed. (required) - :return: DocumentVisibilityList + :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', 'recipient_id', 'template_id'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7762,31 +7628,26 @@ def get_template_recipient_document_visibility_with_http_info(self, account_id, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_template_recipient_document_visibility" % 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_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`") + 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}/templates/{templateId}/recipients/{recipientId}/document_visibility'.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 'recipient_id' in params: - path_params['recipientId'] = params['recipient_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 = {} @@ -7810,7 +7671,7 @@ def get_template_recipient_document_visibility_with_http_info(self, account_id, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentVisibilityList', + response_type='EmailSettings', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7818,53 +7679,59 @@ def get_template_recipient_document_visibility_with_http_info(self, account_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_template_workflow_definition(self, account_id, template_id, **kwargs): + def get_envelope(self, account_id, envelope_id, **kwargs): """ - Returns the workflow definition for a template. + 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_template_workflow_definition(account_id, template_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 template_id: The ID of the template being accessed. (required) - :return: Workflow + :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 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) + return self.get_envelope_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.get_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) + (data) = self.get_envelope_with_http_info(account_id, envelope_id, **kwargs) return data - def get_template_workflow_definition_with_http_info(self, account_id, template_id, **kwargs): + def get_envelope_with_http_info(self, account_id, envelope_id, **kwargs): """ - Returns the workflow definition for a template. + 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_template_workflow_definition_with_http_info(account_id, template_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 template_id: The ID of the template being accessed. (required) - :return: Workflow + :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 If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'template_id'] + 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') @@ -7875,28 +7742,32 @@ def get_template_workflow_definition_with_http_info(self, account_id, template_i if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_template_workflow_definition" % 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_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`") + 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_envelope`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/workflow'.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 'template_id' in params: - path_params['templateId'] = params['template_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 'include' in params: + query_params['include'] = params['include'] header_params = {} @@ -7918,7 +7789,7 @@ def get_template_workflow_definition_with_http_info(self, account_id, template_i body=body_params, post_params=form_params, files=local_var_files, - response_type='Workflow', + response_type='Envelope', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7926,55 +7797,55 @@ def get_template_workflow_definition_with_http_info(self, account_id, template_i _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_audit_events(self, account_id, envelope_id, **kwargs): + def get_envelope_document_html_definitions(self, account_id, document_id, envelope_id, **kwargs): """ - Gets the envelope audit events for an envelope. - Gets the envelope audit events for the specified envelope. + 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.list_audit_events(account_id, envelope_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) - :return: EnvelopeAuditEventResponse + :return: DocumentHtmlDefinitionOriginals 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) + return self.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.list_audit_events_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def list_audit_events_with_http_info(self, account_id, envelope_id, **kwargs): + def get_envelope_document_html_definitions_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Gets the envelope audit events for an envelope. - Gets the envelope audit events for the specified envelope. + 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.list_audit_events_with_http_info(account_id, envelope_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) - :return: EnvelopeAuditEventResponse + :return: DocumentHtmlDefinitionOriginals 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') @@ -7985,24 +7856,29 @@ def list_audit_events_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 list_audit_events" % 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 `list_audit_events`") + 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 `list_audit_events`") + 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}/audit_events'.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'] @@ -8028,7 +7904,7 @@ def list_audit_events_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeAuditEventResponse', + response_type='DocumentHtmlDefinitionOriginals', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8036,50 +7912,48 @@ def list_audit_events_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_custom_fields(self, account_id, envelope_id, **kwargs): + def get_envelope_html_definitions(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. + 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.list_custom_fields(account_id, envelope_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) - :return: CustomFieldsEnvelope + :return: DocumentHtmlDefinitionOriginals 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) + return self.get_envelope_html_definitions_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.list_custom_fields_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_envelope_html_definitions_with_http_info(account_id, envelope_id, **kwargs) return data - def list_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): + def get_envelope_html_definitions_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. + 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.list_custom_fields_with_http_info(account_id, envelope_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) - :return: CustomFieldsEnvelope + :return: DocumentHtmlDefinitionOriginals If the method is called asynchronously, returns the request thread. """ @@ -8095,21 +7969,21 @@ def list_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 list_custom_fields" % 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 `list_custom_fields`") + 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 `list_custom_fields`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelope_html_definitions`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields'.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'] @@ -8138,7 +8012,7 @@ def list_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='CustomFieldsEnvelope', + response_type='DocumentHtmlDefinitionOriginals', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8146,57 +8020,55 @@ def list_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_document_fields(self, account_id, document_id, envelope_id, **kwargs): + def get_envelope_transfer_rules(self, account_id, **kwargs): """ - Gets the custom document fields from an existing envelope document. - Retrieves the custom document field information from an existing envelope document. + 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.list_document_fields(account_id, document_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 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 + :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.list_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.get_envelope_transfer_rules_with_http_info(account_id, **kwargs) else: - (data) = self.list_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.get_envelope_transfer_rules_with_http_info(account_id, **kwargs) return data - def list_document_fields_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def get_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): """ - Gets the custom document fields from an existing envelope document. - Retrieves the custom document field information from an existing envelope document. + 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.list_document_fields_with_http_info(account_id, document_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 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 + :param str count: + :param str start_position: + :return: EnvelopeTransferRuleInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_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') @@ -8207,33 +8079,27 @@ def list_document_fields_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 list_document_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 `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`") + raise ValueError("Missing the required parameter `account_id` when calling `get_envelope_transfer_rules`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/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 '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 'start_position' in params: + query_params['start_position'] = params['start_position'] header_params = {} @@ -8255,7 +8121,7 @@ def list_document_fields_with_http_info(self, account_id, document_id, envelope_ body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentFieldsInformation', + response_type='EnvelopeTransferRuleInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8263,67 +8129,53 @@ def list_document_fields_with_http_info(self, account_id, document_id, envelope_ _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_documents(self, account_id, envelope_id, **kwargs): + def get_envelope_workflow_definition(self, account_id, envelope_id, **kwargs): """ - Gets a list of envelope documents. - Retrieves a list of documents associated with the specified envelope. + 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.list_documents(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) - :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 + :return: Workflow 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) + return self.get_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.list_documents_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 list_documents_with_http_info(self, account_id, envelope_id, **kwargs): + def get_envelope_workflow_definition_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. + 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.list_documents_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) - :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 + :return: Workflow 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 = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8334,21 +8186,21 @@ def list_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 list_documents" % 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 `list_documents`") + 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 `list_documents`") + raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelope_workflow_definition`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents'.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'] @@ -8356,18 +8208,6 @@ def list_documents_with_http_info(self, account_id, envelope_id, **kwargs): 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 = {} @@ -8389,7 +8229,7 @@ def list_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='Workflow', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8397,63 +8237,3333 @@ def list_documents_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_recipients(self, account_id, envelope_id, **kwargs): + def get_form_data(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. + 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.list_recipients(account_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 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: + :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_form_data_with_http_info(account_id, envelope_id, **kwargs) + else: + (data) = self.get_form_data_with_http_info(account_id, envelope_id, **kwargs) + return data + + def get_form_data_with_http_info(self, account_id, envelope_id, **kwargs): + """ + 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_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :return: EnvelopeFormData + 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_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_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`") + + + collection_formats = {} + + 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 '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='EnvelopeFormData', + 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_image(self, account_id, envelope_id, **kwargs): + """ + Returns images 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_image(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 + 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) + else: + (data) = self.get_image_with_http_info(account_id, envelope_id, **kwargs) + return data + + def get_image_with_http_info(self, account_id, envelope_id, **kwargs): + """ + Returns images 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_image_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 + 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_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_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_image`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/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'] + + 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_locale_policy(self, account_id, envelope_id, user_id, **kwargs): + """ + Returns locale policy 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_locale_policy(account_id, envelope_id, user_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 + 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) + else: + (data) = self.get_locale_policy_with_http_info(account_id, envelope_id, user_id, **kwargs) + return data + + def get_locale_policy_with_http_info(self, account_id, envelope_id, user_id, **kwargs): + """ + Returns locale policy 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_locale_policy_with_http_info(account_id, envelope_id, user_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 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'envelope_id', '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_locale_policy" % 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`") + # 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`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/localepolicy/{userId}'.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 = {} + + 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_lock(self, account_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. + 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) + + :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 + 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) + else: + (data) = self.get_lock_with_http_info(account_id, envelope_id, **kwargs) + return data + + def get_lock_with_http_info(self, account_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. + 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) + + :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 + 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_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_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_lock`") + + + collection_formats = {} + + 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 '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='LockInformation', + 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_notification_settings(self, account_id, envelope_id, **kwargs): + """ + 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_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: Notification + 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) + else: + (data) = self.get_notification_settings_with_http_info(account_id, envelope_id, **kwargs) + return data + + def get_notification_settings_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. + 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) + + :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 + 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_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_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_notification_settings`") + + + collection_formats = {} + + 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'] + 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='Notification', + 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_page_tabs(self, account_id, document_id, envelope_id, page_number, **kwargs): + """ + 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_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 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_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + else: + (data) = self.get_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + return data + + def get_page_tabs_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): + """ + 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_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 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', 'page_number'] + 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_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_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`") + # 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`") + + + collection_formats = {} + + 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'] + 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 + # 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 get_pages(self, account_id, document_id, envelope_id, **kwargs): + """ + 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_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) + :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_pages_with_http_info(account_id, document_id, envelope_id, **kwargs) + else: + (data) = self.get_pages_with_http_info(account_id, document_id, envelope_id, **kwargs) + return data + + def get_pages_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + """ + 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_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) + :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', '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') + 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_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_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}/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 = {} + + 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='PageImages', + 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_pdf(self, account_id, envelope_id, pdf_id, **kwargs): + """ + Return pdf 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_pdf(account_id, envelope_id, pdf_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 + 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) + else: + (data) = self.get_pdf_with_http_info(account_id, envelope_id, pdf_id, **kwargs) + return data + + def get_pdf_with_http_info(self, account_id, envelope_id, pdf_id, **kwargs): + """ + Return pdf 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_pdf_with_http_info(account_id, envelope_id, pdf_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 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'envelope_id', 'pdf_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_pdf" % 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`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf/{pdfId}'.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 = {} + + 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='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 get_pdf_blob(self, account_id, envelope_id, **kwargs): + """ + Return 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.get_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.get_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) + else: + (data) = self.get_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) + return data + + def get_pdf_blob_with_http_info(self, account_id, envelope_id, **kwargs): + """ + Return 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.get_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 get_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 `get_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 `get_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, 'GET', + 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 get_recipient_document_visibility(self, account_id, envelope_id, recipient_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_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) + :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_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + else: + (data) = self.get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return data + + def get_recipient_document_visibility_with_http_info(self, account_id, envelope_id, recipient_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_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) + :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', '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_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_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_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}/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 = {} + + 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_recipient_initials_image(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(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. + """ + 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) + else: + (data) = self.get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_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, template_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, 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: 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, template_id, **kwargs) + else: + (data) = self.get_template_info_with_http_info(account_id, template_id, **kwargs) + return data + + def get_template_info_with_http_info(self, account_id, template_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, 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: DisplayApplianceInfo + 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_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`") + # 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_info`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/envelopes/{templateId}/display_appliance_info/templateInfo'.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='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_recipients_with_http_info(account_id, envelope_id, **kwargs) + return self.list_templates_for_document_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.list_recipients_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.list_templates_for_document_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def list_recipients_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): """ - 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. + 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_recipients_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 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 + :param str include: + :return: TemplateInformation 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 = ['account_id', 'document_id', 'envelope_id', 'include'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8464,36 +11574,35 @@ def list_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 list_recipients" % 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 `list_recipients`") + 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_recipients`") + raise ValueError("Missing the required parameter `envelope_id` when calling `list_templates_for_document`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients'.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 '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'] + if 'include' in params: + query_params['include'] = params['include'] header_params = {} @@ -8515,7 +11624,7 @@ def list_recipients_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='Recipients', + response_type='TemplateInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8523,79 +11632,57 @@ def list_recipients_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_status(self, account_id, **kwargs): + def put_attachment(self, account_id, attachment_id, envelope_id, **kwargs): """ - Gets the envelope status for the specified envelopes. - Retrieves the envelope status for the specified envelopes. + 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.list_status(account_id, 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 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 + :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.list_status_with_http_info(account_id, **kwargs) + return self.put_attachment_with_http_info(account_id, attachment_id, envelope_id, **kwargs) else: - (data) = self.list_status_with_http_info(account_id, **kwargs) + (data) = self.put_attachment_with_http_info(account_id, attachment_id, envelope_id, **kwargs) return data - def list_status_with_http_info(self, account_id, **kwargs): + def put_attachment_with_http_info(self, account_id, attachment_id, envelope_id, **kwargs): """ - Gets the envelope status for the specified envelopes. - Retrieves the envelope status for the specified envelopes. + 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.list_status_with_http_info(account_id, 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 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 + :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', '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 = ['account_id', 'attachment_id', 'envelope_id', 'attachment'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8606,47 +11693,33 @@ def list_status_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_status" % 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 `list_status`") + 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/status'.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'] 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 = {} @@ -8654,8 +11727,8 @@ def list_status_with_http_info(self, account_id, **kwargs): local_var_files = {} body_params = None - if 'envelope_ids_request' in params: - body_params = params['envelope_ids_request'] + if 'attachment' in params: + body_params = params['attachment'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -8670,7 +11743,7 @@ def list_status_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopesInformation', + response_type='EnvelopeAttachmentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8678,113 +11751,55 @@ def list_status_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_status_changes(self, account_id, **kwargs): + def put_attachments(self, account_id, envelope_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. + 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.list_status_changes(account_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 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 + :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.list_status_changes_with_http_info(account_id, **kwargs) + return self.put_attachments_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.list_status_changes_with_http_info(account_id, **kwargs) + (data) = self.put_attachments_with_http_info(account_id, envelope_id, **kwargs) return data - def list_status_changes_with_http_info(self, account_id, **kwargs): + def put_attachments_with_http_info(self, account_id, envelope_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. + 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.list_status_changes_with_http_info(account_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 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 + :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', '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 = ['account_id', 'envelope_id', 'envelope_attachments_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8795,83 +11810,28 @@ def list_status_changes_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_status_changes" % 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 `list_status_changes`") + 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'.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'] + 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 '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 = {} @@ -8879,6 +11839,8 @@ def list_status_changes_with_http_info(self, account_id, **kwargs): 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']) @@ -8886,14 +11848,14 @@ def list_status_changes_with_http_info(self, account_id, **kwargs): # 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='EnvelopesInformation', + response_type='EnvelopeAttachmentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8901,61 +11863,61 @@ def list_status_changes_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_tabs(self, account_id, envelope_id, recipient_id, **kwargs): + def rotate_document_page(self, account_id, document_id, envelope_id, page_number, **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. + 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.list_tabs(account_id, envelope_id, recipient_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 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 + :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.list_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + return self.rotate_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) else: - (data) = self.list_tabs_with_http_info(account_id, envelope_id, recipient_id, **kwargs) + (data) = self.rotate_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) return data - def list_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs): + def rotate_document_page_with_http_info(self, account_id, document_id, envelope_id, page_number, **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. + 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.list_tabs_with_http_info(account_id, envelope_id, recipient_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 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 + :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', 'envelope_id', 'recipient_id', 'include_anchor_tab_locations', 'include_metadata'] + 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') @@ -8966,37 +11928,38 @@ def list_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwar if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_tabs" % 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 `list_tabs`") + 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 `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`") + 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}/recipients/{recipientId}/tabs'.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 '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 '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_metadata' in params: - query_params['include_metadata'] = params['include_metadata'] header_params = {} @@ -9004,6 +11967,8 @@ def list_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwar 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']) @@ -9011,14 +11976,14 @@ def list_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwar # 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='Tabs', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9026,57 +11991,61 @@ def list_tabs_with_http_info(self, account_id, envelope_id, recipient_id, **kwar _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_templates(self, account_id, envelope_id, **kwargs): + def update(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. + 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.list_templates(account_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 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 + :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.list_templates_with_http_info(account_id, envelope_id, **kwargs) + return self.update_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.list_templates_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_with_http_info(account_id, envelope_id, **kwargs) return data - def list_templates_with_http_info(self, account_id, envelope_id, **kwargs): + def update_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. + 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.list_templates_with_http_info(account_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 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 + :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', 'envelope_id', 'include'] + 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') @@ -9087,21 +12056,21 @@ def list_templates_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 list_templates" % 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 `list_templates`") + 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 `list_templates`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates'.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'] @@ -9109,8 +12078,10 @@ def list_templates_with_http_info(self, account_id, envelope_id, **kwargs): path_params['envelopeId'] = params['envelope_id'] query_params = {} - if 'include' in params: - query_params['include'] = params['include'] + 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 = {} @@ -9118,6 +12089,8 @@ def list_templates_with_http_info(self, account_id, envelope_id, **kwargs): 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']) @@ -9125,14 +12098,14 @@ def list_templates_with_http_info(self, account_id, envelope_id, **kwargs): # 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='TemplateInformation', + response_type='EnvelopeUpdateSummary', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9140,59 +12113,55 @@ def list_templates_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_templates_for_document(self, account_id, document_id, envelope_id, **kwargs): + def update_chunked_upload(self, account_id, chunked_upload_id, **kwargs): """ - Gets the templates associated with a document in an existing envelope. - Retrieves the templates associated with a document in the specified envelope. + 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.list_templates_for_document(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 str include: - :return: TemplateInformation + :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.list_templates_for_document_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.list_templates_for_document_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 list_templates_for_document_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): """ - Gets the templates associated with a document in an existing envelope. - Retrieves the templates associated with a document in the specified envelope. + 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.list_templates_for_document_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 str include: - :return: TemplateInformation + :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', 'include'] + all_params = ['account_id', 'chunked_upload_id', 'action'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9203,35 +12172,30 @@ def list_templates_for_document_with_http_info(self, account_id, document_id, en if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_templates_for_document" % 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 `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`") + 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}/templates'.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 'include' in params: - query_params['include'] = params['include'] + if 'action' in params: + query_params['action'] = params['action'] header_params = {} @@ -9246,14 +12210,14 @@ def list_templates_for_document_with_http_info(self, account_id, document_id, en # 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='TemplateInformation', + response_type='ChunkedUploadResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9261,57 +12225,57 @@ def list_templates_for_document_with_http_info(self, account_id, document_id, en _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_attachment(self, account_id, attachment_id, envelope_id, **kwargs): + def update_chunked_upload_part(self, account_id, chunked_upload_id, chunked_upload_part_seq, **kwargs): """ - Add an attachment to a DRAFT or IN-PROCESS envelope. + 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.put_attachment(account_id, attachment_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 attachment_id: (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Attachment attachment: - :return: EnvelopeAttachmentsResult + :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.put_attachment_with_http_info(account_id, attachment_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.put_attachment_with_http_info(account_id, attachment_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 put_attachment_with_http_info(self, account_id, attachment_id, envelope_id, **kwargs): + def update_chunked_upload_part_with_http_info(self, account_id, chunked_upload_id, chunked_upload_part_seq, **kwargs): """ - Add an attachment to a DRAFT or IN-PROCESS envelope. + 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.put_attachment_with_http_info(account_id, attachment_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 attachment_id: (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param Attachment attachment: - :return: EnvelopeAttachmentsResult + :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', 'attachment_id', 'envelope_id', 'attachment'] + 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') @@ -9322,31 +12286,31 @@ def put_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 put_attachment" % 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 `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`") + 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}/attachments/{attachmentId}'.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 'attachment_id' in params: - path_params['attachmentId'] = params['attachment_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 = {} @@ -9356,8 +12320,8 @@ def put_attachment_with_http_info(self, account_id, attachment_id, envelope_id, local_var_files = {} body_params = None - if 'attachment' in params: - body_params = params['attachment'] + 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']) @@ -9372,7 +12336,7 @@ def put_attachment_with_http_info(self, account_id, attachment_id, envelope_id, body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeAttachmentsResult', + response_type='ChunkedUploadResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9380,55 +12344,57 @@ def put_attachment_with_http_info(self, account_id, attachment_id, envelope_id, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_attachments(self, account_id, envelope_id, **kwargs): + def update_custom_fields(self, account_id, envelope_id, **kwargs): """ - Add one or more attachments to a DRAFT or IN-PROCESS envelope. + 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.put_attachments(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 EnvelopeAttachmentsRequest envelope_attachments_request: - :return: EnvelopeAttachmentsResult + :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.put_attachments_with_http_info(account_id, envelope_id, **kwargs) + return self.update_custom_fields_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.put_attachments_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_custom_fields_with_http_info(account_id, envelope_id, **kwargs) return data - def put_attachments_with_http_info(self, account_id, envelope_id, **kwargs): + def update_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): """ - Add one or more attachments to a DRAFT or IN-PROCESS envelope. + 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.put_attachments_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 EnvelopeAttachmentsRequest envelope_attachments_request: - :return: EnvelopeAttachmentsResult + :param CustomFields custom_fields: + :return: CustomFields If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'envelope_attachments_request'] + all_params = ['account_id', 'envelope_id', 'custom_fields'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9439,21 +12405,21 @@ def put_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 put_attachments" % 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 `put_attachments`") + 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 `put_attachments`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_custom_fields`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments'.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'] @@ -9468,8 +12434,8 @@ def put_attachments_with_http_info(self, account_id, envelope_id, **kwargs): local_var_files = {} body_params = None - if 'envelope_attachments_request' in params: - body_params = params['envelope_attachments_request'] + if 'custom_fields' in params: + body_params = params['custom_fields'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -9484,7 +12450,7 @@ def put_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='CustomFields', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9492,61 +12458,55 @@ def put_attachments_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def rotate_document_page(self, account_id, document_id, envelope_id, page_number, **kwargs): + def update_document(self, account_id, document_id, envelope_id, **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. + Update document 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.rotate_document_page(account_id, document_id, envelope_id, page_number, 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 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) + return self.update_document_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.rotate_document_page_with_http_info(account_id, document_id, envelope_id, page_number, **kwargs) + (data) = self.update_document_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def rotate_document_page_with_http_info(self, account_id, document_id, envelope_id, page_number, **kwargs): + def update_document_with_http_info(self, account_id, document_id, envelope_id, **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. + Update document 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.rotate_document_page_with_http_info(account_id, document_id, envelope_id, page_number, 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 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 = ['account_id', 'document_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9557,27 +12517,24 @@ def rotate_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 rotate_document_page" % 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 `rotate_document_page`") + 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 `rotate_document_page`") + 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 `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`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_document`") 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}/display_appliance_info/document/{documentId}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -9585,8 +12542,6 @@ def rotate_document_page_with_http_info(self, account_id, document_id, envelope_ 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 = {} @@ -9596,8 +12551,6 @@ def rotate_document_page_with_http_info(self, account_id, document_id, envelope_ 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']) @@ -9620,61 +12573,57 @@ def rotate_document_page_with_http_info(self, account_id, document_id, envelope_ _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update(self, account_id, envelope_id, **kwargs): + def update_document_0(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. + 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(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_document_0(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 + :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_with_http_info(account_id, envelope_id, **kwargs) + return self.update_document_0_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.update_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_document_0_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def update_with_http_info(self, account_id, envelope_id, **kwargs): + def update_document_0_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. + 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_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_document_0_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 + :return: EnvelopeDocument 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'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9685,32 +12634,33 @@ 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 update_document_0" % 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 `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`") # 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 `update_document_0`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}'.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 '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 = {} @@ -9718,8 +12668,6 @@ def update_with_http_info(self, account_id, envelope_id, **kwargs): 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']) @@ -9734,7 +12682,7 @@ def update_with_http_info(self, account_id, envelope_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopeUpdateSummary', + response_type='EnvelopeDocument', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9742,55 +12690,59 @@ def update_with_http_info(self, account_id, envelope_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_chunked_upload(self, account_id, chunked_upload_id, **kwargs): + def update_document_fields(self, account_id, document_id, envelope_id, **kwargs): """ - Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. + 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_chunked_upload(account_id, chunked_upload_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 chunked_upload_id: (required) - :param str action: - :return: ChunkedUploadResponse + :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_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) + return self.update_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) else: - (data) = self.update_chunked_upload_with_http_info(account_id, chunked_upload_id, **kwargs) + (data) = self.update_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) return data - def update_chunked_upload_with_http_info(self, account_id, chunked_upload_id, **kwargs): + def update_document_fields_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. + 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_chunked_upload_with_http_info(account_id, chunked_upload_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 chunked_upload_id: (required) - :param str action: - :return: ChunkedUploadResponse + :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', 'chunked_upload_id', 'action'] + 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') @@ -9801,30 +12753,33 @@ def update_chunked_upload_with_http_info(self, account_id, chunked_upload_id, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_chunked_upload" % 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_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`") + 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}/chunked_uploads/{chunkedUploadId}'.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 'chunked_upload_id' in params: - path_params['chunkedUploadId'] = params['chunked_upload_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 'action' in params: - query_params['action'] = params['action'] header_params = {} @@ -9832,6 +12787,8 @@ def update_chunked_upload_with_http_info(self, account_id, chunked_upload_id, ** 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']) @@ -9846,7 +12803,7 @@ def update_chunked_upload_with_http_info(self, account_id, chunked_upload_id, ** body=body_params, post_params=form_params, files=local_var_files, - response_type='ChunkedUploadResponse', + response_type='DocumentFieldsInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9854,57 +12811,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 update_document_tabs(self, account_id, document_id, envelope_id, **kwargs): """ - Add a chunk, a chunk 'part', to an existing ChunkedUpload. + 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_chunked_upload_part(account_id, chunked_upload_id, chunked_upload_part_seq, 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 str chunked_upload_id: (required) - :param str chunked_upload_part_seq: (required) - :param ChunkedUploadRequest chunked_upload_request: - :return: ChunkedUploadResponse + :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_chunked_upload_part_with_http_info(account_id, chunked_upload_id, chunked_upload_part_seq, **kwargs) + return self.update_document_tabs_with_http_info(account_id, document_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.update_document_tabs_with_http_info(account_id, document_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 update_document_tabs_with_http_info(self, account_id, document_id, envelope_id, **kwargs): """ - Add a chunk, a chunk 'part', to an existing ChunkedUpload. + 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_chunked_upload_part_with_http_info(account_id, chunked_upload_id, chunked_upload_part_seq, 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 str chunked_upload_id: (required) - :param str chunked_upload_part_seq: (required) - :param ChunkedUploadRequest chunked_upload_request: - :return: ChunkedUploadResponse + :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', 'chunked_upload_id', 'chunked_upload_part_seq', 'chunked_upload_request'] + 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') @@ -9915,31 +12872,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 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_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 `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}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}'.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 '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 'document_id' in params: + path_params['documentId'] = params['document_id'] + if 'envelope_id' in params: + path_params['envelopeId'] = params['envelope_id'] query_params = {} @@ -9949,8 +12906,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 'tabs' in params: + body_params = params['tabs'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -9965,7 +12922,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='Tabs', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9973,57 +12930,57 @@ 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 update_documents(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. + 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_custom_fields(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 CustomFields custom_fields: - :return: CustomFields + :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_custom_fields_with_http_info(account_id, envelope_id, **kwargs) + return self.update_documents_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_custom_fields_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_documents_with_http_info(account_id, envelope_id, **kwargs) return data - def update_custom_fields_with_http_info(self, account_id, envelope_id, **kwargs): + def update_documents_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. + 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_custom_fields_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 CustomFields custom_fields: - :return: CustomFields + :param EnvelopeDefinition envelope_definition: + :return: EnvelopeDocumentsResult 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_definition'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10034,21 +12991,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 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_custom_fields`") + 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_custom_fields`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_documents`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_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'] @@ -10063,8 +13020,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_definition' in params: + body_params = params['envelope_definition'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -10079,7 +13036,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='EnvelopeDocumentsResult', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10087,57 +13044,57 @@ 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 update_email_settings(self, account_id, envelope_id, **kwargs): """ - Adds a document to an existing draft envelope. - Adds a document to an existing draft envelope. + 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_document(account_id, document_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 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 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_document_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.update_email_settings_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_document_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.update_email_settings_with_http_info(account_id, envelope_id, **kwargs) return data - def update_document_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def update_email_settings_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. + 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_document_with_http_info(account_id, document_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 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 EmailSettings email_settings: + :return: EmailSettings If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id'] + all_params = ['account_id', 'envelope_id', 'email_settings'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10148,29 +13105,24 @@ 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 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_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`") + 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_document`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_email_settings`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}'.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'] @@ -10182,6 +13134,8 @@ def update_document_with_http_info(self, account_id, document_id, envelope_id, * 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']) @@ -10196,7 +13150,7 @@ def update_document_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='EmailSettings', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10204,59 +13158,55 @@ 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_fields(self, account_id, document_id, envelope_id, **kwargs): + def update_envelope_transfer_rule(self, account_id, envelope_transfer_rule_id, **kwargs): """ - Updates existing custom document fields in an existing envelope document. - Updates existing custom document fields in an existing envelope document. + 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_document_fields(account_id, document_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 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 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_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) else: - (data) = self.update_document_fields_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) return data - def update_document_fields_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def update_envelope_transfer_rule_with_http_info(self, account_id, envelope_transfer_rule_id, **kwargs): """ - Updates existing custom document fields in an existing envelope document. - Updates existing custom document fields in an existing envelope document. + 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_document_fields_with_http_info(account_id, document_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 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 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', 'document_id', 'envelope_id', 'document_fields_information'] + 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') @@ -10267,31 +13217,26 @@ 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_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_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_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}/documents/{documentId}/fields'.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 'document_id' in params: - path_params['documentId'] = params['document_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 = {} @@ -10301,8 +13246,8 @@ def update_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_transfer_rule' in params: + body_params = params['envelope_transfer_rule'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -10317,7 +13262,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='EnvelopeTransferRule', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10325,57 +13270,53 @@ 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_envelope_transfer_rules(self, account_id, **kwargs): """ - Updates the tabs for an envelope document + 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_document_tabs(account_id, document_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 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 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_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) + return self.update_envelope_transfer_rules_with_http_info(account_id, **kwargs) else: - (data) = self.update_document_tabs_with_http_info(account_id, document_id, envelope_id, **kwargs) + (data) = self.update_envelope_transfer_rules_with_http_info(account_id, **kwargs) return data - def update_document_tabs_with_http_info(self, account_id, document_id, envelope_id, **kwargs): + def update_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): """ - Updates the tabs for an envelope document + 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_document_tabs_with_http_info(account_id, document_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 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 EnvelopeTransferRuleInformation envelope_transfer_rule_information: + :return: EnvelopeTransferRuleInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'document_id', 'envelope_id', 'tabs'] + all_params = ['account_id', 'envelope_transfer_rule_information'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10386,31 +13327,21 @@ 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 - ) - 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`") + " 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_envelope_transfer_rules`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs'.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 'document_id' in params: - path_params['documentId'] = params['document_id'] - if 'envelope_id' in params: - path_params['envelopeId'] = params['envelope_id'] query_params = {} @@ -10420,8 +13351,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 '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']) @@ -10436,7 +13367,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='EnvelopeTransferRuleInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10444,57 +13375,55 @@ 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_envelope_workflow_definition(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 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_documents(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) - :param EnvelopeDefinition envelope_definition: - :return: EnvelopeDocumentsResult + :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_documents_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_documents_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_documents_with_http_info(self, account_id, envelope_id, **kwargs): + def update_envelope_workflow_definition_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 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_documents_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) - :param EnvelopeDefinition envelope_definition: - :return: EnvelopeDocumentsResult + :param Workflow workflow: + :return: Workflow If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'envelope_definition'] + all_params = ['account_id', 'envelope_id', 'workflow'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10505,21 +13434,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_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_documents`") + 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_documents`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_envelope_workflow_definition`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents'.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'] @@ -10534,8 +13463,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 'workflow' in params: + body_params = params['workflow'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -10550,7 +13479,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='Workflow', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10558,57 +13487,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_lock(self, account_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. + 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_email_settings(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) - :param EmailSettings email_settings: - :return: EmailSettings + :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_email_settings_with_http_info(account_id, envelope_id, **kwargs) + return self.update_lock_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_email_settings_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_lock_with_http_info(account_id, envelope_id, **kwargs) return data - def update_email_settings_with_http_info(self, account_id, envelope_id, **kwargs): + def update_lock_with_http_info(self, account_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. + 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_email_settings_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) - :param EmailSettings email_settings: - :return: EmailSettings + :param LockRequest lock_request: + :return: LockInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'email_settings'] + all_params = ['account_id', 'envelope_id', 'lock_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10619,21 +13548,21 @@ 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_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_email_settings`") + 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_email_settings`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_lock`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings'.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'] @@ -10648,8 +13577,8 @@ 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'] + if 'lock_request' in params: + body_params = params['lock_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -10664,7 +13593,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='LockInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10672,55 +13601,55 @@ 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_notification_settings(self, account_id, envelope_id, **kwargs): """ - Update an envelope transfer rule for an account. + 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_envelope_transfer_rule(account_id, envelope_transfer_rule_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_transfer_rule_id: (required) - :param EnvelopeTransferRule envelope_transfer_rule: - :return: EnvelopeTransferRule + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :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_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) + return self.update_notification_settings_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, **kwargs) + (data) = self.update_notification_settings_with_http_info(account_id, envelope_id, **kwargs) return data - def update_envelope_transfer_rule_with_http_info(self, account_id, envelope_transfer_rule_id, **kwargs): + def update_notification_settings_with_http_info(self, account_id, envelope_id, **kwargs): """ - Update an envelope transfer rule for an account. + 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_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_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_transfer_rule_id: (required) - :param EnvelopeTransferRule envelope_transfer_rule: - :return: EnvelopeTransferRule + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param EnvelopeNotificationRequest envelope_notification_request: + :return: Notification 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', 'envelope_id', 'envelope_notification_request'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10731,26 +13660,26 @@ 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_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_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_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`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}'.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'] - 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 = {} @@ -10760,8 +13689,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 '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']) @@ -10776,7 +13705,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='Notification', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10784,53 +13713,53 @@ 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_page_info(self, account_id, envelope_id, **kwargs): """ - Update envelope transfer rules for an account. + Update 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.update_envelope_transfer_rules(account_id, callback=callback_function) + >>> thread = api.update_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 EnvelopeTransferRuleInformation envelope_transfer_rule_information: - :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.update_envelope_transfer_rules_with_http_info(account_id, **kwargs) + return self.update_page_info_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_envelope_transfer_rules_with_http_info(account_id, **kwargs) + (data) = self.update_page_info_with_http_info(account_id, envelope_id, **kwargs) return data - def update_envelope_transfer_rules_with_http_info(self, account_id, **kwargs): + def update_page_info_with_http_info(self, account_id, envelope_id, **kwargs): """ - Update envelope transfer rules for an account. + Update 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.update_envelope_transfer_rules_with_http_info(account_id, callback=callback_function) + >>> thread = api.update_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 EnvelopeTransferRuleInformation envelope_transfer_rule_information: - :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', 'envelope_transfer_rule_information'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10841,21 +13770,26 @@ 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_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 `update_envelope_transfer_rules`") + 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`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/transfer_rules'.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_id' in params: + path_params['envelopeId'] = params['envelope_id'] query_params = {} @@ -10865,8 +13799,6 @@ 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'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -10881,7 +13813,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=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10889,55 +13821,53 @@ 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_pdf(self, account_id, envelope_id, **kwargs): """ - Updates the envelope workflow definition for an envelope. + Set latest pdf 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.update_envelope_workflow_definition(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_pdf(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 + :return: DisplayAppliancePdf 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_pdf_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_pdf_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_pdf_with_http_info(self, account_id, envelope_id, **kwargs): """ - Updates the envelope workflow definition for an envelope. + Set latest pdf 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.update_envelope_workflow_definition_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_pdf_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 + :return: DisplayAppliancePdf If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'workflow'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10948,21 +13878,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_pdf" % 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_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 `update_envelope_workflow_definition`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_pdf`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -10977,8 +13907,6 @@ 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'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -10993,7 +13921,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='DisplayAppliancePdf', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -11001,57 +13929,53 @@ 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_pdf_blob(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. + Update 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.update_lock(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_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) - :param LockRequest lock_request: - :return: LockInformation + :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_lock_with_http_info(account_id, envelope_id, **kwargs) + return self.update_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_lock_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_pdf_blob_with_http_info(account_id, envelope_id, **kwargs) return data - def update_lock_with_http_info(self, account_id, envelope_id, **kwargs): + def update_pdf_blob_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. + Update 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.update_lock_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_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) - :param LockRequest lock_request: - :return: LockInformation + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'lock_request'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11062,21 +13986,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_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 `update_lock`") + raise ValueError("Missing the required parameter `account_id` when calling `update_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 `update_lock`") + raise ValueError("Missing the required parameter `envelope_id` when calling `update_pdf_blob`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock'.replace('{format}', 'json') + 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'] @@ -11091,8 +14015,6 @@ 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'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -11107,7 +14029,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=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -11115,55 +14037,53 @@ 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_recipient_denied_document_copy(self, account_id, envelope_id, **kwargs): """ - Sets envelope notification (Reminders/Expirations) structure for an existing envelope. + Update RecipientDeniedDocumentCopy 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.update_notification_settings(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_recipient_denied_document_copy(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 EnvelopeNotificationRequest envelope_notification_request: - :return: Notification + :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_notification_settings_with_http_info(account_id, envelope_id, **kwargs) + return self.update_recipient_denied_document_copy_with_http_info(account_id, envelope_id, **kwargs) else: - (data) = self.update_notification_settings_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.update_recipient_denied_document_copy_with_http_info(account_id, envelope_id, **kwargs) return data - def update_notification_settings_with_http_info(self, account_id, envelope_id, **kwargs): + def update_recipient_denied_document_copy_with_http_info(self, account_id, envelope_id, **kwargs): """ - Sets envelope notification (Reminders/Expirations) structure for an existing envelope. + Update RecipientDeniedDocumentCopy 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.update_notification_settings_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.update_recipient_denied_document_copy_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 EnvelopeNotificationRequest envelope_notification_request: - :return: Notification + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id', 'envelope_notification_request'] + all_params = ['account_id', 'envelope_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11174,21 +14094,21 @@ 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_recipient_denied_document_copy" % 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`") + raise ValueError("Missing the required parameter `account_id` when calling `update_recipient_denied_document_copy`") # 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 `envelope_id` when calling `update_recipient_denied_document_copy`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/recipient_denied_copy'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -11203,8 +14123,6 @@ 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'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -11219,7 +14137,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=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/docusign_esign/apis/groups_api.py b/docusign_esign/apis/groups_api.py index d1ebd77d..dceb1133 100644 --- a/docusign_esign/apis/groups_api.py +++ b/docusign_esign/apis/groups_api.py @@ -164,7 +164,7 @@ def delete_brands(self, account_id, group_id, **kwargs): :param str account_id: The external account number (int) or account ID Guid. (required) :param str group_id: The ID of the group being accessed. (required) :param BrandsRequest brands_request: - :return: BrandsResponse + :return: GroupBrands If the method is called asynchronously, returns the request thread. """ @@ -192,7 +192,7 @@ def delete_brands_with_http_info(self, account_id, group_id, **kwargs): :param str account_id: The external account number (int) or account ID Guid. (required) :param str group_id: The ID of the group being accessed. (required) :param BrandsRequest brands_request: - :return: BrandsResponse + :return: GroupBrands If the method is called asynchronously, returns the request thread. """ @@ -253,7 +253,7 @@ def delete_brands_with_http_info(self, account_id, group_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='BrandsResponse', + response_type='GroupBrands', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -498,7 +498,7 @@ def get_brands(self, account_id, group_id, **kwargs): for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str group_id: The ID of the group being accessed. (required) - :return: BrandsResponse + :return: GroupBrands If the method is called asynchronously, returns the request thread. """ @@ -525,7 +525,7 @@ def get_brands_with_http_info(self, account_id, group_id, **kwargs): for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str group_id: The ID of the group being accessed. (required) - :return: BrandsResponse + :return: GroupBrands If the method is called asynchronously, returns the request thread. """ @@ -584,7 +584,7 @@ def get_brands_with_http_info(self, account_id, group_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='BrandsResponse', + response_type='GroupBrands', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -850,7 +850,7 @@ def update_brands(self, account_id, group_id, **kwargs): :param str account_id: The external account number (int) or account ID Guid. (required) :param str group_id: The ID of the group being accessed. (required) :param BrandsRequest brands_request: - :return: BrandsResponse + :return: GroupBrands If the method is called asynchronously, returns the request thread. """ @@ -878,7 +878,7 @@ def update_brands_with_http_info(self, account_id, group_id, **kwargs): :param str account_id: The external account number (int) or account ID Guid. (required) :param str group_id: The ID of the group being accessed. (required) :param BrandsRequest brands_request: - :return: BrandsResponse + :return: GroupBrands If the method is called asynchronously, returns the request thread. """ @@ -939,7 +939,7 @@ def update_brands_with_http_info(self, account_id, group_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='BrandsResponse', + response_type='GroupBrands', 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 3c38d87c..7950e3e5 100644 --- a/docusign_esign/apis/trust_service_providers_api.py +++ b/docusign_esign/apis/trust_service_providers_api.py @@ -40,6 +40,104 @@ 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. @@ -140,3 +238,390 @@ 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 baf3358a..552b237f 100644 --- a/docusign_esign/apis/users_api.py +++ b/docusign_esign/apis/users_api.py @@ -1859,6 +1859,114 @@ 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/models/__init__.py b/docusign_esign/models/__init__.py index d1d65f72..e9be28dc 100644 --- a/docusign_esign/models/__init__.py +++ b/docusign_esign/models/__init__.py @@ -95,7 +95,6 @@ from docusign_esign.models.brands_response import BrandsResponse from docusign_esign.models.bulk_envelope import BulkEnvelope from docusign_esign.models.bulk_envelope_status import BulkEnvelopeStatus -from docusign_esign.models.bulk_envelopes_response import BulkEnvelopesResponse from docusign_esign.models.bulk_recipient import BulkRecipient from docusign_esign.models.bulk_recipient_signature_provider import BulkRecipientSignatureProvider from docusign_esign.models.bulk_recipient_tab_label import BulkRecipientTabLabel @@ -103,6 +102,7 @@ from docusign_esign.models.bulk_recipients_response import BulkRecipientsResponse from docusign_esign.models.bulk_recipients_summary_response import BulkRecipientsSummaryResponse from docusign_esign.models.bulk_recipients_update_response import BulkRecipientsUpdateResponse +from docusign_esign.models.bulk_send_batch_request import BulkSendBatchRequest from docusign_esign.models.bulk_send_batch_status import BulkSendBatchStatus from docusign_esign.models.bulk_send_batch_summaries import BulkSendBatchSummaries from docusign_esign.models.bulk_send_batch_summary import BulkSendBatchSummary @@ -137,6 +137,8 @@ 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 @@ -162,6 +164,7 @@ 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_feature_set_price import CurrencyFeatureSetPrice @@ -175,6 +178,10 @@ 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 @@ -185,8 +192,10 @@ 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 @@ -227,6 +236,7 @@ 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 @@ -252,6 +262,7 @@ from docusign_esign.models.full_name import FullName from docusign_esign.models.graphics_context import GraphicsContext from docusign_esign.models.group import Group +from docusign_esign.models.group_brands import GroupBrands from docusign_esign.models.group_information import GroupInformation from docusign_esign.models.id_check_configuration import IdCheckConfiguration from docusign_esign.models.id_check_information_input import IdCheckInformationInput @@ -317,6 +328,7 @@ from docusign_esign.models.payment_line_item import PaymentLineItem from docusign_esign.models.payment_method_with_options import PaymentMethodWithOptions from docusign_esign.models.payment_processor_information import PaymentProcessorInformation +from docusign_esign.models.payment_signer_values import PaymentSignerValues from docusign_esign.models.permission_profile import PermissionProfile from docusign_esign.models.permission_profile_information import PermissionProfileInformation from docusign_esign.models.phone_number import PhoneNumber @@ -331,6 +343,7 @@ from docusign_esign.models.power_forms_form_data_response import PowerFormsFormDataResponse from docusign_esign.models.power_forms_request import PowerFormsRequest from docusign_esign.models.power_forms_response import PowerFormsResponse +from docusign_esign.models.prefill_tabs import PrefillTabs from docusign_esign.models.proof_service_resource_token import ProofServiceResourceToken from docusign_esign.models.proof_service_view_link import ProofServiceViewLink from docusign_esign.models.property_metadata import PropertyMetadata @@ -380,18 +393,26 @@ 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 @@ -434,11 +455,18 @@ 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_billing_plan.py b/docusign_esign/models/account_billing_plan.py index 6fe8a058..84d2903d 100644 --- a/docusign_esign/models/account_billing_plan.py +++ b/docusign_esign/models/account_billing_plan.py @@ -40,6 +40,7 @@ class AccountBillingPlan(object): 'included_seats': 'str', 'incremental_seats': 'str', 'is_downgrade': 'str', + 'notification_type': 'str', 'other_discount_percent': 'str', 'payment_cycle': 'str', 'payment_method': 'str', @@ -64,6 +65,7 @@ class AccountBillingPlan(object): 'included_seats': 'includedSeats', 'incremental_seats': 'incrementalSeats', 'is_downgrade': 'isDowngrade', + 'notification_type': 'notificationType', 'other_discount_percent': 'otherDiscountPercent', 'payment_cycle': 'paymentCycle', 'payment_method': 'paymentMethod', @@ -78,7 +80,7 @@ class AccountBillingPlan(object): 'support_plan_fee': 'supportPlanFee' } - def __init__(self, add_ons=None, can_cancel_renewal=None, can_upgrade=None, currency_code=None, downgrade_plan_information=None, enable_support=None, included_seats=None, incremental_seats=None, is_downgrade=None, other_discount_percent=None, payment_cycle=None, payment_method=None, per_seat_price=None, plan_classification=None, plan_feature_sets=None, plan_id=None, plan_name=None, renewal_status=None, seat_discounts=None, support_incident_fee=None, support_plan_fee=None): # noqa: E501 + def __init__(self, add_ons=None, can_cancel_renewal=None, can_upgrade=None, currency_code=None, downgrade_plan_information=None, enable_support=None, included_seats=None, incremental_seats=None, is_downgrade=None, notification_type=None, other_discount_percent=None, payment_cycle=None, payment_method=None, per_seat_price=None, plan_classification=None, plan_feature_sets=None, plan_id=None, plan_name=None, renewal_status=None, seat_discounts=None, support_incident_fee=None, support_plan_fee=None): # noqa: E501 """AccountBillingPlan - a model defined in Swagger""" # noqa: E501 self._add_ons = None @@ -90,6 +92,7 @@ def __init__(self, add_ons=None, can_cancel_renewal=None, can_upgrade=None, curr self._included_seats = None self._incremental_seats = None self._is_downgrade = None + self._notification_type = None self._other_discount_percent = None self._payment_cycle = None self._payment_method = None @@ -122,6 +125,8 @@ def __init__(self, add_ons=None, can_cancel_renewal=None, can_upgrade=None, curr self.incremental_seats = incremental_seats if is_downgrade is not None: self.is_downgrade = is_downgrade + if notification_type is not None: + self.notification_type = notification_type if other_discount_percent is not None: self.other_discount_percent = other_discount_percent if payment_cycle is not None: @@ -352,6 +357,29 @@ def is_downgrade(self, is_downgrade): self._is_downgrade = is_downgrade + @property + def notification_type(self): + """Gets the notification_type of this AccountBillingPlan. # noqa: E501 + + # noqa: E501 + + :return: The notification_type of this AccountBillingPlan. # noqa: E501 + :rtype: str + """ + return self._notification_type + + @notification_type.setter + def notification_type(self, notification_type): + """Sets the notification_type of this AccountBillingPlan. + + # noqa: E501 + + :param notification_type: The notification_type of this AccountBillingPlan. # noqa: E501 + :type: str + """ + + self._notification_type = notification_type + @property def other_discount_percent(self): """Gets the other_discount_percent of this AccountBillingPlan. # noqa: E501 diff --git a/docusign_esign/models/account_information.py b/docusign_esign/models/account_information.py index e75c96f4..48175d17 100644 --- a/docusign_esign/models/account_information.py +++ b/docusign_esign/models/account_information.py @@ -46,6 +46,8 @@ class AccountInformation(object): 'created_date': 'str', 'currency_code': 'str', 'current_plan_id': 'str', + 'display_appliance_start_url': 'str', + 'display_appliance_url': 'str', 'distributor_code': 'str', 'docu_sign_landing_url': 'str', 'dss_values': 'dict(str, str)', @@ -64,7 +66,8 @@ class AccountInformation(object): 'seats_in_use': 'str', 'status21_cfr_part11': 'str', 'suspension_date': 'str', - 'suspension_status': 'str' + 'suspension_status': 'str', + 'use_display_appliance': 'bool' } attribute_map = { @@ -83,6 +86,8 @@ class AccountInformation(object): 'created_date': 'createdDate', 'currency_code': 'currencyCode', 'current_plan_id': 'currentPlanId', + 'display_appliance_start_url': 'displayApplianceStartUrl', + 'display_appliance_url': 'displayApplianceUrl', 'distributor_code': 'distributorCode', 'docu_sign_landing_url': 'docuSignLandingUrl', 'dss_values': 'dssValues', @@ -101,10 +106,11 @@ class AccountInformation(object): 'seats_in_use': 'seatsInUse', 'status21_cfr_part11': 'status21CFRPart11', 'suspension_date': 'suspensionDate', - 'suspension_status': 'suspensionStatus' + 'suspension_status': 'suspensionStatus', + 'use_display_appliance': 'useDisplayAppliance' } - def __init__(self, account_id_guid=None, account_name=None, account_settings=None, allow_transaction_rooms=None, billing_period_days_remaining=None, billing_period_end_date=None, billing_period_envelopes_allowed=None, billing_period_envelopes_sent=None, billing_period_start_date=None, billing_profile=None, can_upgrade=None, connect_permission=None, created_date=None, currency_code=None, current_plan_id=None, distributor_code=None, docu_sign_landing_url=None, dss_values=None, envelope_sending_blocked=None, envelope_unit_price=None, external_account_id=None, forgotten_password_questions_count=None, is_downgrade=None, payment_method=None, plan_classification=None, plan_end_date=None, plan_name=None, plan_start_date=None, recipient_domains=None, seats_allowed=None, seats_in_use=None, status21_cfr_part11=None, suspension_date=None, suspension_status=None): # noqa: E501 + def __init__(self, account_id_guid=None, account_name=None, account_settings=None, allow_transaction_rooms=None, billing_period_days_remaining=None, billing_period_end_date=None, billing_period_envelopes_allowed=None, billing_period_envelopes_sent=None, billing_period_start_date=None, billing_profile=None, can_upgrade=None, connect_permission=None, created_date=None, currency_code=None, current_plan_id=None, display_appliance_start_url=None, display_appliance_url=None, distributor_code=None, docu_sign_landing_url=None, dss_values=None, envelope_sending_blocked=None, envelope_unit_price=None, external_account_id=None, forgotten_password_questions_count=None, is_downgrade=None, payment_method=None, plan_classification=None, plan_end_date=None, plan_name=None, plan_start_date=None, recipient_domains=None, seats_allowed=None, seats_in_use=None, status21_cfr_part11=None, suspension_date=None, suspension_status=None, use_display_appliance=None): # noqa: E501 """AccountInformation - a model defined in Swagger""" # noqa: E501 self._account_id_guid = None @@ -122,6 +128,8 @@ def __init__(self, account_id_guid=None, account_name=None, account_settings=Non self._created_date = None self._currency_code = None self._current_plan_id = None + self._display_appliance_start_url = None + self._display_appliance_url = None self._distributor_code = None self._docu_sign_landing_url = None self._dss_values = None @@ -141,6 +149,7 @@ def __init__(self, account_id_guid=None, account_name=None, account_settings=Non self._status21_cfr_part11 = None self._suspension_date = None self._suspension_status = None + self._use_display_appliance = None self.discriminator = None if account_id_guid is not None: @@ -173,6 +182,10 @@ def __init__(self, account_id_guid=None, account_name=None, account_settings=Non self.currency_code = currency_code if current_plan_id is not None: self.current_plan_id = current_plan_id + if display_appliance_start_url is not None: + self.display_appliance_start_url = display_appliance_start_url + if display_appliance_url is not None: + self.display_appliance_url = display_appliance_url if distributor_code is not None: self.distributor_code = distributor_code if docu_sign_landing_url is not None: @@ -211,6 +224,8 @@ def __init__(self, account_id_guid=None, account_name=None, account_settings=Non self.suspension_date = suspension_date if suspension_status is not None: self.suspension_status = suspension_status + if use_display_appliance is not None: + self.use_display_appliance = use_display_appliance @property def account_id_guid(self): @@ -555,6 +570,52 @@ def current_plan_id(self, current_plan_id): self._current_plan_id = current_plan_id + @property + def display_appliance_start_url(self): + """Gets the display_appliance_start_url of this AccountInformation. # noqa: E501 + + # noqa: E501 + + :return: The display_appliance_start_url of this AccountInformation. # noqa: E501 + :rtype: str + """ + return self._display_appliance_start_url + + @display_appliance_start_url.setter + def display_appliance_start_url(self, display_appliance_start_url): + """Sets the display_appliance_start_url of this AccountInformation. + + # noqa: E501 + + :param display_appliance_start_url: The display_appliance_start_url of this AccountInformation. # noqa: E501 + :type: str + """ + + self._display_appliance_start_url = display_appliance_start_url + + @property + def display_appliance_url(self): + """Gets the display_appliance_url of this AccountInformation. # noqa: E501 + + # noqa: E501 + + :return: The display_appliance_url of this AccountInformation. # noqa: E501 + :rtype: str + """ + return self._display_appliance_url + + @display_appliance_url.setter + def display_appliance_url(self, display_appliance_url): + """Sets the display_appliance_url of this AccountInformation. + + # noqa: E501 + + :param display_appliance_url: The display_appliance_url of this AccountInformation. # noqa: E501 + :type: str + """ + + self._display_appliance_url = display_appliance_url + @property def distributor_code(self): """Gets the distributor_code of this AccountInformation. # noqa: E501 @@ -992,6 +1053,29 @@ def suspension_status(self, suspension_status): self._suspension_status = suspension_status + @property + def use_display_appliance(self): + """Gets the use_display_appliance of this AccountInformation. # noqa: E501 + + # noqa: E501 + + :return: The use_display_appliance of this AccountInformation. # noqa: E501 + :rtype: bool + """ + return self._use_display_appliance + + @use_display_appliance.setter + def use_display_appliance(self, use_display_appliance): + """Sets the use_display_appliance of this AccountInformation. + + # noqa: E501 + + :param use_display_appliance: The use_display_appliance of this AccountInformation. # noqa: E501 + :type: bool + """ + + self._use_display_appliance = use_display_appliance + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/docusign_esign/models/account_settings_information.py b/docusign_esign/models/account_settings_information.py index 85f90ad2..49a758e4 100644 --- a/docusign_esign/models/account_settings_information.py +++ b/docusign_esign/models/account_settings_information.py @@ -102,6 +102,10 @@ class AccountSettingsInformation(object): 'allow_external_signature_pad_metadata': 'SettingsMetadata', 'allow_idv_level1': 'str', 'allow_idv_level1_metadata': 'SettingsMetadata', + 'allow_idv_level2': 'str', + 'allow_idv_level2_metadata': 'SettingsMetadata', + 'allow_idv_level3': 'str', + 'allow_idv_level3_metadata': 'SettingsMetadata', 'allow_idv_platform': 'str', 'allow_idv_platform_metadata': 'SettingsMetadata', 'allow_in_person': 'str', @@ -138,6 +142,8 @@ class AccountSettingsInformation(object): 'allow_phone_auth_override_metadata': 'SettingsMetadata', 'allow_private_signing_groups': 'str', 'allow_private_signing_groups_metadata': 'SettingsMetadata', + 'allow_recipient_connect': 'str', + 'allow_recipient_connect_metadata': 'SettingsMetadata', 'allow_reminders': 'str', 'allow_reminders_metadata': 'SettingsMetadata', 'allow_remote_notary': 'str', @@ -170,6 +176,8 @@ class AccountSettingsInformation(object): 'allow_signing_extensions_metadata': 'SettingsMetadata', 'allow_signing_groups': 'str', 'allow_signing_groups_metadata': 'SettingsMetadata', + 'allow_signing_insights': 'str', + 'allow_signing_insights_metadata': 'SettingsMetadata', 'allow_signing_radio_deselect': 'str', 'allow_signing_radio_deselect_metadata': 'SettingsMetadata', 'allow_sign_now': 'str', @@ -232,6 +240,8 @@ class AccountSettingsInformation(object): 'convert_pdf_fields_metadata': 'SettingsMetadata', 'data_population_scope': 'str', 'data_population_scope_metadata': 'SettingsMetadata', + 'disable_auto_template_matching': 'str', + 'disable_auto_template_matching_metadata': 'SettingsMetadata', 'disable_mobile_app': 'str', 'disable_mobile_app_metadata': 'SettingsMetadata', 'disable_mobile_push_notifications': 'str', @@ -288,6 +298,8 @@ class AccountSettingsInformation(object): 'enable_envelope_stamping_by_account_admin_metadata': 'SettingsMetadata', 'enable_envelope_stamping_by_ds_admin': 'str', 'enable_envelope_stamping_by_ds_admin_metadata': 'SettingsMetadata', + 'enable_esign_communities': 'str', + 'enable_esign_communities_metadata': 'SettingsMetadata', 'enable_in_browser_editor': 'str', 'enable_in_browser_editor_metadata': 'SettingsMetadata', 'enable_payment_processing': 'str', @@ -308,6 +320,8 @@ class AccountSettingsInformation(object): 'enable_responsive_signing_metadata': 'SettingsMetadata', 'enable_scheduled_release': 'str', 'enable_scheduled_release_metadata': 'SettingsMetadata', + 'enable_search': 'str', + 'enable_search_metadata': 'SettingsMetadata', 'enable_search_ui': 'str', 'enable_search_ui_metadata': 'SettingsMetadata', 'enable_sending_tags_font_settings': 'str', @@ -628,6 +642,10 @@ class AccountSettingsInformation(object): 'allow_external_signature_pad_metadata': 'allowExternalSignaturePadMetadata', 'allow_idv_level1': 'allowIDVLevel1', 'allow_idv_level1_metadata': 'allowIDVLevel1Metadata', + 'allow_idv_level2': 'allowIDVLevel2', + 'allow_idv_level2_metadata': 'allowIDVLevel2Metadata', + 'allow_idv_level3': 'allowIDVLevel3', + 'allow_idv_level3_metadata': 'allowIDVLevel3Metadata', 'allow_idv_platform': 'allowIDVPlatform', 'allow_idv_platform_metadata': 'allowIDVPlatformMetadata', 'allow_in_person': 'allowInPerson', @@ -664,6 +682,8 @@ class AccountSettingsInformation(object): 'allow_phone_auth_override_metadata': 'allowPhoneAuthOverrideMetadata', 'allow_private_signing_groups': 'allowPrivateSigningGroups', 'allow_private_signing_groups_metadata': 'allowPrivateSigningGroupsMetadata', + 'allow_recipient_connect': 'allowRecipientConnect', + 'allow_recipient_connect_metadata': 'allowRecipientConnectMetadata', 'allow_reminders': 'allowReminders', 'allow_reminders_metadata': 'allowRemindersMetadata', 'allow_remote_notary': 'allowRemoteNotary', @@ -696,6 +716,8 @@ class AccountSettingsInformation(object): 'allow_signing_extensions_metadata': 'allowSigningExtensionsMetadata', 'allow_signing_groups': 'allowSigningGroups', 'allow_signing_groups_metadata': 'allowSigningGroupsMetadata', + 'allow_signing_insights': 'allowSigningInsights', + 'allow_signing_insights_metadata': 'allowSigningInsightsMetadata', 'allow_signing_radio_deselect': 'allowSigningRadioDeselect', 'allow_signing_radio_deselect_metadata': 'allowSigningRadioDeselectMetadata', 'allow_sign_now': 'allowSignNow', @@ -758,6 +780,8 @@ class AccountSettingsInformation(object): 'convert_pdf_fields_metadata': 'convertPdfFieldsMetadata', 'data_population_scope': 'dataPopulationScope', 'data_population_scope_metadata': 'dataPopulationScopeMetadata', + 'disable_auto_template_matching': 'disableAutoTemplateMatching', + 'disable_auto_template_matching_metadata': 'disableAutoTemplateMatchingMetadata', 'disable_mobile_app': 'disableMobileApp', 'disable_mobile_app_metadata': 'disableMobileAppMetadata', 'disable_mobile_push_notifications': 'disableMobilePushNotifications', @@ -814,6 +838,8 @@ class AccountSettingsInformation(object): 'enable_envelope_stamping_by_account_admin_metadata': 'enableEnvelopeStampingByAccountAdminMetadata', 'enable_envelope_stamping_by_ds_admin': 'enableEnvelopeStampingByDSAdmin', 'enable_envelope_stamping_by_ds_admin_metadata': 'enableEnvelopeStampingByDSAdminMetadata', + 'enable_esign_communities': 'enableEsignCommunities', + 'enable_esign_communities_metadata': 'enableEsignCommunitiesMetadata', 'enable_in_browser_editor': 'enableInBrowserEditor', 'enable_in_browser_editor_metadata': 'enableInBrowserEditorMetadata', 'enable_payment_processing': 'enablePaymentProcessing', @@ -834,6 +860,8 @@ class AccountSettingsInformation(object): 'enable_responsive_signing_metadata': 'enableResponsiveSigningMetadata', 'enable_scheduled_release': 'enableScheduledRelease', 'enable_scheduled_release_metadata': 'enableScheduledReleaseMetadata', + 'enable_search': 'enableSearch', + 'enable_search_metadata': 'enableSearchMetadata', 'enable_search_ui': 'enableSearchUI', 'enable_search_ui_metadata': 'enableSearchUIMetadata', 'enable_sending_tags_font_settings': 'enableSendingTagsFontSettings', @@ -1082,7 +1110,7 @@ class AccountSettingsInformation(object): 'wurfl_min_allowable_screen_size_metadata': 'wurflMinAllowableScreenSizeMetadata' } - def __init__(self, access_code_format=None, account_date_time_format=None, account_date_time_format_metadata=None, account_default_language=None, account_default_language_metadata=None, account_name=None, account_name_metadata=None, account_notification=None, account_ui_settings=None, adopt_sig_config=None, adopt_sig_config_metadata=None, advanced_correct=None, advanced_correct_metadata=None, allow_access_code_format=None, allow_access_code_format_metadata=None, allow_account_management_granular=None, allow_account_management_granular_metadata=None, allow_account_member_name_change=None, allow_account_member_name_change_metadata=None, allow_advanced_recipient_routing_conditional=None, allow_advanced_recipient_routing_conditional_metadata=None, allow_agent_name_email_edit=None, allow_agent_name_email_edit_metadata=None, allow_agreement_actions=None, allow_agreement_actions_metadata=None, allow_auto_nav_settings=None, allow_auto_nav_settings_metadata=None, allow_auto_tagging=None, allow_auto_tagging_metadata=None, allow_bulk_send=None, allow_bulk_send_metadata=None, allow_cd_withdraw=None, allow_cd_withdraw_metadata=None, allow_connect_http_listener_configs=None, allow_connect_send_finish_later=None, allow_connect_send_finish_later_metadata=None, allow_connect_unified_payload_ui=None, allow_consumer_disclosure_override=None, allow_consumer_disclosure_override_metadata=None, allow_data_download=None, allow_data_download_metadata=None, allow_document_disclosures=None, allow_document_disclosures_metadata=None, allow_documents_on_signed_envelopes=None, allow_documents_on_signed_envelopes_metadata=None, allow_document_visibility=None, allow_document_visibility_metadata=None, allow_e_hanko_stamps=None, allow_e_hanko_stamps_metadata=None, allow_e_note_e_original=None, allow_e_note_e_original_metadata=None, allow_envelope_correct=None, allow_envelope_correct_metadata=None, allow_envelope_custody_transfer=None, allow_envelope_custody_transfer_metadata=None, allow_envelope_custom_fields=None, allow_envelope_custom_fields_metadata=None, allow_envelope_publish_reporting=None, allow_envelope_publish_reporting_metadata=None, allow_envelope_reporting=None, allow_envelope_reporting_metadata=None, allow_expression=None, allow_expression_metadata=None, allow_express_signer_certificate=None, allow_express_signer_certificate_metadata=None, allow_extended_sending_resource_file=None, allow_extended_sending_resource_file_metadata=None, allow_external_signature_pad=None, allow_external_signature_pad_metadata=None, allow_idv_level1=None, allow_idv_level1_metadata=None, allow_idv_platform=None, allow_idv_platform_metadata=None, allow_in_person=None, allow_in_person_metadata=None, allow_managed_stamps=None, allow_managed_stamps_metadata=None, allow_markup=None, allow_markup_metadata=None, allow_member_time_zone=None, allow_member_time_zone_metadata=None, allow_merge_fields=None, allow_merge_fields_metadata=None, allow_multiple_brand_profiles=None, allow_multiple_brand_profiles_metadata=None, allow_multiple_signer_attachments=None, allow_multiple_signer_attachments_metadata=None, allow_non_us_phone_auth=None, allow_non_us_phone_auth_metadata=None, allow_ocr_of_envelope_documents=None, allow_ocr_of_envelope_documents_metadata=None, allow_offline_signing=None, allow_offline_signing_metadata=None, allow_open_trust_signer_certificate=None, allow_open_trust_signer_certificate_metadata=None, allow_organizations=None, allow_organizations_metadata=None, allow_payment_processing=None, allow_payment_processing_metadata=None, allow_personal_signer_certificate=None, allow_personal_signer_certificate_metadata=None, allow_phone_authentication=None, allow_phone_authentication_metadata=None, allow_phone_auth_override=None, allow_phone_auth_override_metadata=None, allow_private_signing_groups=None, allow_private_signing_groups_metadata=None, allow_reminders=None, allow_reminders_metadata=None, allow_remote_notary=None, allow_remote_notary_metadata=None, allow_resource_file_branding=None, allow_resource_file_branding_metadata=None, allow_safe_bio_pharma_signer_certificate=None, allow_safe_bio_pharma_signer_certificate_metadata=None, allow_security_appliance=None, allow_security_appliance_metadata=None, allow_send_to_certified_delivery=None, allow_send_to_certified_delivery_metadata=None, allow_send_to_intermediary=None, allow_send_to_intermediary_metadata=None, allow_server_templates=None, allow_server_templates_metadata=None, allow_set_embedded_recipient_start_url=None, allow_set_embedded_recipient_start_url_metadata=None, allow_shared_tabs=None, allow_shared_tabs_metadata=None, allow_signature_stamps=None, allow_signature_stamps_metadata=None, allow_sign_document_from_home_page=None, allow_sign_document_from_home_page_metadata=None, allow_signer_reassign=None, allow_signer_reassign_metadata=None, allow_signer_reassign_override=None, allow_signer_reassign_override_metadata=None, allow_signing_extensions=None, allow_signing_extensions_metadata=None, allow_signing_groups=None, allow_signing_groups_metadata=None, allow_signing_radio_deselect=None, allow_signing_radio_deselect_metadata=None, allow_sign_now=None, allow_sign_now_metadata=None, allow_sms_delivery=None, allow_sms_delivery_metadata=None, allow_social_id_login=None, allow_social_id_login_metadata=None, allow_supplemental_documents=None, allow_supplemental_documents_metadata=None, allow_users_to_access_directory=None, allow_users_to_access_directory_metadata=None, allow_value_insights=None, allow_value_insights_metadata=None, anchor_population_scope=None, anchor_population_scope_metadata=None, anchor_tag_versioned_placement_enabled=None, anchor_tag_versioned_placement_metadata_enabled=None, attach_completed_envelope=None, attach_completed_envelope_metadata=None, authentication_check=None, authentication_check_metadata=None, auto_nav_rule=None, auto_nav_rule_metadata=None, auto_provision_signer_account=None, auto_provision_signer_account_metadata=None, bcc_email_archive=None, bcc_email_archive_metadata=None, beta_switch_configuration=None, beta_switch_configuration_metadata=None, billing_address=None, billing_address_metadata=None, bulk_send=None, bulk_send_max_copies_in_batch=None, bulk_send_max_unprocessed_envelopes_count=None, bulk_send_metadata=None, can_self_brand_send=None, can_self_brand_send_metadata=None, can_self_brand_sign=None, can_self_brand_sign_metadata=None, can_use_salesforce_o_auth=None, can_use_salesforce_o_auth_metadata=None, capture_voice_recording=None, capture_voice_recording_metadata=None, cfr_use_wide_image=None, cfr_use_wide_image_metadata=None, check_for_multiple_admins_on_account=None, check_for_multiple_admins_on_account_metadata=None, chrome_signature_enabled=None, chrome_signature_enabled_metadata=None, comment_email_show_message_text=None, comment_email_show_message_text_metadata=None, comments_allow_envelope_override=None, comments_allow_envelope_override_metadata=None, conditional_fields_enabled=None, conditional_fields_enabled_metadata=None, consumer_disclosure_frequency=None, consumer_disclosure_frequency_metadata=None, convert_pdf_fields=None, convert_pdf_fields_metadata=None, data_population_scope=None, data_population_scope_metadata=None, disable_mobile_app=None, disable_mobile_app_metadata=None, disable_mobile_push_notifications=None, disable_mobile_push_notifications_metadata=None, disable_mobile_sending=None, disable_mobile_sending_metadata=None, disable_multiple_sessions=None, disable_multiple_sessions_metadata=None, disable_purge_notifications_for_sender_metadata=None, disable_signer_cert_view=None, disable_signer_cert_view_metadata=None, disable_signer_history_view=None, disable_signer_history_view_metadata=None, disable_style_signature=None, disable_style_signature_metadata=None, disable_upload_signature=None, disable_upload_signature_metadata=None, disable_user_sharing=None, disable_user_sharing_metadata=None, display_beta_switch=None, display_beta_switch_metadata=None, document_conversion_restrictions=None, document_conversion_restrictions_metadata=None, document_retention=None, document_retention_metadata=None, document_retention_purge_tabs=None, document_visibility=None, document_visibility_metadata=None, email_template_version=None, email_template_version_metadata=None, enable_access_code_generator=None, enable_access_code_generator_metadata=None, enable_advanced_payments=None, enable_advanced_payments_metadata=None, enable_advanced_power_forms=None, enable_advanced_power_forms_metadata=None, enable_agreement_actions_for_clm=None, enable_agreement_actions_for_clm_metadata=None, enable_agreement_actions_for_e_sign=None, enable_agreement_actions_for_e_sign_metadata=None, enable_auto_nav=None, enable_auto_nav_metadata=None, enable_calculated_fields=None, enable_calculated_fields_metadata=None, enable_clickwraps=None, enable_clickwraps_metadata=None, enable_comments_history_download_in_signing=None, enable_comments_history_download_in_signing_metadata=None, enable_customer_satisfaction_metric_tracking=None, enable_customer_satisfaction_metric_tracking_metadata=None, enable_ds_pro=None, enable_ds_pro_metadata=None, enable_envelope_stamping_by_account_admin=None, enable_envelope_stamping_by_account_admin_metadata=None, enable_envelope_stamping_by_ds_admin=None, enable_envelope_stamping_by_ds_admin_metadata=None, enable_in_browser_editor=None, enable_in_browser_editor_metadata=None, enable_payment_processing=None, enable_payment_processing_metadata=None, enable_power_form=None, enable_power_form_direct=None, enable_power_form_direct_metadata=None, enable_power_form_metadata=None, enable_recipient_domain_validation=None, enable_recipient_domain_validation_metadata=None, enable_report_links=None, enable_report_links_metadata=None, enable_require_sign_on_paper=None, enable_require_sign_on_paper_metadata=None, enable_reserved_domain=None, enable_reserved_domain_metadata=None, enable_responsive_signing=None, enable_responsive_signing_metadata=None, enable_scheduled_release=None, enable_scheduled_release_metadata=None, enable_search_ui=None, enable_search_ui_metadata=None, enable_sending_tags_font_settings=None, enable_sending_tags_font_settings_metadata=None, enable_send_to_agent=None, enable_send_to_agent_metadata=None, enable_send_to_intermediary=None, enable_send_to_intermediary_metadata=None, enable_send_to_manage=None, enable_send_to_manage_metadata=None, enable_sequential_signing_api=None, enable_sequential_signing_api_metadata=None, enable_sequential_signing_ui=None, enable_sequential_signing_ui_metadata=None, enable_signer_attachments=None, enable_signer_attachments_metadata=None, enable_signing_extension_comments=None, enable_signing_extension_comments_metadata=None, enable_signing_extension_conversations=None, enable_signing_extension_conversations_metadata=None, enable_signing_order_settings_for_account=None, enable_signing_order_settings_for_account_metadata=None, enable_sign_on_paper=None, enable_sign_on_paper_metadata=None, enable_sign_on_paper_override=None, enable_sign_on_paper_override_metadata=None, enable_sign_with_notary=None, enable_sign_with_notary_metadata=None, enable_smart_contracts=None, enable_smart_contracts_metadata=None, enable_sms_authentication=None, enable_sms_authentication_metadata=None, enable_social_id_login=None, enable_social_id_login_metadata=None, enable_strike_through=None, enable_strike_through_metadata=None, enable_transaction_point=None, enable_transaction_point_metadata=None, enable_vaulting=None, enable_vaulting_metadata=None, enable_witnessing=None, enable_witnessing_metadata=None, enforce_template_name_uniqueness=None, enforce_template_name_uniqueness_metadata=None, envelope_integration_allowed=None, envelope_integration_allowed_metadata=None, envelope_integration_enabled=None, envelope_integration_enabled_metadata=None, envelope_stamping_default_value=None, envelope_stamping_default_value_metadata=None, express_send=None, express_send_allow_tabs=None, express_send_allow_tabs_metadata=None, express_send_metadata=None, external_document_sources=None, external_signature_pad_type=None, external_signature_pad_type_metadata=None, fax_out_enabled=None, fax_out_enabled_metadata=None, guided_forms_html_allowed=None, guided_forms_html_allowed_metadata=None, hide_account_address_in_co_c=None, hide_account_address_in_co_c_metadata=None, hide_pricing=None, hide_pricing_metadata=None, id_check_configurations=None, id_check_expire=None, id_check_expire_days=None, id_check_expire_days_metadata=None, id_check_expire_metadata=None, id_check_expire_minutes=None, id_check_expire_minutes_metadata=None, id_check_required=None, id_check_required_metadata=None, identity_verification=None, identity_verification_metadata=None, ignore_error_if_anchor_tab_not_found=None, ignore_error_if_anchor_tab_not_found_metadata_enabled=None, in_person_id_check_question=None, in_person_id_check_question_metadata=None, in_person_signing_enabled=None, in_person_signing_enabled_metadata=None, in_session_enabled=None, in_session_enabled_metadata=None, in_session_suppress_emails=None, in_session_suppress_emails_metadata=None, maximum_signing_groups=None, maximum_signing_groups_metadata=None, maximum_users_per_signing_group=None, maximum_users_per_signing_group_metadata=None, max_number_of_custom_stamps=None, mobile_session_timeout=None, mobile_session_timeout_metadata=None, number_of_active_custom_stamps=None, opt_in_mobile_signing_v02=None, opt_in_mobile_signing_v02_metadata=None, opt_out_auto_nav_text_and_tab_color_updates=None, opt_out_auto_nav_text_and_tab_color_updates_metadata=None, opt_out_new_platform_seal=None, opt_out_new_platform_seal_platform_metadata=None, phone_auth_recipient_may_provide_phone_number=None, phone_auth_recipient_may_provide_phone_number_metadata=None, pki_sign_downloaded_pdf_docs=None, pki_sign_downloaded_pdf_docs_metadata=None, recipients_can_sign_offline=None, recipients_can_sign_offline_metadata=None, recipient_signing_auto_navigation_control=None, recipient_signing_auto_navigation_control_metadata=None, require21_cf_rpt11_compliance=None, require21_cf_rpt11_compliance_metadata=None, require_decline_reason=None, require_decline_reason_metadata=None, require_external_user_management=None, require_external_user_management_metadata=None, require_signer_certificate_type=None, require_signer_certificate_type_metadata=None, rsa_verid_account_name=None, rsa_verid_password=None, rsa_verid_ruleset=None, rsa_verid_user_id=None, self_signed_recipient_email_document=None, self_signed_recipient_email_document_metadata=None, self_signed_recipient_email_document_user_override=None, self_signed_recipient_email_document_user_override_metadata=None, sender_can_sign_in_each_location=None, sender_can_sign_in_each_location_metadata=None, sender_must_authenticate_signing=None, sender_must_authenticate_signing_metadata=None, sending_tags_font_color=None, sending_tags_font_color_metadata=None, sending_tags_font_name=None, sending_tags_font_name_metadata=None, sending_tags_font_size=None, sending_tags_font_size_metadata=None, send_to_certified_delivery_enabled=None, send_to_certified_delivery_enabled_metadata=None, session_timeout=None, session_timeout_metadata=None, set_recip_email_lang=None, set_recip_email_lang_metadata=None, set_recip_sign_lang=None, set_recip_sign_lang_metadata=None, shared_template_folders=None, shared_template_folders_metadata=None, show_complete_dialog_in_embedded_session=None, show_complete_dialog_in_embedded_session_metadata=None, show_conditional_routing_on_send=None, show_conditional_routing_on_send_metadata=None, show_initial_conditional_fields=None, show_initial_conditional_fields_metadata=None, show_localized_watermarks=None, show_localized_watermarks_metadata=None, show_tutorials=None, show_tutorials_metadata=None, signature_providers=None, signature_providers_metadata=None, sign_date_format=None, sign_date_format_metadata=None, signer_attach_certificate_to_envelope_pdf=None, signer_attach_certificate_to_envelope_pdf_metadata=None, signer_attach_concat=None, signer_attach_concat_metadata=None, signer_can_create_account=None, signer_can_create_account_metadata=None, signer_can_sign_on_mobile=None, signer_can_sign_on_mobile_metadata=None, signer_in_session_use_envelope_complete_email=None, signer_in_session_use_envelope_complete_email_metadata=None, signer_login_requirements=None, signer_login_requirements_metadata=None, signer_must_have_account=None, signer_must_have_account_metadata=None, signer_must_login_to_sign=None, signer_must_login_to_sign_metadata=None, signer_show_secure_field_initial_values=None, signer_show_secure_field_initial_values_metadata=None, signing_session_timeout=None, signing_session_timeout_metadata=None, signing_ui_version=None, signing_ui_version_metadata=None, sign_time_format=None, sign_time_format_metadata=None, sign_time_show_am_pm=None, sign_time_show_am_pm_metadata=None, simplified_sending_enabled=None, simplified_sending_enabled_metadata=None, single_sign_on_enabled=None, single_sign_on_enabled_metadata=None, skip_auth_completed_envelopes=None, skip_auth_completed_envelopes_metadata=None, social_id_recip_auth=None, social_id_recip_auth_metadata=None, specify_document_visibility=None, specify_document_visibility_metadata=None, start_in_advanced_correct=None, start_in_advanced_correct_metadata=None, supplemental_documents_must_accept=None, supplemental_documents_must_accept_metadata=None, supplemental_documents_must_read=None, supplemental_documents_must_read_metadata=None, supplemental_documents_must_view=None, supplemental_documents_must_view_metadata=None, suppress_certificate_enforcement=None, suppress_certificate_enforcement_metadata=None, tab_account_settings=None, timezone_offset_api=None, timezone_offset_api_metadata=None, timezone_offset_ui=None, timezone_offset_ui_metadata=None, universal_signature_opt_in=None, use_account_level_email=None, use_account_level_email_metadata=None, use_consumer_disclosure=None, use_consumer_disclosure_metadata=None, use_consumer_disclosure_within_account=None, use_consumer_disclosure_within_account_metadata=None, use_derived_keys=None, use_derived_keys_metadata=None, use_docu_sign_express_signer_certificate=None, use_docu_sign_express_signer_certificate_metadata=None, use_multi_app_groups_data=None, use_multi_app_groups_data_metadata=None, use_new_blob_for_pdf=None, use_new_blob_for_pdf_metadata=None, use_safe_signer_certificates=None, use_safe_signer_certificates_metadata=None, uses_api=None, uses_api_metadata=None, use_signature_provider_platform=None, use_signature_provider_platform_metadata=None, validations_allowed=None, validations_allowed_metadata=None, validations_brand=None, validations_brand_metadata=None, validations_cadence=None, validations_cadence_metadata=None, validations_enabled=None, validations_enabled_metadata=None, validations_report=None, validations_report_metadata=None, water_mark_enabled=None, water_mark_enabled_metadata=None, write_reminder_to_envelope_history=None, write_reminder_to_envelope_history_metadata=None, wurfl_min_allowable_screen_size=None, wurfl_min_allowable_screen_size_metadata=None): # noqa: E501 + def __init__(self, **kwargs): """AccountSettingsInformation - a model defined in Swagger""" # noqa: E501 self._access_code_format = None @@ -1156,6 +1184,10 @@ def __init__(self, access_code_format=None, account_date_time_format=None, accou self._allow_external_signature_pad_metadata = None self._allow_idv_level1 = None self._allow_idv_level1_metadata = None + self._allow_idv_level2 = None + self._allow_idv_level2_metadata = None + self._allow_idv_level3 = None + self._allow_idv_level3_metadata = None self._allow_idv_platform = None self._allow_idv_platform_metadata = None self._allow_in_person = None @@ -1192,6 +1224,8 @@ def __init__(self, access_code_format=None, account_date_time_format=None, accou self._allow_phone_auth_override_metadata = None self._allow_private_signing_groups = None self._allow_private_signing_groups_metadata = None + self._allow_recipient_connect = None + self._allow_recipient_connect_metadata = None self._allow_reminders = None self._allow_reminders_metadata = None self._allow_remote_notary = None @@ -1224,6 +1258,8 @@ def __init__(self, access_code_format=None, account_date_time_format=None, accou self._allow_signing_extensions_metadata = None self._allow_signing_groups = None self._allow_signing_groups_metadata = None + self._allow_signing_insights = None + self._allow_signing_insights_metadata = None self._allow_signing_radio_deselect = None self._allow_signing_radio_deselect_metadata = None self._allow_sign_now = None @@ -1286,6 +1322,8 @@ def __init__(self, access_code_format=None, account_date_time_format=None, accou self._convert_pdf_fields_metadata = None self._data_population_scope = None self._data_population_scope_metadata = None + self._disable_auto_template_matching = None + self._disable_auto_template_matching_metadata = None self._disable_mobile_app = None self._disable_mobile_app_metadata = None self._disable_mobile_push_notifications = None @@ -1342,6 +1380,8 @@ def __init__(self, access_code_format=None, account_date_time_format=None, accou self._enable_envelope_stamping_by_account_admin_metadata = None self._enable_envelope_stamping_by_ds_admin = None self._enable_envelope_stamping_by_ds_admin_metadata = None + self._enable_esign_communities = None + self._enable_esign_communities_metadata = None self._enable_in_browser_editor = None self._enable_in_browser_editor_metadata = None self._enable_payment_processing = None @@ -1362,6 +1402,8 @@ def __init__(self, access_code_format=None, account_date_time_format=None, accou self._enable_responsive_signing_metadata = None self._enable_scheduled_release = None self._enable_scheduled_release_metadata = None + self._enable_search = None + self._enable_search_metadata = None self._enable_search_ui = None self._enable_search_ui_metadata = None self._enable_sending_tags_font_settings = None @@ -1610,1052 +1652,9 @@ def __init__(self, access_code_format=None, account_date_time_format=None, accou self._wurfl_min_allowable_screen_size_metadata = None self.discriminator = None - if access_code_format is not None: - self.access_code_format = access_code_format - if account_date_time_format is not None: - self.account_date_time_format = account_date_time_format - if account_date_time_format_metadata is not None: - self.account_date_time_format_metadata = account_date_time_format_metadata - if account_default_language is not None: - self.account_default_language = account_default_language - if account_default_language_metadata is not None: - self.account_default_language_metadata = account_default_language_metadata - if account_name is not None: - self.account_name = account_name - if account_name_metadata is not None: - self.account_name_metadata = account_name_metadata - if account_notification is not None: - self.account_notification = account_notification - if account_ui_settings is not None: - self.account_ui_settings = account_ui_settings - if adopt_sig_config is not None: - self.adopt_sig_config = adopt_sig_config - if adopt_sig_config_metadata is not None: - self.adopt_sig_config_metadata = adopt_sig_config_metadata - if advanced_correct is not None: - self.advanced_correct = advanced_correct - if advanced_correct_metadata is not None: - self.advanced_correct_metadata = advanced_correct_metadata - if allow_access_code_format is not None: - self.allow_access_code_format = allow_access_code_format - if allow_access_code_format_metadata is not None: - self.allow_access_code_format_metadata = allow_access_code_format_metadata - if allow_account_management_granular is not None: - self.allow_account_management_granular = allow_account_management_granular - if allow_account_management_granular_metadata is not None: - self.allow_account_management_granular_metadata = allow_account_management_granular_metadata - if allow_account_member_name_change is not None: - self.allow_account_member_name_change = allow_account_member_name_change - if allow_account_member_name_change_metadata is not None: - self.allow_account_member_name_change_metadata = allow_account_member_name_change_metadata - if allow_advanced_recipient_routing_conditional is not None: - self.allow_advanced_recipient_routing_conditional = allow_advanced_recipient_routing_conditional - if allow_advanced_recipient_routing_conditional_metadata is not None: - self.allow_advanced_recipient_routing_conditional_metadata = allow_advanced_recipient_routing_conditional_metadata - if allow_agent_name_email_edit is not None: - self.allow_agent_name_email_edit = allow_agent_name_email_edit - if allow_agent_name_email_edit_metadata is not None: - self.allow_agent_name_email_edit_metadata = allow_agent_name_email_edit_metadata - if allow_agreement_actions is not None: - self.allow_agreement_actions = allow_agreement_actions - if allow_agreement_actions_metadata is not None: - self.allow_agreement_actions_metadata = allow_agreement_actions_metadata - if allow_auto_nav_settings is not None: - self.allow_auto_nav_settings = allow_auto_nav_settings - if allow_auto_nav_settings_metadata is not None: - self.allow_auto_nav_settings_metadata = allow_auto_nav_settings_metadata - if allow_auto_tagging is not None: - self.allow_auto_tagging = allow_auto_tagging - if allow_auto_tagging_metadata is not None: - self.allow_auto_tagging_metadata = allow_auto_tagging_metadata - if allow_bulk_send is not None: - self.allow_bulk_send = allow_bulk_send - if allow_bulk_send_metadata is not None: - self.allow_bulk_send_metadata = allow_bulk_send_metadata - if allow_cd_withdraw is not None: - self.allow_cd_withdraw = allow_cd_withdraw - if allow_cd_withdraw_metadata is not None: - self.allow_cd_withdraw_metadata = allow_cd_withdraw_metadata - if allow_connect_http_listener_configs is not None: - self.allow_connect_http_listener_configs = allow_connect_http_listener_configs - if allow_connect_send_finish_later is not None: - self.allow_connect_send_finish_later = allow_connect_send_finish_later - if allow_connect_send_finish_later_metadata is not None: - self.allow_connect_send_finish_later_metadata = allow_connect_send_finish_later_metadata - if allow_connect_unified_payload_ui is not None: - self.allow_connect_unified_payload_ui = allow_connect_unified_payload_ui - if allow_consumer_disclosure_override is not None: - self.allow_consumer_disclosure_override = allow_consumer_disclosure_override - if allow_consumer_disclosure_override_metadata is not None: - self.allow_consumer_disclosure_override_metadata = allow_consumer_disclosure_override_metadata - if allow_data_download is not None: - self.allow_data_download = allow_data_download - if allow_data_download_metadata is not None: - self.allow_data_download_metadata = allow_data_download_metadata - if allow_document_disclosures is not None: - self.allow_document_disclosures = allow_document_disclosures - if allow_document_disclosures_metadata is not None: - self.allow_document_disclosures_metadata = allow_document_disclosures_metadata - if allow_documents_on_signed_envelopes is not None: - self.allow_documents_on_signed_envelopes = allow_documents_on_signed_envelopes - if allow_documents_on_signed_envelopes_metadata is not None: - self.allow_documents_on_signed_envelopes_metadata = allow_documents_on_signed_envelopes_metadata - if allow_document_visibility is not None: - self.allow_document_visibility = allow_document_visibility - if allow_document_visibility_metadata is not None: - self.allow_document_visibility_metadata = allow_document_visibility_metadata - if allow_e_hanko_stamps is not None: - self.allow_e_hanko_stamps = allow_e_hanko_stamps - if allow_e_hanko_stamps_metadata is not None: - self.allow_e_hanko_stamps_metadata = allow_e_hanko_stamps_metadata - if allow_e_note_e_original is not None: - self.allow_e_note_e_original = allow_e_note_e_original - if allow_e_note_e_original_metadata is not None: - self.allow_e_note_e_original_metadata = allow_e_note_e_original_metadata - if allow_envelope_correct is not None: - self.allow_envelope_correct = allow_envelope_correct - if allow_envelope_correct_metadata is not None: - self.allow_envelope_correct_metadata = allow_envelope_correct_metadata - if allow_envelope_custody_transfer is not None: - self.allow_envelope_custody_transfer = allow_envelope_custody_transfer - if allow_envelope_custody_transfer_metadata is not None: - self.allow_envelope_custody_transfer_metadata = allow_envelope_custody_transfer_metadata - if allow_envelope_custom_fields is not None: - self.allow_envelope_custom_fields = allow_envelope_custom_fields - if allow_envelope_custom_fields_metadata is not None: - self.allow_envelope_custom_fields_metadata = allow_envelope_custom_fields_metadata - if allow_envelope_publish_reporting is not None: - self.allow_envelope_publish_reporting = allow_envelope_publish_reporting - if allow_envelope_publish_reporting_metadata is not None: - self.allow_envelope_publish_reporting_metadata = allow_envelope_publish_reporting_metadata - if allow_envelope_reporting is not None: - self.allow_envelope_reporting = allow_envelope_reporting - if allow_envelope_reporting_metadata is not None: - self.allow_envelope_reporting_metadata = allow_envelope_reporting_metadata - if allow_expression is not None: - self.allow_expression = allow_expression - if allow_expression_metadata is not None: - self.allow_expression_metadata = allow_expression_metadata - if allow_express_signer_certificate is not None: - self.allow_express_signer_certificate = allow_express_signer_certificate - if allow_express_signer_certificate_metadata is not None: - self.allow_express_signer_certificate_metadata = allow_express_signer_certificate_metadata - if allow_extended_sending_resource_file is not None: - self.allow_extended_sending_resource_file = allow_extended_sending_resource_file - if allow_extended_sending_resource_file_metadata is not None: - self.allow_extended_sending_resource_file_metadata = allow_extended_sending_resource_file_metadata - if allow_external_signature_pad is not None: - self.allow_external_signature_pad = allow_external_signature_pad - if allow_external_signature_pad_metadata is not None: - self.allow_external_signature_pad_metadata = allow_external_signature_pad_metadata - if allow_idv_level1 is not None: - self.allow_idv_level1 = allow_idv_level1 - if allow_idv_level1_metadata is not None: - self.allow_idv_level1_metadata = allow_idv_level1_metadata - if allow_idv_platform is not None: - self.allow_idv_platform = allow_idv_platform - if allow_idv_platform_metadata is not None: - self.allow_idv_platform_metadata = allow_idv_platform_metadata - if allow_in_person is not None: - self.allow_in_person = allow_in_person - if allow_in_person_metadata is not None: - self.allow_in_person_metadata = allow_in_person_metadata - if allow_managed_stamps is not None: - self.allow_managed_stamps = allow_managed_stamps - if allow_managed_stamps_metadata is not None: - self.allow_managed_stamps_metadata = allow_managed_stamps_metadata - if allow_markup is not None: - self.allow_markup = allow_markup - if allow_markup_metadata is not None: - self.allow_markup_metadata = allow_markup_metadata - if allow_member_time_zone is not None: - self.allow_member_time_zone = allow_member_time_zone - if allow_member_time_zone_metadata is not None: - self.allow_member_time_zone_metadata = allow_member_time_zone_metadata - if allow_merge_fields is not None: - self.allow_merge_fields = allow_merge_fields - if allow_merge_fields_metadata is not None: - self.allow_merge_fields_metadata = allow_merge_fields_metadata - if allow_multiple_brand_profiles is not None: - self.allow_multiple_brand_profiles = allow_multiple_brand_profiles - if allow_multiple_brand_profiles_metadata is not None: - self.allow_multiple_brand_profiles_metadata = allow_multiple_brand_profiles_metadata - if allow_multiple_signer_attachments is not None: - self.allow_multiple_signer_attachments = allow_multiple_signer_attachments - if allow_multiple_signer_attachments_metadata is not None: - self.allow_multiple_signer_attachments_metadata = allow_multiple_signer_attachments_metadata - if allow_non_us_phone_auth is not None: - self.allow_non_us_phone_auth = allow_non_us_phone_auth - if allow_non_us_phone_auth_metadata is not None: - self.allow_non_us_phone_auth_metadata = allow_non_us_phone_auth_metadata - if allow_ocr_of_envelope_documents is not None: - self.allow_ocr_of_envelope_documents = allow_ocr_of_envelope_documents - if allow_ocr_of_envelope_documents_metadata is not None: - self.allow_ocr_of_envelope_documents_metadata = allow_ocr_of_envelope_documents_metadata - if allow_offline_signing is not None: - self.allow_offline_signing = allow_offline_signing - if allow_offline_signing_metadata is not None: - self.allow_offline_signing_metadata = allow_offline_signing_metadata - if allow_open_trust_signer_certificate is not None: - self.allow_open_trust_signer_certificate = allow_open_trust_signer_certificate - if allow_open_trust_signer_certificate_metadata is not None: - self.allow_open_trust_signer_certificate_metadata = allow_open_trust_signer_certificate_metadata - if allow_organizations is not None: - self.allow_organizations = allow_organizations - if allow_organizations_metadata is not None: - self.allow_organizations_metadata = allow_organizations_metadata - if allow_payment_processing is not None: - self.allow_payment_processing = allow_payment_processing - if allow_payment_processing_metadata is not None: - self.allow_payment_processing_metadata = allow_payment_processing_metadata - if allow_personal_signer_certificate is not None: - self.allow_personal_signer_certificate = allow_personal_signer_certificate - if allow_personal_signer_certificate_metadata is not None: - self.allow_personal_signer_certificate_metadata = allow_personal_signer_certificate_metadata - if allow_phone_authentication is not None: - self.allow_phone_authentication = allow_phone_authentication - if allow_phone_authentication_metadata is not None: - self.allow_phone_authentication_metadata = allow_phone_authentication_metadata - if allow_phone_auth_override is not None: - self.allow_phone_auth_override = allow_phone_auth_override - if allow_phone_auth_override_metadata is not None: - self.allow_phone_auth_override_metadata = allow_phone_auth_override_metadata - if allow_private_signing_groups is not None: - self.allow_private_signing_groups = allow_private_signing_groups - if allow_private_signing_groups_metadata is not None: - self.allow_private_signing_groups_metadata = allow_private_signing_groups_metadata - if allow_reminders is not None: - self.allow_reminders = allow_reminders - if allow_reminders_metadata is not None: - self.allow_reminders_metadata = allow_reminders_metadata - if allow_remote_notary is not None: - self.allow_remote_notary = allow_remote_notary - if allow_remote_notary_metadata is not None: - self.allow_remote_notary_metadata = allow_remote_notary_metadata - if allow_resource_file_branding is not None: - self.allow_resource_file_branding = allow_resource_file_branding - if allow_resource_file_branding_metadata is not None: - self.allow_resource_file_branding_metadata = allow_resource_file_branding_metadata - if allow_safe_bio_pharma_signer_certificate is not None: - self.allow_safe_bio_pharma_signer_certificate = allow_safe_bio_pharma_signer_certificate - if allow_safe_bio_pharma_signer_certificate_metadata is not None: - self.allow_safe_bio_pharma_signer_certificate_metadata = allow_safe_bio_pharma_signer_certificate_metadata - if allow_security_appliance is not None: - self.allow_security_appliance = allow_security_appliance - if allow_security_appliance_metadata is not None: - self.allow_security_appliance_metadata = allow_security_appliance_metadata - if allow_send_to_certified_delivery is not None: - self.allow_send_to_certified_delivery = allow_send_to_certified_delivery - if allow_send_to_certified_delivery_metadata is not None: - self.allow_send_to_certified_delivery_metadata = allow_send_to_certified_delivery_metadata - if allow_send_to_intermediary is not None: - self.allow_send_to_intermediary = allow_send_to_intermediary - if allow_send_to_intermediary_metadata is not None: - self.allow_send_to_intermediary_metadata = allow_send_to_intermediary_metadata - if allow_server_templates is not None: - self.allow_server_templates = allow_server_templates - if allow_server_templates_metadata is not None: - self.allow_server_templates_metadata = allow_server_templates_metadata - if allow_set_embedded_recipient_start_url is not None: - self.allow_set_embedded_recipient_start_url = allow_set_embedded_recipient_start_url - if allow_set_embedded_recipient_start_url_metadata is not None: - self.allow_set_embedded_recipient_start_url_metadata = allow_set_embedded_recipient_start_url_metadata - if allow_shared_tabs is not None: - self.allow_shared_tabs = allow_shared_tabs - if allow_shared_tabs_metadata is not None: - self.allow_shared_tabs_metadata = allow_shared_tabs_metadata - if allow_signature_stamps is not None: - self.allow_signature_stamps = allow_signature_stamps - if allow_signature_stamps_metadata is not None: - self.allow_signature_stamps_metadata = allow_signature_stamps_metadata - if allow_sign_document_from_home_page is not None: - self.allow_sign_document_from_home_page = allow_sign_document_from_home_page - if allow_sign_document_from_home_page_metadata is not None: - self.allow_sign_document_from_home_page_metadata = allow_sign_document_from_home_page_metadata - if allow_signer_reassign is not None: - self.allow_signer_reassign = allow_signer_reassign - if allow_signer_reassign_metadata is not None: - self.allow_signer_reassign_metadata = allow_signer_reassign_metadata - if allow_signer_reassign_override is not None: - self.allow_signer_reassign_override = allow_signer_reassign_override - if allow_signer_reassign_override_metadata is not None: - self.allow_signer_reassign_override_metadata = allow_signer_reassign_override_metadata - if allow_signing_extensions is not None: - self.allow_signing_extensions = allow_signing_extensions - if allow_signing_extensions_metadata is not None: - self.allow_signing_extensions_metadata = allow_signing_extensions_metadata - if allow_signing_groups is not None: - self.allow_signing_groups = allow_signing_groups - if allow_signing_groups_metadata is not None: - self.allow_signing_groups_metadata = allow_signing_groups_metadata - if allow_signing_radio_deselect is not None: - self.allow_signing_radio_deselect = allow_signing_radio_deselect - if allow_signing_radio_deselect_metadata is not None: - self.allow_signing_radio_deselect_metadata = allow_signing_radio_deselect_metadata - if allow_sign_now is not None: - self.allow_sign_now = allow_sign_now - if allow_sign_now_metadata is not None: - self.allow_sign_now_metadata = allow_sign_now_metadata - if allow_sms_delivery is not None: - self.allow_sms_delivery = allow_sms_delivery - if allow_sms_delivery_metadata is not None: - self.allow_sms_delivery_metadata = allow_sms_delivery_metadata - if allow_social_id_login is not None: - self.allow_social_id_login = allow_social_id_login - if allow_social_id_login_metadata is not None: - self.allow_social_id_login_metadata = allow_social_id_login_metadata - if allow_supplemental_documents is not None: - self.allow_supplemental_documents = allow_supplemental_documents - if allow_supplemental_documents_metadata is not None: - self.allow_supplemental_documents_metadata = allow_supplemental_documents_metadata - if allow_users_to_access_directory is not None: - self.allow_users_to_access_directory = allow_users_to_access_directory - if allow_users_to_access_directory_metadata is not None: - self.allow_users_to_access_directory_metadata = allow_users_to_access_directory_metadata - if allow_value_insights is not None: - self.allow_value_insights = allow_value_insights - if allow_value_insights_metadata is not None: - self.allow_value_insights_metadata = allow_value_insights_metadata - if anchor_population_scope is not None: - self.anchor_population_scope = anchor_population_scope - if anchor_population_scope_metadata is not None: - self.anchor_population_scope_metadata = anchor_population_scope_metadata - if anchor_tag_versioned_placement_enabled is not None: - self.anchor_tag_versioned_placement_enabled = anchor_tag_versioned_placement_enabled - if anchor_tag_versioned_placement_metadata_enabled is not None: - self.anchor_tag_versioned_placement_metadata_enabled = anchor_tag_versioned_placement_metadata_enabled - if attach_completed_envelope is not None: - self.attach_completed_envelope = attach_completed_envelope - if attach_completed_envelope_metadata is not None: - self.attach_completed_envelope_metadata = attach_completed_envelope_metadata - if authentication_check is not None: - self.authentication_check = authentication_check - if authentication_check_metadata is not None: - self.authentication_check_metadata = authentication_check_metadata - if auto_nav_rule is not None: - self.auto_nav_rule = auto_nav_rule - if auto_nav_rule_metadata is not None: - self.auto_nav_rule_metadata = auto_nav_rule_metadata - if auto_provision_signer_account is not None: - self.auto_provision_signer_account = auto_provision_signer_account - if auto_provision_signer_account_metadata is not None: - self.auto_provision_signer_account_metadata = auto_provision_signer_account_metadata - if bcc_email_archive is not None: - self.bcc_email_archive = bcc_email_archive - if bcc_email_archive_metadata is not None: - self.bcc_email_archive_metadata = bcc_email_archive_metadata - if beta_switch_configuration is not None: - self.beta_switch_configuration = beta_switch_configuration - if beta_switch_configuration_metadata is not None: - self.beta_switch_configuration_metadata = beta_switch_configuration_metadata - if billing_address is not None: - self.billing_address = billing_address - if billing_address_metadata is not None: - self.billing_address_metadata = billing_address_metadata - if bulk_send is not None: - self.bulk_send = bulk_send - if bulk_send_max_copies_in_batch is not None: - self.bulk_send_max_copies_in_batch = bulk_send_max_copies_in_batch - if bulk_send_max_unprocessed_envelopes_count is not None: - self.bulk_send_max_unprocessed_envelopes_count = bulk_send_max_unprocessed_envelopes_count - if bulk_send_metadata is not None: - self.bulk_send_metadata = bulk_send_metadata - if can_self_brand_send is not None: - self.can_self_brand_send = can_self_brand_send - if can_self_brand_send_metadata is not None: - self.can_self_brand_send_metadata = can_self_brand_send_metadata - if can_self_brand_sign is not None: - self.can_self_brand_sign = can_self_brand_sign - if can_self_brand_sign_metadata is not None: - self.can_self_brand_sign_metadata = can_self_brand_sign_metadata - if can_use_salesforce_o_auth is not None: - self.can_use_salesforce_o_auth = can_use_salesforce_o_auth - if can_use_salesforce_o_auth_metadata is not None: - self.can_use_salesforce_o_auth_metadata = can_use_salesforce_o_auth_metadata - if capture_voice_recording is not None: - self.capture_voice_recording = capture_voice_recording - if capture_voice_recording_metadata is not None: - self.capture_voice_recording_metadata = capture_voice_recording_metadata - if cfr_use_wide_image is not None: - self.cfr_use_wide_image = cfr_use_wide_image - if cfr_use_wide_image_metadata is not None: - self.cfr_use_wide_image_metadata = cfr_use_wide_image_metadata - if check_for_multiple_admins_on_account is not None: - self.check_for_multiple_admins_on_account = check_for_multiple_admins_on_account - if check_for_multiple_admins_on_account_metadata is not None: - self.check_for_multiple_admins_on_account_metadata = check_for_multiple_admins_on_account_metadata - if chrome_signature_enabled is not None: - self.chrome_signature_enabled = chrome_signature_enabled - if chrome_signature_enabled_metadata is not None: - self.chrome_signature_enabled_metadata = chrome_signature_enabled_metadata - if comment_email_show_message_text is not None: - self.comment_email_show_message_text = comment_email_show_message_text - if comment_email_show_message_text_metadata is not None: - self.comment_email_show_message_text_metadata = comment_email_show_message_text_metadata - if comments_allow_envelope_override is not None: - self.comments_allow_envelope_override = comments_allow_envelope_override - if comments_allow_envelope_override_metadata is not None: - self.comments_allow_envelope_override_metadata = comments_allow_envelope_override_metadata - if conditional_fields_enabled is not None: - self.conditional_fields_enabled = conditional_fields_enabled - if conditional_fields_enabled_metadata is not None: - self.conditional_fields_enabled_metadata = conditional_fields_enabled_metadata - if consumer_disclosure_frequency is not None: - self.consumer_disclosure_frequency = consumer_disclosure_frequency - if consumer_disclosure_frequency_metadata is not None: - self.consumer_disclosure_frequency_metadata = consumer_disclosure_frequency_metadata - if convert_pdf_fields is not None: - self.convert_pdf_fields = convert_pdf_fields - if convert_pdf_fields_metadata is not None: - self.convert_pdf_fields_metadata = convert_pdf_fields_metadata - if data_population_scope is not None: - self.data_population_scope = data_population_scope - if data_population_scope_metadata is not None: - self.data_population_scope_metadata = data_population_scope_metadata - if disable_mobile_app is not None: - self.disable_mobile_app = disable_mobile_app - if disable_mobile_app_metadata is not None: - self.disable_mobile_app_metadata = disable_mobile_app_metadata - if disable_mobile_push_notifications is not None: - self.disable_mobile_push_notifications = disable_mobile_push_notifications - if disable_mobile_push_notifications_metadata is not None: - self.disable_mobile_push_notifications_metadata = disable_mobile_push_notifications_metadata - if disable_mobile_sending is not None: - self.disable_mobile_sending = disable_mobile_sending - if disable_mobile_sending_metadata is not None: - self.disable_mobile_sending_metadata = disable_mobile_sending_metadata - if disable_multiple_sessions is not None: - self.disable_multiple_sessions = disable_multiple_sessions - if disable_multiple_sessions_metadata is not None: - self.disable_multiple_sessions_metadata = disable_multiple_sessions_metadata - if disable_purge_notifications_for_sender_metadata is not None: - self.disable_purge_notifications_for_sender_metadata = disable_purge_notifications_for_sender_metadata - if disable_signer_cert_view is not None: - self.disable_signer_cert_view = disable_signer_cert_view - if disable_signer_cert_view_metadata is not None: - self.disable_signer_cert_view_metadata = disable_signer_cert_view_metadata - if disable_signer_history_view is not None: - self.disable_signer_history_view = disable_signer_history_view - if disable_signer_history_view_metadata is not None: - self.disable_signer_history_view_metadata = disable_signer_history_view_metadata - if disable_style_signature is not None: - self.disable_style_signature = disable_style_signature - if disable_style_signature_metadata is not None: - self.disable_style_signature_metadata = disable_style_signature_metadata - if disable_upload_signature is not None: - self.disable_upload_signature = disable_upload_signature - if disable_upload_signature_metadata is not None: - self.disable_upload_signature_metadata = disable_upload_signature_metadata - if disable_user_sharing is not None: - self.disable_user_sharing = disable_user_sharing - if disable_user_sharing_metadata is not None: - self.disable_user_sharing_metadata = disable_user_sharing_metadata - if display_beta_switch is not None: - self.display_beta_switch = display_beta_switch - if display_beta_switch_metadata is not None: - self.display_beta_switch_metadata = display_beta_switch_metadata - if document_conversion_restrictions is not None: - self.document_conversion_restrictions = document_conversion_restrictions - if document_conversion_restrictions_metadata is not None: - self.document_conversion_restrictions_metadata = document_conversion_restrictions_metadata - if document_retention is not None: - self.document_retention = document_retention - if document_retention_metadata is not None: - self.document_retention_metadata = document_retention_metadata - if document_retention_purge_tabs is not None: - self.document_retention_purge_tabs = document_retention_purge_tabs - if document_visibility is not None: - self.document_visibility = document_visibility - if document_visibility_metadata is not None: - self.document_visibility_metadata = document_visibility_metadata - if email_template_version is not None: - self.email_template_version = email_template_version - if email_template_version_metadata is not None: - self.email_template_version_metadata = email_template_version_metadata - if enable_access_code_generator is not None: - self.enable_access_code_generator = enable_access_code_generator - if enable_access_code_generator_metadata is not None: - self.enable_access_code_generator_metadata = enable_access_code_generator_metadata - if enable_advanced_payments is not None: - self.enable_advanced_payments = enable_advanced_payments - if enable_advanced_payments_metadata is not None: - self.enable_advanced_payments_metadata = enable_advanced_payments_metadata - if enable_advanced_power_forms is not None: - self.enable_advanced_power_forms = enable_advanced_power_forms - if enable_advanced_power_forms_metadata is not None: - self.enable_advanced_power_forms_metadata = enable_advanced_power_forms_metadata - if enable_agreement_actions_for_clm is not None: - self.enable_agreement_actions_for_clm = enable_agreement_actions_for_clm - if enable_agreement_actions_for_clm_metadata is not None: - self.enable_agreement_actions_for_clm_metadata = enable_agreement_actions_for_clm_metadata - if enable_agreement_actions_for_e_sign is not None: - self.enable_agreement_actions_for_e_sign = enable_agreement_actions_for_e_sign - if enable_agreement_actions_for_e_sign_metadata is not None: - self.enable_agreement_actions_for_e_sign_metadata = enable_agreement_actions_for_e_sign_metadata - if enable_auto_nav is not None: - self.enable_auto_nav = enable_auto_nav - if enable_auto_nav_metadata is not None: - self.enable_auto_nav_metadata = enable_auto_nav_metadata - if enable_calculated_fields is not None: - self.enable_calculated_fields = enable_calculated_fields - if enable_calculated_fields_metadata is not None: - self.enable_calculated_fields_metadata = enable_calculated_fields_metadata - if enable_clickwraps is not None: - self.enable_clickwraps = enable_clickwraps - if enable_clickwraps_metadata is not None: - self.enable_clickwraps_metadata = enable_clickwraps_metadata - if enable_comments_history_download_in_signing is not None: - self.enable_comments_history_download_in_signing = enable_comments_history_download_in_signing - if enable_comments_history_download_in_signing_metadata is not None: - self.enable_comments_history_download_in_signing_metadata = enable_comments_history_download_in_signing_metadata - if enable_customer_satisfaction_metric_tracking is not None: - self.enable_customer_satisfaction_metric_tracking = enable_customer_satisfaction_metric_tracking - if enable_customer_satisfaction_metric_tracking_metadata is not None: - self.enable_customer_satisfaction_metric_tracking_metadata = enable_customer_satisfaction_metric_tracking_metadata - if enable_ds_pro is not None: - self.enable_ds_pro = enable_ds_pro - if enable_ds_pro_metadata is not None: - self.enable_ds_pro_metadata = enable_ds_pro_metadata - if enable_envelope_stamping_by_account_admin is not None: - self.enable_envelope_stamping_by_account_admin = enable_envelope_stamping_by_account_admin - if enable_envelope_stamping_by_account_admin_metadata is not None: - self.enable_envelope_stamping_by_account_admin_metadata = enable_envelope_stamping_by_account_admin_metadata - if enable_envelope_stamping_by_ds_admin is not None: - self.enable_envelope_stamping_by_ds_admin = enable_envelope_stamping_by_ds_admin - if enable_envelope_stamping_by_ds_admin_metadata is not None: - self.enable_envelope_stamping_by_ds_admin_metadata = enable_envelope_stamping_by_ds_admin_metadata - if enable_in_browser_editor is not None: - self.enable_in_browser_editor = enable_in_browser_editor - if enable_in_browser_editor_metadata is not None: - self.enable_in_browser_editor_metadata = enable_in_browser_editor_metadata - if enable_payment_processing is not None: - self.enable_payment_processing = enable_payment_processing - if enable_payment_processing_metadata is not None: - self.enable_payment_processing_metadata = enable_payment_processing_metadata - if enable_power_form is not None: - self.enable_power_form = enable_power_form - if enable_power_form_direct is not None: - self.enable_power_form_direct = enable_power_form_direct - if enable_power_form_direct_metadata is not None: - self.enable_power_form_direct_metadata = enable_power_form_direct_metadata - if enable_power_form_metadata is not None: - self.enable_power_form_metadata = enable_power_form_metadata - if enable_recipient_domain_validation is not None: - self.enable_recipient_domain_validation = enable_recipient_domain_validation - if enable_recipient_domain_validation_metadata is not None: - self.enable_recipient_domain_validation_metadata = enable_recipient_domain_validation_metadata - if enable_report_links is not None: - self.enable_report_links = enable_report_links - if enable_report_links_metadata is not None: - self.enable_report_links_metadata = enable_report_links_metadata - if enable_require_sign_on_paper is not None: - self.enable_require_sign_on_paper = enable_require_sign_on_paper - if enable_require_sign_on_paper_metadata is not None: - self.enable_require_sign_on_paper_metadata = enable_require_sign_on_paper_metadata - if enable_reserved_domain is not None: - self.enable_reserved_domain = enable_reserved_domain - if enable_reserved_domain_metadata is not None: - self.enable_reserved_domain_metadata = enable_reserved_domain_metadata - if enable_responsive_signing is not None: - self.enable_responsive_signing = enable_responsive_signing - if enable_responsive_signing_metadata is not None: - self.enable_responsive_signing_metadata = enable_responsive_signing_metadata - if enable_scheduled_release is not None: - self.enable_scheduled_release = enable_scheduled_release - if enable_scheduled_release_metadata is not None: - self.enable_scheduled_release_metadata = enable_scheduled_release_metadata - if enable_search_ui is not None: - self.enable_search_ui = enable_search_ui - if enable_search_ui_metadata is not None: - self.enable_search_ui_metadata = enable_search_ui_metadata - if enable_sending_tags_font_settings is not None: - self.enable_sending_tags_font_settings = enable_sending_tags_font_settings - if enable_sending_tags_font_settings_metadata is not None: - self.enable_sending_tags_font_settings_metadata = enable_sending_tags_font_settings_metadata - if enable_send_to_agent is not None: - self.enable_send_to_agent = enable_send_to_agent - if enable_send_to_agent_metadata is not None: - self.enable_send_to_agent_metadata = enable_send_to_agent_metadata - if enable_send_to_intermediary is not None: - self.enable_send_to_intermediary = enable_send_to_intermediary - if enable_send_to_intermediary_metadata is not None: - self.enable_send_to_intermediary_metadata = enable_send_to_intermediary_metadata - if enable_send_to_manage is not None: - self.enable_send_to_manage = enable_send_to_manage - if enable_send_to_manage_metadata is not None: - self.enable_send_to_manage_metadata = enable_send_to_manage_metadata - if enable_sequential_signing_api is not None: - self.enable_sequential_signing_api = enable_sequential_signing_api - if enable_sequential_signing_api_metadata is not None: - self.enable_sequential_signing_api_metadata = enable_sequential_signing_api_metadata - if enable_sequential_signing_ui is not None: - self.enable_sequential_signing_ui = enable_sequential_signing_ui - if enable_sequential_signing_ui_metadata is not None: - self.enable_sequential_signing_ui_metadata = enable_sequential_signing_ui_metadata - if enable_signer_attachments is not None: - self.enable_signer_attachments = enable_signer_attachments - if enable_signer_attachments_metadata is not None: - self.enable_signer_attachments_metadata = enable_signer_attachments_metadata - if enable_signing_extension_comments is not None: - self.enable_signing_extension_comments = enable_signing_extension_comments - if enable_signing_extension_comments_metadata is not None: - self.enable_signing_extension_comments_metadata = enable_signing_extension_comments_metadata - if enable_signing_extension_conversations is not None: - self.enable_signing_extension_conversations = enable_signing_extension_conversations - if enable_signing_extension_conversations_metadata is not None: - self.enable_signing_extension_conversations_metadata = enable_signing_extension_conversations_metadata - if enable_signing_order_settings_for_account is not None: - self.enable_signing_order_settings_for_account = enable_signing_order_settings_for_account - if enable_signing_order_settings_for_account_metadata is not None: - self.enable_signing_order_settings_for_account_metadata = enable_signing_order_settings_for_account_metadata - if enable_sign_on_paper is not None: - self.enable_sign_on_paper = enable_sign_on_paper - if enable_sign_on_paper_metadata is not None: - self.enable_sign_on_paper_metadata = enable_sign_on_paper_metadata - if enable_sign_on_paper_override is not None: - self.enable_sign_on_paper_override = enable_sign_on_paper_override - if enable_sign_on_paper_override_metadata is not None: - self.enable_sign_on_paper_override_metadata = enable_sign_on_paper_override_metadata - if enable_sign_with_notary is not None: - self.enable_sign_with_notary = enable_sign_with_notary - if enable_sign_with_notary_metadata is not None: - self.enable_sign_with_notary_metadata = enable_sign_with_notary_metadata - if enable_smart_contracts is not None: - self.enable_smart_contracts = enable_smart_contracts - if enable_smart_contracts_metadata is not None: - self.enable_smart_contracts_metadata = enable_smart_contracts_metadata - if enable_sms_authentication is not None: - self.enable_sms_authentication = enable_sms_authentication - if enable_sms_authentication_metadata is not None: - self.enable_sms_authentication_metadata = enable_sms_authentication_metadata - if enable_social_id_login is not None: - self.enable_social_id_login = enable_social_id_login - if enable_social_id_login_metadata is not None: - self.enable_social_id_login_metadata = enable_social_id_login_metadata - if enable_strike_through is not None: - self.enable_strike_through = enable_strike_through - if enable_strike_through_metadata is not None: - self.enable_strike_through_metadata = enable_strike_through_metadata - if enable_transaction_point is not None: - self.enable_transaction_point = enable_transaction_point - if enable_transaction_point_metadata is not None: - self.enable_transaction_point_metadata = enable_transaction_point_metadata - if enable_vaulting is not None: - self.enable_vaulting = enable_vaulting - if enable_vaulting_metadata is not None: - self.enable_vaulting_metadata = enable_vaulting_metadata - if enable_witnessing is not None: - self.enable_witnessing = enable_witnessing - if enable_witnessing_metadata is not None: - self.enable_witnessing_metadata = enable_witnessing_metadata - if enforce_template_name_uniqueness is not None: - self.enforce_template_name_uniqueness = enforce_template_name_uniqueness - if enforce_template_name_uniqueness_metadata is not None: - self.enforce_template_name_uniqueness_metadata = enforce_template_name_uniqueness_metadata - if envelope_integration_allowed is not None: - self.envelope_integration_allowed = envelope_integration_allowed - if envelope_integration_allowed_metadata is not None: - self.envelope_integration_allowed_metadata = envelope_integration_allowed_metadata - if envelope_integration_enabled is not None: - self.envelope_integration_enabled = envelope_integration_enabled - if envelope_integration_enabled_metadata is not None: - self.envelope_integration_enabled_metadata = envelope_integration_enabled_metadata - if envelope_stamping_default_value is not None: - self.envelope_stamping_default_value = envelope_stamping_default_value - if envelope_stamping_default_value_metadata is not None: - self.envelope_stamping_default_value_metadata = envelope_stamping_default_value_metadata - if express_send is not None: - self.express_send = express_send - if express_send_allow_tabs is not None: - self.express_send_allow_tabs = express_send_allow_tabs - if express_send_allow_tabs_metadata is not None: - self.express_send_allow_tabs_metadata = express_send_allow_tabs_metadata - if express_send_metadata is not None: - self.express_send_metadata = express_send_metadata - if external_document_sources is not None: - self.external_document_sources = external_document_sources - if external_signature_pad_type is not None: - self.external_signature_pad_type = external_signature_pad_type - if external_signature_pad_type_metadata is not None: - self.external_signature_pad_type_metadata = external_signature_pad_type_metadata - if fax_out_enabled is not None: - self.fax_out_enabled = fax_out_enabled - if fax_out_enabled_metadata is not None: - self.fax_out_enabled_metadata = fax_out_enabled_metadata - if guided_forms_html_allowed is not None: - self.guided_forms_html_allowed = guided_forms_html_allowed - if guided_forms_html_allowed_metadata is not None: - self.guided_forms_html_allowed_metadata = guided_forms_html_allowed_metadata - if hide_account_address_in_co_c is not None: - self.hide_account_address_in_co_c = hide_account_address_in_co_c - if hide_account_address_in_co_c_metadata is not None: - self.hide_account_address_in_co_c_metadata = hide_account_address_in_co_c_metadata - if hide_pricing is not None: - self.hide_pricing = hide_pricing - if hide_pricing_metadata is not None: - self.hide_pricing_metadata = hide_pricing_metadata - if id_check_configurations is not None: - self.id_check_configurations = id_check_configurations - if id_check_expire is not None: - self.id_check_expire = id_check_expire - if id_check_expire_days is not None: - self.id_check_expire_days = id_check_expire_days - if id_check_expire_days_metadata is not None: - self.id_check_expire_days_metadata = id_check_expire_days_metadata - if id_check_expire_metadata is not None: - self.id_check_expire_metadata = id_check_expire_metadata - if id_check_expire_minutes is not None: - self.id_check_expire_minutes = id_check_expire_minutes - if id_check_expire_minutes_metadata is not None: - self.id_check_expire_minutes_metadata = id_check_expire_minutes_metadata - if id_check_required is not None: - self.id_check_required = id_check_required - if id_check_required_metadata is not None: - self.id_check_required_metadata = id_check_required_metadata - if identity_verification is not None: - self.identity_verification = identity_verification - if identity_verification_metadata is not None: - self.identity_verification_metadata = identity_verification_metadata - if ignore_error_if_anchor_tab_not_found is not None: - self.ignore_error_if_anchor_tab_not_found = ignore_error_if_anchor_tab_not_found - if ignore_error_if_anchor_tab_not_found_metadata_enabled is not None: - self.ignore_error_if_anchor_tab_not_found_metadata_enabled = ignore_error_if_anchor_tab_not_found_metadata_enabled - if in_person_id_check_question is not None: - self.in_person_id_check_question = in_person_id_check_question - if in_person_id_check_question_metadata is not None: - self.in_person_id_check_question_metadata = in_person_id_check_question_metadata - if in_person_signing_enabled is not None: - self.in_person_signing_enabled = in_person_signing_enabled - if in_person_signing_enabled_metadata is not None: - self.in_person_signing_enabled_metadata = in_person_signing_enabled_metadata - if in_session_enabled is not None: - self.in_session_enabled = in_session_enabled - if in_session_enabled_metadata is not None: - self.in_session_enabled_metadata = in_session_enabled_metadata - if in_session_suppress_emails is not None: - self.in_session_suppress_emails = in_session_suppress_emails - if in_session_suppress_emails_metadata is not None: - self.in_session_suppress_emails_metadata = in_session_suppress_emails_metadata - if maximum_signing_groups is not None: - self.maximum_signing_groups = maximum_signing_groups - if maximum_signing_groups_metadata is not None: - self.maximum_signing_groups_metadata = maximum_signing_groups_metadata - if maximum_users_per_signing_group is not None: - self.maximum_users_per_signing_group = maximum_users_per_signing_group - if maximum_users_per_signing_group_metadata is not None: - self.maximum_users_per_signing_group_metadata = maximum_users_per_signing_group_metadata - if max_number_of_custom_stamps is not None: - self.max_number_of_custom_stamps = max_number_of_custom_stamps - if mobile_session_timeout is not None: - self.mobile_session_timeout = mobile_session_timeout - if mobile_session_timeout_metadata is not None: - self.mobile_session_timeout_metadata = mobile_session_timeout_metadata - if number_of_active_custom_stamps is not None: - self.number_of_active_custom_stamps = number_of_active_custom_stamps - if opt_in_mobile_signing_v02 is not None: - self.opt_in_mobile_signing_v02 = opt_in_mobile_signing_v02 - if opt_in_mobile_signing_v02_metadata is not None: - self.opt_in_mobile_signing_v02_metadata = opt_in_mobile_signing_v02_metadata - if opt_out_auto_nav_text_and_tab_color_updates is not None: - self.opt_out_auto_nav_text_and_tab_color_updates = opt_out_auto_nav_text_and_tab_color_updates - if opt_out_auto_nav_text_and_tab_color_updates_metadata is not None: - self.opt_out_auto_nav_text_and_tab_color_updates_metadata = opt_out_auto_nav_text_and_tab_color_updates_metadata - if opt_out_new_platform_seal is not None: - self.opt_out_new_platform_seal = opt_out_new_platform_seal - if opt_out_new_platform_seal_platform_metadata is not None: - self.opt_out_new_platform_seal_platform_metadata = opt_out_new_platform_seal_platform_metadata - if phone_auth_recipient_may_provide_phone_number is not None: - self.phone_auth_recipient_may_provide_phone_number = phone_auth_recipient_may_provide_phone_number - if phone_auth_recipient_may_provide_phone_number_metadata is not None: - self.phone_auth_recipient_may_provide_phone_number_metadata = phone_auth_recipient_may_provide_phone_number_metadata - if pki_sign_downloaded_pdf_docs is not None: - self.pki_sign_downloaded_pdf_docs = pki_sign_downloaded_pdf_docs - if pki_sign_downloaded_pdf_docs_metadata is not None: - self.pki_sign_downloaded_pdf_docs_metadata = pki_sign_downloaded_pdf_docs_metadata - if recipients_can_sign_offline is not None: - self.recipients_can_sign_offline = recipients_can_sign_offline - if recipients_can_sign_offline_metadata is not None: - self.recipients_can_sign_offline_metadata = recipients_can_sign_offline_metadata - if recipient_signing_auto_navigation_control is not None: - self.recipient_signing_auto_navigation_control = recipient_signing_auto_navigation_control - if recipient_signing_auto_navigation_control_metadata is not None: - self.recipient_signing_auto_navigation_control_metadata = recipient_signing_auto_navigation_control_metadata - if require21_cf_rpt11_compliance is not None: - self.require21_cf_rpt11_compliance = require21_cf_rpt11_compliance - if require21_cf_rpt11_compliance_metadata is not None: - self.require21_cf_rpt11_compliance_metadata = require21_cf_rpt11_compliance_metadata - if require_decline_reason is not None: - self.require_decline_reason = require_decline_reason - if require_decline_reason_metadata is not None: - self.require_decline_reason_metadata = require_decline_reason_metadata - if require_external_user_management is not None: - self.require_external_user_management = require_external_user_management - if require_external_user_management_metadata is not None: - self.require_external_user_management_metadata = require_external_user_management_metadata - if require_signer_certificate_type is not None: - self.require_signer_certificate_type = require_signer_certificate_type - if require_signer_certificate_type_metadata is not None: - self.require_signer_certificate_type_metadata = require_signer_certificate_type_metadata - if rsa_verid_account_name is not None: - self.rsa_verid_account_name = rsa_verid_account_name - if rsa_verid_password is not None: - self.rsa_verid_password = rsa_verid_password - if rsa_verid_ruleset is not None: - self.rsa_verid_ruleset = rsa_verid_ruleset - if rsa_verid_user_id is not None: - self.rsa_verid_user_id = rsa_verid_user_id - if self_signed_recipient_email_document is not None: - self.self_signed_recipient_email_document = self_signed_recipient_email_document - if self_signed_recipient_email_document_metadata is not None: - self.self_signed_recipient_email_document_metadata = self_signed_recipient_email_document_metadata - if self_signed_recipient_email_document_user_override is not None: - self.self_signed_recipient_email_document_user_override = self_signed_recipient_email_document_user_override - if self_signed_recipient_email_document_user_override_metadata is not None: - self.self_signed_recipient_email_document_user_override_metadata = self_signed_recipient_email_document_user_override_metadata - if sender_can_sign_in_each_location is not None: - self.sender_can_sign_in_each_location = sender_can_sign_in_each_location - if sender_can_sign_in_each_location_metadata is not None: - self.sender_can_sign_in_each_location_metadata = sender_can_sign_in_each_location_metadata - if sender_must_authenticate_signing is not None: - self.sender_must_authenticate_signing = sender_must_authenticate_signing - if sender_must_authenticate_signing_metadata is not None: - self.sender_must_authenticate_signing_metadata = sender_must_authenticate_signing_metadata - if sending_tags_font_color is not None: - self.sending_tags_font_color = sending_tags_font_color - if sending_tags_font_color_metadata is not None: - self.sending_tags_font_color_metadata = sending_tags_font_color_metadata - if sending_tags_font_name is not None: - self.sending_tags_font_name = sending_tags_font_name - if sending_tags_font_name_metadata is not None: - self.sending_tags_font_name_metadata = sending_tags_font_name_metadata - if sending_tags_font_size is not None: - self.sending_tags_font_size = sending_tags_font_size - if sending_tags_font_size_metadata is not None: - self.sending_tags_font_size_metadata = sending_tags_font_size_metadata - if send_to_certified_delivery_enabled is not None: - self.send_to_certified_delivery_enabled = send_to_certified_delivery_enabled - if send_to_certified_delivery_enabled_metadata is not None: - self.send_to_certified_delivery_enabled_metadata = send_to_certified_delivery_enabled_metadata - if session_timeout is not None: - self.session_timeout = session_timeout - if session_timeout_metadata is not None: - self.session_timeout_metadata = session_timeout_metadata - if set_recip_email_lang is not None: - self.set_recip_email_lang = set_recip_email_lang - if set_recip_email_lang_metadata is not None: - self.set_recip_email_lang_metadata = set_recip_email_lang_metadata - if set_recip_sign_lang is not None: - self.set_recip_sign_lang = set_recip_sign_lang - if set_recip_sign_lang_metadata is not None: - self.set_recip_sign_lang_metadata = set_recip_sign_lang_metadata - if shared_template_folders is not None: - self.shared_template_folders = shared_template_folders - if shared_template_folders_metadata is not None: - self.shared_template_folders_metadata = shared_template_folders_metadata - if show_complete_dialog_in_embedded_session is not None: - self.show_complete_dialog_in_embedded_session = show_complete_dialog_in_embedded_session - if show_complete_dialog_in_embedded_session_metadata is not None: - self.show_complete_dialog_in_embedded_session_metadata = show_complete_dialog_in_embedded_session_metadata - if show_conditional_routing_on_send is not None: - self.show_conditional_routing_on_send = show_conditional_routing_on_send - if show_conditional_routing_on_send_metadata is not None: - self.show_conditional_routing_on_send_metadata = show_conditional_routing_on_send_metadata - if show_initial_conditional_fields is not None: - self.show_initial_conditional_fields = show_initial_conditional_fields - if show_initial_conditional_fields_metadata is not None: - self.show_initial_conditional_fields_metadata = show_initial_conditional_fields_metadata - if show_localized_watermarks is not None: - self.show_localized_watermarks = show_localized_watermarks - if show_localized_watermarks_metadata is not None: - self.show_localized_watermarks_metadata = show_localized_watermarks_metadata - if show_tutorials is not None: - self.show_tutorials = show_tutorials - if show_tutorials_metadata is not None: - self.show_tutorials_metadata = show_tutorials_metadata - if signature_providers is not None: - self.signature_providers = signature_providers - if signature_providers_metadata is not None: - self.signature_providers_metadata = signature_providers_metadata - if sign_date_format is not None: - self.sign_date_format = sign_date_format - if sign_date_format_metadata is not None: - self.sign_date_format_metadata = sign_date_format_metadata - if signer_attach_certificate_to_envelope_pdf is not None: - self.signer_attach_certificate_to_envelope_pdf = signer_attach_certificate_to_envelope_pdf - if signer_attach_certificate_to_envelope_pdf_metadata is not None: - self.signer_attach_certificate_to_envelope_pdf_metadata = signer_attach_certificate_to_envelope_pdf_metadata - if signer_attach_concat is not None: - self.signer_attach_concat = signer_attach_concat - if signer_attach_concat_metadata is not None: - self.signer_attach_concat_metadata = signer_attach_concat_metadata - if signer_can_create_account is not None: - self.signer_can_create_account = signer_can_create_account - if signer_can_create_account_metadata is not None: - self.signer_can_create_account_metadata = signer_can_create_account_metadata - if signer_can_sign_on_mobile is not None: - self.signer_can_sign_on_mobile = signer_can_sign_on_mobile - if signer_can_sign_on_mobile_metadata is not None: - self.signer_can_sign_on_mobile_metadata = signer_can_sign_on_mobile_metadata - if signer_in_session_use_envelope_complete_email is not None: - self.signer_in_session_use_envelope_complete_email = signer_in_session_use_envelope_complete_email - if signer_in_session_use_envelope_complete_email_metadata is not None: - self.signer_in_session_use_envelope_complete_email_metadata = signer_in_session_use_envelope_complete_email_metadata - if signer_login_requirements is not None: - self.signer_login_requirements = signer_login_requirements - if signer_login_requirements_metadata is not None: - self.signer_login_requirements_metadata = signer_login_requirements_metadata - if signer_must_have_account is not None: - self.signer_must_have_account = signer_must_have_account - if signer_must_have_account_metadata is not None: - self.signer_must_have_account_metadata = signer_must_have_account_metadata - if signer_must_login_to_sign is not None: - self.signer_must_login_to_sign = signer_must_login_to_sign - if signer_must_login_to_sign_metadata is not None: - self.signer_must_login_to_sign_metadata = signer_must_login_to_sign_metadata - if signer_show_secure_field_initial_values is not None: - self.signer_show_secure_field_initial_values = signer_show_secure_field_initial_values - if signer_show_secure_field_initial_values_metadata is not None: - self.signer_show_secure_field_initial_values_metadata = signer_show_secure_field_initial_values_metadata - if signing_session_timeout is not None: - self.signing_session_timeout = signing_session_timeout - if signing_session_timeout_metadata is not None: - self.signing_session_timeout_metadata = signing_session_timeout_metadata - if signing_ui_version is not None: - self.signing_ui_version = signing_ui_version - if signing_ui_version_metadata is not None: - self.signing_ui_version_metadata = signing_ui_version_metadata - if sign_time_format is not None: - self.sign_time_format = sign_time_format - if sign_time_format_metadata is not None: - self.sign_time_format_metadata = sign_time_format_metadata - if sign_time_show_am_pm is not None: - self.sign_time_show_am_pm = sign_time_show_am_pm - if sign_time_show_am_pm_metadata is not None: - self.sign_time_show_am_pm_metadata = sign_time_show_am_pm_metadata - if simplified_sending_enabled is not None: - self.simplified_sending_enabled = simplified_sending_enabled - if simplified_sending_enabled_metadata is not None: - self.simplified_sending_enabled_metadata = simplified_sending_enabled_metadata - if single_sign_on_enabled is not None: - self.single_sign_on_enabled = single_sign_on_enabled - if single_sign_on_enabled_metadata is not None: - self.single_sign_on_enabled_metadata = single_sign_on_enabled_metadata - if skip_auth_completed_envelopes is not None: - self.skip_auth_completed_envelopes = skip_auth_completed_envelopes - if skip_auth_completed_envelopes_metadata is not None: - self.skip_auth_completed_envelopes_metadata = skip_auth_completed_envelopes_metadata - if social_id_recip_auth is not None: - self.social_id_recip_auth = social_id_recip_auth - if social_id_recip_auth_metadata is not None: - self.social_id_recip_auth_metadata = social_id_recip_auth_metadata - if specify_document_visibility is not None: - self.specify_document_visibility = specify_document_visibility - if specify_document_visibility_metadata is not None: - self.specify_document_visibility_metadata = specify_document_visibility_metadata - if start_in_advanced_correct is not None: - self.start_in_advanced_correct = start_in_advanced_correct - if start_in_advanced_correct_metadata is not None: - self.start_in_advanced_correct_metadata = start_in_advanced_correct_metadata - if supplemental_documents_must_accept is not None: - self.supplemental_documents_must_accept = supplemental_documents_must_accept - if supplemental_documents_must_accept_metadata is not None: - self.supplemental_documents_must_accept_metadata = supplemental_documents_must_accept_metadata - if supplemental_documents_must_read is not None: - self.supplemental_documents_must_read = supplemental_documents_must_read - if supplemental_documents_must_read_metadata is not None: - self.supplemental_documents_must_read_metadata = supplemental_documents_must_read_metadata - if supplemental_documents_must_view is not None: - self.supplemental_documents_must_view = supplemental_documents_must_view - if supplemental_documents_must_view_metadata is not None: - self.supplemental_documents_must_view_metadata = supplemental_documents_must_view_metadata - if suppress_certificate_enforcement is not None: - self.suppress_certificate_enforcement = suppress_certificate_enforcement - if suppress_certificate_enforcement_metadata is not None: - self.suppress_certificate_enforcement_metadata = suppress_certificate_enforcement_metadata - if tab_account_settings is not None: - self.tab_account_settings = tab_account_settings - if timezone_offset_api is not None: - self.timezone_offset_api = timezone_offset_api - if timezone_offset_api_metadata is not None: - self.timezone_offset_api_metadata = timezone_offset_api_metadata - if timezone_offset_ui is not None: - self.timezone_offset_ui = timezone_offset_ui - if timezone_offset_ui_metadata is not None: - self.timezone_offset_ui_metadata = timezone_offset_ui_metadata - if universal_signature_opt_in is not None: - self.universal_signature_opt_in = universal_signature_opt_in - if use_account_level_email is not None: - self.use_account_level_email = use_account_level_email - if use_account_level_email_metadata is not None: - self.use_account_level_email_metadata = use_account_level_email_metadata - if use_consumer_disclosure is not None: - self.use_consumer_disclosure = use_consumer_disclosure - if use_consumer_disclosure_metadata is not None: - self.use_consumer_disclosure_metadata = use_consumer_disclosure_metadata - if use_consumer_disclosure_within_account is not None: - self.use_consumer_disclosure_within_account = use_consumer_disclosure_within_account - if use_consumer_disclosure_within_account_metadata is not None: - self.use_consumer_disclosure_within_account_metadata = use_consumer_disclosure_within_account_metadata - if use_derived_keys is not None: - self.use_derived_keys = use_derived_keys - if use_derived_keys_metadata is not None: - self.use_derived_keys_metadata = use_derived_keys_metadata - if use_docu_sign_express_signer_certificate is not None: - self.use_docu_sign_express_signer_certificate = use_docu_sign_express_signer_certificate - if use_docu_sign_express_signer_certificate_metadata is not None: - self.use_docu_sign_express_signer_certificate_metadata = use_docu_sign_express_signer_certificate_metadata - if use_multi_app_groups_data is not None: - self.use_multi_app_groups_data = use_multi_app_groups_data - if use_multi_app_groups_data_metadata is not None: - self.use_multi_app_groups_data_metadata = use_multi_app_groups_data_metadata - if use_new_blob_for_pdf is not None: - self.use_new_blob_for_pdf = use_new_blob_for_pdf - if use_new_blob_for_pdf_metadata is not None: - self.use_new_blob_for_pdf_metadata = use_new_blob_for_pdf_metadata - if use_safe_signer_certificates is not None: - self.use_safe_signer_certificates = use_safe_signer_certificates - if use_safe_signer_certificates_metadata is not None: - self.use_safe_signer_certificates_metadata = use_safe_signer_certificates_metadata - if uses_api is not None: - self.uses_api = uses_api - if uses_api_metadata is not None: - self.uses_api_metadata = uses_api_metadata - if use_signature_provider_platform is not None: - self.use_signature_provider_platform = use_signature_provider_platform - if use_signature_provider_platform_metadata is not None: - self.use_signature_provider_platform_metadata = use_signature_provider_platform_metadata - if validations_allowed is not None: - self.validations_allowed = validations_allowed - if validations_allowed_metadata is not None: - self.validations_allowed_metadata = validations_allowed_metadata - if validations_brand is not None: - self.validations_brand = validations_brand - if validations_brand_metadata is not None: - self.validations_brand_metadata = validations_brand_metadata - if validations_cadence is not None: - self.validations_cadence = validations_cadence - if validations_cadence_metadata is not None: - self.validations_cadence_metadata = validations_cadence_metadata - if validations_enabled is not None: - self.validations_enabled = validations_enabled - if validations_enabled_metadata is not None: - self.validations_enabled_metadata = validations_enabled_metadata - if validations_report is not None: - self.validations_report = validations_report - if validations_report_metadata is not None: - self.validations_report_metadata = validations_report_metadata - if water_mark_enabled is not None: - self.water_mark_enabled = water_mark_enabled - if water_mark_enabled_metadata is not None: - self.water_mark_enabled_metadata = water_mark_enabled_metadata - if write_reminder_to_envelope_history is not None: - self.write_reminder_to_envelope_history = write_reminder_to_envelope_history - if write_reminder_to_envelope_history_metadata is not None: - self.write_reminder_to_envelope_history_metadata = write_reminder_to_envelope_history_metadata - if wurfl_min_allowable_screen_size is not None: - self.wurfl_min_allowable_screen_size = wurfl_min_allowable_screen_size - if wurfl_min_allowable_screen_size_metadata is not None: - self.wurfl_min_allowable_screen_size_metadata = wurfl_min_allowable_screen_size_metadata + for key in self.swagger_types: + value = kwargs.get(key, None) + setattr(self, "_{}".format(key), value) @property def access_code_format(self): @@ -4218,6 +3217,94 @@ def allow_idv_level1_metadata(self, allow_idv_level1_metadata): self._allow_idv_level1_metadata = allow_idv_level1_metadata + @property + def allow_idv_level2(self): + """Gets the allow_idv_level2 of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The allow_idv_level2 of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._allow_idv_level2 + + @allow_idv_level2.setter + def allow_idv_level2(self, allow_idv_level2): + """Sets the allow_idv_level2 of this AccountSettingsInformation. + + # noqa: E501 + + :param allow_idv_level2: The allow_idv_level2 of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._allow_idv_level2 = allow_idv_level2 + + @property + def allow_idv_level2_metadata(self): + """Gets the allow_idv_level2_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The allow_idv_level2_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._allow_idv_level2_metadata + + @allow_idv_level2_metadata.setter + def allow_idv_level2_metadata(self, allow_idv_level2_metadata): + """Sets the allow_idv_level2_metadata of this AccountSettingsInformation. + + + :param allow_idv_level2_metadata: The allow_idv_level2_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._allow_idv_level2_metadata = allow_idv_level2_metadata + + @property + def allow_idv_level3(self): + """Gets the allow_idv_level3 of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The allow_idv_level3 of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._allow_idv_level3 + + @allow_idv_level3.setter + def allow_idv_level3(self, allow_idv_level3): + """Sets the allow_idv_level3 of this AccountSettingsInformation. + + # noqa: E501 + + :param allow_idv_level3: The allow_idv_level3 of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._allow_idv_level3 = allow_idv_level3 + + @property + def allow_idv_level3_metadata(self): + """Gets the allow_idv_level3_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The allow_idv_level3_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._allow_idv_level3_metadata + + @allow_idv_level3_metadata.setter + def allow_idv_level3_metadata(self, allow_idv_level3_metadata): + """Sets the allow_idv_level3_metadata of this AccountSettingsInformation. + + + :param allow_idv_level3_metadata: The allow_idv_level3_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._allow_idv_level3_metadata = allow_idv_level3_metadata + @property def allow_idv_platform(self): """Gets the allow_idv_platform of this AccountSettingsInformation. # noqa: E501 @@ -5010,6 +4097,50 @@ def allow_private_signing_groups_metadata(self, allow_private_signing_groups_met self._allow_private_signing_groups_metadata = allow_private_signing_groups_metadata + @property + def allow_recipient_connect(self): + """Gets the allow_recipient_connect of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The allow_recipient_connect of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._allow_recipient_connect + + @allow_recipient_connect.setter + def allow_recipient_connect(self, allow_recipient_connect): + """Sets the allow_recipient_connect of this AccountSettingsInformation. + + # noqa: E501 + + :param allow_recipient_connect: The allow_recipient_connect of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._allow_recipient_connect = allow_recipient_connect + + @property + def allow_recipient_connect_metadata(self): + """Gets the allow_recipient_connect_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The allow_recipient_connect_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._allow_recipient_connect_metadata + + @allow_recipient_connect_metadata.setter + def allow_recipient_connect_metadata(self, allow_recipient_connect_metadata): + """Sets the allow_recipient_connect_metadata of this AccountSettingsInformation. + + + :param allow_recipient_connect_metadata: The allow_recipient_connect_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._allow_recipient_connect_metadata = allow_recipient_connect_metadata + @property def allow_reminders(self): """Gets the allow_reminders of this AccountSettingsInformation. # noqa: E501 @@ -5714,6 +4845,50 @@ def allow_signing_groups_metadata(self, allow_signing_groups_metadata): self._allow_signing_groups_metadata = allow_signing_groups_metadata + @property + def allow_signing_insights(self): + """Gets the allow_signing_insights of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The allow_signing_insights of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._allow_signing_insights + + @allow_signing_insights.setter + def allow_signing_insights(self, allow_signing_insights): + """Sets the allow_signing_insights of this AccountSettingsInformation. + + # noqa: E501 + + :param allow_signing_insights: The allow_signing_insights of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._allow_signing_insights = allow_signing_insights + + @property + def allow_signing_insights_metadata(self): + """Gets the allow_signing_insights_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The allow_signing_insights_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._allow_signing_insights_metadata + + @allow_signing_insights_metadata.setter + def allow_signing_insights_metadata(self, allow_signing_insights_metadata): + """Sets the allow_signing_insights_metadata of this AccountSettingsInformation. + + + :param allow_signing_insights_metadata: The allow_signing_insights_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._allow_signing_insights_metadata = allow_signing_insights_metadata + @property def allow_signing_radio_deselect(self): """Gets the allow_signing_radio_deselect of this AccountSettingsInformation. # noqa: E501 @@ -7080,6 +6255,50 @@ def data_population_scope_metadata(self, data_population_scope_metadata): self._data_population_scope_metadata = data_population_scope_metadata + @property + def disable_auto_template_matching(self): + """Gets the disable_auto_template_matching of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The disable_auto_template_matching of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._disable_auto_template_matching + + @disable_auto_template_matching.setter + def disable_auto_template_matching(self, disable_auto_template_matching): + """Sets the disable_auto_template_matching of this AccountSettingsInformation. + + # noqa: E501 + + :param disable_auto_template_matching: The disable_auto_template_matching of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._disable_auto_template_matching = disable_auto_template_matching + + @property + def disable_auto_template_matching_metadata(self): + """Gets the disable_auto_template_matching_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The disable_auto_template_matching_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._disable_auto_template_matching_metadata + + @disable_auto_template_matching_metadata.setter + def disable_auto_template_matching_metadata(self, disable_auto_template_matching_metadata): + """Sets the disable_auto_template_matching_metadata of this AccountSettingsInformation. + + + :param disable_auto_template_matching_metadata: The disable_auto_template_matching_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._disable_auto_template_matching_metadata = disable_auto_template_matching_metadata + @property def disable_mobile_app(self): """Gets the disable_mobile_app of this AccountSettingsInformation. # noqa: E501 @@ -8312,6 +7531,50 @@ def enable_envelope_stamping_by_ds_admin_metadata(self, enable_envelope_stamping self._enable_envelope_stamping_by_ds_admin_metadata = enable_envelope_stamping_by_ds_admin_metadata + @property + def enable_esign_communities(self): + """Gets the enable_esign_communities of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The enable_esign_communities of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._enable_esign_communities + + @enable_esign_communities.setter + def enable_esign_communities(self, enable_esign_communities): + """Sets the enable_esign_communities of this AccountSettingsInformation. + + # noqa: E501 + + :param enable_esign_communities: The enable_esign_communities of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._enable_esign_communities = enable_esign_communities + + @property + def enable_esign_communities_metadata(self): + """Gets the enable_esign_communities_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The enable_esign_communities_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._enable_esign_communities_metadata + + @enable_esign_communities_metadata.setter + def enable_esign_communities_metadata(self, enable_esign_communities_metadata): + """Sets the enable_esign_communities_metadata of this AccountSettingsInformation. + + + :param enable_esign_communities_metadata: The enable_esign_communities_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._enable_esign_communities_metadata = enable_esign_communities_metadata + @property def enable_in_browser_editor(self): """Gets the enable_in_browser_editor of this AccountSettingsInformation. # noqa: E501 @@ -8752,6 +8015,50 @@ def enable_scheduled_release_metadata(self, enable_scheduled_release_metadata): self._enable_scheduled_release_metadata = enable_scheduled_release_metadata + @property + def enable_search(self): + """Gets the enable_search of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The enable_search of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._enable_search + + @enable_search.setter + def enable_search(self, enable_search): + """Sets the enable_search of this AccountSettingsInformation. + + # noqa: E501 + + :param enable_search: The enable_search of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._enable_search = enable_search + + @property + def enable_search_metadata(self): + """Gets the enable_search_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The enable_search_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._enable_search_metadata + + @enable_search_metadata.setter + def enable_search_metadata(self, enable_search_metadata): + """Sets the enable_search_metadata of this AccountSettingsInformation. + + + :param enable_search_metadata: The enable_search_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._enable_search_metadata = enable_search_metadata + @property def enable_search_ui(self): """Gets the enable_search_ui of this AccountSettingsInformation. # noqa: E501 diff --git a/docusign_esign/models/account_ui_settings.py b/docusign_esign/models/account_ui_settings.py index 7fc84b2a..1b9cf637 100644 --- a/docusign_esign/models/account_ui_settings.py +++ b/docusign_esign/models/account_ui_settings.py @@ -41,6 +41,8 @@ class AccountUISettings(object): 'enable_easy_sign_template_upload_metadata': 'SettingsMetadata', 'enable_envelope_copy_with_data': 'str', 'enable_envelope_copy_with_data_metadata': 'SettingsMetadata', + 'enable_legacy_homepage_link': 'str', + 'enable_legacy_homepage_link_metadata': 'SettingsMetadata', 'hide_send_an_envelope': 'str', 'hide_send_an_envelope_metadata': 'SettingsMetadata', 'hide_use_a_template': 'str', @@ -68,6 +70,8 @@ class AccountUISettings(object): 'enable_easy_sign_template_upload_metadata': 'enableEasySignTemplateUploadMetadata', 'enable_envelope_copy_with_data': 'enableEnvelopeCopyWithData', 'enable_envelope_copy_with_data_metadata': 'enableEnvelopeCopyWithDataMetadata', + 'enable_legacy_homepage_link': 'enableLegacyHomepageLink', + 'enable_legacy_homepage_link_metadata': 'enableLegacyHomepageLinkMetadata', 'hide_send_an_envelope': 'hideSendAnEnvelope', 'hide_send_an_envelope_metadata': 'hideSendAnEnvelopeMetadata', 'hide_use_a_template': 'hideUseATemplate', @@ -84,7 +88,7 @@ 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_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, 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, 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 @@ -97,6 +101,8 @@ def __init__(self, admin_message=None, ask_an_admin=None, enable_admin_message=N self._enable_easy_sign_template_upload_metadata = None self._enable_envelope_copy_with_data = None self._enable_envelope_copy_with_data_metadata = None + self._enable_legacy_homepage_link = None + self._enable_legacy_homepage_link_metadata = None self._hide_send_an_envelope = None self._hide_send_an_envelope_metadata = None self._hide_use_a_template = None @@ -133,6 +139,10 @@ def __init__(self, admin_message=None, ask_an_admin=None, enable_admin_message=N self.enable_envelope_copy_with_data = enable_envelope_copy_with_data if enable_envelope_copy_with_data_metadata is not None: self.enable_envelope_copy_with_data_metadata = enable_envelope_copy_with_data_metadata + if enable_legacy_homepage_link is not None: + self.enable_legacy_homepage_link = enable_legacy_homepage_link + if enable_legacy_homepage_link_metadata is not None: + self.enable_legacy_homepage_link_metadata = enable_legacy_homepage_link_metadata if hide_send_an_envelope is not None: self.hide_send_an_envelope = hide_send_an_envelope if hide_send_an_envelope_metadata is not None: @@ -380,6 +390,50 @@ def enable_envelope_copy_with_data_metadata(self, enable_envelope_copy_with_data self._enable_envelope_copy_with_data_metadata = enable_envelope_copy_with_data_metadata + @property + def enable_legacy_homepage_link(self): + """Gets the enable_legacy_homepage_link of this AccountUISettings. # noqa: E501 + + # noqa: E501 + + :return: The enable_legacy_homepage_link of this AccountUISettings. # noqa: E501 + :rtype: str + """ + return self._enable_legacy_homepage_link + + @enable_legacy_homepage_link.setter + def enable_legacy_homepage_link(self, enable_legacy_homepage_link): + """Sets the enable_legacy_homepage_link of this AccountUISettings. + + # noqa: E501 + + :param enable_legacy_homepage_link: The enable_legacy_homepage_link of this AccountUISettings. # noqa: E501 + :type: str + """ + + self._enable_legacy_homepage_link = enable_legacy_homepage_link + + @property + def enable_legacy_homepage_link_metadata(self): + """Gets the enable_legacy_homepage_link_metadata of this AccountUISettings. # noqa: E501 + + + :return: The enable_legacy_homepage_link_metadata of this AccountUISettings. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._enable_legacy_homepage_link_metadata + + @enable_legacy_homepage_link_metadata.setter + def enable_legacy_homepage_link_metadata(self, enable_legacy_homepage_link_metadata): + """Sets the enable_legacy_homepage_link_metadata of this AccountUISettings. + + + :param enable_legacy_homepage_link_metadata: The enable_legacy_homepage_link_metadata of this AccountUISettings. # noqa: E501 + :type: SettingsMetadata + """ + + self._enable_legacy_homepage_link_metadata = enable_legacy_homepage_link_metadata + @property def hide_send_an_envelope(self): """Gets the hide_send_an_envelope of this AccountUISettings. # noqa: E501 diff --git a/docusign_esign/models/bulk_send_batch_request.py b/docusign_esign/models/bulk_send_batch_request.py new file mode 100644 index 00000000..95f09712 --- /dev/null +++ b/docusign_esign/models/bulk_send_batch_request.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + DocuSign REST API + + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 + + OpenAPI spec version: v2.1 + Contact: devcenter@docusign.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class BulkSendBatchRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'batch_name': 'str' + } + + attribute_map = { + 'batch_name': 'batchName' + } + + def __init__(self, batch_name=None): # noqa: E501 + """BulkSendBatchRequest - a model defined in Swagger""" # noqa: E501 + + self._batch_name = None + self.discriminator = None + + if batch_name is not None: + self.batch_name = batch_name + + @property + def batch_name(self): + """Gets the batch_name of this BulkSendBatchRequest. # noqa: E501 + + # noqa: E501 + + :return: The batch_name of this BulkSendBatchRequest. # noqa: E501 + :rtype: str + """ + return self._batch_name + + @batch_name.setter + def batch_name(self, batch_name): + """Sets the batch_name of this BulkSendBatchRequest. + + # noqa: E501 + + :param batch_name: The batch_name of this BulkSendBatchRequest. # noqa: E501 + :type: str + """ + + self._batch_name = batch_name + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(BulkSendBatchRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, BulkSendBatchRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/docusign_esign/models/bulk_send_batch_status.py b/docusign_esign/models/bulk_send_batch_status.py index 0e9e94de..5e3ed0fa 100644 --- a/docusign_esign/models/bulk_send_batch_status.py +++ b/docusign_esign/models/bulk_send_batch_status.py @@ -39,7 +39,9 @@ class BulkSendBatchStatus(object): 'envelopes_uri': 'str', 'failed': 'str', 'mailing_list_id': 'str', + 'owner_user_id': 'str', 'queued': 'str', + 'sender_user_id': 'str', 'sent': 'str', 'submitted_date': 'str' } @@ -53,12 +55,14 @@ class BulkSendBatchStatus(object): 'envelopes_uri': 'envelopesUri', 'failed': 'failed', 'mailing_list_id': 'mailingListId', + 'owner_user_id': 'ownerUserId', 'queued': 'queued', + 'sender_user_id': 'senderUserId', 'sent': 'sent', '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, queued=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, 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 @@ -69,7 +73,9 @@ 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._owner_user_id = None self._queued = None + self._sender_user_id = None self._sent = None self._submitted_date = None self.discriminator = None @@ -90,8 +96,12 @@ 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 owner_user_id is not None: + self.owner_user_id = owner_user_id if queued is not None: self.queued = queued + if sender_user_id is not None: + self.sender_user_id = sender_user_id if sent is not None: self.sent = sent if submitted_date is not None: @@ -281,6 +291,29 @@ def mailing_list_id(self, mailing_list_id): self._mailing_list_id = mailing_list_id + @property + def owner_user_id(self): + """Gets the owner_user_id of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The owner_user_id of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._owner_user_id + + @owner_user_id.setter + def owner_user_id(self, owner_user_id): + """Sets the owner_user_id of this BulkSendBatchStatus. + + # noqa: E501 + + :param owner_user_id: The owner_user_id of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._owner_user_id = owner_user_id + @property def queued(self): """Gets the queued of this BulkSendBatchStatus. # noqa: E501 @@ -304,6 +337,29 @@ def queued(self, queued): self._queued = queued + @property + def sender_user_id(self): + """Gets the sender_user_id of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The sender_user_id of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._sender_user_id + + @sender_user_id.setter + def sender_user_id(self, sender_user_id): + """Sets the sender_user_id of this BulkSendBatchStatus. + + # noqa: E501 + + :param sender_user_id: The sender_user_id of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._sender_user_id = sender_user_id + @property def sent(self): """Gets the sent of this BulkSendBatchStatus. # noqa: E501 diff --git a/docusign_esign/models/complete_sign_hash_response.py b/docusign_esign/models/complete_sign_hash_response.py index e4003f40..310ec0b4 100644 --- a/docusign_esign/models/complete_sign_hash_response.py +++ b/docusign_esign/models/complete_sign_hash_response.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,59 +11,70 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class CompleteSignHashResponse(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, documents=None, redirection_url=None, remaining_signature_requests=None): - """ - CompleteSignHashResponse - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'documents': 'list[SignHashDocument]', - 'redirection_url': 'str', - 'remaining_signature_requests': 'str' - } - - self.attribute_map = { - 'documents': 'documents', - 'redirection_url': 'redirectionUrl', - 'remaining_signature_requests': 'remainingSignatureRequests' - } - - self._documents = documents - self._redirection_url = redirection_url - self._remaining_signature_requests = remaining_signature_requests + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'documents': 'list[SignHashDocument]', + 'redirection_url': 'str', + 'remaining_signature_requests': 'str' + } + + attribute_map = { + 'documents': 'documents', + 'redirection_url': 'redirectionUrl', + 'remaining_signature_requests': 'remainingSignatureRequests' + } + + def __init__(self, documents=None, redirection_url=None, remaining_signature_requests=None): # noqa: E501 + """CompleteSignHashResponse - a model defined in Swagger""" # noqa: E501 + + self._documents = None + self._redirection_url = None + self._remaining_signature_requests = None + self.discriminator = None + + if documents is not None: + self.documents = documents + if redirection_url is not None: + self.redirection_url = redirection_url + if remaining_signature_requests is not None: + self.remaining_signature_requests = remaining_signature_requests @property def documents(self): - """ - Gets the documents of this CompleteSignHashResponse. - Complex element contains the details on the documents in the envelope. + """Gets the documents of this CompleteSignHashResponse. # noqa: E501 + + Complex element contains the details on the documents in the envelope. # noqa: E501 - :return: The documents of this CompleteSignHashResponse. + :return: The documents of this CompleteSignHashResponse. # noqa: E501 :rtype: list[SignHashDocument] """ return self._documents @documents.setter def documents(self, documents): - """ - Sets the documents of this CompleteSignHashResponse. - Complex element contains the details on the documents in the envelope. + """Sets the documents of this CompleteSignHashResponse. + + Complex element contains the details on the documents in the envelope. # noqa: E501 - :param documents: The documents of this CompleteSignHashResponse. + :param documents: The documents of this CompleteSignHashResponse. # noqa: E501 :type: list[SignHashDocument] """ @@ -71,22 +82,22 @@ def documents(self, documents): @property def redirection_url(self): - """ - Gets the redirection_url of this CompleteSignHashResponse. - + """Gets the redirection_url of this CompleteSignHashResponse. # noqa: E501 + + # noqa: E501 - :return: The redirection_url of this CompleteSignHashResponse. + :return: The redirection_url of this CompleteSignHashResponse. # noqa: E501 :rtype: str """ return self._redirection_url @redirection_url.setter def redirection_url(self, redirection_url): - """ - Sets the redirection_url of this CompleteSignHashResponse. - + """Sets the redirection_url of this CompleteSignHashResponse. + + # noqa: E501 - :param redirection_url: The redirection_url of this CompleteSignHashResponse. + :param redirection_url: The redirection_url of this CompleteSignHashResponse. # noqa: E501 :type: str """ @@ -94,34 +105,32 @@ def redirection_url(self, redirection_url): @property def remaining_signature_requests(self): - """ - Gets the remaining_signature_requests of this CompleteSignHashResponse. - + """Gets the remaining_signature_requests of this CompleteSignHashResponse. # noqa: E501 - :return: The remaining_signature_requests of this CompleteSignHashResponse. + # noqa: E501 + + :return: The remaining_signature_requests of this CompleteSignHashResponse. # noqa: E501 :rtype: str """ return self._remaining_signature_requests @remaining_signature_requests.setter def remaining_signature_requests(self, remaining_signature_requests): - """ - Sets the remaining_signature_requests of this CompleteSignHashResponse. - + """Sets the remaining_signature_requests of this CompleteSignHashResponse. - :param remaining_signature_requests: The remaining_signature_requests of this CompleteSignHashResponse. + # noqa: E501 + + :param remaining_signature_requests: The remaining_signature_requests of this CompleteSignHashResponse. # noqa: E501 :type: str """ self._remaining_signature_requests = remaining_signature_requests def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -138,29 +147,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CompleteSignHashResponse, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CompleteSignHashResponse): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/complete_sign_request.py b/docusign_esign/models/complete_sign_request.py index 3be04a20..9907d794 100644 --- a/docusign_esign/models/complete_sign_request.py +++ b/docusign_esign/models/complete_sign_request.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,68 +11,85 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class CompleteSignRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, certificate=None, correlation_id=None, document_update_infos=None, max_signature_length=None, signing_location=None, transaction_id=None): - """ - CompleteSignRequest - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'certificate': 'str', - 'correlation_id': 'str', - 'document_update_infos': 'list[DocumentUpdateInfo]', - 'max_signature_length': 'str', - 'signing_location': 'str', - 'transaction_id': 'str' - } - - self.attribute_map = { - 'certificate': 'certificate', - 'correlation_id': 'correlationId', - 'document_update_infos': 'documentUpdateInfos', - 'max_signature_length': 'maxSignatureLength', - 'signing_location': 'signingLocation', - 'transaction_id': 'transactionId' - } - - self._certificate = certificate - self._correlation_id = correlation_id - self._document_update_infos = document_update_infos - self._max_signature_length = max_signature_length - self._signing_location = signing_location - self._transaction_id = transaction_id + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'certificate': 'str', + 'correlation_id': 'str', + 'document_update_infos': 'list[DocumentUpdateInfo]', + 'max_signature_length': 'str', + 'signing_location': 'str', + 'transaction_id': 'str' + } + + attribute_map = { + 'certificate': 'certificate', + 'correlation_id': 'correlationId', + 'document_update_infos': 'documentUpdateInfos', + 'max_signature_length': 'maxSignatureLength', + 'signing_location': 'signingLocation', + 'transaction_id': 'transactionId' + } + + def __init__(self, certificate=None, correlation_id=None, document_update_infos=None, max_signature_length=None, signing_location=None, transaction_id=None): # noqa: E501 + """CompleteSignRequest - a model defined in Swagger""" # noqa: E501 + + self._certificate = None + self._correlation_id = None + self._document_update_infos = None + self._max_signature_length = None + self._signing_location = None + self._transaction_id = None + self.discriminator = None + + if certificate is not None: + self.certificate = certificate + if correlation_id is not None: + self.correlation_id = correlation_id + if document_update_infos is not None: + self.document_update_infos = document_update_infos + if max_signature_length is not None: + self.max_signature_length = max_signature_length + if signing_location is not None: + self.signing_location = signing_location + if transaction_id is not None: + self.transaction_id = transaction_id @property def certificate(self): - """ - Gets the certificate of this CompleteSignRequest. - + """Gets the certificate of this CompleteSignRequest. # noqa: E501 + + # noqa: E501 - :return: The certificate of this CompleteSignRequest. + :return: The certificate of this CompleteSignRequest. # noqa: E501 :rtype: str """ return self._certificate @certificate.setter def certificate(self, certificate): - """ - Sets the certificate of this CompleteSignRequest. - + """Sets the certificate of this CompleteSignRequest. + + # noqa: E501 - :param certificate: The certificate of this CompleteSignRequest. + :param certificate: The certificate of this CompleteSignRequest. # noqa: E501 :type: str """ @@ -80,22 +97,22 @@ def certificate(self, certificate): @property def correlation_id(self): - """ - Gets the correlation_id of this CompleteSignRequest. - + """Gets the correlation_id of this CompleteSignRequest. # noqa: E501 - :return: The correlation_id of this CompleteSignRequest. + # noqa: E501 + + :return: The correlation_id of this CompleteSignRequest. # noqa: E501 :rtype: str """ return self._correlation_id @correlation_id.setter def correlation_id(self, correlation_id): - """ - Sets the correlation_id of this CompleteSignRequest. - + """Sets the correlation_id of this CompleteSignRequest. + + # noqa: E501 - :param correlation_id: The correlation_id of this CompleteSignRequest. + :param correlation_id: The correlation_id of this CompleteSignRequest. # noqa: E501 :type: str """ @@ -103,22 +120,22 @@ def correlation_id(self, correlation_id): @property def document_update_infos(self): - """ - Gets the document_update_infos of this CompleteSignRequest. - + """Gets the document_update_infos of this CompleteSignRequest. # noqa: E501 + + # noqa: E501 - :return: The document_update_infos of this CompleteSignRequest. + :return: The document_update_infos of this CompleteSignRequest. # noqa: E501 :rtype: list[DocumentUpdateInfo] """ return self._document_update_infos @document_update_infos.setter def document_update_infos(self, document_update_infos): - """ - Sets the document_update_infos of this CompleteSignRequest. - + """Sets the document_update_infos of this CompleteSignRequest. - :param document_update_infos: The document_update_infos of this CompleteSignRequest. + # noqa: E501 + + :param document_update_infos: The document_update_infos of this CompleteSignRequest. # noqa: E501 :type: list[DocumentUpdateInfo] """ @@ -126,22 +143,22 @@ def document_update_infos(self, document_update_infos): @property def max_signature_length(self): - """ - Gets the max_signature_length of this CompleteSignRequest. - + """Gets the max_signature_length of this CompleteSignRequest. # noqa: E501 + + # noqa: E501 - :return: The max_signature_length of this CompleteSignRequest. + :return: The max_signature_length of this CompleteSignRequest. # noqa: E501 :rtype: str """ return self._max_signature_length @max_signature_length.setter def max_signature_length(self, max_signature_length): - """ - Sets the max_signature_length of this CompleteSignRequest. - + """Sets the max_signature_length of this CompleteSignRequest. + + # noqa: E501 - :param max_signature_length: The max_signature_length of this CompleteSignRequest. + :param max_signature_length: The max_signature_length of this CompleteSignRequest. # noqa: E501 :type: str """ @@ -149,22 +166,22 @@ def max_signature_length(self, max_signature_length): @property def signing_location(self): - """ - Gets the signing_location of this CompleteSignRequest. - Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. + """Gets the signing_location of this CompleteSignRequest. # noqa: E501 - :return: The signing_location of this CompleteSignRequest. + Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. # noqa: E501 + + :return: The signing_location of this CompleteSignRequest. # noqa: E501 :rtype: str """ return self._signing_location @signing_location.setter def signing_location(self, signing_location): - """ - Sets the signing_location of this CompleteSignRequest. - Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. + """Sets the signing_location of this CompleteSignRequest. + + Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. # noqa: E501 - :param signing_location: The signing_location of this CompleteSignRequest. + :param signing_location: The signing_location of this CompleteSignRequest. # noqa: E501 :type: str """ @@ -172,34 +189,32 @@ def signing_location(self, signing_location): @property def transaction_id(self): - """ - Gets the transaction_id of this CompleteSignRequest. - Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. + """Gets the transaction_id of this CompleteSignRequest. # noqa: E501 + + Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. # noqa: E501 - :return: The transaction_id of this CompleteSignRequest. + :return: The transaction_id of this CompleteSignRequest. # noqa: E501 :rtype: str """ return self._transaction_id @transaction_id.setter def transaction_id(self, transaction_id): - """ - Sets the transaction_id of this CompleteSignRequest. - Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. + """Sets the transaction_id of this CompleteSignRequest. - :param transaction_id: The transaction_id of this CompleteSignRequest. + Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. # noqa: E501 + + :param transaction_id: The transaction_id of this CompleteSignRequest. # noqa: E501 :type: str """ self._transaction_id = transaction_id def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -216,29 +231,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CompleteSignRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CompleteSignRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/credential.py b/docusign_esign/models/credential.py index 4b51fbc5..c84992aa 100644 --- a/docusign_esign/models/credential.py +++ b/docusign_esign/models/credential.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,59 +11,70 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class Credential(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, access_code=None, type=None, value=None): - """ - Credential - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'access_code': 'str', - 'type': 'str', - 'value': 'str' - } - - self.attribute_map = { - 'access_code': 'accessCode', - 'type': 'type', - 'value': 'value' - } - - self._access_code = access_code - self._type = type - self._value = value + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'access_code': 'str', + 'type': 'str', + 'value': 'str' + } + + attribute_map = { + 'access_code': 'accessCode', + 'type': 'type', + 'value': 'value' + } + + def __init__(self, access_code=None, type=None, value=None): # noqa: E501 + """Credential - a model defined in Swagger""" # noqa: E501 + + self._access_code = None + self._type = None + self._value = None + self.discriminator = None + + if access_code is not None: + self.access_code = access_code + if type is not None: + self.type = type + if value is not None: + self.value = value @property def access_code(self): - """ - Gets the access_code of this Credential. - If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + """Gets the access_code of this Credential. # noqa: E501 + + If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 - :return: The access_code of this Credential. + :return: The access_code of this Credential. # noqa: E501 :rtype: str """ return self._access_code @access_code.setter def access_code(self, access_code): - """ - Sets the access_code of this Credential. - If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + """Sets the access_code of this Credential. + + If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 - :param access_code: The access_code of this Credential. + :param access_code: The access_code of this Credential. # noqa: E501 :type: str """ @@ -71,22 +82,22 @@ def access_code(self, access_code): @property def type(self): - """ - Gets the type of this Credential. - + """Gets the type of this Credential. # noqa: E501 + + # noqa: E501 - :return: The type of this Credential. + :return: The type of this Credential. # noqa: E501 :rtype: str """ return self._type @type.setter def type(self, type): - """ - Sets the type of this Credential. - + """Sets the type of this Credential. + + # noqa: E501 - :param type: The type of this Credential. + :param type: The type of this Credential. # noqa: E501 :type: str """ @@ -94,34 +105,32 @@ def type(self, type): @property def value(self): - """ - Gets the value of this Credential. - Specifies the value of the tab. + """Gets the value of this Credential. # noqa: E501 - :return: The value of this Credential. + Specifies the value of the tab. # noqa: E501 + + :return: The value of this Credential. # noqa: E501 :rtype: str """ return self._value @value.setter def value(self, value): - """ - Sets the value of this Credential. - Specifies the value of the tab. + """Sets the value of this Credential. - :param value: The value of this Credential. + Specifies the value of the tab. # noqa: E501 + + :param value: The value of this Credential. # noqa: E501 :type: str """ self._value = value def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -138,29 +147,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Credential, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Credential): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/display_appliance_account.py b/docusign_esign/models/display_appliance_account.py index 6452e8f7..c6147f9d 100644 --- a/docusign_esign/models/display_appliance_account.py +++ b/docusign_esign/models/display_appliance_account.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,65 +11,80 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class DisplayApplianceAccount(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, account_id=None, opt_out_auto_nav_text_and_tab_color_updates=None, show_initial_conditional_fields=None, signing_version=None, tag_has_sig_block=None): - """ - DisplayApplianceAccount - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'account_id': 'str', - 'opt_out_auto_nav_text_and_tab_color_updates': 'bool', - 'show_initial_conditional_fields': 'bool', - 'signing_version': 'str', - 'tag_has_sig_block': 'bool' - } - - self.attribute_map = { - 'account_id': 'accountId', - 'opt_out_auto_nav_text_and_tab_color_updates': 'optOutAutoNavTextAndTabColorUpdates', - 'show_initial_conditional_fields': 'showInitialConditionalFields', - 'signing_version': 'signingVersion', - 'tag_has_sig_block': 'tagHasSigBlock' - } - self._account_id = account_id - self._opt_out_auto_nav_text_and_tab_color_updates = opt_out_auto_nav_text_and_tab_color_updates - self._show_initial_conditional_fields = show_initial_conditional_fields - self._signing_version = signing_version - self._tag_has_sig_block = tag_has_sig_block + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'account_id': 'str', + 'opt_out_auto_nav_text_and_tab_color_updates': 'bool', + 'show_initial_conditional_fields': 'bool', + 'signing_version': 'str', + 'tag_has_sig_block': 'bool' + } + + attribute_map = { + 'account_id': 'accountId', + 'opt_out_auto_nav_text_and_tab_color_updates': 'optOutAutoNavTextAndTabColorUpdates', + 'show_initial_conditional_fields': 'showInitialConditionalFields', + 'signing_version': 'signingVersion', + 'tag_has_sig_block': 'tagHasSigBlock' + } + + def __init__(self, account_id=None, opt_out_auto_nav_text_and_tab_color_updates=None, show_initial_conditional_fields=None, signing_version=None, tag_has_sig_block=None): # noqa: E501 + """DisplayApplianceAccount - a model defined in Swagger""" # noqa: E501 + + self._account_id = None + self._opt_out_auto_nav_text_and_tab_color_updates = None + self._show_initial_conditional_fields = None + self._signing_version = None + self._tag_has_sig_block = None + self.discriminator = None + + if account_id is not None: + self.account_id = account_id + if opt_out_auto_nav_text_and_tab_color_updates is not None: + self.opt_out_auto_nav_text_and_tab_color_updates = opt_out_auto_nav_text_and_tab_color_updates + if show_initial_conditional_fields is not None: + self.show_initial_conditional_fields = show_initial_conditional_fields + if signing_version is not None: + self.signing_version = signing_version + if tag_has_sig_block is not None: + self.tag_has_sig_block = tag_has_sig_block @property def account_id(self): - """ - Gets the account_id of this DisplayApplianceAccount. - The account ID associated with the envelope. + """Gets the account_id of this DisplayApplianceAccount. # noqa: E501 - :return: The account_id of this DisplayApplianceAccount. + The account ID associated with the envelope. # noqa: E501 + + :return: The account_id of this DisplayApplianceAccount. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this DisplayApplianceAccount. - The account ID associated with the envelope. + """Sets the account_id of this DisplayApplianceAccount. + + The account ID associated with the envelope. # noqa: E501 - :param account_id: The account_id of this DisplayApplianceAccount. + :param account_id: The account_id of this DisplayApplianceAccount. # noqa: E501 :type: str """ @@ -77,22 +92,22 @@ def account_id(self, account_id): @property def opt_out_auto_nav_text_and_tab_color_updates(self): - """ - Gets the opt_out_auto_nav_text_and_tab_color_updates of this DisplayApplianceAccount. - + """Gets the opt_out_auto_nav_text_and_tab_color_updates of this DisplayApplianceAccount. # noqa: E501 + + # noqa: E501 - :return: The opt_out_auto_nav_text_and_tab_color_updates of this DisplayApplianceAccount. + :return: The opt_out_auto_nav_text_and_tab_color_updates of this DisplayApplianceAccount. # noqa: E501 :rtype: bool """ return self._opt_out_auto_nav_text_and_tab_color_updates @opt_out_auto_nav_text_and_tab_color_updates.setter def opt_out_auto_nav_text_and_tab_color_updates(self, opt_out_auto_nav_text_and_tab_color_updates): - """ - Sets the opt_out_auto_nav_text_and_tab_color_updates of this DisplayApplianceAccount. - + """Sets the opt_out_auto_nav_text_and_tab_color_updates of this DisplayApplianceAccount. - :param opt_out_auto_nav_text_and_tab_color_updates: The opt_out_auto_nav_text_and_tab_color_updates of this DisplayApplianceAccount. + # noqa: E501 + + :param opt_out_auto_nav_text_and_tab_color_updates: The opt_out_auto_nav_text_and_tab_color_updates of this DisplayApplianceAccount. # noqa: E501 :type: bool """ @@ -100,22 +115,22 @@ def opt_out_auto_nav_text_and_tab_color_updates(self, opt_out_auto_nav_text_and_ @property def show_initial_conditional_fields(self): - """ - Gets the show_initial_conditional_fields of this DisplayApplianceAccount. - + """Gets the show_initial_conditional_fields of this DisplayApplianceAccount. # noqa: E501 - :return: The show_initial_conditional_fields of this DisplayApplianceAccount. + # noqa: E501 + + :return: The show_initial_conditional_fields of this DisplayApplianceAccount. # noqa: E501 :rtype: bool """ return self._show_initial_conditional_fields @show_initial_conditional_fields.setter def show_initial_conditional_fields(self, show_initial_conditional_fields): - """ - Sets the show_initial_conditional_fields of this DisplayApplianceAccount. - + """Sets the show_initial_conditional_fields of this DisplayApplianceAccount. + + # noqa: E501 - :param show_initial_conditional_fields: The show_initial_conditional_fields of this DisplayApplianceAccount. + :param show_initial_conditional_fields: The show_initial_conditional_fields of this DisplayApplianceAccount. # noqa: E501 :type: bool """ @@ -123,22 +138,22 @@ def show_initial_conditional_fields(self, show_initial_conditional_fields): @property def signing_version(self): - """ - Gets the signing_version of this DisplayApplianceAccount. - + """Gets the signing_version of this DisplayApplianceAccount. # noqa: E501 + + # noqa: E501 - :return: The signing_version of this DisplayApplianceAccount. + :return: The signing_version of this DisplayApplianceAccount. # noqa: E501 :rtype: str """ return self._signing_version @signing_version.setter def signing_version(self, signing_version): - """ - Sets the signing_version of this DisplayApplianceAccount. - + """Sets the signing_version of this DisplayApplianceAccount. - :param signing_version: The signing_version of this DisplayApplianceAccount. + # noqa: E501 + + :param signing_version: The signing_version of this DisplayApplianceAccount. # noqa: E501 :type: str """ @@ -146,34 +161,32 @@ def signing_version(self, signing_version): @property def tag_has_sig_block(self): - """ - Gets the tag_has_sig_block of this DisplayApplianceAccount. - + """Gets the tag_has_sig_block of this DisplayApplianceAccount. # noqa: E501 + + # noqa: E501 - :return: The tag_has_sig_block of this DisplayApplianceAccount. + :return: The tag_has_sig_block of this DisplayApplianceAccount. # noqa: E501 :rtype: bool """ return self._tag_has_sig_block @tag_has_sig_block.setter def tag_has_sig_block(self, tag_has_sig_block): - """ - Sets the tag_has_sig_block of this DisplayApplianceAccount. - + """Sets the tag_has_sig_block of this DisplayApplianceAccount. + + # noqa: E501 - :param tag_has_sig_block: The tag_has_sig_block of this DisplayApplianceAccount. + :param tag_has_sig_block: The tag_has_sig_block of this DisplayApplianceAccount. # noqa: E501 :type: bool """ self._tag_has_sig_block = tag_has_sig_block def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -190,29 +203,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(DisplayApplianceAccount, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, DisplayApplianceAccount): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/display_appliance_info.py b/docusign_esign/models/display_appliance_info.py index 2f74b636..2c90c119 100644 --- a/docusign_esign/models/display_appliance_info.py +++ b/docusign_esign/models/display_appliance_info.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,401 +11,40 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class DisplayApplianceInfo(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, culture_name=None, custom_fields=None, date_signed=None, document_data=None, document_pages=None, dynamic_system_settings=None, envelope_data=None, image=None, is_non_display_appliance_template=None, locale_policy=None, page_data=None, recipient_data=None, translate_height=None, update_tab_module=None): - """ - DisplayApplianceInfo - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'culture_name': 'str', - 'custom_fields': 'list[DisplayApplianceCustomField]', - 'date_signed': 'str', - 'document_data': 'list[DisplayApplianceDocument]', - 'document_pages': 'list[DisplayApplianceDocumentPage]', - 'dynamic_system_settings': 'dict(str, object)', - 'envelope_data': 'DisplayApplianceEnvelope', - 'image': 'str', - 'is_non_display_appliance_template': 'bool', - 'locale_policy': 'dict(str, str)', - 'page_data': 'list[DisplayAppliancePage]', - 'recipient_data': 'list[DisplayApplianceRecipient]', - 'translate_height': 'bool', - 'update_tab_module': 'bool' - } - - self.attribute_map = { - 'culture_name': 'cultureName', - 'custom_fields': 'customFields', - 'date_signed': 'dateSigned', - 'document_data': 'documentData', - 'document_pages': 'documentPages', - 'dynamic_system_settings': 'dynamicSystemSettings', - 'envelope_data': 'envelopeData', - 'image': 'image', - 'is_non_display_appliance_template': 'isNonDisplayApplianceTemplate', - 'locale_policy': 'localePolicy', - 'page_data': 'pageData', - 'recipient_data': 'recipientData', - 'translate_height': 'translateHeight', - 'update_tab_module': 'updateTabModule' - } - - self._culture_name = culture_name - self._custom_fields = custom_fields - self._date_signed = date_signed - self._document_data = document_data - self._document_pages = document_pages - self._dynamic_system_settings = dynamic_system_settings - self._envelope_data = envelope_data - self._image = image - self._is_non_display_appliance_template = is_non_display_appliance_template - self._locale_policy = locale_policy - self._page_data = page_data - self._recipient_data = recipient_data - self._translate_height = translate_height - self._update_tab_module = update_tab_module - - @property - def culture_name(self): - """ - Gets the culture_name of this DisplayApplianceInfo. - - - :return: The culture_name of this DisplayApplianceInfo. - :rtype: str - """ - return self._culture_name - - @culture_name.setter - def culture_name(self, culture_name): - """ - Sets the culture_name of this DisplayApplianceInfo. - - - :param culture_name: The culture_name of this DisplayApplianceInfo. - :type: str - """ - - self._culture_name = culture_name - - @property - def custom_fields(self): - """ - Gets the custom_fields of this DisplayApplianceInfo. - An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. - - :return: The custom_fields of this DisplayApplianceInfo. - :rtype: list[DisplayApplianceCustomField] - """ - return self._custom_fields - - @custom_fields.setter - def custom_fields(self, custom_fields): - """ - Sets the custom_fields of this DisplayApplianceInfo. - An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. - - :param custom_fields: The custom_fields of this DisplayApplianceInfo. - :type: list[DisplayApplianceCustomField] - """ - - self._custom_fields = custom_fields - - @property - def date_signed(self): - """ - Gets the date_signed of this DisplayApplianceInfo. - - - :return: The date_signed of this DisplayApplianceInfo. - :rtype: str - """ - return self._date_signed - - @date_signed.setter - def date_signed(self, date_signed): - """ - Sets the date_signed of this DisplayApplianceInfo. - - - :param date_signed: The date_signed of this DisplayApplianceInfo. - :type: str - """ - - self._date_signed = date_signed - - @property - def document_data(self): - """ - Gets the document_data of this DisplayApplianceInfo. - - - :return: The document_data of this DisplayApplianceInfo. - :rtype: list[DisplayApplianceDocument] - """ - return self._document_data - - @document_data.setter - def document_data(self, document_data): - """ - Sets the document_data of this DisplayApplianceInfo. - - - :param document_data: The document_data of this DisplayApplianceInfo. - :type: list[DisplayApplianceDocument] - """ - - self._document_data = document_data - - @property - def document_pages(self): - """ - Gets the document_pages of this DisplayApplianceInfo. - - - :return: The document_pages of this DisplayApplianceInfo. - :rtype: list[DisplayApplianceDocumentPage] - """ - return self._document_pages - - @document_pages.setter - def document_pages(self, document_pages): - """ - Sets the document_pages of this DisplayApplianceInfo. - - - :param document_pages: The document_pages of this DisplayApplianceInfo. - :type: list[DisplayApplianceDocumentPage] - """ - - self._document_pages = document_pages - - @property - def dynamic_system_settings(self): - """ - Gets the dynamic_system_settings of this DisplayApplianceInfo. - - - :return: The dynamic_system_settings of this DisplayApplianceInfo. - :rtype: dict(str, object) - """ - return self._dynamic_system_settings - - @dynamic_system_settings.setter - def dynamic_system_settings(self, dynamic_system_settings): - """ - Sets the dynamic_system_settings of this DisplayApplianceInfo. - - - :param dynamic_system_settings: The dynamic_system_settings of this DisplayApplianceInfo. - :type: dict(str, object) - """ - - self._dynamic_system_settings = dynamic_system_settings - - @property - def envelope_data(self): - """ - Gets the envelope_data of this DisplayApplianceInfo. - - :return: The envelope_data of this DisplayApplianceInfo. - :rtype: DisplayApplianceEnvelope - """ - return self._envelope_data - @envelope_data.setter - def envelope_data(self, envelope_data): - """ - Sets the envelope_data of this DisplayApplianceInfo. - - :param envelope_data: The envelope_data of this DisplayApplianceInfo. - :type: DisplayApplianceEnvelope - """ - - self._envelope_data = envelope_data - - @property - def image(self): - """ - Gets the image of this DisplayApplianceInfo. - - - :return: The image of this DisplayApplianceInfo. - :rtype: str - """ - return self._image - - @image.setter - def image(self, image): - """ - Sets the image of this DisplayApplianceInfo. - - - :param image: The image of this DisplayApplianceInfo. - :type: str - """ - - self._image = image - - @property - def is_non_display_appliance_template(self): - """ - Gets the is_non_display_appliance_template of this DisplayApplianceInfo. - - - :return: The is_non_display_appliance_template of this DisplayApplianceInfo. - :rtype: bool - """ - return self._is_non_display_appliance_template - - @is_non_display_appliance_template.setter - def is_non_display_appliance_template(self, is_non_display_appliance_template): - """ - Sets the is_non_display_appliance_template of this DisplayApplianceInfo. - - - :param is_non_display_appliance_template: The is_non_display_appliance_template of this DisplayApplianceInfo. - :type: bool - """ - - self._is_non_display_appliance_template = is_non_display_appliance_template - - @property - def locale_policy(self): - """ - Gets the locale_policy of this DisplayApplianceInfo. - - - :return: The locale_policy of this DisplayApplianceInfo. - :rtype: dict(str, str) - """ - return self._locale_policy - - @locale_policy.setter - def locale_policy(self, locale_policy): - """ - Sets the locale_policy of this DisplayApplianceInfo. - - - :param locale_policy: The locale_policy of this DisplayApplianceInfo. - :type: dict(str, str) - """ - - self._locale_policy = locale_policy - - @property - def page_data(self): - """ - Gets the page_data of this DisplayApplianceInfo. - - - :return: The page_data of this DisplayApplianceInfo. - :rtype: list[DisplayAppliancePage] - """ - return self._page_data - - @page_data.setter - def page_data(self, page_data): - """ - Sets the page_data of this DisplayApplianceInfo. - - - :param page_data: The page_data of this DisplayApplianceInfo. - :type: list[DisplayAppliancePage] - """ - - self._page_data = page_data - - @property - def recipient_data(self): - """ - Gets the recipient_data of this DisplayApplianceInfo. - - - :return: The recipient_data of this DisplayApplianceInfo. - :rtype: list[DisplayApplianceRecipient] - """ - return self._recipient_data - - @recipient_data.setter - def recipient_data(self, recipient_data): - """ - Sets the recipient_data of this DisplayApplianceInfo. - - - :param recipient_data: The recipient_data of this DisplayApplianceInfo. - :type: list[DisplayApplianceRecipient] - """ - - self._recipient_data = recipient_data - - @property - def translate_height(self): - """ - Gets the translate_height of this DisplayApplianceInfo. - - - :return: The translate_height of this DisplayApplianceInfo. - :rtype: bool - """ - return self._translate_height - - @translate_height.setter - def translate_height(self, translate_height): - """ - Sets the translate_height of this DisplayApplianceInfo. - - - :param translate_height: The translate_height of this DisplayApplianceInfo. - :type: bool - """ - - self._translate_height = translate_height - - @property - def update_tab_module(self): - """ - Gets the update_tab_module of this DisplayApplianceInfo. - - - :return: The update_tab_module of this DisplayApplianceInfo. - :rtype: bool - """ - return self._update_tab_module - - @update_tab_module.setter - def update_tab_module(self, update_tab_module): - """ - Sets the update_tab_module of this DisplayApplianceInfo. - + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } - :param update_tab_module: The update_tab_module of this DisplayApplianceInfo. - :type: bool - """ + attribute_map = { + } - self._update_tab_module = update_tab_module + def __init__(self): # noqa: E501 + """DisplayApplianceInfo - a model defined in Swagger""" # noqa: E501 + self.discriminator = None def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -422,29 +61,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(DisplayApplianceInfo, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, DisplayApplianceInfo): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/display_appliance_pdf.py b/docusign_esign/models/display_appliance_pdf.py index 586287b1..7c48c8f1 100644 --- a/docusign_esign/models/display_appliance_pdf.py +++ b/docusign_esign/models/display_appliance_pdf.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,323 +11,40 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class DisplayAppliancePdf(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, attachment_info=None, doc_name=None, document_id=None, latest_pdf=None, latest_pdf_id=None, original_pdf=None, original_pdf_id=None, page_count=None, pdf=None, pdf_type=None, sequence=None): - """ - DisplayAppliancePdf - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'attachment_info': 'DisplayApplianceSignerAttachment', - 'doc_name': 'str', - 'document_id': 'str', - 'latest_pdf': 'str', - 'latest_pdf_id': 'str', - 'original_pdf': 'str', - 'original_pdf_id': 'str', - 'page_count': 'int', - 'pdf': 'str', - 'pdf_type': 'str', - 'sequence': 'str' - } - - self.attribute_map = { - 'attachment_info': 'attachmentInfo', - 'doc_name': 'docName', - 'document_id': 'documentId', - 'latest_pdf': 'latestPdf', - 'latest_pdf_id': 'latestPDFId', - 'original_pdf': 'originalPdf', - 'original_pdf_id': 'originalPDFId', - 'page_count': 'pageCount', - 'pdf': 'pdf', - 'pdf_type': 'pdfType', - 'sequence': 'sequence' - } - - self._attachment_info = attachment_info - self._doc_name = doc_name - self._document_id = document_id - self._latest_pdf = latest_pdf - self._latest_pdf_id = latest_pdf_id - self._original_pdf = original_pdf - self._original_pdf_id = original_pdf_id - self._page_count = page_count - self._pdf = pdf - self._pdf_type = pdf_type - self._sequence = sequence - - @property - def attachment_info(self): - """ - Gets the attachment_info of this DisplayAppliancePdf. - - :return: The attachment_info of this DisplayAppliancePdf. - :rtype: DisplayApplianceSignerAttachment - """ - return self._attachment_info - - @attachment_info.setter - def attachment_info(self, attachment_info): - """ - Sets the attachment_info of this DisplayAppliancePdf. - - :param attachment_info: The attachment_info of this DisplayAppliancePdf. - :type: DisplayApplianceSignerAttachment - """ - - self._attachment_info = attachment_info - - @property - def doc_name(self): - """ - Gets the doc_name of this DisplayAppliancePdf. - - - :return: The doc_name of this DisplayAppliancePdf. - :rtype: str - """ - return self._doc_name - - @doc_name.setter - def doc_name(self, doc_name): - """ - Sets the doc_name of this DisplayAppliancePdf. - - - :param doc_name: The doc_name of this DisplayAppliancePdf. - :type: str - """ - - self._doc_name = doc_name - - @property - def document_id(self): - """ - Gets the document_id of this DisplayAppliancePdf. - Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - - :return: The document_id of this DisplayAppliancePdf. - :rtype: str - """ - return self._document_id - - @document_id.setter - def document_id(self, document_id): - """ - Sets the document_id of this DisplayAppliancePdf. - Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - - :param document_id: The document_id of this DisplayAppliancePdf. - :type: str - """ - - self._document_id = document_id - - @property - def latest_pdf(self): - """ - Gets the latest_pdf of this DisplayAppliancePdf. - - - :return: The latest_pdf of this DisplayAppliancePdf. - :rtype: str - """ - return self._latest_pdf - - @latest_pdf.setter - def latest_pdf(self, latest_pdf): - """ - Sets the latest_pdf of this DisplayAppliancePdf. - - - :param latest_pdf: The latest_pdf of this DisplayAppliancePdf. - :type: str - """ - - self._latest_pdf = latest_pdf - - @property - def latest_pdf_id(self): - """ - Gets the latest_pdf_id of this DisplayAppliancePdf. - - - :return: The latest_pdf_id of this DisplayAppliancePdf. - :rtype: str - """ - return self._latest_pdf_id - - @latest_pdf_id.setter - def latest_pdf_id(self, latest_pdf_id): - """ - Sets the latest_pdf_id of this DisplayAppliancePdf. - - - :param latest_pdf_id: The latest_pdf_id of this DisplayAppliancePdf. - :type: str - """ - - self._latest_pdf_id = latest_pdf_id - @property - def original_pdf(self): - """ - Gets the original_pdf of this DisplayAppliancePdf. - - - :return: The original_pdf of this DisplayAppliancePdf. - :rtype: str - """ - return self._original_pdf - - @original_pdf.setter - def original_pdf(self, original_pdf): - """ - Sets the original_pdf of this DisplayAppliancePdf. - - - :param original_pdf: The original_pdf of this DisplayAppliancePdf. - :type: str - """ - - self._original_pdf = original_pdf - - @property - def original_pdf_id(self): - """ - Gets the original_pdf_id of this DisplayAppliancePdf. - - - :return: The original_pdf_id of this DisplayAppliancePdf. - :rtype: str - """ - return self._original_pdf_id - - @original_pdf_id.setter - def original_pdf_id(self, original_pdf_id): - """ - Sets the original_pdf_id of this DisplayAppliancePdf. - - - :param original_pdf_id: The original_pdf_id of this DisplayAppliancePdf. - :type: str - """ - - self._original_pdf_id = original_pdf_id - - @property - def page_count(self): - """ - Gets the page_count of this DisplayAppliancePdf. - - - :return: The page_count of this DisplayAppliancePdf. - :rtype: int - """ - return self._page_count - - @page_count.setter - def page_count(self, page_count): - """ - Sets the page_count of this DisplayAppliancePdf. - - - :param page_count: The page_count of this DisplayAppliancePdf. - :type: int - """ - - self._page_count = page_count - - @property - def pdf(self): - """ - Gets the pdf of this DisplayAppliancePdf. - - - :return: The pdf of this DisplayAppliancePdf. - :rtype: str - """ - return self._pdf - - @pdf.setter - def pdf(self, pdf): - """ - Sets the pdf of this DisplayAppliancePdf. - - - :param pdf: The pdf of this DisplayAppliancePdf. - :type: str - """ - - self._pdf = pdf - - @property - def pdf_type(self): - """ - Gets the pdf_type of this DisplayAppliancePdf. - - - :return: The pdf_type of this DisplayAppliancePdf. - :rtype: str - """ - return self._pdf_type - - @pdf_type.setter - def pdf_type(self, pdf_type): - """ - Sets the pdf_type of this DisplayAppliancePdf. - - - :param pdf_type: The pdf_type of this DisplayAppliancePdf. - :type: str - """ - - self._pdf_type = pdf_type - - @property - def sequence(self): - """ - Gets the sequence of this DisplayAppliancePdf. - - - :return: The sequence of this DisplayAppliancePdf. - :rtype: str - """ - return self._sequence - - @sequence.setter - def sequence(self, sequence): - """ - Sets the sequence of this DisplayAppliancePdf. - + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } - :param sequence: The sequence of this DisplayAppliancePdf. - :type: str - """ + attribute_map = { + } - self._sequence = sequence + def __init__(self): # noqa: E501 + """DisplayAppliancePdf - a model defined in Swagger""" # noqa: E501 + self.discriminator = None def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -344,29 +61,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(DisplayAppliancePdf, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, DisplayAppliancePdf): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/display_appliance_signer_attachment.py b/docusign_esign/models/display_appliance_signer_attachment.py index 208387c6..56190536 100644 --- a/docusign_esign/models/display_appliance_signer_attachment.py +++ b/docusign_esign/models/display_appliance_signer_attachment.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,221 +11,40 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class DisplayApplianceSignerAttachment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, attachment_description=None, attachment_tab_id=None, document_id=None, envelope_id=None, page_count=None, page_id=None, recipient_id=None): - """ - DisplayApplianceSignerAttachment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'attachment_description': 'str', - 'attachment_tab_id': 'str', - 'document_id': 'str', - 'envelope_id': 'str', - 'page_count': 'int', - 'page_id': 'str', - 'recipient_id': 'str' - } - - self.attribute_map = { - 'attachment_description': 'attachmentDescription', - 'attachment_tab_id': 'attachmentTabId', - 'document_id': 'documentId', - 'envelope_id': 'envelopeId', - 'page_count': 'pageCount', - 'page_id': 'pageId', - 'recipient_id': 'recipientId' - } - - self._attachment_description = attachment_description - self._attachment_tab_id = attachment_tab_id - self._document_id = document_id - self._envelope_id = envelope_id - self._page_count = page_count - self._page_id = page_id - self._recipient_id = recipient_id - - @property - def attachment_description(self): - """ - Gets the attachment_description of this DisplayApplianceSignerAttachment. - - - :return: The attachment_description of this DisplayApplianceSignerAttachment. - :rtype: str - """ - return self._attachment_description - - @attachment_description.setter - def attachment_description(self, attachment_description): - """ - Sets the attachment_description of this DisplayApplianceSignerAttachment. - - - :param attachment_description: The attachment_description of this DisplayApplianceSignerAttachment. - :type: str - """ - - self._attachment_description = attachment_description - - @property - def attachment_tab_id(self): - """ - Gets the attachment_tab_id of this DisplayApplianceSignerAttachment. - - - :return: The attachment_tab_id of this DisplayApplianceSignerAttachment. - :rtype: str - """ - return self._attachment_tab_id - - @attachment_tab_id.setter - def attachment_tab_id(self, attachment_tab_id): - """ - Sets the attachment_tab_id of this DisplayApplianceSignerAttachment. - - - :param attachment_tab_id: The attachment_tab_id of this DisplayApplianceSignerAttachment. - :type: str - """ - - self._attachment_tab_id = attachment_tab_id - - @property - def document_id(self): - """ - Gets the document_id of this DisplayApplianceSignerAttachment. - Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - - :return: The document_id of this DisplayApplianceSignerAttachment. - :rtype: str - """ - return self._document_id - - @document_id.setter - def document_id(self, document_id): - """ - Sets the document_id of this DisplayApplianceSignerAttachment. - Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - - :param document_id: The document_id of this DisplayApplianceSignerAttachment. - :type: str - """ - - self._document_id = document_id - @property - def envelope_id(self): - """ - Gets the envelope_id of this DisplayApplianceSignerAttachment. - The envelope ID of the envelope status that failed to post. - - :return: The envelope_id of this DisplayApplianceSignerAttachment. - :rtype: str - """ - return self._envelope_id - - @envelope_id.setter - def envelope_id(self, envelope_id): - """ - Sets the envelope_id of this DisplayApplianceSignerAttachment. - The envelope ID of the envelope status that failed to post. - - :param envelope_id: The envelope_id of this DisplayApplianceSignerAttachment. - :type: str - """ - - self._envelope_id = envelope_id - - @property - def page_count(self): - """ - Gets the page_count of this DisplayApplianceSignerAttachment. - - - :return: The page_count of this DisplayApplianceSignerAttachment. - :rtype: int - """ - return self._page_count - - @page_count.setter - def page_count(self, page_count): - """ - Sets the page_count of this DisplayApplianceSignerAttachment. - - - :param page_count: The page_count of this DisplayApplianceSignerAttachment. - :type: int - """ - - self._page_count = page_count - - @property - def page_id(self): - """ - Gets the page_id of this DisplayApplianceSignerAttachment. - - - :return: The page_id of this DisplayApplianceSignerAttachment. - :rtype: str - """ - return self._page_id - - @page_id.setter - def page_id(self, page_id): - """ - Sets the page_id of this DisplayApplianceSignerAttachment. - - - :param page_id: The page_id of this DisplayApplianceSignerAttachment. - :type: str - """ - - self._page_id = page_id - - @property - def recipient_id(self): - """ - Gets the recipient_id of this DisplayApplianceSignerAttachment. - Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - - :return: The recipient_id of this DisplayApplianceSignerAttachment. - :rtype: str - """ - return self._recipient_id - - @recipient_id.setter - def recipient_id(self, recipient_id): - """ - Sets the recipient_id of this DisplayApplianceSignerAttachment. - Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } - :param recipient_id: The recipient_id of this DisplayApplianceSignerAttachment. - :type: str - """ + attribute_map = { + } - self._recipient_id = recipient_id + def __init__(self): # noqa: E501 + """DisplayApplianceSignerAttachment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -242,29 +61,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(DisplayApplianceSignerAttachment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, DisplayApplianceSignerAttachment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/document.py b/docusign_esign/models/document.py index f3c5ffd8..815d483c 100644 --- a/docusign_esign/models/document.py +++ b/docusign_esign/models/document.py @@ -32,6 +32,7 @@ class Document(object): """ swagger_types = { 'apply_anchor_tabs': 'str', + 'assign_tabs_to_recipient_id': 'str', 'display': 'str', 'document_base64': 'str', 'document_fields': 'list[NameValue]', @@ -59,6 +60,7 @@ class Document(object): attribute_map = { 'apply_anchor_tabs': 'applyAnchorTabs', + 'assign_tabs_to_recipient_id': 'assignTabsToRecipientId', 'display': 'display', 'document_base64': 'documentBase64', 'document_fields': 'documentFields', @@ -84,10 +86,11 @@ class Document(object): 'uri': 'uri' } - def __init__(self, apply_anchor_tabs=None, display=None, document_base64=None, document_fields=None, document_id=None, encrypted_with_key_manager=None, file_extension=None, file_format_hint=None, html_definition=None, include_in_download=None, match_boxes=None, name=None, order=None, pages=None, password=None, pdf_form_field_option=None, remote_url=None, signer_must_acknowledge=None, signer_must_acknowledge_use_account_default=None, tabs=None, template_locked=None, template_required=None, transform_pdf_fields=None, uri=None): # noqa: E501 + def __init__(self, apply_anchor_tabs=None, assign_tabs_to_recipient_id=None, display=None, document_base64=None, document_fields=None, document_id=None, encrypted_with_key_manager=None, file_extension=None, file_format_hint=None, html_definition=None, include_in_download=None, match_boxes=None, name=None, order=None, pages=None, password=None, pdf_form_field_option=None, remote_url=None, signer_must_acknowledge=None, signer_must_acknowledge_use_account_default=None, tabs=None, template_locked=None, template_required=None, transform_pdf_fields=None, uri=None): # noqa: E501 """Document - a model defined in Swagger""" # noqa: E501 self._apply_anchor_tabs = None + self._assign_tabs_to_recipient_id = None self._display = None self._document_base64 = None self._document_fields = None @@ -115,6 +118,8 @@ def __init__(self, apply_anchor_tabs=None, display=None, document_base64=None, d if apply_anchor_tabs is not None: self.apply_anchor_tabs = apply_anchor_tabs + if assign_tabs_to_recipient_id is not None: + self.assign_tabs_to_recipient_id = assign_tabs_to_recipient_id if display is not None: self.display = display if document_base64 is not None: @@ -185,6 +190,29 @@ def apply_anchor_tabs(self, apply_anchor_tabs): self._apply_anchor_tabs = apply_anchor_tabs + @property + def assign_tabs_to_recipient_id(self): + """Gets the assign_tabs_to_recipient_id of this Document. # noqa: E501 + + # noqa: E501 + + :return: The assign_tabs_to_recipient_id of this Document. # noqa: E501 + :rtype: str + """ + return self._assign_tabs_to_recipient_id + + @assign_tabs_to_recipient_id.setter + def assign_tabs_to_recipient_id(self, assign_tabs_to_recipient_id): + """Sets the assign_tabs_to_recipient_id of this Document. + + # noqa: E501 + + :param assign_tabs_to_recipient_id: The assign_tabs_to_recipient_id of this Document. # noqa: E501 + :type: str + """ + + self._assign_tabs_to_recipient_id = assign_tabs_to_recipient_id + @property def display(self): """Gets the display of this Document. # noqa: E501 diff --git a/docusign_esign/models/document_security_store.py b/docusign_esign/models/document_security_store.py index 92f1384b..ca28b3f9 100644 --- a/docusign_esign/models/document_security_store.py +++ b/docusign_esign/models/document_security_store.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,59 +11,70 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class DocumentSecurityStore(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, certificates=None, crls=None, ocsps=None): - """ - DocumentSecurityStore - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'certificates': 'list[str]', - 'crls': 'list[str]', - 'ocsps': 'list[str]' - } - - self.attribute_map = { - 'certificates': 'certificates', - 'crls': 'crls', - 'ocsps': 'ocsps' - } - - self._certificates = certificates - self._crls = crls - self._ocsps = ocsps + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'certificates': 'list[str]', + 'crls': 'list[str]', + 'ocsps': 'list[str]' + } + + attribute_map = { + 'certificates': 'certificates', + 'crls': 'crls', + 'ocsps': 'ocsps' + } + + def __init__(self, certificates=None, crls=None, ocsps=None): # noqa: E501 + """DocumentSecurityStore - a model defined in Swagger""" # noqa: E501 + + self._certificates = None + self._crls = None + self._ocsps = None + self.discriminator = None + + if certificates is not None: + self.certificates = certificates + if crls is not None: + self.crls = crls + if ocsps is not None: + self.ocsps = ocsps @property def certificates(self): - """ - Gets the certificates of this DocumentSecurityStore. - + """Gets the certificates of this DocumentSecurityStore. # noqa: E501 + + # noqa: E501 - :return: The certificates of this DocumentSecurityStore. + :return: The certificates of this DocumentSecurityStore. # noqa: E501 :rtype: list[str] """ return self._certificates @certificates.setter def certificates(self, certificates): - """ - Sets the certificates of this DocumentSecurityStore. - + """Sets the certificates of this DocumentSecurityStore. + + # noqa: E501 - :param certificates: The certificates of this DocumentSecurityStore. + :param certificates: The certificates of this DocumentSecurityStore. # noqa: E501 :type: list[str] """ @@ -71,22 +82,22 @@ def certificates(self, certificates): @property def crls(self): - """ - Gets the crls of this DocumentSecurityStore. - + """Gets the crls of this DocumentSecurityStore. # noqa: E501 + + # noqa: E501 - :return: The crls of this DocumentSecurityStore. + :return: The crls of this DocumentSecurityStore. # noqa: E501 :rtype: list[str] """ return self._crls @crls.setter def crls(self, crls): - """ - Sets the crls of this DocumentSecurityStore. - + """Sets the crls of this DocumentSecurityStore. + + # noqa: E501 - :param crls: The crls of this DocumentSecurityStore. + :param crls: The crls of this DocumentSecurityStore. # noqa: E501 :type: list[str] """ @@ -94,34 +105,32 @@ def crls(self, crls): @property def ocsps(self): - """ - Gets the ocsps of this DocumentSecurityStore. - + """Gets the ocsps of this DocumentSecurityStore. # noqa: E501 - :return: The ocsps of this DocumentSecurityStore. + # noqa: E501 + + :return: The ocsps of this DocumentSecurityStore. # noqa: E501 :rtype: list[str] """ return self._ocsps @ocsps.setter def ocsps(self, ocsps): - """ - Sets the ocsps of this DocumentSecurityStore. - + """Sets the ocsps of this DocumentSecurityStore. - :param ocsps: The ocsps of this DocumentSecurityStore. + # noqa: E501 + + :param ocsps: The ocsps of this DocumentSecurityStore. # noqa: E501 :type: list[str] """ self._ocsps = ocsps def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -138,29 +147,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(DocumentSecurityStore, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, DocumentSecurityStore): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/document_update_info.py b/docusign_esign/models/document_update_info.py index dc2357a2..642aed15 100644 --- a/docusign_esign/models/document_update_info.py +++ b/docusign_esign/models/document_update_info.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,71 +11,90 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class DocumentUpdateInfo(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, data=None, document_id=None, document_security_store=None, name=None, return_format=None, signature_data_infos=None, time_stamp_field=None): - """ - DocumentUpdateInfo - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'data': 'str', - 'document_id': 'str', - 'document_security_store': 'DocumentSecurityStore', - 'name': 'str', - 'return_format': 'str', - 'signature_data_infos': 'list[SignatureDataInfo]', - 'time_stamp_field': 'TimeStampField' - } - - self.attribute_map = { - 'data': 'data', - 'document_id': 'documentId', - 'document_security_store': 'documentSecurityStore', - 'name': 'name', - 'return_format': 'returnFormat', - 'signature_data_infos': 'signatureDataInfos', - 'time_stamp_field': 'timeStampField' - } - - self._data = data - self._document_id = document_id - self._document_security_store = document_security_store - self._name = name - self._return_format = return_format - self._signature_data_infos = signature_data_infos - self._time_stamp_field = time_stamp_field + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'data': 'str', + 'document_id': 'str', + 'document_security_store': 'DocumentSecurityStore', + 'name': 'str', + 'return_format': 'str', + 'signature_data_infos': 'list[SignatureDataInfo]', + 'time_stamp_field': 'TimeStampField' + } + + attribute_map = { + 'data': 'data', + 'document_id': 'documentId', + 'document_security_store': 'documentSecurityStore', + 'name': 'name', + 'return_format': 'returnFormat', + 'signature_data_infos': 'signatureDataInfos', + 'time_stamp_field': 'timeStampField' + } + + def __init__(self, data=None, document_id=None, document_security_store=None, name=None, return_format=None, signature_data_infos=None, time_stamp_field=None): # noqa: E501 + """DocumentUpdateInfo - a model defined in Swagger""" # noqa: E501 + + self._data = None + self._document_id = None + self._document_security_store = None + self._name = None + self._return_format = None + self._signature_data_infos = None + self._time_stamp_field = None + self.discriminator = None + + if data is not None: + self.data = data + if document_id is not None: + self.document_id = document_id + if document_security_store is not None: + self.document_security_store = document_security_store + if name is not None: + self.name = name + if return_format is not None: + self.return_format = return_format + if signature_data_infos is not None: + self.signature_data_infos = signature_data_infos + if time_stamp_field is not None: + self.time_stamp_field = time_stamp_field @property def data(self): - """ - Gets the data of this DocumentUpdateInfo. - + """Gets the data of this DocumentUpdateInfo. # noqa: E501 - :return: The data of this DocumentUpdateInfo. + # noqa: E501 + + :return: The data of this DocumentUpdateInfo. # noqa: E501 :rtype: str """ return self._data @data.setter def data(self, data): - """ - Sets the data of this DocumentUpdateInfo. - + """Sets the data of this DocumentUpdateInfo. - :param data: The data of this DocumentUpdateInfo. + # noqa: E501 + + :param data: The data of this DocumentUpdateInfo. # noqa: E501 :type: str """ @@ -83,22 +102,22 @@ def data(self, data): @property def document_id(self): - """ - Gets the document_id of this DocumentUpdateInfo. - Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + """Gets the document_id of this DocumentUpdateInfo. # noqa: E501 + + Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 - :return: The document_id of this DocumentUpdateInfo. + :return: The document_id of this DocumentUpdateInfo. # noqa: E501 :rtype: str """ return self._document_id @document_id.setter def document_id(self, document_id): - """ - Sets the document_id of this DocumentUpdateInfo. - Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + """Sets the document_id of this DocumentUpdateInfo. + + Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 - :param document_id: The document_id of this DocumentUpdateInfo. + :param document_id: The document_id of this DocumentUpdateInfo. # noqa: E501 :type: str """ @@ -106,20 +125,20 @@ def document_id(self, document_id): @property def document_security_store(self): - """ - Gets the document_security_store of this DocumentUpdateInfo. + """Gets the document_security_store of this DocumentUpdateInfo. # noqa: E501 - :return: The document_security_store of this DocumentUpdateInfo. + + :return: The document_security_store of this DocumentUpdateInfo. # noqa: E501 :rtype: DocumentSecurityStore """ return self._document_security_store @document_security_store.setter def document_security_store(self, document_security_store): - """ - Sets the document_security_store of this DocumentUpdateInfo. + """Sets the document_security_store of this DocumentUpdateInfo. + - :param document_security_store: The document_security_store of this DocumentUpdateInfo. + :param document_security_store: The document_security_store of this DocumentUpdateInfo. # noqa: E501 :type: DocumentSecurityStore """ @@ -127,22 +146,22 @@ def document_security_store(self, document_security_store): @property def name(self): - """ - Gets the name of this DocumentUpdateInfo. - + """Gets the name of this DocumentUpdateInfo. # noqa: E501 + + # noqa: E501 - :return: The name of this DocumentUpdateInfo. + :return: The name of this DocumentUpdateInfo. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this DocumentUpdateInfo. - + """Sets the name of this DocumentUpdateInfo. + + # noqa: E501 - :param name: The name of this DocumentUpdateInfo. + :param name: The name of this DocumentUpdateInfo. # noqa: E501 :type: str """ @@ -150,22 +169,22 @@ def name(self, name): @property def return_format(self): - """ - Gets the return_format of this DocumentUpdateInfo. - + """Gets the return_format of this DocumentUpdateInfo. # noqa: E501 + + # noqa: E501 - :return: The return_format of this DocumentUpdateInfo. + :return: The return_format of this DocumentUpdateInfo. # noqa: E501 :rtype: str """ return self._return_format @return_format.setter def return_format(self, return_format): - """ - Sets the return_format of this DocumentUpdateInfo. - + """Sets the return_format of this DocumentUpdateInfo. - :param return_format: The return_format of this DocumentUpdateInfo. + # noqa: E501 + + :param return_format: The return_format of this DocumentUpdateInfo. # noqa: E501 :type: str """ @@ -173,22 +192,22 @@ def return_format(self, return_format): @property def signature_data_infos(self): - """ - Gets the signature_data_infos of this DocumentUpdateInfo. - + """Gets the signature_data_infos of this DocumentUpdateInfo. # noqa: E501 - :return: The signature_data_infos of this DocumentUpdateInfo. + # noqa: E501 + + :return: The signature_data_infos of this DocumentUpdateInfo. # noqa: E501 :rtype: list[SignatureDataInfo] """ return self._signature_data_infos @signature_data_infos.setter def signature_data_infos(self, signature_data_infos): - """ - Sets the signature_data_infos of this DocumentUpdateInfo. - + """Sets the signature_data_infos of this DocumentUpdateInfo. - :param signature_data_infos: The signature_data_infos of this DocumentUpdateInfo. + # noqa: E501 + + :param signature_data_infos: The signature_data_infos of this DocumentUpdateInfo. # noqa: E501 :type: list[SignatureDataInfo] """ @@ -196,32 +215,30 @@ def signature_data_infos(self, signature_data_infos): @property def time_stamp_field(self): - """ - Gets the time_stamp_field of this DocumentUpdateInfo. + """Gets the time_stamp_field of this DocumentUpdateInfo. # noqa: E501 + - :return: The time_stamp_field of this DocumentUpdateInfo. + :return: The time_stamp_field of this DocumentUpdateInfo. # noqa: E501 :rtype: TimeStampField """ return self._time_stamp_field @time_stamp_field.setter def time_stamp_field(self, time_stamp_field): - """ - Sets the time_stamp_field of this DocumentUpdateInfo. + """Sets the time_stamp_field of this DocumentUpdateInfo. + - :param time_stamp_field: The time_stamp_field of this DocumentUpdateInfo. + :param time_stamp_field: The time_stamp_field of this DocumentUpdateInfo. # noqa: E501 :type: TimeStampField """ self._time_stamp_field = time_stamp_field def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -238,29 +255,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(DocumentUpdateInfo, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, DocumentUpdateInfo): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/envelope_document.py b/docusign_esign/models/envelope_document.py index 6843955e..136c01da 100644 --- a/docusign_esign/models/envelope_document.py +++ b/docusign_esign/models/envelope_document.py @@ -622,7 +622,7 @@ def size_bytes(self): # noqa: E501 :return: The size_bytes of this EnvelopeDocument. # noqa: E501 - :rtype: str + :rtype: object """ return self._size_bytes @@ -633,7 +633,7 @@ def size_bytes(self, size_bytes): # noqa: E501 :param size_bytes: The size_bytes of this EnvelopeDocument. # noqa: E501 - :type: str + :type: object """ self._size_bytes = size_bytes diff --git a/docusign_esign/models/envelope_form_data.py b/docusign_esign/models/envelope_form_data.py index 951ff45c..b85ec839 100644 --- a/docusign_esign/models/envelope_form_data.py +++ b/docusign_esign/models/envelope_form_data.py @@ -34,6 +34,7 @@ class EnvelopeFormData(object): 'email_subject': 'str', 'envelope_id': 'str', 'form_data': 'list[FormDataItem]', + 'prefill_form_data': 'list[FormDataItem]', 'recipient_form_data': 'list[RecipientFormData]', 'sent_date_time': 'str', 'status': 'str' @@ -43,17 +44,19 @@ class EnvelopeFormData(object): 'email_subject': 'emailSubject', 'envelope_id': 'envelopeId', 'form_data': 'formData', + 'prefill_form_data': 'prefillFormData', 'recipient_form_data': 'recipientFormData', 'sent_date_time': 'sentDateTime', 'status': 'status' } - def __init__(self, email_subject=None, envelope_id=None, form_data=None, recipient_form_data=None, sent_date_time=None, status=None): # noqa: E501 + def __init__(self, email_subject=None, envelope_id=None, form_data=None, prefill_form_data=None, recipient_form_data=None, sent_date_time=None, status=None): # noqa: E501 """EnvelopeFormData - a model defined in Swagger""" # noqa: E501 self._email_subject = None self._envelope_id = None self._form_data = None + self._prefill_form_data = None self._recipient_form_data = None self._sent_date_time = None self._status = None @@ -65,6 +68,8 @@ def __init__(self, email_subject=None, envelope_id=None, form_data=None, recipie self.envelope_id = envelope_id if form_data is not None: self.form_data = form_data + if prefill_form_data is not None: + self.prefill_form_data = prefill_form_data if recipient_form_data is not None: self.recipient_form_data = recipient_form_data if sent_date_time is not None: @@ -141,6 +146,29 @@ def form_data(self, form_data): self._form_data = form_data + @property + def prefill_form_data(self): + """Gets the prefill_form_data of this EnvelopeFormData. # noqa: E501 + + # noqa: E501 + + :return: The prefill_form_data of this EnvelopeFormData. # noqa: E501 + :rtype: list[FormDataItem] + """ + return self._prefill_form_data + + @prefill_form_data.setter + def prefill_form_data(self, prefill_form_data): + """Sets the prefill_form_data of this EnvelopeFormData. + + # noqa: E501 + + :param prefill_form_data: The prefill_form_data of this EnvelopeFormData. # noqa: E501 + :type: list[FormDataItem] + """ + + self._prefill_form_data = prefill_form_data + @property def recipient_form_data(self): """Gets the recipient_form_data of this EnvelopeFormData. # noqa: E501 diff --git a/docusign_esign/models/external_claim.py b/docusign_esign/models/external_claim.py index 7e2392a0..501e56ce 100644 --- a/docusign_esign/models/external_claim.py +++ b/docusign_esign/models/external_claim.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,62 +11,75 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class ExternalClaim(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, acquired_time=None, claim_name=None, provider=None, value=None): - """ - ExternalClaim - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'acquired_time': 'str', - 'claim_name': 'str', - 'provider': 'str', - 'value': 'str' - } - - self.attribute_map = { - 'acquired_time': 'acquiredTime', - 'claim_name': 'claimName', - 'provider': 'provider', - 'value': 'value' - } - self._acquired_time = acquired_time - self._claim_name = claim_name - self._provider = provider - self._value = value + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'acquired_time': 'str', + 'claim_name': 'str', + 'provider': 'str', + 'value': 'str' + } + + attribute_map = { + 'acquired_time': 'acquiredTime', + 'claim_name': 'claimName', + 'provider': 'provider', + 'value': 'value' + } + + def __init__(self, acquired_time=None, claim_name=None, provider=None, value=None): # noqa: E501 + """ExternalClaim - a model defined in Swagger""" # noqa: E501 + + self._acquired_time = None + self._claim_name = None + self._provider = None + self._value = None + self.discriminator = None + + if acquired_time is not None: + self.acquired_time = acquired_time + if claim_name is not None: + self.claim_name = claim_name + if provider is not None: + self.provider = provider + if value is not None: + self.value = value @property def acquired_time(self): - """ - Gets the acquired_time of this ExternalClaim. - + """Gets the acquired_time of this ExternalClaim. # noqa: E501 - :return: The acquired_time of this ExternalClaim. + # noqa: E501 + + :return: The acquired_time of this ExternalClaim. # noqa: E501 :rtype: str """ return self._acquired_time @acquired_time.setter def acquired_time(self, acquired_time): - """ - Sets the acquired_time of this ExternalClaim. - + """Sets the acquired_time of this ExternalClaim. - :param acquired_time: The acquired_time of this ExternalClaim. + # noqa: E501 + + :param acquired_time: The acquired_time of this ExternalClaim. # noqa: E501 :type: str """ @@ -74,22 +87,22 @@ def acquired_time(self, acquired_time): @property def claim_name(self): - """ - Gets the claim_name of this ExternalClaim. - + """Gets the claim_name of this ExternalClaim. # noqa: E501 + + # noqa: E501 - :return: The claim_name of this ExternalClaim. + :return: The claim_name of this ExternalClaim. # noqa: E501 :rtype: str """ return self._claim_name @claim_name.setter def claim_name(self, claim_name): - """ - Sets the claim_name of this ExternalClaim. - + """Sets the claim_name of this ExternalClaim. + + # noqa: E501 - :param claim_name: The claim_name of this ExternalClaim. + :param claim_name: The claim_name of this ExternalClaim. # noqa: E501 :type: str """ @@ -97,22 +110,22 @@ def claim_name(self, claim_name): @property def provider(self): - """ - Gets the provider of this ExternalClaim. - + """Gets the provider of this ExternalClaim. # noqa: E501 + + # noqa: E501 - :return: The provider of this ExternalClaim. + :return: The provider of this ExternalClaim. # noqa: E501 :rtype: str """ return self._provider @provider.setter def provider(self, provider): - """ - Sets the provider of this ExternalClaim. - + """Sets the provider of this ExternalClaim. - :param provider: The provider of this ExternalClaim. + # noqa: E501 + + :param provider: The provider of this ExternalClaim. # noqa: E501 :type: str """ @@ -120,34 +133,32 @@ def provider(self, provider): @property def value(self): - """ - Gets the value of this ExternalClaim. - Specifies the value of the tab. + """Gets the value of this ExternalClaim. # noqa: E501 - :return: The value of this ExternalClaim. + Specifies the value of the tab. # noqa: E501 + + :return: The value of this ExternalClaim. # noqa: E501 :rtype: str """ return self._value @value.setter def value(self, value): - """ - Sets the value of this ExternalClaim. - Specifies the value of the tab. + """Sets the value of this ExternalClaim. + + Specifies the value of the tab. # noqa: E501 - :param value: The value of this ExternalClaim. + :param value: The value of this ExternalClaim. # noqa: E501 :type: str """ self._value = value def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -164,29 +175,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(ExternalClaim, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, ExternalClaim): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/group_brands.py b/docusign_esign/models/group_brands.py new file mode 100644 index 00000000..d36ebed9 --- /dev/null +++ b/docusign_esign/models/group_brands.py @@ -0,0 +1,173 @@ +# coding: utf-8 + +""" + DocuSign REST API + + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 + + OpenAPI spec version: v2.1 + Contact: devcenter@docusign.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class GroupBrands(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'recipient_brand_id_default': 'str', + 'sender_brand_id_default': 'str', + 'brand_options': 'list[Brand]' + } + + attribute_map = { + 'recipient_brand_id_default': 'recipientBrandIdDefault', + 'sender_brand_id_default': 'senderBrandIdDefault', + 'brand_options': 'brandOptions' + } + + def __init__(self, recipient_brand_id_default=None, sender_brand_id_default=None, brand_options=None): # noqa: E501 + """GroupBrands - a model defined in Swagger""" # noqa: E501 + + self._recipient_brand_id_default = None + self._sender_brand_id_default = None + self._brand_options = None + self.discriminator = None + + if recipient_brand_id_default is not None: + self.recipient_brand_id_default = recipient_brand_id_default + if sender_brand_id_default is not None: + self.sender_brand_id_default = sender_brand_id_default + if brand_options is not None: + self.brand_options = brand_options + + @property + def recipient_brand_id_default(self): + """Gets the recipient_brand_id_default of this GroupBrands. # noqa: E501 + + The brand seen by envelope recipients when a brand is not explicitly set. # noqa: E501 + + :return: The recipient_brand_id_default of this GroupBrands. # noqa: E501 + :rtype: str + """ + return self._recipient_brand_id_default + + @recipient_brand_id_default.setter + def recipient_brand_id_default(self, recipient_brand_id_default): + """Sets the recipient_brand_id_default of this GroupBrands. + + The brand seen by envelope recipients when a brand is not explicitly set. # noqa: E501 + + :param recipient_brand_id_default: The recipient_brand_id_default of this GroupBrands. # noqa: E501 + :type: str + """ + + self._recipient_brand_id_default = recipient_brand_id_default + + @property + def sender_brand_id_default(self): + """Gets the sender_brand_id_default of this GroupBrands. # noqa: E501 + + The brand seen by envelope senders when a brand is not explicitly set. # noqa: E501 + + :return: The sender_brand_id_default of this GroupBrands. # noqa: E501 + :rtype: str + """ + return self._sender_brand_id_default + + @sender_brand_id_default.setter + def sender_brand_id_default(self, sender_brand_id_default): + """Sets the sender_brand_id_default of this GroupBrands. + + The brand seen by envelope senders when a brand is not explicitly set. # noqa: E501 + + :param sender_brand_id_default: The sender_brand_id_default of this GroupBrands. # noqa: E501 + :type: str + """ + + self._sender_brand_id_default = sender_brand_id_default + + @property + def brand_options(self): + """Gets the brand_options of this GroupBrands. # noqa: E501 + + The list of brands. # noqa: E501 + + :return: The brand_options of this GroupBrands. # noqa: E501 + :rtype: list[Brand] + """ + return self._brand_options + + @brand_options.setter + def brand_options(self, brand_options): + """Sets the brand_options of this GroupBrands. + + The list of brands. # noqa: E501 + + :param brand_options: The brand_options of this GroupBrands. # noqa: E501 + :type: list[Brand] + """ + + self._brand_options = brand_options + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(GroupBrands, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, GroupBrands): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/docusign_esign/models/payment_details.py b/docusign_esign/models/payment_details.py index f5e6e4d6..141300bc 100644 --- a/docusign_esign/models/payment_details.py +++ b/docusign_esign/models/payment_details.py @@ -45,6 +45,7 @@ class PaymentDetails(object): 'line_items': 'list[PaymentLineItem]', 'payment_option': 'str', 'payment_source_id': 'str', + 'signer_values': 'PaymentSignerValues', 'status': 'str', 'total': 'Money' } @@ -64,11 +65,12 @@ class PaymentDetails(object): 'line_items': 'lineItems', 'payment_option': 'paymentOption', 'payment_source_id': 'paymentSourceId', + 'signer_values': 'signerValues', 'status': 'status', 'total': 'total' } - def __init__(self, allowed_payment_methods=None, charge_id=None, currency_code=None, currency_code_metadata=None, customer_id=None, custom_metadata=None, custom_metadata_required=None, gateway_account_id=None, gateway_account_id_metadata=None, gateway_display_name=None, gateway_name=None, line_items=None, payment_option=None, payment_source_id=None, status=None, total=None): # noqa: E501 + def __init__(self, allowed_payment_methods=None, charge_id=None, currency_code=None, currency_code_metadata=None, customer_id=None, custom_metadata=None, custom_metadata_required=None, gateway_account_id=None, gateway_account_id_metadata=None, gateway_display_name=None, gateway_name=None, line_items=None, payment_option=None, payment_source_id=None, signer_values=None, status=None, total=None): # noqa: E501 """PaymentDetails - a model defined in Swagger""" # noqa: E501 self._allowed_payment_methods = None @@ -85,6 +87,7 @@ def __init__(self, allowed_payment_methods=None, charge_id=None, currency_code=N self._line_items = None self._payment_option = None self._payment_source_id = None + self._signer_values = None self._status = None self._total = None self.discriminator = None @@ -117,6 +120,8 @@ def __init__(self, allowed_payment_methods=None, charge_id=None, currency_code=N self.payment_option = payment_option if payment_source_id is not None: self.payment_source_id = payment_source_id + if signer_values is not None: + self.signer_values = signer_values if status is not None: self.status = status if total is not None: @@ -440,6 +445,27 @@ def payment_source_id(self, payment_source_id): self._payment_source_id = payment_source_id + @property + def signer_values(self): + """Gets the signer_values of this PaymentDetails. # noqa: E501 + + + :return: The signer_values of this PaymentDetails. # noqa: E501 + :rtype: PaymentSignerValues + """ + return self._signer_values + + @signer_values.setter + def signer_values(self, signer_values): + """Sets the signer_values of this PaymentDetails. + + + :param signer_values: The signer_values of this PaymentDetails. # noqa: E501 + :type: PaymentSignerValues + """ + + self._signer_values = signer_values + @property def status(self): """Gets the status of this PaymentDetails. # noqa: E501 diff --git a/docusign_esign/models/payment_signer_values.py b/docusign_esign/models/payment_signer_values.py new file mode 100644 index 00000000..3f7a95b6 --- /dev/null +++ b/docusign_esign/models/payment_signer_values.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + DocuSign REST API + + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 + + OpenAPI spec version: v2.1 + Contact: devcenter@docusign.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class PaymentSignerValues(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'payment_option': 'str' + } + + attribute_map = { + 'payment_option': 'paymentOption' + } + + def __init__(self, payment_option=None): # noqa: E501 + """PaymentSignerValues - a model defined in Swagger""" # noqa: E501 + + self._payment_option = None + self.discriminator = None + + if payment_option is not None: + self.payment_option = payment_option + + @property + def payment_option(self): + """Gets the payment_option of this PaymentSignerValues. # noqa: E501 + + # noqa: E501 + + :return: The payment_option of this PaymentSignerValues. # noqa: E501 + :rtype: str + """ + return self._payment_option + + @payment_option.setter + def payment_option(self, payment_option): + """Sets the payment_option of this PaymentSignerValues. + + # noqa: E501 + + :param payment_option: The payment_option of this PaymentSignerValues. # noqa: E501 + :type: str + """ + + self._payment_option = payment_option + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PaymentSignerValues, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PaymentSignerValues): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/docusign_esign/models/prefill_tabs.py b/docusign_esign/models/prefill_tabs.py new file mode 100644 index 00000000..92f3b27e --- /dev/null +++ b/docusign_esign/models/prefill_tabs.py @@ -0,0 +1,201 @@ +# coding: utf-8 + +""" + DocuSign REST API + + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 + + OpenAPI spec version: v2.1 + Contact: devcenter@docusign.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class PrefillTabs(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'checkbox_tabs': 'list[Checkbox]', + 'radio_group_tabs': 'list[RadioGroup]', + 'tab_groups': 'list[TabGroup]', + 'text_tabs': 'list[Text]' + } + + attribute_map = { + 'checkbox_tabs': 'checkboxTabs', + 'radio_group_tabs': 'radioGroupTabs', + 'tab_groups': 'tabGroups', + 'text_tabs': 'textTabs' + } + + def __init__(self, checkbox_tabs=None, radio_group_tabs=None, tab_groups=None, text_tabs=None): # noqa: E501 + """PrefillTabs - a model defined in Swagger""" # noqa: E501 + + self._checkbox_tabs = None + self._radio_group_tabs = None + self._tab_groups = None + self._text_tabs = None + self.discriminator = None + + if checkbox_tabs is not None: + self.checkbox_tabs = checkbox_tabs + if radio_group_tabs is not None: + self.radio_group_tabs = radio_group_tabs + if tab_groups is not None: + self.tab_groups = tab_groups + if text_tabs is not None: + self.text_tabs = text_tabs + + @property + def checkbox_tabs(self): + """Gets the checkbox_tabs of this PrefillTabs. # noqa: E501 + + Specifies a tag on the document in a location where the recipient can select an option. # noqa: E501 + + :return: The checkbox_tabs of this PrefillTabs. # noqa: E501 + :rtype: list[Checkbox] + """ + return self._checkbox_tabs + + @checkbox_tabs.setter + def checkbox_tabs(self, checkbox_tabs): + """Sets the checkbox_tabs of this PrefillTabs. + + Specifies a tag on the document in a location where the recipient can select an option. # noqa: E501 + + :param checkbox_tabs: The checkbox_tabs of this PrefillTabs. # noqa: E501 + :type: list[Checkbox] + """ + + self._checkbox_tabs = checkbox_tabs + + @property + def radio_group_tabs(self): + """Gets the radio_group_tabs of this PrefillTabs. # noqa: E501 + + Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. # noqa: E501 + + :return: The radio_group_tabs of this PrefillTabs. # noqa: E501 + :rtype: list[RadioGroup] + """ + return self._radio_group_tabs + + @radio_group_tabs.setter + def radio_group_tabs(self, radio_group_tabs): + """Sets the radio_group_tabs of this PrefillTabs. + + Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. # noqa: E501 + + :param radio_group_tabs: The radio_group_tabs of this PrefillTabs. # noqa: E501 + :type: list[RadioGroup] + """ + + self._radio_group_tabs = radio_group_tabs + + @property + def tab_groups(self): + """Gets the tab_groups of this PrefillTabs. # noqa: E501 + + # noqa: E501 + + :return: The tab_groups of this PrefillTabs. # noqa: E501 + :rtype: list[TabGroup] + """ + return self._tab_groups + + @tab_groups.setter + def tab_groups(self, tab_groups): + """Sets the tab_groups of this PrefillTabs. + + # noqa: E501 + + :param tab_groups: The tab_groups of this PrefillTabs. # noqa: E501 + :type: list[TabGroup] + """ + + self._tab_groups = tab_groups + + @property + def text_tabs(self): + """Gets the text_tabs of this PrefillTabs. # noqa: E501 + + Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 + + :return: The text_tabs of this PrefillTabs. # noqa: E501 + :rtype: list[Text] + """ + return self._text_tabs + + @text_tabs.setter + def text_tabs(self, text_tabs): + """Sets the text_tabs of this PrefillTabs. + + Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 + + :param text_tabs: The text_tabs of this PrefillTabs. # noqa: E501 + :type: list[Text] + """ + + self._text_tabs = text_tabs + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PrefillTabs, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PrefillTabs): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/docusign_esign/models/revision.py b/docusign_esign/models/revision.py index ee407820..b508d255 100644 --- a/docusign_esign/models/revision.py +++ b/docusign_esign/models/revision.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,68 +11,85 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class Revision(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, end_data=None, field_name=None, max_signature_length=None, signature_properties=None, signature_type=None, start_data=None): - """ - Revision - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'end_data': 'str', - 'field_name': 'str', - 'max_signature_length': 'str', - 'signature_properties': 'SignatureProperties', - 'signature_type': 'str', - 'start_data': 'str' - } - - self.attribute_map = { - 'end_data': 'endData', - 'field_name': 'fieldName', - 'max_signature_length': 'maxSignatureLength', - 'signature_properties': 'signatureProperties', - 'signature_type': 'signatureType', - 'start_data': 'startData' - } - - self._end_data = end_data - self._field_name = field_name - self._max_signature_length = max_signature_length - self._signature_properties = signature_properties - self._signature_type = signature_type - self._start_data = start_data + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'end_data': 'str', + 'field_name': 'str', + 'max_signature_length': 'str', + 'signature_properties': 'SignatureProperties', + 'signature_type': 'str', + 'start_data': 'str' + } + + attribute_map = { + 'end_data': 'endData', + 'field_name': 'fieldName', + 'max_signature_length': 'maxSignatureLength', + 'signature_properties': 'signatureProperties', + 'signature_type': 'signatureType', + 'start_data': 'startData' + } + + def __init__(self, end_data=None, field_name=None, max_signature_length=None, signature_properties=None, signature_type=None, start_data=None): # noqa: E501 + """Revision - a model defined in Swagger""" # noqa: E501 + + self._end_data = None + self._field_name = None + self._max_signature_length = None + self._signature_properties = None + self._signature_type = None + self._start_data = None + self.discriminator = None + + if end_data is not None: + self.end_data = end_data + if field_name is not None: + self.field_name = field_name + if max_signature_length is not None: + self.max_signature_length = max_signature_length + if signature_properties is not None: + self.signature_properties = signature_properties + if signature_type is not None: + self.signature_type = signature_type + if start_data is not None: + self.start_data = start_data @property def end_data(self): - """ - Gets the end_data of this Revision. - + """Gets the end_data of this Revision. # noqa: E501 + + # noqa: E501 - :return: The end_data of this Revision. + :return: The end_data of this Revision. # noqa: E501 :rtype: str """ return self._end_data @end_data.setter def end_data(self, end_data): - """ - Sets the end_data of this Revision. - + """Sets the end_data of this Revision. + + # noqa: E501 - :param end_data: The end_data of this Revision. + :param end_data: The end_data of this Revision. # noqa: E501 :type: str """ @@ -80,22 +97,22 @@ def end_data(self, end_data): @property def field_name(self): - """ - Gets the field_name of this Revision. - + """Gets the field_name of this Revision. # noqa: E501 - :return: The field_name of this Revision. + # noqa: E501 + + :return: The field_name of this Revision. # noqa: E501 :rtype: str """ return self._field_name @field_name.setter def field_name(self, field_name): - """ - Sets the field_name of this Revision. - + """Sets the field_name of this Revision. + + # noqa: E501 - :param field_name: The field_name of this Revision. + :param field_name: The field_name of this Revision. # noqa: E501 :type: str """ @@ -103,22 +120,22 @@ def field_name(self, field_name): @property def max_signature_length(self): - """ - Gets the max_signature_length of this Revision. - + """Gets the max_signature_length of this Revision. # noqa: E501 + + # noqa: E501 - :return: The max_signature_length of this Revision. + :return: The max_signature_length of this Revision. # noqa: E501 :rtype: str """ return self._max_signature_length @max_signature_length.setter def max_signature_length(self, max_signature_length): - """ - Sets the max_signature_length of this Revision. - + """Sets the max_signature_length of this Revision. - :param max_signature_length: The max_signature_length of this Revision. + # noqa: E501 + + :param max_signature_length: The max_signature_length of this Revision. # noqa: E501 :type: str """ @@ -126,20 +143,20 @@ def max_signature_length(self, max_signature_length): @property def signature_properties(self): - """ - Gets the signature_properties of this Revision. + """Gets the signature_properties of this Revision. # noqa: E501 + - :return: The signature_properties of this Revision. + :return: The signature_properties of this Revision. # noqa: E501 :rtype: SignatureProperties """ return self._signature_properties @signature_properties.setter def signature_properties(self, signature_properties): - """ - Sets the signature_properties of this Revision. + """Sets the signature_properties of this Revision. + - :param signature_properties: The signature_properties of this Revision. + :param signature_properties: The signature_properties of this Revision. # noqa: E501 :type: SignatureProperties """ @@ -147,22 +164,22 @@ def signature_properties(self, signature_properties): @property def signature_type(self): - """ - Gets the signature_type of this Revision. - + """Gets the signature_type of this Revision. # noqa: E501 - :return: The signature_type of this Revision. + # noqa: E501 + + :return: The signature_type of this Revision. # noqa: E501 :rtype: str """ return self._signature_type @signature_type.setter def signature_type(self, signature_type): - """ - Sets the signature_type of this Revision. - + """Sets the signature_type of this Revision. + + # noqa: E501 - :param signature_type: The signature_type of this Revision. + :param signature_type: The signature_type of this Revision. # noqa: E501 :type: str """ @@ -170,34 +187,32 @@ def signature_type(self, signature_type): @property def start_data(self): - """ - Gets the start_data of this Revision. - + """Gets the start_data of this Revision. # noqa: E501 + + # noqa: E501 - :return: The start_data of this Revision. + :return: The start_data of this Revision. # noqa: E501 :rtype: str """ return self._start_data @start_data.setter def start_data(self, start_data): - """ - Sets the start_data of this Revision. - + """Sets the start_data of this Revision. - :param start_data: The start_data of this Revision. + # noqa: E501 + + :param start_data: The start_data of this Revision. # noqa: E501 :type: str """ self._start_data = start_data def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -214,29 +229,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Revision, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Revision): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/seal.py b/docusign_esign/models/seal.py index f88cca5d..672cfd4b 100644 --- a/docusign_esign/models/seal.py +++ b/docusign_esign/models/seal.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,56 +11,65 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class Seal(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, configuration=None, seal_identifier=None): - """ - Seal - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'configuration': 'dict(str, str)', - 'seal_identifier': 'str' - } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'configuration': 'dict(str, str)', + 'seal_identifier': 'str' + } - self.attribute_map = { - 'configuration': 'configuration', - 'seal_identifier': 'sealIdentifier' - } + attribute_map = { + 'configuration': 'configuration', + 'seal_identifier': 'sealIdentifier' + } - self._configuration = configuration - self._seal_identifier = seal_identifier + def __init__(self, configuration=None, seal_identifier=None): # noqa: E501 + """Seal - a model defined in Swagger""" # noqa: E501 + + self._configuration = None + self._seal_identifier = None + self.discriminator = None + + if configuration is not None: + self.configuration = configuration + if seal_identifier is not None: + self.seal_identifier = seal_identifier @property def configuration(self): - """ - Gets the configuration of this Seal. - + """Gets the configuration of this Seal. # noqa: E501 - :return: The configuration of this Seal. + # noqa: E501 + + :return: The configuration of this Seal. # noqa: E501 :rtype: dict(str, str) """ return self._configuration @configuration.setter def configuration(self, configuration): - """ - Sets the configuration of this Seal. - + """Sets the configuration of this Seal. + + # noqa: E501 - :param configuration: The configuration of this Seal. + :param configuration: The configuration of this Seal. # noqa: E501 :type: dict(str, str) """ @@ -68,34 +77,32 @@ def configuration(self, configuration): @property def seal_identifier(self): - """ - Gets the seal_identifier of this Seal. - + """Gets the seal_identifier of this Seal. # noqa: E501 + + # noqa: E501 - :return: The seal_identifier of this Seal. + :return: The seal_identifier of this Seal. # noqa: E501 :rtype: str """ return self._seal_identifier @seal_identifier.setter def seal_identifier(self, seal_identifier): - """ - Sets the seal_identifier of this Seal. - + """Sets the seal_identifier of this Seal. + + # noqa: E501 - :param seal_identifier: The seal_identifier of this Seal. + :param seal_identifier: The seal_identifier of this Seal. # noqa: E501 :type: str """ self._seal_identifier = seal_identifier def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -112,29 +119,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Seal, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Seal): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/sender.py b/docusign_esign/models/sender.py index 76bfd2c0..60d0d530 100644 --- a/docusign_esign/models/sender.py +++ b/docusign_esign/models/sender.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,56 +11,65 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class Sender(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, account_id_guid=None, company_name=None): - """ - Sender - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'account_id_guid': 'str', - 'company_name': 'str' - } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'account_id_guid': 'str', + 'company_name': 'str' + } - self.attribute_map = { - 'account_id_guid': 'accountIdGuid', - 'company_name': 'companyName' - } + attribute_map = { + 'account_id_guid': 'accountIdGuid', + 'company_name': 'companyName' + } - self._account_id_guid = account_id_guid - self._company_name = company_name + def __init__(self, account_id_guid=None, company_name=None): # noqa: E501 + """Sender - a model defined in Swagger""" # noqa: E501 + + self._account_id_guid = None + self._company_name = None + self.discriminator = None + + if account_id_guid is not None: + self.account_id_guid = account_id_guid + if company_name is not None: + self.company_name = company_name @property def account_id_guid(self): - """ - Gets the account_id_guid of this Sender. - The GUID associated with the account ID. + """Gets the account_id_guid of this Sender. # noqa: E501 - :return: The account_id_guid of this Sender. + The GUID associated with the account ID. # noqa: E501 + + :return: The account_id_guid of this Sender. # noqa: E501 :rtype: str """ return self._account_id_guid @account_id_guid.setter def account_id_guid(self, account_id_guid): - """ - Sets the account_id_guid of this Sender. - The GUID associated with the account ID. + """Sets the account_id_guid of this Sender. + + The GUID associated with the account ID. # noqa: E501 - :param account_id_guid: The account_id_guid of this Sender. + :param account_id_guid: The account_id_guid of this Sender. # noqa: E501 :type: str """ @@ -68,34 +77,32 @@ def account_id_guid(self, account_id_guid): @property def company_name(self): - """ - Gets the company_name of this Sender. - + """Gets the company_name of this Sender. # noqa: E501 + + # noqa: E501 - :return: The company_name of this Sender. + :return: The company_name of this Sender. # noqa: E501 :rtype: str """ return self._company_name @company_name.setter def company_name(self, company_name): - """ - Sets the company_name of this Sender. - + """Sets the company_name of this Sender. + + # noqa: E501 - :param company_name: The company_name of this Sender. + :param company_name: The company_name of this Sender. # noqa: E501 :type: str """ self._company_name = company_name def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -112,29 +119,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Sender, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Sender): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/sign_hash_document.py b/docusign_esign/models/sign_hash_document.py index 93bf5e45..4d09d381 100644 --- a/docusign_esign/models/sign_hash_document.py +++ b/docusign_esign/models/sign_hash_document.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,74 +11,95 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class SignHashDocument(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, data=None, document_id=None, format=None, name=None, remaining_signatures=None, revisions=None, signature_properties=None, signature_type=None): - """ - SignHashDocument - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'data': 'str', - 'document_id': 'str', - 'format': 'str', - 'name': 'str', - 'remaining_signatures': 'int', - 'revisions': 'list[Revision]', - 'signature_properties': 'SignatureProperties', - 'signature_type': 'str' - } - - self.attribute_map = { - 'data': 'data', - 'document_id': 'documentId', - 'format': 'format', - 'name': 'name', - 'remaining_signatures': 'remainingSignatures', - 'revisions': 'revisions', - 'signature_properties': 'signatureProperties', - 'signature_type': 'signatureType' - } - - self._data = data - self._document_id = document_id - self._format = format - self._name = name - self._remaining_signatures = remaining_signatures - self._revisions = revisions - self._signature_properties = signature_properties - self._signature_type = signature_type + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'data': 'str', + 'document_id': 'str', + 'format': 'str', + 'name': 'str', + 'remaining_signatures': 'int', + 'revisions': 'list[Revision]', + 'signature_properties': 'SignatureProperties', + 'signature_type': 'str' + } + + attribute_map = { + 'data': 'data', + 'document_id': 'documentId', + 'format': 'format', + 'name': 'name', + 'remaining_signatures': 'remainingSignatures', + 'revisions': 'revisions', + 'signature_properties': 'signatureProperties', + 'signature_type': 'signatureType' + } + + def __init__(self, data=None, document_id=None, format=None, name=None, remaining_signatures=None, revisions=None, signature_properties=None, signature_type=None): # noqa: E501 + """SignHashDocument - a model defined in Swagger""" # noqa: E501 + + self._data = None + self._document_id = None + self._format = None + self._name = None + self._remaining_signatures = None + self._revisions = None + self._signature_properties = None + self._signature_type = None + self.discriminator = None + + if data is not None: + self.data = data + if document_id is not None: + self.document_id = document_id + if format is not None: + self.format = format + if name is not None: + self.name = name + if remaining_signatures is not None: + self.remaining_signatures = remaining_signatures + if revisions is not None: + self.revisions = revisions + if signature_properties is not None: + self.signature_properties = signature_properties + if signature_type is not None: + self.signature_type = signature_type @property def data(self): - """ - Gets the data of this SignHashDocument. - + """Gets the data of this SignHashDocument. # noqa: E501 - :return: The data of this SignHashDocument. + # noqa: E501 + + :return: The data of this SignHashDocument. # noqa: E501 :rtype: str """ return self._data @data.setter def data(self, data): - """ - Sets the data of this SignHashDocument. - + """Sets the data of this SignHashDocument. - :param data: The data of this SignHashDocument. + # noqa: E501 + + :param data: The data of this SignHashDocument. # noqa: E501 :type: str """ @@ -86,22 +107,22 @@ def data(self, data): @property def document_id(self): - """ - Gets the document_id of this SignHashDocument. - Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + """Gets the document_id of this SignHashDocument. # noqa: E501 - :return: The document_id of this SignHashDocument. + Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 + + :return: The document_id of this SignHashDocument. # noqa: E501 :rtype: str """ return self._document_id @document_id.setter def document_id(self, document_id): - """ - Sets the document_id of this SignHashDocument. - Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + """Sets the document_id of this SignHashDocument. - :param document_id: The document_id of this SignHashDocument. + Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 + + :param document_id: The document_id of this SignHashDocument. # noqa: E501 :type: str """ @@ -109,22 +130,22 @@ def document_id(self, document_id): @property def format(self): - """ - Gets the format of this SignHashDocument. - + """Gets the format of this SignHashDocument. # noqa: E501 - :return: The format of this SignHashDocument. + # noqa: E501 + + :return: The format of this SignHashDocument. # noqa: E501 :rtype: str """ return self._format @format.setter def format(self, format): - """ - Sets the format of this SignHashDocument. - + """Sets the format of this SignHashDocument. - :param format: The format of this SignHashDocument. + # noqa: E501 + + :param format: The format of this SignHashDocument. # noqa: E501 :type: str """ @@ -132,22 +153,22 @@ def format(self, format): @property def name(self): - """ - Gets the name of this SignHashDocument. - + """Gets the name of this SignHashDocument. # noqa: E501 + + # noqa: E501 - :return: The name of this SignHashDocument. + :return: The name of this SignHashDocument. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this SignHashDocument. - + """Sets the name of this SignHashDocument. + + # noqa: E501 - :param name: The name of this SignHashDocument. + :param name: The name of this SignHashDocument. # noqa: E501 :type: str """ @@ -155,22 +176,22 @@ def name(self, name): @property def remaining_signatures(self): - """ - Gets the remaining_signatures of this SignHashDocument. - + """Gets the remaining_signatures of this SignHashDocument. # noqa: E501 + + # noqa: E501 - :return: The remaining_signatures of this SignHashDocument. + :return: The remaining_signatures of this SignHashDocument. # noqa: E501 :rtype: int """ return self._remaining_signatures @remaining_signatures.setter def remaining_signatures(self, remaining_signatures): - """ - Sets the remaining_signatures of this SignHashDocument. - + """Sets the remaining_signatures of this SignHashDocument. + + # noqa: E501 - :param remaining_signatures: The remaining_signatures of this SignHashDocument. + :param remaining_signatures: The remaining_signatures of this SignHashDocument. # noqa: E501 :type: int """ @@ -178,22 +199,22 @@ def remaining_signatures(self, remaining_signatures): @property def revisions(self): - """ - Gets the revisions of this SignHashDocument. - + """Gets the revisions of this SignHashDocument. # noqa: E501 + + # noqa: E501 - :return: The revisions of this SignHashDocument. + :return: The revisions of this SignHashDocument. # noqa: E501 :rtype: list[Revision] """ return self._revisions @revisions.setter def revisions(self, revisions): - """ - Sets the revisions of this SignHashDocument. - + """Sets the revisions of this SignHashDocument. + + # noqa: E501 - :param revisions: The revisions of this SignHashDocument. + :param revisions: The revisions of this SignHashDocument. # noqa: E501 :type: list[Revision] """ @@ -201,20 +222,20 @@ def revisions(self, revisions): @property def signature_properties(self): - """ - Gets the signature_properties of this SignHashDocument. + """Gets the signature_properties of this SignHashDocument. # noqa: E501 + - :return: The signature_properties of this SignHashDocument. + :return: The signature_properties of this SignHashDocument. # noqa: E501 :rtype: SignatureProperties """ return self._signature_properties @signature_properties.setter def signature_properties(self, signature_properties): - """ - Sets the signature_properties of this SignHashDocument. + """Sets the signature_properties of this SignHashDocument. + - :param signature_properties: The signature_properties of this SignHashDocument. + :param signature_properties: The signature_properties of this SignHashDocument. # noqa: E501 :type: SignatureProperties """ @@ -222,34 +243,32 @@ def signature_properties(self, signature_properties): @property def signature_type(self): - """ - Gets the signature_type of this SignHashDocument. - + """Gets the signature_type of this SignHashDocument. # noqa: E501 - :return: The signature_type of this SignHashDocument. + # noqa: E501 + + :return: The signature_type of this SignHashDocument. # noqa: E501 :rtype: str """ return self._signature_type @signature_type.setter def signature_type(self, signature_type): - """ - Sets the signature_type of this SignHashDocument. - + """Sets the signature_type of this SignHashDocument. - :param signature_type: The signature_type of this SignHashDocument. + # noqa: E501 + + :param signature_type: The signature_type of this SignHashDocument. # noqa: E501 :type: str """ self._signature_type = signature_type def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -266,29 +285,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(SignHashDocument, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, SignHashDocument): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/sign_hash_session_info_response.py b/docusign_esign/models/sign_hash_session_info_response.py index a72e4475..81969b55 100644 --- a/docusign_esign/models/sign_hash_session_info_response.py +++ b/docusign_esign/models/sign_hash_session_info_response.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,74 +11,95 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class SignHashSessionInfoResponse(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, documents=None, envelope_id=None, language=None, redirection_url=None, remaining_signature_requests=None, seal=None, sender=None, user=None): - """ - SignHashSessionInfoResponse - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'documents': 'list[SignHashDocument]', - 'envelope_id': 'str', - 'language': 'str', - 'redirection_url': 'str', - 'remaining_signature_requests': 'int', - 'seal': 'Seal', - 'sender': 'Sender', - 'user': 'User' - } - - self.attribute_map = { - 'documents': 'documents', - 'envelope_id': 'envelopeId', - 'language': 'language', - 'redirection_url': 'redirectionUrl', - 'remaining_signature_requests': 'remainingSignatureRequests', - 'seal': 'seal', - 'sender': 'sender', - 'user': 'user' - } - - self._documents = documents - self._envelope_id = envelope_id - self._language = language - self._redirection_url = redirection_url - self._remaining_signature_requests = remaining_signature_requests - self._seal = seal - self._sender = sender - self._user = user + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'documents': 'list[SignHashDocument]', + 'envelope_id': 'str', + 'language': 'str', + 'redirection_url': 'str', + 'remaining_signature_requests': 'int', + 'seal': 'Seal', + 'sender': 'Sender', + 'user': 'User' + } + + attribute_map = { + 'documents': 'documents', + 'envelope_id': 'envelopeId', + 'language': 'language', + 'redirection_url': 'redirectionUrl', + 'remaining_signature_requests': 'remainingSignatureRequests', + 'seal': 'seal', + 'sender': 'sender', + 'user': 'user' + } + + def __init__(self, documents=None, envelope_id=None, language=None, redirection_url=None, remaining_signature_requests=None, seal=None, sender=None, user=None): # noqa: E501 + """SignHashSessionInfoResponse - a model defined in Swagger""" # noqa: E501 + + self._documents = None + self._envelope_id = None + self._language = None + self._redirection_url = None + self._remaining_signature_requests = None + self._seal = None + self._sender = None + self._user = None + self.discriminator = None + + if documents is not None: + self.documents = documents + if envelope_id is not None: + self.envelope_id = envelope_id + if language is not None: + self.language = language + if redirection_url is not None: + self.redirection_url = redirection_url + if remaining_signature_requests is not None: + self.remaining_signature_requests = remaining_signature_requests + if seal is not None: + self.seal = seal + if sender is not None: + self.sender = sender + if user is not None: + self.user = user @property def documents(self): - """ - Gets the documents of this SignHashSessionInfoResponse. - Complex element contains the details on the documents in the envelope. + """Gets the documents of this SignHashSessionInfoResponse. # noqa: E501 - :return: The documents of this SignHashSessionInfoResponse. + Complex element contains the details on the documents in the envelope. # noqa: E501 + + :return: The documents of this SignHashSessionInfoResponse. # noqa: E501 :rtype: list[SignHashDocument] """ return self._documents @documents.setter def documents(self, documents): - """ - Sets the documents of this SignHashSessionInfoResponse. - Complex element contains the details on the documents in the envelope. + """Sets the documents of this SignHashSessionInfoResponse. - :param documents: The documents of this SignHashSessionInfoResponse. + Complex element contains the details on the documents in the envelope. # noqa: E501 + + :param documents: The documents of this SignHashSessionInfoResponse. # noqa: E501 :type: list[SignHashDocument] """ @@ -86,22 +107,22 @@ def documents(self, documents): @property def envelope_id(self): - """ - Gets the envelope_id of this SignHashSessionInfoResponse. - The envelope ID of the envelope status that failed to post. + """Gets the envelope_id of this SignHashSessionInfoResponse. # noqa: E501 - :return: The envelope_id of this SignHashSessionInfoResponse. + The envelope ID of the envelope status that failed to post. # noqa: E501 + + :return: The envelope_id of this SignHashSessionInfoResponse. # noqa: E501 :rtype: str """ return self._envelope_id @envelope_id.setter def envelope_id(self, envelope_id): - """ - Sets the envelope_id of this SignHashSessionInfoResponse. - The envelope ID of the envelope status that failed to post. + """Sets the envelope_id of this SignHashSessionInfoResponse. - :param envelope_id: The envelope_id of this SignHashSessionInfoResponse. + The envelope ID of the envelope status that failed to post. # noqa: E501 + + :param envelope_id: The envelope_id of this SignHashSessionInfoResponse. # noqa: E501 :type: str """ @@ -109,22 +130,22 @@ def envelope_id(self, envelope_id): @property def language(self): - """ - Gets the language of this SignHashSessionInfoResponse. - + """Gets the language of this SignHashSessionInfoResponse. # noqa: E501 - :return: The language of this SignHashSessionInfoResponse. + # noqa: E501 + + :return: The language of this SignHashSessionInfoResponse. # noqa: E501 :rtype: str """ return self._language @language.setter def language(self, language): - """ - Sets the language of this SignHashSessionInfoResponse. - + """Sets the language of this SignHashSessionInfoResponse. - :param language: The language of this SignHashSessionInfoResponse. + # noqa: E501 + + :param language: The language of this SignHashSessionInfoResponse. # noqa: E501 :type: str """ @@ -132,22 +153,22 @@ def language(self, language): @property def redirection_url(self): - """ - Gets the redirection_url of this SignHashSessionInfoResponse. - + """Gets the redirection_url of this SignHashSessionInfoResponse. # noqa: E501 + + # noqa: E501 - :return: The redirection_url of this SignHashSessionInfoResponse. + :return: The redirection_url of this SignHashSessionInfoResponse. # noqa: E501 :rtype: str """ return self._redirection_url @redirection_url.setter def redirection_url(self, redirection_url): - """ - Sets the redirection_url of this SignHashSessionInfoResponse. - + """Sets the redirection_url of this SignHashSessionInfoResponse. + + # noqa: E501 - :param redirection_url: The redirection_url of this SignHashSessionInfoResponse. + :param redirection_url: The redirection_url of this SignHashSessionInfoResponse. # noqa: E501 :type: str """ @@ -155,22 +176,22 @@ def redirection_url(self, redirection_url): @property def remaining_signature_requests(self): - """ - Gets the remaining_signature_requests of this SignHashSessionInfoResponse. - + """Gets the remaining_signature_requests of this SignHashSessionInfoResponse. # noqa: E501 + + # noqa: E501 - :return: The remaining_signature_requests of this SignHashSessionInfoResponse. + :return: The remaining_signature_requests of this SignHashSessionInfoResponse. # noqa: E501 :rtype: int """ return self._remaining_signature_requests @remaining_signature_requests.setter def remaining_signature_requests(self, remaining_signature_requests): - """ - Sets the remaining_signature_requests of this SignHashSessionInfoResponse. - + """Sets the remaining_signature_requests of this SignHashSessionInfoResponse. + + # noqa: E501 - :param remaining_signature_requests: The remaining_signature_requests of this SignHashSessionInfoResponse. + :param remaining_signature_requests: The remaining_signature_requests of this SignHashSessionInfoResponse. # noqa: E501 :type: int """ @@ -178,20 +199,20 @@ def remaining_signature_requests(self, remaining_signature_requests): @property def seal(self): - """ - Gets the seal of this SignHashSessionInfoResponse. + """Gets the seal of this SignHashSessionInfoResponse. # noqa: E501 + - :return: The seal of this SignHashSessionInfoResponse. + :return: The seal of this SignHashSessionInfoResponse. # noqa: E501 :rtype: Seal """ return self._seal @seal.setter def seal(self, seal): - """ - Sets the seal of this SignHashSessionInfoResponse. + """Sets the seal of this SignHashSessionInfoResponse. + - :param seal: The seal of this SignHashSessionInfoResponse. + :param seal: The seal of this SignHashSessionInfoResponse. # noqa: E501 :type: Seal """ @@ -199,20 +220,20 @@ def seal(self, seal): @property def sender(self): - """ - Gets the sender of this SignHashSessionInfoResponse. + """Gets the sender of this SignHashSessionInfoResponse. # noqa: E501 + - :return: The sender of this SignHashSessionInfoResponse. + :return: The sender of this SignHashSessionInfoResponse. # noqa: E501 :rtype: Sender """ return self._sender @sender.setter def sender(self, sender): - """ - Sets the sender of this SignHashSessionInfoResponse. + """Sets the sender of this SignHashSessionInfoResponse. + - :param sender: The sender of this SignHashSessionInfoResponse. + :param sender: The sender of this SignHashSessionInfoResponse. # noqa: E501 :type: Sender """ @@ -220,32 +241,30 @@ def sender(self, sender): @property def user(self): - """ - Gets the user of this SignHashSessionInfoResponse. + """Gets the user of this SignHashSessionInfoResponse. # noqa: E501 - :return: The user of this SignHashSessionInfoResponse. + + :return: The user of this SignHashSessionInfoResponse. # noqa: E501 :rtype: User """ return self._user @user.setter def user(self, user): - """ - Sets the user of this SignHashSessionInfoResponse. + """Sets the user of this SignHashSessionInfoResponse. - :param user: The user of this SignHashSessionInfoResponse. + + :param user: The user of this SignHashSessionInfoResponse. # noqa: E501 :type: User """ self._user = user def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -262,29 +281,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(SignHashSessionInfoResponse, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, SignHashSessionInfoResponse): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/sign_session_info_request.py b/docusign_esign/models/sign_session_info_request.py index e23c085d..cffb974a 100644 --- a/docusign_esign/models/sign_session_info_request.py +++ b/docusign_esign/models/sign_session_info_request.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,62 +11,75 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class SignSessionInfoRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, certificate=None, max_signature_length=None, return_format=None, signing_location=None): - """ - SignSessionInfoRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'certificate': 'str', - 'max_signature_length': 'str', - 'return_format': 'str', - 'signing_location': 'str' - } - - self.attribute_map = { - 'certificate': 'certificate', - 'max_signature_length': 'maxSignatureLength', - 'return_format': 'returnFormat', - 'signing_location': 'signingLocation' - } - self._certificate = certificate - self._max_signature_length = max_signature_length - self._return_format = return_format - self._signing_location = signing_location + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'certificate': 'str', + 'max_signature_length': 'str', + 'return_format': 'str', + 'signing_location': 'str' + } + + attribute_map = { + 'certificate': 'certificate', + 'max_signature_length': 'maxSignatureLength', + 'return_format': 'returnFormat', + 'signing_location': 'signingLocation' + } + + def __init__(self, certificate=None, max_signature_length=None, return_format=None, signing_location=None): # noqa: E501 + """SignSessionInfoRequest - a model defined in Swagger""" # noqa: E501 + + self._certificate = None + self._max_signature_length = None + self._return_format = None + self._signing_location = None + self.discriminator = None + + if certificate is not None: + self.certificate = certificate + if max_signature_length is not None: + self.max_signature_length = max_signature_length + if return_format is not None: + self.return_format = return_format + if signing_location is not None: + self.signing_location = signing_location @property def certificate(self): - """ - Gets the certificate of this SignSessionInfoRequest. - + """Gets the certificate of this SignSessionInfoRequest. # noqa: E501 - :return: The certificate of this SignSessionInfoRequest. + # noqa: E501 + + :return: The certificate of this SignSessionInfoRequest. # noqa: E501 :rtype: str """ return self._certificate @certificate.setter def certificate(self, certificate): - """ - Sets the certificate of this SignSessionInfoRequest. - + """Sets the certificate of this SignSessionInfoRequest. - :param certificate: The certificate of this SignSessionInfoRequest. + # noqa: E501 + + :param certificate: The certificate of this SignSessionInfoRequest. # noqa: E501 :type: str """ @@ -74,22 +87,22 @@ def certificate(self, certificate): @property def max_signature_length(self): - """ - Gets the max_signature_length of this SignSessionInfoRequest. - + """Gets the max_signature_length of this SignSessionInfoRequest. # noqa: E501 + + # noqa: E501 - :return: The max_signature_length of this SignSessionInfoRequest. + :return: The max_signature_length of this SignSessionInfoRequest. # noqa: E501 :rtype: str """ return self._max_signature_length @max_signature_length.setter def max_signature_length(self, max_signature_length): - """ - Sets the max_signature_length of this SignSessionInfoRequest. - + """Sets the max_signature_length of this SignSessionInfoRequest. + + # noqa: E501 - :param max_signature_length: The max_signature_length of this SignSessionInfoRequest. + :param max_signature_length: The max_signature_length of this SignSessionInfoRequest. # noqa: E501 :type: str """ @@ -97,22 +110,22 @@ def max_signature_length(self, max_signature_length): @property def return_format(self): - """ - Gets the return_format of this SignSessionInfoRequest. - + """Gets the return_format of this SignSessionInfoRequest. # noqa: E501 + + # noqa: E501 - :return: The return_format of this SignSessionInfoRequest. + :return: The return_format of this SignSessionInfoRequest. # noqa: E501 :rtype: str """ return self._return_format @return_format.setter def return_format(self, return_format): - """ - Sets the return_format of this SignSessionInfoRequest. - + """Sets the return_format of this SignSessionInfoRequest. - :param return_format: The return_format of this SignSessionInfoRequest. + # noqa: E501 + + :param return_format: The return_format of this SignSessionInfoRequest. # noqa: E501 :type: str """ @@ -120,34 +133,32 @@ def return_format(self, return_format): @property def signing_location(self): - """ - Gets the signing_location of this SignSessionInfoRequest. - Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. + """Gets the signing_location of this SignSessionInfoRequest. # noqa: E501 - :return: The signing_location of this SignSessionInfoRequest. + Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. # noqa: E501 + + :return: The signing_location of this SignSessionInfoRequest. # noqa: E501 :rtype: str """ return self._signing_location @signing_location.setter def signing_location(self, signing_location): - """ - Sets the signing_location of this SignSessionInfoRequest. - Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. + """Sets the signing_location of this SignSessionInfoRequest. + + Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. # noqa: E501 - :param signing_location: The signing_location of this SignSessionInfoRequest. + :param signing_location: The signing_location of this SignSessionInfoRequest. # noqa: E501 :type: str """ self._signing_location = signing_location def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -164,29 +175,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(SignSessionInfoRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, SignSessionInfoRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/signature_data_info.py b/docusign_esign/models/signature_data_info.py index 496c14c1..92e6de2f 100644 --- a/docusign_esign/models/signature_data_info.py +++ b/docusign_esign/models/signature_data_info.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,57 +11,68 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class SignatureDataInfo(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, document_security_store=None, signature_data=None, signature_field_name=None): - """ - SignatureDataInfo - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'document_security_store': 'DocumentSecurityStore', - 'signature_data': 'str', - 'signature_field_name': 'str' - } - - self.attribute_map = { - 'document_security_store': 'documentSecurityStore', - 'signature_data': 'signatureData', - 'signature_field_name': 'signatureFieldName' - } - - self._document_security_store = document_security_store - self._signature_data = signature_data - self._signature_field_name = signature_field_name + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'document_security_store': 'DocumentSecurityStore', + 'signature_data': 'str', + 'signature_field_name': 'str' + } + + attribute_map = { + 'document_security_store': 'documentSecurityStore', + 'signature_data': 'signatureData', + 'signature_field_name': 'signatureFieldName' + } + + def __init__(self, document_security_store=None, signature_data=None, signature_field_name=None): # noqa: E501 + """SignatureDataInfo - a model defined in Swagger""" # noqa: E501 + + self._document_security_store = None + self._signature_data = None + self._signature_field_name = None + self.discriminator = None + + if document_security_store is not None: + self.document_security_store = document_security_store + if signature_data is not None: + self.signature_data = signature_data + if signature_field_name is not None: + self.signature_field_name = signature_field_name @property def document_security_store(self): - """ - Gets the document_security_store of this SignatureDataInfo. + """Gets the document_security_store of this SignatureDataInfo. # noqa: E501 + - :return: The document_security_store of this SignatureDataInfo. + :return: The document_security_store of this SignatureDataInfo. # noqa: E501 :rtype: DocumentSecurityStore """ return self._document_security_store @document_security_store.setter def document_security_store(self, document_security_store): - """ - Sets the document_security_store of this SignatureDataInfo. + """Sets the document_security_store of this SignatureDataInfo. + - :param document_security_store: The document_security_store of this SignatureDataInfo. + :param document_security_store: The document_security_store of this SignatureDataInfo. # noqa: E501 :type: DocumentSecurityStore """ @@ -69,22 +80,22 @@ def document_security_store(self, document_security_store): @property def signature_data(self): - """ - Gets the signature_data of this SignatureDataInfo. - + """Gets the signature_data of this SignatureDataInfo. # noqa: E501 + + # noqa: E501 - :return: The signature_data of this SignatureDataInfo. + :return: The signature_data of this SignatureDataInfo. # noqa: E501 :rtype: str """ return self._signature_data @signature_data.setter def signature_data(self, signature_data): - """ - Sets the signature_data of this SignatureDataInfo. - + """Sets the signature_data of this SignatureDataInfo. + + # noqa: E501 - :param signature_data: The signature_data of this SignatureDataInfo. + :param signature_data: The signature_data of this SignatureDataInfo. # noqa: E501 :type: str """ @@ -92,34 +103,32 @@ def signature_data(self, signature_data): @property def signature_field_name(self): - """ - Gets the signature_field_name of this SignatureDataInfo. - + """Gets the signature_field_name of this SignatureDataInfo. # noqa: E501 - :return: The signature_field_name of this SignatureDataInfo. + # noqa: E501 + + :return: The signature_field_name of this SignatureDataInfo. # noqa: E501 :rtype: str """ return self._signature_field_name @signature_field_name.setter def signature_field_name(self, signature_field_name): - """ - Sets the signature_field_name of this SignatureDataInfo. - + """Sets the signature_field_name of this SignatureDataInfo. - :param signature_field_name: The signature_field_name of this SignatureDataInfo. + # noqa: E501 + + :param signature_field_name: The signature_field_name of this SignatureDataInfo. # noqa: E501 :type: str """ self._signature_field_name = signature_field_name def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -136,29 +145,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(SignatureDataInfo, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, SignatureDataInfo): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/signature_properties.py b/docusign_esign/models/signature_properties.py index 17964998..effd5605 100644 --- a/docusign_esign/models/signature_properties.py +++ b/docusign_esign/models/signature_properties.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,56 +11,65 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class SignatureProperties(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, filter=None, sub_filter=None): - """ - SignatureProperties - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'filter': 'str', - 'sub_filter': 'str' - } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'filter': 'str', + 'sub_filter': 'str' + } - self.attribute_map = { - 'filter': 'filter', - 'sub_filter': 'subFilter' - } + attribute_map = { + 'filter': 'filter', + 'sub_filter': 'subFilter' + } - self._filter = filter - self._sub_filter = sub_filter + def __init__(self, filter=None, sub_filter=None): # noqa: E501 + """SignatureProperties - a model defined in Swagger""" # noqa: E501 + + self._filter = None + self._sub_filter = None + self.discriminator = None + + if filter is not None: + self.filter = filter + if sub_filter is not None: + self.sub_filter = sub_filter @property def filter(self): - """ - Gets the filter of this SignatureProperties. - + """Gets the filter of this SignatureProperties. # noqa: E501 - :return: The filter of this SignatureProperties. + # noqa: E501 + + :return: The filter of this SignatureProperties. # noqa: E501 :rtype: str """ return self._filter @filter.setter def filter(self, filter): - """ - Sets the filter of this SignatureProperties. - + """Sets the filter of this SignatureProperties. + + # noqa: E501 - :param filter: The filter of this SignatureProperties. + :param filter: The filter of this SignatureProperties. # noqa: E501 :type: str """ @@ -68,34 +77,32 @@ def filter(self, filter): @property def sub_filter(self): - """ - Gets the sub_filter of this SignatureProperties. - + """Gets the sub_filter of this SignatureProperties. # noqa: E501 + + # noqa: E501 - :return: The sub_filter of this SignatureProperties. + :return: The sub_filter of this SignatureProperties. # noqa: E501 :rtype: str """ return self._sub_filter @sub_filter.setter def sub_filter(self, sub_filter): - """ - Sets the sub_filter of this SignatureProperties. - + """Sets the sub_filter of this SignatureProperties. + + # noqa: E501 - :param sub_filter: The sub_filter of this SignatureProperties. + :param sub_filter: The sub_filter of this SignatureProperties. # noqa: E501 :type: str """ self._sub_filter = sub_filter def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -112,29 +119,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(SignatureProperties, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, SignatureProperties): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/tab_account_settings.py b/docusign_esign/models/tab_account_settings.py index 8eb1f328..04da75d0 100644 --- a/docusign_esign/models/tab_account_settings.py +++ b/docusign_esign/models/tab_account_settings.py @@ -51,6 +51,8 @@ class TabAccountSettings(object): 'list_tabs_metadata': 'SettingsMetadata', 'note_tabs_enabled': 'str', 'note_tabs_metadata': 'SettingsMetadata', + 'prefill_tabs_enabled': 'str', + 'prefill_tabs_metadata': 'SettingsMetadata', 'radio_tabs_enabled': 'str', 'radio_tabs_metadata': 'SettingsMetadata', 'saving_custom_tabs_enabled': 'str', @@ -94,6 +96,8 @@ class TabAccountSettings(object): 'list_tabs_metadata': 'listTabsMetadata', 'note_tabs_enabled': 'noteTabsEnabled', 'note_tabs_metadata': 'noteTabsMetadata', + 'prefill_tabs_enabled': 'prefillTabsEnabled', + 'prefill_tabs_metadata': 'prefillTabsMetadata', 'radio_tabs_enabled': 'radioTabsEnabled', 'radio_tabs_metadata': 'radioTabsMetadata', 'saving_custom_tabs_enabled': 'savingCustomTabsEnabled', @@ -116,7 +120,7 @@ class TabAccountSettings(object): 'text_tabs_metadata': 'textTabsMetadata' } - def __init__(self, allow_tab_order=None, allow_tab_order_metadata=None, approve_decline_tabs_enabled=None, approve_decline_tabs_metadata=None, calculated_fields_enabled=None, calculated_fields_metadata=None, checkbox_tabs_enabled=None, check_box_tabs_metadata=None, data_field_regex_enabled=None, data_field_regex_metadata=None, data_field_size_enabled=None, data_field_size_metadata=None, draw_tabs_enabled=None, draw_tabs_metadata=None, first_last_email_tabs_enabled=None, first_last_email_tabs_metadata=None, list_tabs_enabled=None, list_tabs_metadata=None, note_tabs_enabled=None, note_tabs_metadata=None, radio_tabs_enabled=None, radio_tabs_metadata=None, saving_custom_tabs_enabled=None, saving_custom_tabs_metadata=None, sender_to_change_tab_assignments_enabled=None, sender_to_change_tab_assignments_metadata=None, shared_custom_tabs_enabled=None, shared_custom_tabs_metadata=None, tab_data_label_enabled=None, tab_data_label_metadata=None, tab_location_enabled=None, tab_location_metadata=None, tab_locking_enabled=None, tab_locking_metadata=None, tab_scale_enabled=None, tab_scale_metadata=None, tab_text_formatting_enabled=None, tab_text_formatting_metadata=None, text_tabs_enabled=None, text_tabs_metadata=None): # noqa: E501 + def __init__(self, allow_tab_order=None, allow_tab_order_metadata=None, approve_decline_tabs_enabled=None, approve_decline_tabs_metadata=None, calculated_fields_enabled=None, calculated_fields_metadata=None, checkbox_tabs_enabled=None, check_box_tabs_metadata=None, data_field_regex_enabled=None, data_field_regex_metadata=None, data_field_size_enabled=None, data_field_size_metadata=None, draw_tabs_enabled=None, draw_tabs_metadata=None, first_last_email_tabs_enabled=None, first_last_email_tabs_metadata=None, list_tabs_enabled=None, list_tabs_metadata=None, note_tabs_enabled=None, note_tabs_metadata=None, prefill_tabs_enabled=None, prefill_tabs_metadata=None, radio_tabs_enabled=None, radio_tabs_metadata=None, saving_custom_tabs_enabled=None, saving_custom_tabs_metadata=None, sender_to_change_tab_assignments_enabled=None, sender_to_change_tab_assignments_metadata=None, shared_custom_tabs_enabled=None, shared_custom_tabs_metadata=None, tab_data_label_enabled=None, tab_data_label_metadata=None, tab_location_enabled=None, tab_location_metadata=None, tab_locking_enabled=None, tab_locking_metadata=None, tab_scale_enabled=None, tab_scale_metadata=None, tab_text_formatting_enabled=None, tab_text_formatting_metadata=None, text_tabs_enabled=None, text_tabs_metadata=None): # noqa: E501 """TabAccountSettings - a model defined in Swagger""" # noqa: E501 self._allow_tab_order = None @@ -139,6 +143,8 @@ def __init__(self, allow_tab_order=None, allow_tab_order_metadata=None, approve_ self._list_tabs_metadata = None self._note_tabs_enabled = None self._note_tabs_metadata = None + self._prefill_tabs_enabled = None + self._prefill_tabs_metadata = None self._radio_tabs_enabled = None self._radio_tabs_metadata = None self._saving_custom_tabs_enabled = None @@ -201,6 +207,10 @@ def __init__(self, allow_tab_order=None, allow_tab_order_metadata=None, approve_ self.note_tabs_enabled = note_tabs_enabled if note_tabs_metadata is not None: self.note_tabs_metadata = note_tabs_metadata + if prefill_tabs_enabled is not None: + self.prefill_tabs_enabled = prefill_tabs_enabled + if prefill_tabs_metadata is not None: + self.prefill_tabs_metadata = prefill_tabs_metadata if radio_tabs_enabled is not None: self.radio_tabs_enabled = radio_tabs_enabled if radio_tabs_metadata is not None: @@ -682,6 +692,50 @@ def note_tabs_metadata(self, note_tabs_metadata): self._note_tabs_metadata = note_tabs_metadata + @property + def prefill_tabs_enabled(self): + """Gets the prefill_tabs_enabled of this TabAccountSettings. # noqa: E501 + + # noqa: E501 + + :return: The prefill_tabs_enabled of this TabAccountSettings. # noqa: E501 + :rtype: str + """ + return self._prefill_tabs_enabled + + @prefill_tabs_enabled.setter + def prefill_tabs_enabled(self, prefill_tabs_enabled): + """Sets the prefill_tabs_enabled of this TabAccountSettings. + + # noqa: E501 + + :param prefill_tabs_enabled: The prefill_tabs_enabled of this TabAccountSettings. # noqa: E501 + :type: str + """ + + self._prefill_tabs_enabled = prefill_tabs_enabled + + @property + def prefill_tabs_metadata(self): + """Gets the prefill_tabs_metadata of this TabAccountSettings. # noqa: E501 + + + :return: The prefill_tabs_metadata of this TabAccountSettings. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._prefill_tabs_metadata + + @prefill_tabs_metadata.setter + def prefill_tabs_metadata(self, prefill_tabs_metadata): + """Sets the prefill_tabs_metadata of this TabAccountSettings. + + + :param prefill_tabs_metadata: The prefill_tabs_metadata of this TabAccountSettings. # noqa: E501 + :type: SettingsMetadata + """ + + self._prefill_tabs_metadata = prefill_tabs_metadata + @property def radio_tabs_enabled(self): """Gets the radio_tabs_enabled of this TabAccountSettings. # noqa: E501 diff --git a/docusign_esign/models/tabs.py b/docusign_esign/models/tabs.py index e798588a..0f6503f3 100644 --- a/docusign_esign/models/tabs.py +++ b/docusign_esign/models/tabs.py @@ -58,6 +58,7 @@ class Tabs(object): 'number_tabs': 'list[Number]', 'phone_number_tabs': 'list[PhoneNumber]', 'poly_line_overlay_tabs': 'list[PolyLineOverlay]', + 'prefill_tabs': 'PrefillTabs', 'radio_group_tabs': 'list[RadioGroup]', 'signer_attachment_tabs': 'list[SignerAttachment]', 'sign_here_tabs': 'list[SignHere]', @@ -98,6 +99,7 @@ class Tabs(object): 'number_tabs': 'numberTabs', 'phone_number_tabs': 'phoneNumberTabs', 'poly_line_overlay_tabs': 'polyLineOverlayTabs', + 'prefill_tabs': 'prefillTabs', 'radio_group_tabs': 'radioGroupTabs', 'signer_attachment_tabs': 'signerAttachmentTabs', 'sign_here_tabs': 'signHereTabs', @@ -110,7 +112,7 @@ class Tabs(object): 'zip_tabs': 'zipTabs' } - def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=None, commission_county_tabs=None, commission_expiration_tabs=None, commission_number_tabs=None, commission_state_tabs=None, company_tabs=None, date_signed_tabs=None, date_tabs=None, decline_tabs=None, draw_tabs=None, email_address_tabs=None, email_tabs=None, envelope_id_tabs=None, first_name_tabs=None, formula_tabs=None, full_name_tabs=None, initial_here_tabs=None, last_name_tabs=None, list_tabs=None, notarize_tabs=None, notary_seal_tabs=None, note_tabs=None, number_tabs=None, phone_number_tabs=None, poly_line_overlay_tabs=None, radio_group_tabs=None, signer_attachment_tabs=None, sign_here_tabs=None, smart_section_tabs=None, ssn_tabs=None, tab_groups=None, text_tabs=None, title_tabs=None, view_tabs=None, zip_tabs=None): # noqa: E501 + def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=None, commission_county_tabs=None, commission_expiration_tabs=None, commission_number_tabs=None, commission_state_tabs=None, company_tabs=None, date_signed_tabs=None, date_tabs=None, decline_tabs=None, draw_tabs=None, email_address_tabs=None, email_tabs=None, envelope_id_tabs=None, first_name_tabs=None, formula_tabs=None, full_name_tabs=None, initial_here_tabs=None, last_name_tabs=None, list_tabs=None, notarize_tabs=None, notary_seal_tabs=None, note_tabs=None, number_tabs=None, phone_number_tabs=None, poly_line_overlay_tabs=None, prefill_tabs=None, radio_group_tabs=None, signer_attachment_tabs=None, sign_here_tabs=None, smart_section_tabs=None, ssn_tabs=None, tab_groups=None, text_tabs=None, title_tabs=None, view_tabs=None, zip_tabs=None): # noqa: E501 """Tabs - a model defined in Swagger""" # noqa: E501 self._approve_tabs = None @@ -140,6 +142,7 @@ def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=No self._number_tabs = None self._phone_number_tabs = None self._poly_line_overlay_tabs = None + self._prefill_tabs = None self._radio_group_tabs = None self._signer_attachment_tabs = None self._sign_here_tabs = None @@ -206,6 +209,8 @@ def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=No self.phone_number_tabs = phone_number_tabs if poly_line_overlay_tabs is not None: self.poly_line_overlay_tabs = poly_line_overlay_tabs + if prefill_tabs is not None: + self.prefill_tabs = prefill_tabs if radio_group_tabs is not None: self.radio_group_tabs = radio_group_tabs if signer_attachment_tabs is not None: @@ -848,6 +853,27 @@ def poly_line_overlay_tabs(self, poly_line_overlay_tabs): self._poly_line_overlay_tabs = poly_line_overlay_tabs + @property + def prefill_tabs(self): + """Gets the prefill_tabs of this Tabs. # noqa: E501 + + + :return: The prefill_tabs of this Tabs. # noqa: E501 + :rtype: PrefillTabs + """ + return self._prefill_tabs + + @prefill_tabs.setter + def prefill_tabs(self, prefill_tabs): + """Sets the prefill_tabs of this Tabs. + + + :param prefill_tabs: The prefill_tabs of this Tabs. # noqa: E501 + :type: PrefillTabs + """ + + self._prefill_tabs = prefill_tabs + @property def radio_group_tabs(self): """Gets the radio_group_tabs of this Tabs. # noqa: E501 diff --git a/docusign_esign/models/template_tabs.py b/docusign_esign/models/template_tabs.py index 16325119..58014cfa 100644 --- a/docusign_esign/models/template_tabs.py +++ b/docusign_esign/models/template_tabs.py @@ -58,6 +58,7 @@ class TemplateTabs(object): 'number_tabs': 'list[Number]', 'phone_number_tabs': 'list[PhoneNumber]', 'poly_line_overlay_tabs': 'list[PolyLineOverlay]', + 'prefill_tabs': 'PrefillTabs', 'radio_group_tabs': 'list[RadioGroup]', 'signer_attachment_tabs': 'list[SignerAttachment]', 'sign_here_tabs': 'list[SignHere]', @@ -98,6 +99,7 @@ class TemplateTabs(object): 'number_tabs': 'numberTabs', 'phone_number_tabs': 'phoneNumberTabs', 'poly_line_overlay_tabs': 'polyLineOverlayTabs', + 'prefill_tabs': 'prefillTabs', 'radio_group_tabs': 'radioGroupTabs', 'signer_attachment_tabs': 'signerAttachmentTabs', 'sign_here_tabs': 'signHereTabs', @@ -110,7 +112,7 @@ class TemplateTabs(object): 'zip_tabs': 'zipTabs' } - def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=None, commission_county_tabs=None, commission_expiration_tabs=None, commission_number_tabs=None, commission_state_tabs=None, company_tabs=None, date_signed_tabs=None, date_tabs=None, decline_tabs=None, draw_tabs=None, email_address_tabs=None, email_tabs=None, envelope_id_tabs=None, first_name_tabs=None, formula_tabs=None, full_name_tabs=None, initial_here_tabs=None, last_name_tabs=None, list_tabs=None, notarize_tabs=None, notary_seal_tabs=None, note_tabs=None, number_tabs=None, phone_number_tabs=None, poly_line_overlay_tabs=None, radio_group_tabs=None, signer_attachment_tabs=None, sign_here_tabs=None, smart_section_tabs=None, ssn_tabs=None, tab_groups=None, text_tabs=None, title_tabs=None, view_tabs=None, zip_tabs=None): # noqa: E501 + def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=None, commission_county_tabs=None, commission_expiration_tabs=None, commission_number_tabs=None, commission_state_tabs=None, company_tabs=None, date_signed_tabs=None, date_tabs=None, decline_tabs=None, draw_tabs=None, email_address_tabs=None, email_tabs=None, envelope_id_tabs=None, first_name_tabs=None, formula_tabs=None, full_name_tabs=None, initial_here_tabs=None, last_name_tabs=None, list_tabs=None, notarize_tabs=None, notary_seal_tabs=None, note_tabs=None, number_tabs=None, phone_number_tabs=None, poly_line_overlay_tabs=None, prefill_tabs=None, radio_group_tabs=None, signer_attachment_tabs=None, sign_here_tabs=None, smart_section_tabs=None, ssn_tabs=None, tab_groups=None, text_tabs=None, title_tabs=None, view_tabs=None, zip_tabs=None): # noqa: E501 """TemplateTabs - a model defined in Swagger""" # noqa: E501 self._approve_tabs = None @@ -140,6 +142,7 @@ def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=No self._number_tabs = None self._phone_number_tabs = None self._poly_line_overlay_tabs = None + self._prefill_tabs = None self._radio_group_tabs = None self._signer_attachment_tabs = None self._sign_here_tabs = None @@ -206,6 +209,8 @@ def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=No self.phone_number_tabs = phone_number_tabs if poly_line_overlay_tabs is not None: self.poly_line_overlay_tabs = poly_line_overlay_tabs + if prefill_tabs is not None: + self.prefill_tabs = prefill_tabs if radio_group_tabs is not None: self.radio_group_tabs = radio_group_tabs if signer_attachment_tabs is not None: @@ -848,6 +853,27 @@ def poly_line_overlay_tabs(self, poly_line_overlay_tabs): self._poly_line_overlay_tabs = poly_line_overlay_tabs + @property + def prefill_tabs(self): + """Gets the prefill_tabs of this TemplateTabs. # noqa: E501 + + + :return: The prefill_tabs of this TemplateTabs. # noqa: E501 + :rtype: PrefillTabs + """ + return self._prefill_tabs + + @prefill_tabs.setter + def prefill_tabs(self, prefill_tabs): + """Sets the prefill_tabs of this TemplateTabs. + + + :param prefill_tabs: The prefill_tabs of this TemplateTabs. # noqa: E501 + :type: PrefillTabs + """ + + self._prefill_tabs = prefill_tabs + @property def radio_group_tabs(self): """Gets the radio_group_tabs of this TemplateTabs. # noqa: E501 diff --git a/docusign_esign/models/time_stamp_field.py b/docusign_esign/models/time_stamp_field.py index 4809b172..1ed72361 100644 --- a/docusign_esign/models/time_stamp_field.py +++ b/docusign_esign/models/time_stamp_field.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,57 +11,68 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class TimeStampField(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, document_security_store=None, max_time_stamp_signature_length=None, time_stamp_field_name=None): - """ - TimeStampField - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'document_security_store': 'DocumentSecurityStore', - 'max_time_stamp_signature_length': 'str', - 'time_stamp_field_name': 'str' - } - - self.attribute_map = { - 'document_security_store': 'documentSecurityStore', - 'max_time_stamp_signature_length': 'maxTimeStampSignatureLength', - 'time_stamp_field_name': 'timeStampFieldName' - } - - self._document_security_store = document_security_store - self._max_time_stamp_signature_length = max_time_stamp_signature_length - self._time_stamp_field_name = time_stamp_field_name + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'document_security_store': 'DocumentSecurityStore', + 'max_time_stamp_signature_length': 'str', + 'time_stamp_field_name': 'str' + } + + attribute_map = { + 'document_security_store': 'documentSecurityStore', + 'max_time_stamp_signature_length': 'maxTimeStampSignatureLength', + 'time_stamp_field_name': 'timeStampFieldName' + } + + def __init__(self, document_security_store=None, max_time_stamp_signature_length=None, time_stamp_field_name=None): # noqa: E501 + """TimeStampField - a model defined in Swagger""" # noqa: E501 + + self._document_security_store = None + self._max_time_stamp_signature_length = None + self._time_stamp_field_name = None + self.discriminator = None + + if document_security_store is not None: + self.document_security_store = document_security_store + if max_time_stamp_signature_length is not None: + self.max_time_stamp_signature_length = max_time_stamp_signature_length + if time_stamp_field_name is not None: + self.time_stamp_field_name = time_stamp_field_name @property def document_security_store(self): - """ - Gets the document_security_store of this TimeStampField. + """Gets the document_security_store of this TimeStampField. # noqa: E501 + - :return: The document_security_store of this TimeStampField. + :return: The document_security_store of this TimeStampField. # noqa: E501 :rtype: DocumentSecurityStore """ return self._document_security_store @document_security_store.setter def document_security_store(self, document_security_store): - """ - Sets the document_security_store of this TimeStampField. + """Sets the document_security_store of this TimeStampField. + - :param document_security_store: The document_security_store of this TimeStampField. + :param document_security_store: The document_security_store of this TimeStampField. # noqa: E501 :type: DocumentSecurityStore """ @@ -69,22 +80,22 @@ def document_security_store(self, document_security_store): @property def max_time_stamp_signature_length(self): - """ - Gets the max_time_stamp_signature_length of this TimeStampField. - + """Gets the max_time_stamp_signature_length of this TimeStampField. # noqa: E501 + + # noqa: E501 - :return: The max_time_stamp_signature_length of this TimeStampField. + :return: The max_time_stamp_signature_length of this TimeStampField. # noqa: E501 :rtype: str """ return self._max_time_stamp_signature_length @max_time_stamp_signature_length.setter def max_time_stamp_signature_length(self, max_time_stamp_signature_length): - """ - Sets the max_time_stamp_signature_length of this TimeStampField. - + """Sets the max_time_stamp_signature_length of this TimeStampField. + + # noqa: E501 - :param max_time_stamp_signature_length: The max_time_stamp_signature_length of this TimeStampField. + :param max_time_stamp_signature_length: The max_time_stamp_signature_length of this TimeStampField. # noqa: E501 :type: str """ @@ -92,34 +103,32 @@ def max_time_stamp_signature_length(self, max_time_stamp_signature_length): @property def time_stamp_field_name(self): - """ - Gets the time_stamp_field_name of this TimeStampField. - + """Gets the time_stamp_field_name of this TimeStampField. # noqa: E501 - :return: The time_stamp_field_name of this TimeStampField. + # noqa: E501 + + :return: The time_stamp_field_name of this TimeStampField. # noqa: E501 :rtype: str """ return self._time_stamp_field_name @time_stamp_field_name.setter def time_stamp_field_name(self, time_stamp_field_name): - """ - Sets the time_stamp_field_name of this TimeStampField. - + """Sets the time_stamp_field_name of this TimeStampField. - :param time_stamp_field_name: The time_stamp_field_name of this TimeStampField. + # noqa: E501 + + :param time_stamp_field_name: The time_stamp_field_name of this TimeStampField. # noqa: E501 :type: str """ self._time_stamp_field_name = time_stamp_field_name def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -136,29 +145,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(TimeStampField, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, TimeStampField): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/tsp_health_check_request.py b/docusign_esign/models/tsp_health_check_request.py index f8f9ed47..43e58a8b 100644 --- a/docusign_esign/models/tsp_health_check_request.py +++ b/docusign_esign/models/tsp_health_check_request.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,65 +11,80 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class TspHealthCheckRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, app_version=None, description=None, error=None, status=None, status_description=None): - """ - TspHealthCheckRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'app_version': 'str', - 'description': 'str', - 'error': 'str', - 'status': 'str', - 'status_description': 'list[TspHealthCheckStatusDescription]' - } - - self.attribute_map = { - 'app_version': 'appVersion', - 'description': 'description', - 'error': 'error', - 'status': 'status', - 'status_description': 'statusDescription' - } - self._app_version = app_version - self._description = description - self._error = error - self._status = status - self._status_description = status_description + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'app_version': 'str', + 'description': 'str', + 'error': 'str', + 'status': 'str', + 'status_description': 'list[TspHealthCheckStatusDescription]' + } + + attribute_map = { + 'app_version': 'appVersion', + 'description': 'description', + 'error': 'error', + 'status': 'status', + 'status_description': 'statusDescription' + } + + def __init__(self, app_version=None, description=None, error=None, status=None, status_description=None): # noqa: E501 + """TspHealthCheckRequest - a model defined in Swagger""" # noqa: E501 + + self._app_version = None + self._description = None + self._error = None + self._status = None + self._status_description = None + self.discriminator = None + + if app_version is not None: + self.app_version = app_version + if description is not None: + self.description = description + if error is not None: + self.error = error + if status is not None: + self.status = status + if status_description is not None: + self.status_description = status_description @property def app_version(self): - """ - Gets the app_version of this TspHealthCheckRequest. - + """Gets the app_version of this TspHealthCheckRequest. # noqa: E501 - :return: The app_version of this TspHealthCheckRequest. + # noqa: E501 + + :return: The app_version of this TspHealthCheckRequest. # noqa: E501 :rtype: str """ return self._app_version @app_version.setter def app_version(self, app_version): - """ - Sets the app_version of this TspHealthCheckRequest. - + """Sets the app_version of this TspHealthCheckRequest. + + # noqa: E501 - :param app_version: The app_version of this TspHealthCheckRequest. + :param app_version: The app_version of this TspHealthCheckRequest. # noqa: E501 :type: str """ @@ -77,22 +92,22 @@ def app_version(self, app_version): @property def description(self): - """ - Gets the description of this TspHealthCheckRequest. - + """Gets the description of this TspHealthCheckRequest. # noqa: E501 + + # noqa: E501 - :return: The description of this TspHealthCheckRequest. + :return: The description of this TspHealthCheckRequest. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this TspHealthCheckRequest. - + """Sets the description of this TspHealthCheckRequest. - :param description: The description of this TspHealthCheckRequest. + # noqa: E501 + + :param description: The description of this TspHealthCheckRequest. # noqa: E501 :type: str """ @@ -100,22 +115,22 @@ def description(self, description): @property def error(self): - """ - Gets the error of this TspHealthCheckRequest. - + """Gets the error of this TspHealthCheckRequest. # noqa: E501 - :return: The error of this TspHealthCheckRequest. + # noqa: E501 + + :return: The error of this TspHealthCheckRequest. # noqa: E501 :rtype: str """ return self._error @error.setter def error(self, error): - """ - Sets the error of this TspHealthCheckRequest. - + """Sets the error of this TspHealthCheckRequest. + + # noqa: E501 - :param error: The error of this TspHealthCheckRequest. + :param error: The error of this TspHealthCheckRequest. # noqa: E501 :type: str """ @@ -123,22 +138,22 @@ def error(self, error): @property def status(self): - """ - Gets the status of this TspHealthCheckRequest. - Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. + """Gets the status of this TspHealthCheckRequest. # noqa: E501 + + Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 - :return: The status of this TspHealthCheckRequest. + :return: The status of this TspHealthCheckRequest. # noqa: E501 :rtype: str """ return self._status @status.setter def status(self, status): - """ - Sets the status of this TspHealthCheckRequest. - Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. + """Sets the status of this TspHealthCheckRequest. - :param status: The status of this TspHealthCheckRequest. + Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 + + :param status: The status of this TspHealthCheckRequest. # noqa: E501 :type: str """ @@ -146,34 +161,32 @@ def status(self, status): @property def status_description(self): - """ - Gets the status_description of this TspHealthCheckRequest. - + """Gets the status_description of this TspHealthCheckRequest. # noqa: E501 + + # noqa: E501 - :return: The status_description of this TspHealthCheckRequest. + :return: The status_description of this TspHealthCheckRequest. # noqa: E501 :rtype: list[TspHealthCheckStatusDescription] """ return self._status_description @status_description.setter def status_description(self, status_description): - """ - Sets the status_description of this TspHealthCheckRequest. - + """Sets the status_description of this TspHealthCheckRequest. + + # noqa: E501 - :param status_description: The status_description of this TspHealthCheckRequest. + :param status_description: The status_description of this TspHealthCheckRequest. # noqa: E501 :type: list[TspHealthCheckStatusDescription] """ self._status_description = status_description def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -190,29 +203,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(TspHealthCheckRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, TspHealthCheckRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/tsp_health_check_status_description.py b/docusign_esign/models/tsp_health_check_status_description.py index aff0e0c6..d6e63746 100644 --- a/docusign_esign/models/tsp_health_check_status_description.py +++ b/docusign_esign/models/tsp_health_check_status_description.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,68 +11,85 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class TspHealthCheckStatusDescription(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, description=None, error=None, hostname=None, response_seconds=None, status=None, type=None): - """ - TspHealthCheckStatusDescription - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'description': 'str', - 'error': 'str', - 'hostname': 'str', - 'response_seconds': 'str', - 'status': 'str', - 'type': 'str' - } - - self.attribute_map = { - 'description': 'description', - 'error': 'error', - 'hostname': 'hostname', - 'response_seconds': 'responseSeconds', - 'status': 'status', - 'type': 'type' - } - - self._description = description - self._error = error - self._hostname = hostname - self._response_seconds = response_seconds - self._status = status - self._type = type + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'description': 'str', + 'error': 'str', + 'hostname': 'str', + 'response_seconds': 'str', + 'status': 'str', + 'type': 'str' + } + + attribute_map = { + 'description': 'description', + 'error': 'error', + 'hostname': 'hostname', + 'response_seconds': 'responseSeconds', + 'status': 'status', + 'type': 'type' + } + + def __init__(self, description=None, error=None, hostname=None, response_seconds=None, status=None, type=None): # noqa: E501 + """TspHealthCheckStatusDescription - a model defined in Swagger""" # noqa: E501 + + self._description = None + self._error = None + self._hostname = None + self._response_seconds = None + self._status = None + self._type = None + self.discriminator = None + + if description is not None: + self.description = description + if error is not None: + self.error = error + if hostname is not None: + self.hostname = hostname + if response_seconds is not None: + self.response_seconds = response_seconds + if status is not None: + self.status = status + if type is not None: + self.type = type @property def description(self): - """ - Gets the description of this TspHealthCheckStatusDescription. - + """Gets the description of this TspHealthCheckStatusDescription. # noqa: E501 + + # noqa: E501 - :return: The description of this TspHealthCheckStatusDescription. + :return: The description of this TspHealthCheckStatusDescription. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this TspHealthCheckStatusDescription. - + """Sets the description of this TspHealthCheckStatusDescription. + + # noqa: E501 - :param description: The description of this TspHealthCheckStatusDescription. + :param description: The description of this TspHealthCheckStatusDescription. # noqa: E501 :type: str """ @@ -80,22 +97,22 @@ def description(self, description): @property def error(self): - """ - Gets the error of this TspHealthCheckStatusDescription. - + """Gets the error of this TspHealthCheckStatusDescription. # noqa: E501 - :return: The error of this TspHealthCheckStatusDescription. + # noqa: E501 + + :return: The error of this TspHealthCheckStatusDescription. # noqa: E501 :rtype: str """ return self._error @error.setter def error(self, error): - """ - Sets the error of this TspHealthCheckStatusDescription. - + """Sets the error of this TspHealthCheckStatusDescription. + + # noqa: E501 - :param error: The error of this TspHealthCheckStatusDescription. + :param error: The error of this TspHealthCheckStatusDescription. # noqa: E501 :type: str """ @@ -103,22 +120,22 @@ def error(self, error): @property def hostname(self): - """ - Gets the hostname of this TspHealthCheckStatusDescription. - + """Gets the hostname of this TspHealthCheckStatusDescription. # noqa: E501 + + # noqa: E501 - :return: The hostname of this TspHealthCheckStatusDescription. + :return: The hostname of this TspHealthCheckStatusDescription. # noqa: E501 :rtype: str """ return self._hostname @hostname.setter def hostname(self, hostname): - """ - Sets the hostname of this TspHealthCheckStatusDescription. - + """Sets the hostname of this TspHealthCheckStatusDescription. - :param hostname: The hostname of this TspHealthCheckStatusDescription. + # noqa: E501 + + :param hostname: The hostname of this TspHealthCheckStatusDescription. # noqa: E501 :type: str """ @@ -126,22 +143,22 @@ def hostname(self, hostname): @property def response_seconds(self): - """ - Gets the response_seconds of this TspHealthCheckStatusDescription. - + """Gets the response_seconds of this TspHealthCheckStatusDescription. # noqa: E501 + + # noqa: E501 - :return: The response_seconds of this TspHealthCheckStatusDescription. + :return: The response_seconds of this TspHealthCheckStatusDescription. # noqa: E501 :rtype: str """ return self._response_seconds @response_seconds.setter def response_seconds(self, response_seconds): - """ - Sets the response_seconds of this TspHealthCheckStatusDescription. - + """Sets the response_seconds of this TspHealthCheckStatusDescription. + + # noqa: E501 - :param response_seconds: The response_seconds of this TspHealthCheckStatusDescription. + :param response_seconds: The response_seconds of this TspHealthCheckStatusDescription. # noqa: E501 :type: str """ @@ -149,22 +166,22 @@ def response_seconds(self, response_seconds): @property def status(self): - """ - Gets the status of this TspHealthCheckStatusDescription. - Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. + """Gets the status of this TspHealthCheckStatusDescription. # noqa: E501 - :return: The status of this TspHealthCheckStatusDescription. + Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 + + :return: The status of this TspHealthCheckStatusDescription. # noqa: E501 :rtype: str """ return self._status @status.setter def status(self, status): - """ - Sets the status of this TspHealthCheckStatusDescription. - Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. + """Sets the status of this TspHealthCheckStatusDescription. + + Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 - :param status: The status of this TspHealthCheckStatusDescription. + :param status: The status of this TspHealthCheckStatusDescription. # noqa: E501 :type: str """ @@ -172,34 +189,32 @@ def status(self, status): @property def type(self): - """ - Gets the type of this TspHealthCheckStatusDescription. - + """Gets the type of this TspHealthCheckStatusDescription. # noqa: E501 + + # noqa: E501 - :return: The type of this TspHealthCheckStatusDescription. + :return: The type of this TspHealthCheckStatusDescription. # noqa: E501 :rtype: str """ return self._type @type.setter def type(self, type): - """ - Sets the type of this TspHealthCheckStatusDescription. - + """Sets the type of this TspHealthCheckStatusDescription. - :param type: The type of this TspHealthCheckStatusDescription. + # noqa: E501 + + :param type: The type of this TspHealthCheckStatusDescription. # noqa: E501 :type: str """ self._type = type def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -216,29 +231,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(TspHealthCheckStatusDescription, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, TspHealthCheckStatusDescription): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/update_transaction_request.py b/docusign_esign/models/update_transaction_request.py index 4f9692ca..2fcce05f 100644 --- a/docusign_esign/models/update_transaction_request.py +++ b/docusign_esign/models/update_transaction_request.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,59 +11,70 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class UpdateTransactionRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, code=None, message=None, state=None): - """ - UpdateTransactionRequest - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'code': 'str', - 'message': 'str', - 'state': 'str' - } - - self.attribute_map = { - 'code': 'code', - 'message': 'message', - 'state': 'state' - } - - self._code = code - self._message = message - self._state = state + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'str', + 'message': 'str', + 'state': 'str' + } + + attribute_map = { + 'code': 'code', + 'message': 'message', + 'state': 'state' + } + + def __init__(self, code=None, message=None, state=None): # noqa: E501 + """UpdateTransactionRequest - a model defined in Swagger""" # noqa: E501 + + self._code = None + self._message = None + self._state = None + self.discriminator = None + + if code is not None: + self.code = code + if message is not None: + self.message = message + if state is not None: + self.state = state @property def code(self): - """ - Gets the code of this UpdateTransactionRequest. - + """Gets the code of this UpdateTransactionRequest. # noqa: E501 + + # noqa: E501 - :return: The code of this UpdateTransactionRequest. + :return: The code of this UpdateTransactionRequest. # noqa: E501 :rtype: str """ return self._code @code.setter def code(self, code): - """ - Sets the code of this UpdateTransactionRequest. - + """Sets the code of this UpdateTransactionRequest. + + # noqa: E501 - :param code: The code of this UpdateTransactionRequest. + :param code: The code of this UpdateTransactionRequest. # noqa: E501 :type: str """ @@ -71,22 +82,22 @@ def code(self, code): @property def message(self): - """ - Gets the message of this UpdateTransactionRequest. - + """Gets the message of this UpdateTransactionRequest. # noqa: E501 + + # noqa: E501 - :return: The message of this UpdateTransactionRequest. + :return: The message of this UpdateTransactionRequest. # noqa: E501 :rtype: str """ return self._message @message.setter def message(self, message): - """ - Sets the message of this UpdateTransactionRequest. - + """Sets the message of this UpdateTransactionRequest. + + # noqa: E501 - :param message: The message of this UpdateTransactionRequest. + :param message: The message of this UpdateTransactionRequest. # noqa: E501 :type: str """ @@ -94,34 +105,32 @@ def message(self, message): @property def state(self): - """ - Gets the state of this UpdateTransactionRequest. - The state or province associated with the address. + """Gets the state of this UpdateTransactionRequest. # noqa: E501 - :return: The state of this UpdateTransactionRequest. + The state or province associated with the address. # noqa: E501 + + :return: The state of this UpdateTransactionRequest. # noqa: E501 :rtype: str """ return self._state @state.setter def state(self, state): - """ - Sets the state of this UpdateTransactionRequest. - The state or province associated with the address. + """Sets the state of this UpdateTransactionRequest. - :param state: The state of this UpdateTransactionRequest. + The state or province associated with the address. # noqa: E501 + + :param state: The state of this UpdateTransactionRequest. # noqa: E501 :type: str """ self._state = state def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -138,29 +147,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(UpdateTransactionRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, UpdateTransactionRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/update_transaction_response.py b/docusign_esign/models/update_transaction_response.py index b049baed..ce14384d 100644 --- a/docusign_esign/models/update_transaction_response.py +++ b/docusign_esign/models/update_transaction_response.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,65 +11,70 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class UpdateTransactionResponse(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, redirection_url=None): - """ - UpdateTransactionResponse - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'redirection_url': 'str' - } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'redirection_url': 'str' + } - self.attribute_map = { - 'redirection_url': 'redirectionUrl' - } + attribute_map = { + 'redirection_url': 'redirectionUrl' + } - self._redirection_url = redirection_url + def __init__(self, redirection_url=None): # noqa: E501 + """UpdateTransactionResponse - a model defined in Swagger""" # noqa: E501 + + self._redirection_url = None + self.discriminator = None + + if redirection_url is not None: + self.redirection_url = redirection_url @property def redirection_url(self): - """ - Gets the redirection_url of this UpdateTransactionResponse. - + """Gets the redirection_url of this UpdateTransactionResponse. # noqa: E501 + + # noqa: E501 - :return: The redirection_url of this UpdateTransactionResponse. + :return: The redirection_url of this UpdateTransactionResponse. # noqa: E501 :rtype: str """ return self._redirection_url @redirection_url.setter def redirection_url(self, redirection_url): - """ - Sets the redirection_url of this UpdateTransactionResponse. - + """Sets the redirection_url of this UpdateTransactionResponse. - :param redirection_url: The redirection_url of this UpdateTransactionResponse. + # noqa: E501 + + :param redirection_url: The redirection_url of this UpdateTransactionResponse. # noqa: E501 :type: str """ self._redirection_url = redirection_url def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -86,29 +91,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(UpdateTransactionResponse, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, UpdateTransactionResponse): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/user.py b/docusign_esign/models/user.py index 0b08ed0e..7956ee89 100644 --- a/docusign_esign/models/user.py +++ b/docusign_esign/models/user.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,68 +11,85 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class User(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, cell_phone_number=None, country_code=None, credentials=None, display_name=None, email=None, external_claims=None): - """ - User - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'cell_phone_number': 'str', - 'country_code': 'str', - 'credentials': 'list[Credential]', - 'display_name': 'str', - 'email': 'str', - 'external_claims': 'list[ExternalClaim]' - } - - self.attribute_map = { - 'cell_phone_number': 'cellPhoneNumber', - 'country_code': 'countryCode', - 'credentials': 'credentials', - 'display_name': 'displayName', - 'email': 'email', - 'external_claims': 'externalClaims' - } - - self._cell_phone_number = cell_phone_number - self._country_code = country_code - self._credentials = credentials - self._display_name = display_name - self._email = email - self._external_claims = external_claims + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'cell_phone_number': 'str', + 'country_code': 'str', + 'credentials': 'list[Credential]', + 'display_name': 'str', + 'email': 'str', + 'external_claims': 'list[ExternalClaim]' + } + + attribute_map = { + 'cell_phone_number': 'cellPhoneNumber', + 'country_code': 'countryCode', + 'credentials': 'credentials', + 'display_name': 'displayName', + 'email': 'email', + 'external_claims': 'externalClaims' + } + + def __init__(self, cell_phone_number=None, country_code=None, credentials=None, display_name=None, email=None, external_claims=None): # noqa: E501 + """User - a model defined in Swagger""" # noqa: E501 + + self._cell_phone_number = None + self._country_code = None + self._credentials = None + self._display_name = None + self._email = None + self._external_claims = None + self.discriminator = None + + if cell_phone_number is not None: + self.cell_phone_number = cell_phone_number + if country_code is not None: + self.country_code = country_code + if credentials is not None: + self.credentials = credentials + if display_name is not None: + self.display_name = display_name + if email is not None: + self.email = email + if external_claims is not None: + self.external_claims = external_claims @property def cell_phone_number(self): - """ - Gets the cell_phone_number of this User. - + """Gets the cell_phone_number of this User. # noqa: E501 + + # noqa: E501 - :return: The cell_phone_number of this User. + :return: The cell_phone_number of this User. # noqa: E501 :rtype: str """ return self._cell_phone_number @cell_phone_number.setter def cell_phone_number(self, cell_phone_number): - """ - Sets the cell_phone_number of this User. - + """Sets the cell_phone_number of this User. + + # noqa: E501 - :param cell_phone_number: The cell_phone_number of this User. + :param cell_phone_number: The cell_phone_number of this User. # noqa: E501 :type: str """ @@ -80,22 +97,22 @@ def cell_phone_number(self, cell_phone_number): @property def country_code(self): - """ - Gets the country_code of this User. - + """Gets the country_code of this User. # noqa: E501 - :return: The country_code of this User. + # noqa: E501 + + :return: The country_code of this User. # noqa: E501 :rtype: str """ return self._country_code @country_code.setter def country_code(self, country_code): - """ - Sets the country_code of this User. - + """Sets the country_code of this User. + + # noqa: E501 - :param country_code: The country_code of this User. + :param country_code: The country_code of this User. # noqa: E501 :type: str """ @@ -103,22 +120,22 @@ def country_code(self, country_code): @property def credentials(self): - """ - Gets the credentials of this User. - + """Gets the credentials of this User. # noqa: E501 + + # noqa: E501 - :return: The credentials of this User. + :return: The credentials of this User. # noqa: E501 :rtype: list[Credential] """ return self._credentials @credentials.setter def credentials(self, credentials): - """ - Sets the credentials of this User. - + """Sets the credentials of this User. - :param credentials: The credentials of this User. + # noqa: E501 + + :param credentials: The credentials of this User. # noqa: E501 :type: list[Credential] """ @@ -126,22 +143,22 @@ def credentials(self, credentials): @property def display_name(self): - """ - Gets the display_name of this User. - + """Gets the display_name of this User. # noqa: E501 + + # noqa: E501 - :return: The display_name of this User. + :return: The display_name of this User. # noqa: E501 :rtype: str """ return self._display_name @display_name.setter def display_name(self, display_name): - """ - Sets the display_name of this User. - + """Sets the display_name of this User. + + # noqa: E501 - :param display_name: The display_name of this User. + :param display_name: The display_name of this User. # noqa: E501 :type: str """ @@ -149,22 +166,22 @@ def display_name(self, display_name): @property def email(self): - """ - Gets the email of this User. - + """Gets the email of this User. # noqa: E501 - :return: The email of this User. + # noqa: E501 + + :return: The email of this User. # noqa: E501 :rtype: str """ return self._email @email.setter def email(self, email): - """ - Sets the email of this User. - + """Sets the email of this User. + + # noqa: E501 - :param email: The email of this User. + :param email: The email of this User. # noqa: E501 :type: str """ @@ -172,34 +189,32 @@ def email(self, email): @property def external_claims(self): - """ - Gets the external_claims of this User. - + """Gets the external_claims of this User. # noqa: E501 + + # noqa: E501 - :return: The external_claims of this User. + :return: The external_claims of this User. # noqa: E501 :rtype: list[ExternalClaim] """ return self._external_claims @external_claims.setter def external_claims(self, external_claims): - """ - Sets the external_claims of this User. - + """Sets the external_claims of this User. - :param external_claims: The external_claims of this User. + # noqa: E501 + + :param external_claims: The external_claims of this User. # noqa: E501 :type: list[ExternalClaim] """ self._external_claims = external_claims def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -216,29 +231,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(User, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, User): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/user_info_response.py b/docusign_esign/models/user_info_response.py index 3c6e2c6d..6b341860 100644 --- a/docusign_esign/models/user_info_response.py +++ b/docusign_esign/models/user_info_response.py @@ -3,7 +3,7 @@ """ DocuSign REST API - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 OpenAPI spec version: v2.1 Contact: devcenter@docusign.com @@ -11,65 +11,80 @@ """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 + +import six class UserInfoResponse(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, envelope_id=None, language=None, seal=None, sender=None, user=None): - """ - UserInfoResponse - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'envelope_id': 'str', - 'language': 'str', - 'seal': 'Seal', - 'sender': 'Sender', - 'user': 'User' - } - - self.attribute_map = { - 'envelope_id': 'envelopeId', - 'language': 'language', - 'seal': 'seal', - 'sender': 'sender', - 'user': 'user' - } - self._envelope_id = envelope_id - self._language = language - self._seal = seal - self._sender = sender - self._user = user + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'envelope_id': 'str', + 'language': 'str', + 'seal': 'Seal', + 'sender': 'Sender', + 'user': 'User' + } + + attribute_map = { + 'envelope_id': 'envelopeId', + 'language': 'language', + 'seal': 'seal', + 'sender': 'sender', + 'user': 'user' + } + + def __init__(self, envelope_id=None, language=None, seal=None, sender=None, user=None): # noqa: E501 + """UserInfoResponse - a model defined in Swagger""" # noqa: E501 + + self._envelope_id = None + self._language = None + self._seal = None + self._sender = None + self._user = None + self.discriminator = None + + if envelope_id is not None: + self.envelope_id = envelope_id + if language is not None: + self.language = language + if seal is not None: + self.seal = seal + if sender is not None: + self.sender = sender + if user is not None: + self.user = user @property def envelope_id(self): - """ - Gets the envelope_id of this UserInfoResponse. - The envelope ID of the envelope status that failed to post. + """Gets the envelope_id of this UserInfoResponse. # noqa: E501 - :return: The envelope_id of this UserInfoResponse. + The envelope ID of the envelope status that failed to post. # noqa: E501 + + :return: The envelope_id of this UserInfoResponse. # noqa: E501 :rtype: str """ return self._envelope_id @envelope_id.setter def envelope_id(self, envelope_id): - """ - Sets the envelope_id of this UserInfoResponse. - The envelope ID of the envelope status that failed to post. + """Sets the envelope_id of this UserInfoResponse. + + The envelope ID of the envelope status that failed to post. # noqa: E501 - :param envelope_id: The envelope_id of this UserInfoResponse. + :param envelope_id: The envelope_id of this UserInfoResponse. # noqa: E501 :type: str """ @@ -77,22 +92,22 @@ def envelope_id(self, envelope_id): @property def language(self): - """ - Gets the language of this UserInfoResponse. - + """Gets the language of this UserInfoResponse. # noqa: E501 + + # noqa: E501 - :return: The language of this UserInfoResponse. + :return: The language of this UserInfoResponse. # noqa: E501 :rtype: str """ return self._language @language.setter def language(self, language): - """ - Sets the language of this UserInfoResponse. - + """Sets the language of this UserInfoResponse. - :param language: The language of this UserInfoResponse. + # noqa: E501 + + :param language: The language of this UserInfoResponse. # noqa: E501 :type: str """ @@ -100,20 +115,20 @@ def language(self, language): @property def seal(self): - """ - Gets the seal of this UserInfoResponse. + """Gets the seal of this UserInfoResponse. # noqa: E501 - :return: The seal of this UserInfoResponse. + + :return: The seal of this UserInfoResponse. # noqa: E501 :rtype: Seal """ return self._seal @seal.setter def seal(self, seal): - """ - Sets the seal of this UserInfoResponse. + """Sets the seal of this UserInfoResponse. + - :param seal: The seal of this UserInfoResponse. + :param seal: The seal of this UserInfoResponse. # noqa: E501 :type: Seal """ @@ -121,20 +136,20 @@ def seal(self, seal): @property def sender(self): - """ - Gets the sender of this UserInfoResponse. + """Gets the sender of this UserInfoResponse. # noqa: E501 + - :return: The sender of this UserInfoResponse. + :return: The sender of this UserInfoResponse. # noqa: E501 :rtype: Sender """ return self._sender @sender.setter def sender(self, sender): - """ - Sets the sender of this UserInfoResponse. + """Sets the sender of this UserInfoResponse. - :param sender: The sender of this UserInfoResponse. + + :param sender: The sender of this UserInfoResponse. # noqa: E501 :type: Sender """ @@ -142,32 +157,30 @@ def sender(self, sender): @property def user(self): - """ - Gets the user of this UserInfoResponse. + """Gets the user of this UserInfoResponse. # noqa: E501 + - :return: The user of this UserInfoResponse. + :return: The user of this UserInfoResponse. # noqa: E501 :rtype: User """ return self._user @user.setter def user(self, user): - """ - Sets the user of this UserInfoResponse. + """Sets the user of this UserInfoResponse. + - :param user: The user of this UserInfoResponse. + :param user: The user of this UserInfoResponse. # noqa: E501 :type: User """ self._user = user def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -184,29 +197,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(UserInfoResponse, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, UserInfoResponse): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/docusign_esign/models/user_information.py b/docusign_esign/models/user_information.py index 03fdf48f..0f547f90 100644 --- a/docusign_esign/models/user_information.py +++ b/docusign_esign/models/user_information.py @@ -44,6 +44,7 @@ class UserInformation(object): 'first_name': 'str', 'forgotten_password_info': 'ForgottenPasswordInformation', 'group_list': 'list[Group]', + 'has_remote_notary': 'bool', 'home_address': 'AddressInformation', 'initials_image_uri': 'str', 'is_admin': 'str', @@ -89,6 +90,7 @@ class UserInformation(object): 'first_name': 'firstName', 'forgotten_password_info': 'forgottenPasswordInfo', 'group_list': 'groupList', + 'has_remote_notary': 'hasRemoteNotary', 'home_address': 'homeAddress', 'initials_image_uri': 'initialsImageUri', 'is_admin': 'isAdmin', @@ -120,7 +122,7 @@ class UserInformation(object): 'work_address': 'workAddress' } - def __init__(self, activation_access_code=None, company=None, connect_configurations=None, country_code=None, created_date_time=None, custom_settings=None, default_account_id=None, email=None, enable_connect_for_user=None, error_details=None, first_name=None, forgotten_password_info=None, group_list=None, home_address=None, initials_image_uri=None, is_admin=None, is_nar_enabled=None, job_title=None, last_login=None, last_name=None, login_status=None, middle_name=None, password=None, password_expiration=None, permission_profile_id=None, permission_profile_name=None, profile_image_uri=None, send_activation_email=None, send_activation_on_invalid_login=None, signature_image_uri=None, subscribe=None, suffix_name=None, title=None, uri=None, user_added_to_account_date_time=None, user_id=None, user_name=None, user_profile_last_modified_date=None, user_settings=None, user_status=None, user_type=None, work_address=None): # noqa: E501 + def __init__(self, activation_access_code=None, company=None, connect_configurations=None, country_code=None, created_date_time=None, custom_settings=None, default_account_id=None, email=None, enable_connect_for_user=None, error_details=None, first_name=None, forgotten_password_info=None, group_list=None, has_remote_notary=None, home_address=None, initials_image_uri=None, is_admin=None, is_nar_enabled=None, job_title=None, last_login=None, last_name=None, login_status=None, middle_name=None, password=None, password_expiration=None, permission_profile_id=None, permission_profile_name=None, profile_image_uri=None, send_activation_email=None, send_activation_on_invalid_login=None, signature_image_uri=None, subscribe=None, suffix_name=None, title=None, uri=None, user_added_to_account_date_time=None, user_id=None, user_name=None, user_profile_last_modified_date=None, user_settings=None, user_status=None, user_type=None, work_address=None): # noqa: E501 """UserInformation - a model defined in Swagger""" # noqa: E501 self._activation_access_code = None @@ -136,6 +138,7 @@ def __init__(self, activation_access_code=None, company=None, connect_configurat self._first_name = None self._forgotten_password_info = None self._group_list = None + self._has_remote_notary = None self._home_address = None self._initials_image_uri = None self._is_admin = None @@ -193,6 +196,8 @@ def __init__(self, activation_access_code=None, company=None, connect_configurat self.forgotten_password_info = forgotten_password_info if group_list is not None: self.group_list = group_list + if has_remote_notary is not None: + self.has_remote_notary = has_remote_notary if home_address is not None: self.home_address = home_address if initials_image_uri is not None: @@ -547,6 +552,29 @@ def group_list(self, group_list): self._group_list = group_list + @property + def has_remote_notary(self): + """Gets the has_remote_notary of this UserInformation. # noqa: E501 + + # noqa: E501 + + :return: The has_remote_notary of this UserInformation. # noqa: E501 + :rtype: bool + """ + return self._has_remote_notary + + @has_remote_notary.setter + def has_remote_notary(self, has_remote_notary): + """Sets the has_remote_notary of this UserInformation. + + # noqa: E501 + + :param has_remote_notary: The has_remote_notary of this UserInformation. # noqa: E501 + :type: bool + """ + + self._has_remote_notary = has_remote_notary + @property def home_address(self): """Gets the home_address of this UserInformation. # noqa: E501 diff --git a/requirements.txt b/requirements.txt index 30a801ab..15341f10 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,6 +3,6 @@ six >= 1.8.0 python_dateutil >= 2.5.3 setuptools >= 21.0.0 urllib3 >= 1.15 -PyJWT>=1.7.1 +PyJWT>=1.7.1,<2 cryptography>=2.5 nose>=1.3.7 diff --git a/setup.py b/setup.py index c0d37c31..afef77ea 100644 --- a/setup.py +++ b/setup.py @@ -10,10 +10,11 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git """ + from setuptools import setup, find_packages, Command, os # noqa: H301 NAME = "docusign-esign" -VERSION = "3.7.1" +VERSION = "3.8.0rc1" # To install the library, run the following # # python setup.py install @@ -21,7 +22,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools -REQUIRES = ["urllib3 >= 1.15", "six >= 1.8.0", "certifi >= 14.05.14", "python-dateutil >= 2.5.3", "setuptools >= 21.0.0", "PyJWT>=1.7.1", "cryptography>=2.5", "nose>=1.3.7"] +REQUIRES = ["urllib3 >= 1.15", "six >= 1.8.0", "certifi >= 14.05.14", "python-dateutil >= 2.5.3", "setuptools >= 21.0.0", "PyJWT>=1.7.1,<2", "cryptography>=2.5", "nose>=1.3.7"] class CleanCommand(Command): """Custom clean command to tidy up the project root."""