From f23bfb3acbbe0a04fb67484c5bbdb4058ef6f370 Mon Sep 17 00:00:00 2001 From: Harsha Rahul Boggaram Date: Tue, 11 Aug 2020 12:02:04 -0700 Subject: [PATCH] v3.5.0rc1 (#82) * sdk built through Tir * v3.5.0rc1 updates & commments API removed * adding CleanCmd back into setup.py Co-authored-by: Harsha Rahul Boggaram --- docusign_esign/__init__.py | 1 - docusign_esign/apis/accounts_api.py | 866 +++- docusign_esign/apis/bulk_envelopes_api.py | 231 +- docusign_esign/apis/comments_api.py | 153 - docusign_esign/apis/envelopes_api.py | 744 +++- docusign_esign/models/__init__.py | 24 + .../models/account_settings_information.py | 26 + .../models/bulk_send_batch_status.py | 397 ++ .../models/bulk_send_batch_summaries.py | 369 ++ .../models/bulk_send_batch_summary.py | 313 ++ .../models/bulk_send_error_status.py | 173 + .../models/conditional_recipient_rule.py | 199 + .../conditional_recipient_rule_condition.py | 173 + .../conditional_recipient_rule_filter.py | 257 ++ docusign_esign/models/e_note_configuration.py | 30 +- docusign_esign/models/envelope.py | 32 +- docusign_esign/models/envelope_definition.py | 32 +- docusign_esign/models/envelope_template.py | 32 +- docusign_esign/models/new_user.py | 30 +- .../models/proof_service_resource_token.py | 32 +- .../recipient_additional_notification.py | 34 +- docusign_esign/models/recipient_group.py | 173 + docusign_esign/models/recipient_option.py | 229 ++ docusign_esign/models/recipient_routing.py | 115 + docusign_esign/models/recipient_rules.py | 117 + .../report_in_product_csv_run_request.py | 817 ++++ .../models/report_in_product_field.py | 201 + .../models/report_in_product_get.py | 899 +++++ .../models/report_in_product_list.py | 117 + .../models/report_in_product_list_item.py | 481 +++ .../models/report_in_product_run_request.py | 705 ++++ .../models/report_in_product_run_response.py | 285 ++ .../report_in_product_run_response_row.py | 143 + ...port_in_product_run_response_row_fields.py | 3505 +++++++++++++++++ .../models/report_in_product_save_response.py | 117 + .../report_in_product_sent_by_details.py | 145 + .../models/sender_email_notifications.py | 30 +- docusign_esign/models/tab_metadata.py | 58 +- docusign_esign/models/workflow.py | 173 + docusign_esign/models/workflow_step.py | 311 ++ setup.py | 8 +- 41 files changed, 12491 insertions(+), 286 deletions(-) delete mode 100644 docusign_esign/apis/comments_api.py create mode 100644 docusign_esign/models/bulk_send_batch_status.py create mode 100644 docusign_esign/models/bulk_send_batch_summaries.py create mode 100644 docusign_esign/models/bulk_send_batch_summary.py create mode 100644 docusign_esign/models/bulk_send_error_status.py create mode 100644 docusign_esign/models/conditional_recipient_rule.py create mode 100644 docusign_esign/models/conditional_recipient_rule_condition.py create mode 100644 docusign_esign/models/conditional_recipient_rule_filter.py create mode 100644 docusign_esign/models/recipient_group.py create mode 100644 docusign_esign/models/recipient_option.py create mode 100644 docusign_esign/models/recipient_routing.py create mode 100644 docusign_esign/models/recipient_rules.py create mode 100644 docusign_esign/models/report_in_product_csv_run_request.py create mode 100644 docusign_esign/models/report_in_product_field.py create mode 100644 docusign_esign/models/report_in_product_get.py create mode 100644 docusign_esign/models/report_in_product_list.py create mode 100644 docusign_esign/models/report_in_product_list_item.py create mode 100644 docusign_esign/models/report_in_product_run_request.py create mode 100644 docusign_esign/models/report_in_product_run_response.py create mode 100644 docusign_esign/models/report_in_product_run_response_row.py create mode 100644 docusign_esign/models/report_in_product_run_response_row_fields.py create mode 100644 docusign_esign/models/report_in_product_save_response.py create mode 100644 docusign_esign/models/report_in_product_sent_by_details.py create mode 100644 docusign_esign/models/workflow.py create mode 100644 docusign_esign/models/workflow_step.py diff --git a/docusign_esign/__init__.py b/docusign_esign/__init__.py index f3ef9514..9e458ecf 100644 --- a/docusign_esign/__init__.py +++ b/docusign_esign/__init__.py @@ -384,7 +384,6 @@ from .apis.billing_api import BillingApi from .apis.bulk_envelopes_api import BulkEnvelopesApi from .apis.cloud_storage_api import CloudStorageApi -from .apis.comments_api import CommentsApi from .apis.connect_api import ConnectApi from .apis.custom_tabs_api import CustomTabsApi from .apis.diagnostics_api import DiagnosticsApi diff --git a/docusign_esign/apis/accounts_api.py b/docusign_esign/apis/accounts_api.py index 890a4540..75a692c5 100644 --- a/docusign_esign/apis/accounts_api.py +++ b/docusign_esign/apis/accounts_api.py @@ -469,6 +469,111 @@ def create_permission_profile_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def create_report_in_product_create(self, account_id, **kwargs): + """ + Creates a customized report + This method makes a synchronous HTTP request by default. To make 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_report_in_product_create(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 ReportInProductRunRequest report_in_product_run_request: + :return: ReportInProductSaveResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.create_report_in_product_create_with_http_info(account_id, **kwargs) + else: + (data) = self.create_report_in_product_create_with_http_info(account_id, **kwargs) + return data + + def create_report_in_product_create_with_http_info(self, account_id, **kwargs): + """ + Creates a customized report + This method makes a synchronous HTTP request by default. To make 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_report_in_product_create_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 ReportInProductRunRequest report_in_product_run_request: + :return: ReportInProductSaveResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'report_in_product_run_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 create_report_in_product_create" % 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_report_in_product_create`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/reports'.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 + if 'report_in_product_run_request' in params: + body_params = params['report_in_product_run_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='ReportInProductSaveResponse', + 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(self, account_id, **kwargs): """ Deletes the specified account. @@ -1341,6 +1446,114 @@ def delete_permission_profile_with_http_info(self, account_id, permission_profil _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def delete_report_in_product(self, account_id, id, **kwargs): + """ + Removes a customized report + This method makes a synchronous HTTP request by default. To make 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_report_in_product(account_id, id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str id: (required) + :return: ReportInProductSaveResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_report_in_product_with_http_info(account_id, id, **kwargs) + else: + (data) = self.delete_report_in_product_with_http_info(account_id, id, **kwargs) + return data + + def delete_report_in_product_with_http_info(self, account_id, id, **kwargs): + """ + Removes a customized report + This method makes a synchronous HTTP request by default. To make 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_report_in_product_with_http_info(account_id, id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str id: (required) + :return: ReportInProductSaveResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', '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_report_in_product" % 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_report_in_product`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `delete_report_in_product`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/reports/{id}'.replace('{format}', 'json') + path_params = {} + if 'account_id' in params: + path_params['accountId'] = params['account_id'] + if 'id' in params: + path_params['id'] = params['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='ReportInProductSaveResponse', + 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_identity_verification(self, account_id, **kwargs): """ Get the list of identity verification options for an account @@ -3450,51 +3663,53 @@ def get_provisioning_with_http_info(self, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_supported_languages(self, account_id, **kwargs): + def get_report_in_product(self, account_id, id, **kwargs): """ - Gets list of supported languages for recipient language setting. + Gets the specified report This method makes a synchronous HTTP request by default. To make 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_supported_languages(account_id, callback=callback_function) + >>> thread = api.get_report_in_product(account_id, id, callback=callback_function) :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: SupportedLanguages + :param str id: (required) + :return: ReportInProductGet If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_supported_languages_with_http_info(account_id, **kwargs) + return self.get_report_in_product_with_http_info(account_id, id, **kwargs) else: - (data) = self.get_supported_languages_with_http_info(account_id, **kwargs) + (data) = self.get_report_in_product_with_http_info(account_id, id, **kwargs) return data - def get_supported_languages_with_http_info(self, account_id, **kwargs): + def get_report_in_product_with_http_info(self, account_id, id, **kwargs): """ - Gets list of supported languages for recipient language setting. + Gets the specified report This method makes a synchronous HTTP request by default. To make 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_supported_languages_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_report_in_product_with_http_info(account_id, id, callback=callback_function) :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: SupportedLanguages + :param str id: (required) + :return: ReportInProductGet If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id'] + all_params = ['account_id', 'id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3505,21 +3720,26 @@ def get_supported_languages_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_supported_languages" % key + " to method get_report_in_product" % 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_supported_languages`") + raise ValueError("Missing the required parameter `account_id` when calling `get_report_in_product`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_report_in_product`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/supported_languages'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/reports/{id}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] + if 'id' in params: + path_params['id'] = params['id'] query_params = {} @@ -3543,7 +3763,7 @@ def get_supported_languages_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='SupportedLanguages', + response_type='ReportInProductGet', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3551,46 +3771,46 @@ def get_supported_languages_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_watermark(self, account_id, **kwargs): + def get_report_in_product_list(self, account_id, **kwargs): """ - Get watermark information. + Gets the descriptors for all of an account's active reports (for listings) This method makes a synchronous HTTP request by default. To make 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_watermark(account_id, callback=callback_function) + >>> thread = api.get_report_in_product_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) - :return: Watermark + :return: ReportInProductList If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_watermark_with_http_info(account_id, **kwargs) + return self.get_report_in_product_list_with_http_info(account_id, **kwargs) else: - (data) = self.get_watermark_with_http_info(account_id, **kwargs) + (data) = self.get_report_in_product_list_with_http_info(account_id, **kwargs) return data - def get_watermark_with_http_info(self, account_id, **kwargs): + def get_report_in_product_list_with_http_info(self, account_id, **kwargs): """ - Get watermark information. + Gets the descriptors for all of an account's active reports (for listings) This method makes a synchronous HTTP request by default. To make 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_watermark_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_report_in_product_list_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: Watermark + :return: ReportInProductList If the method is called asynchronously, returns the request thread. """ @@ -3606,18 +3826,18 @@ def get_watermark_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_watermark" % key + " to method get_report_in_product_list" % 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_watermark`") + raise ValueError("Missing the required parameter `account_id` when calling `get_report_in_product_list`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/watermark'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/reports'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -3644,7 +3864,7 @@ def get_watermark_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='Watermark', + response_type='ReportInProductList', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3652,53 +3872,51 @@ def get_watermark_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_watermark_preview(self, account_id, **kwargs): + def get_supported_languages(self, account_id, **kwargs): """ - Get watermark preview. + Gets list of supported languages for recipient language setting. This method makes a synchronous HTTP request by default. To make 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_watermark_preview(account_id, callback=callback_function) + >>> thread = api.get_supported_languages(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 Watermark watermark: - :return: Watermark + :return: SupportedLanguages If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_watermark_preview_with_http_info(account_id, **kwargs) + return self.get_supported_languages_with_http_info(account_id, **kwargs) else: - (data) = self.get_watermark_preview_with_http_info(account_id, **kwargs) + (data) = self.get_supported_languages_with_http_info(account_id, **kwargs) return data - def get_watermark_preview_with_http_info(self, account_id, **kwargs): + def get_supported_languages_with_http_info(self, account_id, **kwargs): """ - Get watermark preview. + Gets list of supported languages for recipient language setting. This method makes a synchronous HTTP request by default. To make 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_watermark_preview_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_supported_languages_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 Watermark watermark: - :return: Watermark + :return: SupportedLanguages If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'watermark'] + all_params = ['account_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3709,18 +3927,18 @@ def get_watermark_preview_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_watermark_preview" % key + " to method get_supported_languages" % 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_watermark_preview`") + raise ValueError("Missing the required parameter `account_id` when calling `get_supported_languages`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/watermark/preview'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/supported_languages'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -3733,8 +3951,6 @@ def get_watermark_preview_with_http_info(self, account_id, **kwargs): local_var_files = {} body_params = None - if 'watermark' in params: - body_params = params['watermark'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -3742,14 +3958,14 @@ def get_watermark_preview_with_http_info(self, account_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'PUT', + return self.api_client.call_api(resource_path, 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='Watermark', + response_type='SupportedLanguages', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3757,38 +3973,244 @@ def get_watermark_preview_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_brands(self, account_id, **kwargs): + def get_watermark(self, account_id, **kwargs): """ - Gets a list of brand profiles. - Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call. + Get watermark information. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.list_brands(account_id, callback=callback_function) + >>> thread = api.get_watermark(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 exclude_distributor_brand: When set to **true**, excludes distributor brand information from the response set. - :param str include_logos: When set to **true**, returns the logos associated with the brand. - :return: BrandsResponse + :return: Watermark If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.list_brands_with_http_info(account_id, **kwargs) + return self.get_watermark_with_http_info(account_id, **kwargs) else: - (data) = self.list_brands_with_http_info(account_id, **kwargs) + (data) = self.get_watermark_with_http_info(account_id, **kwargs) return data - def list_brands_with_http_info(self, account_id, **kwargs): + def get_watermark_with_http_info(self, account_id, **kwargs): """ - Gets a list of brand profiles. - Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call. + Get watermark information. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_watermark_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: Watermark + 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_watermark" % 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_watermark`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/watermark'.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='Watermark', + 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_watermark_preview(self, account_id, **kwargs): + """ + Get watermark preview. + This method makes a synchronous HTTP request by default. To make 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_watermark_preview(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 Watermark watermark: + :return: Watermark + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_watermark_preview_with_http_info(account_id, **kwargs) + else: + (data) = self.get_watermark_preview_with_http_info(account_id, **kwargs) + return data + + def get_watermark_preview_with_http_info(self, account_id, **kwargs): + """ + Get watermark preview. + This method makes a synchronous HTTP request by default. To make 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_watermark_preview_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 Watermark watermark: + :return: Watermark + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'watermark'] + 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_watermark_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 `get_watermark_preview`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/watermark/preview'.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 + if 'watermark' in params: + body_params = params['watermark'] + # 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='Watermark', + 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_brands(self, account_id, **kwargs): + """ + Gets a list of brand profiles. + Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call. + This method makes a synchronous HTTP request by default. To make 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_brands(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 exclude_distributor_brand: When set to **true**, excludes distributor brand information from the response set. + :param str include_logos: When set to **true**, returns the logos associated with the brand. + :return: BrandsResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.list_brands_with_http_info(account_id, **kwargs) + else: + (data) = self.list_brands_with_http_info(account_id, **kwargs) + return data + + def list_brands_with_http_info(self, account_id, **kwargs): + """ + Gets a list of brand profiles. + Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -6063,6 +6485,328 @@ def update_permission_profile_with_http_info(self, account_id, permission_profil _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def update_report_in_product_run_results(self, account_id, **kwargs): + """ + Returns the result set from running the specified report + This method makes a synchronous HTTP request by default. To make 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_report_in_product_run_results(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 ReportInProductRunRequest report_in_product_run_request: + :return: ReportInProductRunResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.update_report_in_product_run_results_with_http_info(account_id, **kwargs) + else: + (data) = self.update_report_in_product_run_results_with_http_info(account_id, **kwargs) + return data + + def update_report_in_product_run_results_with_http_info(self, account_id, **kwargs): + """ + Returns the result set from running the specified report + This method makes a synchronous HTTP request by default. To make 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_report_in_product_run_results_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 ReportInProductRunRequest report_in_product_run_request: + :return: ReportInProductRunResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'report_in_product_run_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_report_in_product_run_results" % 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_report_in_product_run_results`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/reports/report_results'.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 + if 'report_in_product_run_request' in params: + body_params = params['report_in_product_run_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='ReportInProductRunResponse', + 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_report_in_product_save(self, account_id, id, **kwargs): + """ + Saves a customized report + This method makes a synchronous HTTP request by default. To make 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_report_in_product_save(account_id, id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str id: (required) + :param ReportInProductRunRequest report_in_product_run_request: + :return: ReportInProductSaveResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.update_report_in_product_save_with_http_info(account_id, id, **kwargs) + else: + (data) = self.update_report_in_product_save_with_http_info(account_id, id, **kwargs) + return data + + def update_report_in_product_save_with_http_info(self, account_id, id, **kwargs): + """ + Saves a customized report + This method makes a synchronous HTTP request by default. To make 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_report_in_product_save_with_http_info(account_id, id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str id: (required) + :param ReportInProductRunRequest report_in_product_run_request: + :return: ReportInProductSaveResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'id', 'report_in_product_run_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_report_in_product_save" % 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_report_in_product_save`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_report_in_product_save`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/reports/{id}'.replace('{format}', 'json') + path_params = {} + if 'account_id' in params: + path_params['accountId'] = params['account_id'] + if 'id' in params: + path_params['id'] = params['id'] + + query_params = {} + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'report_in_product_run_request' in params: + body_params = params['report_in_product_run_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='ReportInProductSaveResponse', + 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_report_results_csv(self, account_id, **kwargs): + """ + Returns the specified report as a CSV string + This method makes a synchronous HTTP request by default. To make 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_report_results_csv(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 ReportInProductCsvRunRequest report_in_product_csv_run_request: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.update_report_results_csv_with_http_info(account_id, **kwargs) + else: + (data) = self.update_report_results_csv_with_http_info(account_id, **kwargs) + return data + + def update_report_results_csv_with_http_info(self, account_id, **kwargs): + """ + Returns the specified report as a CSV string + This method makes a synchronous HTTP request by default. To make 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_report_results_csv_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 ReportInProductCsvRunRequest report_in_product_csv_run_request: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'report_in_product_csv_run_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_report_results_csv" % 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_report_results_csv`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/reports/report_results_csv'.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 + if 'report_in_product_csv_run_request' in params: + body_params = params['report_in_product_csv_run_request'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(resource_path, 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def update_settings(self, account_id, **kwargs): """ Updates the account settings for an account. diff --git a/docusign_esign/apis/bulk_envelopes_api.py b/docusign_esign/apis/bulk_envelopes_api.py index 8dbcf22c..342f4f02 100644 --- a/docusign_esign/apis/bulk_envelopes_api.py +++ b/docusign_esign/apis/bulk_envelopes_api.py @@ -716,6 +716,231 @@ def get_with_http_info(self, account_id, batch_id, **kwargs): _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 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_bulk_send_batch_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 bulk_send_batch_id: (required) + :return: BulkSendBatchStatus + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id, **kwargs) + else: + (data) = self.get_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id, **kwargs) + return data + + def get_bulk_send_batch_status_with_http_info(self, account_id, bulk_send_batch_id, **kwargs): + """ + Gets 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_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 bulk_send_batch_id: (required) + :return: BulkSendBatchStatus + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'bulk_send_batch_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_bulk_send_batch_status" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_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 `get_bulk_send_batch_status`") + + + collection_formats = {} + + 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 = {} + + 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='BulkSendBatchStatus', + 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_batches(self, account_id, **kwargs): + """ + Returns a list of bulk send batch satuses initiated by 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_bulk_send_batches(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 batch_ids: + :param str count: + :param str start_position: + :param str status: + :return: BulkSendBatchSummaries + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_bulk_send_batches_with_http_info(account_id, **kwargs) + else: + (data) = self.get_bulk_send_batches_with_http_info(account_id, **kwargs) + return data + + def get_bulk_send_batches_with_http_info(self, account_id, **kwargs): + """ + Returns a list of bulk send batch satuses initiated by 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_bulk_send_batches_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 batch_ids: + :param str count: + :param str start_position: + :param str status: + :return: BulkSendBatchSummaries + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'batch_ids', 'count', 'start_position', 'status'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_bulk_send_batches" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_bulk_send_batches`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/bulk_send_batch'.replace('{format}', 'json') + path_params = {} + if 'account_id' in params: + path_params['accountId'] = params['account_id'] + + query_params = {} + if 'batch_ids' in params: + query_params['batch_ids'] = params['batch_ids'] + if 'count' in params: + query_params['count'] = params['count'] + if 'start_position' in params: + query_params['start_position'] = params['start_position'] + if 'status' in params: + query_params['status'] = params['status'] + + 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='BulkSendBatchSummaries', + 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_list(self, account_id, bulk_send_list_id, **kwargs): """ Gets a specific bulk send list @@ -1066,7 +1291,6 @@ def list(self, account_id, **kwargs): 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 include: :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 If the method is called asynchronously, @@ -1095,14 +1319,13 @@ def list_with_http_info(self, account_id, **kwargs): for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str count: The number of results to return. This can be 1 to 20. - :param str include: :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 If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'count', 'include', 'start_position'] + all_params = ['account_id', 'count', 'start_position'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1132,8 +1355,6 @@ def list_with_http_info(self, account_id, **kwargs): 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'] diff --git a/docusign_esign/apis/comments_api.py b/docusign_esign/apis/comments_api.py deleted file mode 100644 index b3994a78..00000000 --- a/docusign_esign/apis/comments_api.py +++ /dev/null @@ -1,153 +0,0 @@ -# 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. - - OpenAPI spec version: v2 - Contact: devcenter@docusign.com - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..client.configuration import Configuration -from ..client.api_client import ApiClient - - -class CommentsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_comments_transcript(self, account_id, envelope_id, **kwargs): - """ - 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_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) - :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_comments_transcript_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.get_comments_transcript_with_http_info(account_id, envelope_id, **kwargs) - return data - - def get_comments_transcript_with_http_info(self, account_id, envelope_id, **kwargs): - """ - 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_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) - :param str encoding: - :return: file - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'encoding'] - 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_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_comments_transcript`") - # verify the required parameter 'envelope_id' is set - if ('envelope_id' not in params) or (params['envelope_id'] is None): - raise ValueError("Missing the required parameter `envelope_id` when calling `get_comments_transcript`") - - - collection_formats = {} - - resource_path = '/v2/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript'.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 'encoding' in params: - query_params['encoding'] = params['encoding'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/pdf']) - - # 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) diff --git a/docusign_esign/apis/envelopes_api.py b/docusign_esign/apis/envelopes_api.py index f44ec503..d5198663 100644 --- a/docusign_esign/apis/envelopes_api.py +++ b/docusign_esign/apis/envelopes_api.py @@ -3838,6 +3838,114 @@ 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): + """ + Delete the workflow definition for an envelope. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.delete_envelope_workflow_definition(account_id, envelope_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :return: 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_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + else: + (data) = self.delete_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + return data + + def delete_envelope_workflow_definition_with_http_info(self, account_id, envelope_id, **kwargs): + """ + Delete the workflow definition for an envelope. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.delete_envelope_workflow_definition_with_http_info(account_id, envelope_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :return: 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 delete_envelope_workflow_definition" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `delete_envelope_workflow_definition`") + # verify the required parameter 'envelope_id' is set + if ('envelope_id' not in params) or (params['envelope_id'] is None): + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_envelope_workflow_definition`") + + + collection_formats = {} + + 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 '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, '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_lock(self, account_id, envelope_id, **kwargs): """ Deletes an envelope lock. @@ -4300,6 +4408,114 @@ 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): + """ + Delete the workflow definition for a template. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.delete_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: 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) + else: + (data) = self.delete_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) + return data + + def delete_template_workflow_definition_with_http_info(self, account_id, template_id, **kwargs): + """ + Delete the workflow definition for a template. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.delete_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: None + 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 delete_template_workflow_definition" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `delete_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}/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, '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_templates_from_document(self, account_id, document_id, envelope_id, template_id, **kwargs): """ Deletes a template from a document in an existing envelope. @@ -6092,6 +6308,114 @@ 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): + """ + Returns the workflow definition for an envelope. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_envelope_workflow_definition(account_id, envelope_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :return: Workflow + 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) + else: + (data) = self.get_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + return data + + def get_envelope_workflow_definition_with_http_info(self, account_id, envelope_id, **kwargs): + """ + Returns the workflow definition for an envelope. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_envelope_workflow_definition_with_http_info(account_id, envelope_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :return: Workflow + 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_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_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`") + + + collection_formats = {} + + 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 '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='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 get_form_data(self, account_id, envelope_id, **kwargs): """ Returns envelope form data for an existing envelope. @@ -7161,51 +7485,161 @@ def get_recipient_signature_image_with_http_info(self, account_id, envelope_id, def get_tabs_blob(self, account_id, envelope_id, **kwargs): """ - Get encrypted tabs for envelope. + 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_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_tabs_blob(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_template_recipient_document_visibility(account_id, recipient_id, template_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :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_tabs_blob_with_http_info(account_id, envelope_id, **kwargs) + return self.get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, **kwargs) else: - (data) = self.get_tabs_blob_with_http_info(account_id, envelope_id, **kwargs) + (data) = self.get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, **kwargs) return data - def get_tabs_blob_with_http_info(self, account_id, envelope_id, **kwargs): + def get_template_recipient_document_visibility_with_http_info(self, account_id, recipient_id, template_id, **kwargs): """ - Get encrypted tabs for envelope. + Returns document visibility for the recipients This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_tabs_blob_with_http_info(account_id, envelope_id, callback=callback_function) + >>> thread = api.get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :return: None + :param str recipient_id: The ID of the recipient being accessed. (required) + :param str template_id: The ID of the template being accessed. (required) + :return: DocumentVisibilityList If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'envelope_id'] + all_params = ['account_id', 'recipient_id', 'template_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7216,26 +7650,31 @@ 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_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_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_template_recipient_document_visibility`") + # verify the required parameter 'recipient_id' is set + if ('recipient_id' not in params) or (params['recipient_id'] is None): + raise ValueError("Missing the required parameter `recipient_id` when calling `get_template_recipient_document_visibility`") + # verify the required parameter 'template_id' is set + if ('template_id' not in params) or (params['template_id'] is None): + raise ValueError("Missing the required parameter `template_id` when calling `get_template_recipient_document_visibility`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'envelope_id' in params: - path_params['envelopeId'] = params['envelope_id'] + if 'recipient_id' in params: + path_params['recipientId'] = params['recipient_id'] + if 'template_id' in params: + path_params['templateId'] = params['template_id'] query_params = {} @@ -7259,7 +7698,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='DocumentVisibilityList', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7267,55 +7706,53 @@ 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_template_workflow_definition(self, account_id, template_id, **kwargs): """ - Returns document visibility for the recipients + 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_recipient_document_visibility(account_id, recipient_id, template_id, callback=callback_function) + >>> thread = api.get_template_workflow_definition(account_id, template_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) :param str template_id: The ID of the template being accessed. (required) - :return: DocumentVisibilityList + :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_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, **kwargs) + return self.get_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) else: - (data) = self.get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, **kwargs) + (data) = self.get_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) return data - def get_template_recipient_document_visibility_with_http_info(self, account_id, recipient_id, template_id, **kwargs): + def get_template_workflow_definition_with_http_info(self, account_id, template_id, **kwargs): """ - Returns document visibility for the recipients + 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_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, callback=callback_function) + >>> thread = api.get_template_workflow_definition_with_http_info(account_id, template_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str recipient_id: The ID of the recipient being accessed. (required) :param str template_id: The ID of the template being accessed. (required) - :return: DocumentVisibilityList + :return: Workflow If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'recipient_id', 'template_id'] + all_params = ['account_id', 'template_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7326,29 +7763,24 @@ 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_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_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`") + 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_recipient_document_visibility`") + raise ValueError("Missing the required parameter `template_id` when calling `get_template_workflow_definition`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility'.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 'recipient_id' in params: - path_params['recipientId'] = params['recipient_id'] if 'template_id' in params: path_params['templateId'] = params['template_id'] @@ -7374,7 +7806,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='Workflow', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10345,6 +10777,118 @@ 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): + """ + 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_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 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_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + else: + (data) = self.update_envelope_workflow_definition_with_http_info(account_id, envelope_id, **kwargs) + return data + + def update_envelope_workflow_definition_with_http_info(self, account_id, envelope_id, **kwargs): + """ + 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_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 Workflow workflow: + :return: Workflow + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'envelope_id', 'workflow'] + 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_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_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_envelope_workflow_definition`") + + + collection_formats = {} + + 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 'envelope_id' in params: + path_params['envelopeId'] = params['envelope_id'] + + query_params = {} + + header_params = {} + + form_params = [] + 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']) + + # 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='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 update_lock(self, account_id, envelope_id, **kwargs): """ Updates an envelope lock. @@ -11629,3 +12173,115 @@ def update_template_recipients_document_visibility_with_http_info(self, account_ _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + + def update_template_workflow_definition(self, account_id, template_id, **kwargs): + """ + Updates 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.update_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) + :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_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) + else: + (data) = self.update_template_workflow_definition_with_http_info(account_id, template_id, **kwargs) + return data + + def update_template_workflow_definition_with_http_info(self, account_id, template_id, **kwargs): + """ + Updates 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.update_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) + :param Workflow workflow: + :return: Workflow + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'template_id', 'workflow'] + 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_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 `update_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 `update_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 + if 'workflow' in params: + body_params = params['workflow'] + # 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='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) diff --git a/docusign_esign/models/__init__.py b/docusign_esign/models/__init__.py index 17716898..1c9a353f 100644 --- a/docusign_esign/models/__init__.py +++ b/docusign_esign/models/__init__.py @@ -100,6 +100,10 @@ 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_status import BulkSendBatchStatus +from docusign_esign.models.bulk_send_batch_summaries import BulkSendBatchSummaries +from docusign_esign.models.bulk_send_batch_summary import BulkSendBatchSummary +from docusign_esign.models.bulk_send_error_status import BulkSendErrorStatus from docusign_esign.models.bulk_send_request import BulkSendRequest from docusign_esign.models.bulk_send_response import BulkSendResponse from docusign_esign.models.bulk_send_test_response import BulkSendTestResponse @@ -127,6 +131,9 @@ from docusign_esign.models.comments_publish import CommentsPublish from docusign_esign.models.company import Company 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 +from docusign_esign.models.conditional_recipient_rule_filter import ConditionalRecipientRuleFilter from docusign_esign.models.connect_config_results import ConnectConfigResults from docusign_esign.models.connect_custom_configuration import ConnectCustomConfiguration from docusign_esign.models.connect_debug_log import ConnectDebugLog @@ -328,14 +335,18 @@ from docusign_esign.models.recipient_email_notification import RecipientEmailNotification from docusign_esign.models.recipient_event import RecipientEvent from docusign_esign.models.recipient_form_data import RecipientFormData +from docusign_esign.models.recipient_group import RecipientGroup from docusign_esign.models.recipient_identity_input_option import RecipientIdentityInputOption from docusign_esign.models.recipient_identity_phone_number import RecipientIdentityPhoneNumber from docusign_esign.models.recipient_identity_verification import RecipientIdentityVerification from docusign_esign.models.recipient_names_response import RecipientNamesResponse +from docusign_esign.models.recipient_option import RecipientOption from docusign_esign.models.recipient_phone_authentication import RecipientPhoneAuthentication from docusign_esign.models.recipient_phone_number import RecipientPhoneNumber from docusign_esign.models.recipient_preview_request import RecipientPreviewRequest from docusign_esign.models.recipient_proof_file import RecipientProofFile +from docusign_esign.models.recipient_routing import RecipientRouting +from docusign_esign.models.recipient_rules import RecipientRules from docusign_esign.models.recipient_sms_authentication import RecipientSMSAuthentication from docusign_esign.models.recipient_signature_information import RecipientSignatureInformation from docusign_esign.models.recipient_signature_provider import RecipientSignatureProvider @@ -346,6 +357,17 @@ from docusign_esign.models.recipients_update_summary import RecipientsUpdateSummary from docusign_esign.models.referral_information import ReferralInformation from docusign_esign.models.reminders import Reminders +from docusign_esign.models.report_in_product_csv_run_request import ReportInProductCsvRunRequest +from docusign_esign.models.report_in_product_field import ReportInProductField +from docusign_esign.models.report_in_product_get import ReportInProductGet +from docusign_esign.models.report_in_product_list import ReportInProductList +from docusign_esign.models.report_in_product_list_item import ReportInProductListItem +from docusign_esign.models.report_in_product_run_request import ReportInProductRunRequest +from docusign_esign.models.report_in_product_run_response import ReportInProductRunResponse +from docusign_esign.models.report_in_product_run_response_row import ReportInProductRunResponseRow +from docusign_esign.models.report_in_product_run_response_row_fields import ReportInProductRunResponseRowFields +from docusign_esign.models.report_in_product_save_response import ReportInProductSaveResponse +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.seal_identifier import SealIdentifier @@ -419,6 +441,8 @@ from docusign_esign.models.view_url import ViewUrl from docusign_esign.models.watermark import Watermark from docusign_esign.models.witness import Witness +from docusign_esign.models.workflow import Workflow +from docusign_esign.models.workflow_step import WorkflowStep from docusign_esign.models.workspace import Workspace from docusign_esign.models.workspace_folder_contents import WorkspaceFolderContents from docusign_esign.models.workspace_item import WorkspaceItem diff --git a/docusign_esign/models/account_settings_information.py b/docusign_esign/models/account_settings_information.py index 71d121e2..cce3333a 100644 --- a/docusign_esign/models/account_settings_information.py +++ b/docusign_esign/models/account_settings_information.py @@ -65,6 +65,7 @@ class AccountSettingsInformation(object): 'allow_connect_http_listener_configs': 'str', 'allow_connect_send_finish_later': 'str', 'allow_connect_send_finish_later_metadata': 'SettingsMetadata', + 'allow_connect_unified_payload_ui': 'str', 'allow_consumer_disclosure_override': 'str', 'allow_consumer_disclosure_override_metadata': 'SettingsMetadata', 'allow_data_download': 'str', @@ -582,6 +583,7 @@ class AccountSettingsInformation(object): 'allow_connect_http_listener_configs': 'allowConnectHttpListenerConfigs', 'allow_connect_send_finish_later': 'allowConnectSendFinishLater', 'allow_connect_send_finish_later_metadata': 'allowConnectSendFinishLaterMetadata', + 'allow_connect_unified_payload_ui': 'allowConnectUnifiedPayloadUI', 'allow_consumer_disclosure_override': 'allowConsumerDisclosureOverride', 'allow_consumer_disclosure_override_metadata': 'allowConsumerDisclosureOverrideMetadata', 'allow_data_download': 'allowDataDownload', @@ -1101,6 +1103,7 @@ def __init__(self, **kwargs): self._allow_connect_http_listener_configs = None self._allow_connect_send_finish_later = None self._allow_connect_send_finish_later_metadata = None + self._allow_connect_unified_payload_ui = None self._allow_consumer_disclosure_override = None self._allow_consumer_disclosure_override_metadata = None self._allow_data_download = None @@ -2333,6 +2336,29 @@ def allow_connect_send_finish_later_metadata(self, allow_connect_send_finish_lat self._allow_connect_send_finish_later_metadata = allow_connect_send_finish_later_metadata + @property + def allow_connect_unified_payload_ui(self): + """Gets the allow_connect_unified_payload_ui of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The allow_connect_unified_payload_ui of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._allow_connect_unified_payload_ui + + @allow_connect_unified_payload_ui.setter + def allow_connect_unified_payload_ui(self, allow_connect_unified_payload_ui): + """Sets the allow_connect_unified_payload_ui of this AccountSettingsInformation. + + # noqa: E501 + + :param allow_connect_unified_payload_ui: The allow_connect_unified_payload_ui of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._allow_connect_unified_payload_ui = allow_connect_unified_payload_ui + @property def allow_consumer_disclosure_override(self): """Gets the allow_consumer_disclosure_override of this AccountSettingsInformation. # noqa: E501 diff --git a/docusign_esign/models/bulk_send_batch_status.py b/docusign_esign/models/bulk_send_batch_status.py new file mode 100644 index 00000000..0e9e94de --- /dev/null +++ b/docusign_esign/models/bulk_send_batch_status.py @@ -0,0 +1,397 @@ +# 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 BulkSendBatchStatus(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_id': 'str', + 'batch_name': 'str', + 'batch_size': 'str', + 'bulk_errors': 'list[BulkSendErrorStatus]', + 'envelope_id_or_template_id': 'str', + 'envelopes_uri': 'str', + 'failed': 'str', + 'mailing_list_id': 'str', + 'queued': 'str', + 'sent': 'str', + 'submitted_date': 'str' + } + + attribute_map = { + 'batch_id': 'batchId', + 'batch_name': 'batchName', + 'batch_size': 'batchSize', + 'bulk_errors': 'bulkErrors', + 'envelope_id_or_template_id': 'envelopeIdOrTemplateId', + 'envelopes_uri': 'envelopesUri', + 'failed': 'failed', + 'mailing_list_id': 'mailingListId', + 'queued': 'queued', + '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 + """BulkSendBatchStatus - a model defined in Swagger""" # noqa: E501 + + self._batch_id = None + self._batch_name = None + self._batch_size = None + self._bulk_errors = None + self._envelope_id_or_template_id = None + self._envelopes_uri = None + self._failed = None + self._mailing_list_id = None + self._queued = None + self._sent = None + self._submitted_date = None + self.discriminator = None + + if batch_id is not None: + self.batch_id = batch_id + if batch_name is not None: + self.batch_name = batch_name + if batch_size is not None: + self.batch_size = batch_size + if bulk_errors is not None: + self.bulk_errors = bulk_errors + if envelope_id_or_template_id is not None: + self.envelope_id_or_template_id = envelope_id_or_template_id + if envelopes_uri is not None: + self.envelopes_uri = envelopes_uri + if failed is not None: + self.failed = failed + if mailing_list_id is not None: + self.mailing_list_id = mailing_list_id + if queued is not None: + self.queued = queued + if sent is not None: + self.sent = sent + if submitted_date is not None: + self.submitted_date = submitted_date + + @property + def batch_id(self): + """Gets the batch_id of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The batch_id of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._batch_id + + @batch_id.setter + def batch_id(self, batch_id): + """Sets the batch_id of this BulkSendBatchStatus. + + # noqa: E501 + + :param batch_id: The batch_id of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._batch_id = batch_id + + @property + def batch_name(self): + """Gets the batch_name of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The batch_name of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._batch_name + + @batch_name.setter + def batch_name(self, batch_name): + """Sets the batch_name of this BulkSendBatchStatus. + + # noqa: E501 + + :param batch_name: The batch_name of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._batch_name = batch_name + + @property + def batch_size(self): + """Gets the batch_size of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The batch_size of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._batch_size + + @batch_size.setter + def batch_size(self, batch_size): + """Sets the batch_size of this BulkSendBatchStatus. + + # noqa: E501 + + :param batch_size: The batch_size of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._batch_size = batch_size + + @property + def bulk_errors(self): + """Gets the bulk_errors of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The bulk_errors of this BulkSendBatchStatus. # noqa: E501 + :rtype: list[BulkSendErrorStatus] + """ + return self._bulk_errors + + @bulk_errors.setter + def bulk_errors(self, bulk_errors): + """Sets the bulk_errors of this BulkSendBatchStatus. + + # noqa: E501 + + :param bulk_errors: The bulk_errors of this BulkSendBatchStatus. # noqa: E501 + :type: list[BulkSendErrorStatus] + """ + + self._bulk_errors = bulk_errors + + @property + def envelope_id_or_template_id(self): + """Gets the envelope_id_or_template_id of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The envelope_id_or_template_id of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._envelope_id_or_template_id + + @envelope_id_or_template_id.setter + def envelope_id_or_template_id(self, envelope_id_or_template_id): + """Sets the envelope_id_or_template_id of this BulkSendBatchStatus. + + # noqa: E501 + + :param envelope_id_or_template_id: The envelope_id_or_template_id of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._envelope_id_or_template_id = envelope_id_or_template_id + + @property + def envelopes_uri(self): + """Gets the envelopes_uri of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The envelopes_uri of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._envelopes_uri + + @envelopes_uri.setter + def envelopes_uri(self, envelopes_uri): + """Sets the envelopes_uri of this BulkSendBatchStatus. + + # noqa: E501 + + :param envelopes_uri: The envelopes_uri of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._envelopes_uri = envelopes_uri + + @property + def failed(self): + """Gets the failed of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The failed of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._failed + + @failed.setter + def failed(self, failed): + """Sets the failed of this BulkSendBatchStatus. + + # noqa: E501 + + :param failed: The failed of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._failed = failed + + @property + def mailing_list_id(self): + """Gets the mailing_list_id of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The mailing_list_id of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._mailing_list_id + + @mailing_list_id.setter + def mailing_list_id(self, mailing_list_id): + """Sets the mailing_list_id of this BulkSendBatchStatus. + + # noqa: E501 + + :param mailing_list_id: The mailing_list_id of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._mailing_list_id = mailing_list_id + + @property + def queued(self): + """Gets the queued of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The queued of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._queued + + @queued.setter + def queued(self, queued): + """Sets the queued of this BulkSendBatchStatus. + + # noqa: E501 + + :param queued: The queued of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._queued = queued + + @property + def sent(self): + """Gets the sent of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The sent of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._sent + + @sent.setter + def sent(self, sent): + """Sets the sent of this BulkSendBatchStatus. + + # noqa: E501 + + :param sent: The sent of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._sent = sent + + @property + def submitted_date(self): + """Gets the submitted_date of this BulkSendBatchStatus. # noqa: E501 + + # noqa: E501 + + :return: The submitted_date of this BulkSendBatchStatus. # noqa: E501 + :rtype: str + """ + return self._submitted_date + + @submitted_date.setter + def submitted_date(self, submitted_date): + """Sets the submitted_date of this BulkSendBatchStatus. + + # noqa: E501 + + :param submitted_date: The submitted_date of this BulkSendBatchStatus. # noqa: E501 + :type: str + """ + + self._submitted_date = submitted_date + + 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(BulkSendBatchStatus, 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, BulkSendBatchStatus): + 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_summaries.py b/docusign_esign/models/bulk_send_batch_summaries.py new file mode 100644 index 00000000..cb6a4909 --- /dev/null +++ b/docusign_esign/models/bulk_send_batch_summaries.py @@ -0,0 +1,369 @@ +# 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 BulkSendBatchSummaries(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_size_limit': 'str', + 'bulk_batch_summaries': 'list[BulkSendBatchSummary]', + 'end_position': 'str', + 'next_uri': 'str', + 'previous_uri': 'str', + 'queue_limit': 'str', + 'result_set_size': 'str', + 'start_position': 'str', + 'total_queued': 'str', + 'total_set_size': 'str' + } + + attribute_map = { + 'batch_size_limit': 'batchSizeLimit', + 'bulk_batch_summaries': 'bulkBatchSummaries', + 'end_position': 'endPosition', + 'next_uri': 'nextUri', + 'previous_uri': 'previousUri', + 'queue_limit': 'queueLimit', + 'result_set_size': 'resultSetSize', + 'start_position': 'startPosition', + 'total_queued': 'totalQueued', + 'total_set_size': 'totalSetSize' + } + + def __init__(self, batch_size_limit=None, bulk_batch_summaries=None, end_position=None, next_uri=None, previous_uri=None, queue_limit=None, result_set_size=None, start_position=None, total_queued=None, total_set_size=None): # noqa: E501 + """BulkSendBatchSummaries - a model defined in Swagger""" # noqa: E501 + + self._batch_size_limit = None + self._bulk_batch_summaries = None + self._end_position = None + self._next_uri = None + self._previous_uri = None + self._queue_limit = None + self._result_set_size = None + self._start_position = None + self._total_queued = None + self._total_set_size = None + self.discriminator = None + + if batch_size_limit is not None: + self.batch_size_limit = batch_size_limit + if bulk_batch_summaries is not None: + self.bulk_batch_summaries = bulk_batch_summaries + if end_position is not None: + self.end_position = end_position + if next_uri is not None: + self.next_uri = next_uri + if previous_uri is not None: + self.previous_uri = previous_uri + if queue_limit is not None: + self.queue_limit = queue_limit + if result_set_size is not None: + self.result_set_size = result_set_size + if start_position is not None: + self.start_position = start_position + if total_queued is not None: + self.total_queued = total_queued + if total_set_size is not None: + self.total_set_size = total_set_size + + @property + def batch_size_limit(self): + """Gets the batch_size_limit of this BulkSendBatchSummaries. # noqa: E501 + + # noqa: E501 + + :return: The batch_size_limit of this BulkSendBatchSummaries. # noqa: E501 + :rtype: str + """ + return self._batch_size_limit + + @batch_size_limit.setter + def batch_size_limit(self, batch_size_limit): + """Sets the batch_size_limit of this BulkSendBatchSummaries. + + # noqa: E501 + + :param batch_size_limit: The batch_size_limit of this BulkSendBatchSummaries. # noqa: E501 + :type: str + """ + + self._batch_size_limit = batch_size_limit + + @property + def bulk_batch_summaries(self): + """Gets the bulk_batch_summaries of this BulkSendBatchSummaries. # noqa: E501 + + # noqa: E501 + + :return: The bulk_batch_summaries of this BulkSendBatchSummaries. # noqa: E501 + :rtype: list[BulkSendBatchSummary] + """ + return self._bulk_batch_summaries + + @bulk_batch_summaries.setter + def bulk_batch_summaries(self, bulk_batch_summaries): + """Sets the bulk_batch_summaries of this BulkSendBatchSummaries. + + # noqa: E501 + + :param bulk_batch_summaries: The bulk_batch_summaries of this BulkSendBatchSummaries. # noqa: E501 + :type: list[BulkSendBatchSummary] + """ + + self._bulk_batch_summaries = bulk_batch_summaries + + @property + def end_position(self): + """Gets the end_position of this BulkSendBatchSummaries. # noqa: E501 + + The last position in the result set. # noqa: E501 + + :return: The end_position of this BulkSendBatchSummaries. # noqa: E501 + :rtype: str + """ + return self._end_position + + @end_position.setter + def end_position(self, end_position): + """Sets the end_position of this BulkSendBatchSummaries. + + The last position in the result set. # noqa: E501 + + :param end_position: The end_position of this BulkSendBatchSummaries. # noqa: E501 + :type: str + """ + + self._end_position = end_position + + @property + def next_uri(self): + """Gets the next_uri of this BulkSendBatchSummaries. # noqa: E501 + + The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. # noqa: E501 + + :return: The next_uri of this BulkSendBatchSummaries. # noqa: E501 + :rtype: str + """ + return self._next_uri + + @next_uri.setter + def next_uri(self, next_uri): + """Sets the next_uri of this BulkSendBatchSummaries. + + The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. # noqa: E501 + + :param next_uri: The next_uri of this BulkSendBatchSummaries. # noqa: E501 + :type: str + """ + + self._next_uri = next_uri + + @property + def previous_uri(self): + """Gets the previous_uri of this BulkSendBatchSummaries. # noqa: E501 + + The postal code for the billing address. # noqa: E501 + + :return: The previous_uri of this BulkSendBatchSummaries. # noqa: E501 + :rtype: str + """ + return self._previous_uri + + @previous_uri.setter + def previous_uri(self, previous_uri): + """Sets the previous_uri of this BulkSendBatchSummaries. + + The postal code for the billing address. # noqa: E501 + + :param previous_uri: The previous_uri of this BulkSendBatchSummaries. # noqa: E501 + :type: str + """ + + self._previous_uri = previous_uri + + @property + def queue_limit(self): + """Gets the queue_limit of this BulkSendBatchSummaries. # noqa: E501 + + # noqa: E501 + + :return: The queue_limit of this BulkSendBatchSummaries. # noqa: E501 + :rtype: str + """ + return self._queue_limit + + @queue_limit.setter + def queue_limit(self, queue_limit): + """Sets the queue_limit of this BulkSendBatchSummaries. + + # noqa: E501 + + :param queue_limit: The queue_limit of this BulkSendBatchSummaries. # noqa: E501 + :type: str + """ + + self._queue_limit = queue_limit + + @property + def result_set_size(self): + """Gets the result_set_size of this BulkSendBatchSummaries. # noqa: E501 + + The number of results returned in this response. # noqa: E501 + + :return: The result_set_size of this BulkSendBatchSummaries. # noqa: E501 + :rtype: str + """ + return self._result_set_size + + @result_set_size.setter + def result_set_size(self, result_set_size): + """Sets the result_set_size of this BulkSendBatchSummaries. + + The number of results returned in this response. # noqa: E501 + + :param result_set_size: The result_set_size of this BulkSendBatchSummaries. # noqa: E501 + :type: str + """ + + self._result_set_size = result_set_size + + @property + def start_position(self): + """Gets the start_position of this BulkSendBatchSummaries. # noqa: E501 + + Starting position of the current result set. # noqa: E501 + + :return: The start_position of this BulkSendBatchSummaries. # noqa: E501 + :rtype: str + """ + return self._start_position + + @start_position.setter + def start_position(self, start_position): + """Sets the start_position of this BulkSendBatchSummaries. + + Starting position of the current result set. # noqa: E501 + + :param start_position: The start_position of this BulkSendBatchSummaries. # noqa: E501 + :type: str + """ + + self._start_position = start_position + + @property + def total_queued(self): + """Gets the total_queued of this BulkSendBatchSummaries. # noqa: E501 + + # noqa: E501 + + :return: The total_queued of this BulkSendBatchSummaries. # noqa: E501 + :rtype: str + """ + return self._total_queued + + @total_queued.setter + def total_queued(self, total_queued): + """Sets the total_queued of this BulkSendBatchSummaries. + + # noqa: E501 + + :param total_queued: The total_queued of this BulkSendBatchSummaries. # noqa: E501 + :type: str + """ + + self._total_queued = total_queued + + @property + def total_set_size(self): + """Gets the total_set_size of this BulkSendBatchSummaries. # noqa: E501 + + The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. # noqa: E501 + + :return: The total_set_size of this BulkSendBatchSummaries. # noqa: E501 + :rtype: str + """ + return self._total_set_size + + @total_set_size.setter + def total_set_size(self, total_set_size): + """Sets the total_set_size of this BulkSendBatchSummaries. + + The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. # noqa: E501 + + :param total_set_size: The total_set_size of this BulkSendBatchSummaries. # noqa: E501 + :type: str + """ + + self._total_set_size = total_set_size + + 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(BulkSendBatchSummaries, 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, BulkSendBatchSummaries): + 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_summary.py b/docusign_esign/models/bulk_send_batch_summary.py new file mode 100644 index 00000000..87a1db59 --- /dev/null +++ b/docusign_esign/models/bulk_send_batch_summary.py @@ -0,0 +1,313 @@ +# 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 BulkSendBatchSummary(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_id': 'str', + 'batch_name': 'str', + 'batch_size': 'str', + 'batch_uri': 'str', + 'failed': 'str', + 'queued': 'str', + 'sent': 'str', + 'submitted_date': 'str' + } + + attribute_map = { + 'batch_id': 'batchId', + 'batch_name': 'batchName', + 'batch_size': 'batchSize', + 'batch_uri': 'batchUri', + 'failed': 'failed', + 'queued': 'queued', + 'sent': 'sent', + 'submitted_date': 'submittedDate' + } + + def __init__(self, batch_id=None, batch_name=None, batch_size=None, batch_uri=None, failed=None, queued=None, sent=None, submitted_date=None): # noqa: E501 + """BulkSendBatchSummary - a model defined in Swagger""" # noqa: E501 + + self._batch_id = None + self._batch_name = None + self._batch_size = None + self._batch_uri = None + self._failed = None + self._queued = None + self._sent = None + self._submitted_date = None + self.discriminator = None + + if batch_id is not None: + self.batch_id = batch_id + if batch_name is not None: + self.batch_name = batch_name + if batch_size is not None: + self.batch_size = batch_size + if batch_uri is not None: + self.batch_uri = batch_uri + if failed is not None: + self.failed = failed + if queued is not None: + self.queued = queued + if sent is not None: + self.sent = sent + if submitted_date is not None: + self.submitted_date = submitted_date + + @property + def batch_id(self): + """Gets the batch_id of this BulkSendBatchSummary. # noqa: E501 + + # noqa: E501 + + :return: The batch_id of this BulkSendBatchSummary. # noqa: E501 + :rtype: str + """ + return self._batch_id + + @batch_id.setter + def batch_id(self, batch_id): + """Sets the batch_id of this BulkSendBatchSummary. + + # noqa: E501 + + :param batch_id: The batch_id of this BulkSendBatchSummary. # noqa: E501 + :type: str + """ + + self._batch_id = batch_id + + @property + def batch_name(self): + """Gets the batch_name of this BulkSendBatchSummary. # noqa: E501 + + # noqa: E501 + + :return: The batch_name of this BulkSendBatchSummary. # noqa: E501 + :rtype: str + """ + return self._batch_name + + @batch_name.setter + def batch_name(self, batch_name): + """Sets the batch_name of this BulkSendBatchSummary. + + # noqa: E501 + + :param batch_name: The batch_name of this BulkSendBatchSummary. # noqa: E501 + :type: str + """ + + self._batch_name = batch_name + + @property + def batch_size(self): + """Gets the batch_size of this BulkSendBatchSummary. # noqa: E501 + + # noqa: E501 + + :return: The batch_size of this BulkSendBatchSummary. # noqa: E501 + :rtype: str + """ + return self._batch_size + + @batch_size.setter + def batch_size(self, batch_size): + """Sets the batch_size of this BulkSendBatchSummary. + + # noqa: E501 + + :param batch_size: The batch_size of this BulkSendBatchSummary. # noqa: E501 + :type: str + """ + + self._batch_size = batch_size + + @property + def batch_uri(self): + """Gets the batch_uri of this BulkSendBatchSummary. # noqa: E501 + + # noqa: E501 + + :return: The batch_uri of this BulkSendBatchSummary. # noqa: E501 + :rtype: str + """ + return self._batch_uri + + @batch_uri.setter + def batch_uri(self, batch_uri): + """Sets the batch_uri of this BulkSendBatchSummary. + + # noqa: E501 + + :param batch_uri: The batch_uri of this BulkSendBatchSummary. # noqa: E501 + :type: str + """ + + self._batch_uri = batch_uri + + @property + def failed(self): + """Gets the failed of this BulkSendBatchSummary. # noqa: E501 + + # noqa: E501 + + :return: The failed of this BulkSendBatchSummary. # noqa: E501 + :rtype: str + """ + return self._failed + + @failed.setter + def failed(self, failed): + """Sets the failed of this BulkSendBatchSummary. + + # noqa: E501 + + :param failed: The failed of this BulkSendBatchSummary. # noqa: E501 + :type: str + """ + + self._failed = failed + + @property + def queued(self): + """Gets the queued of this BulkSendBatchSummary. # noqa: E501 + + # noqa: E501 + + :return: The queued of this BulkSendBatchSummary. # noqa: E501 + :rtype: str + """ + return self._queued + + @queued.setter + def queued(self, queued): + """Sets the queued of this BulkSendBatchSummary. + + # noqa: E501 + + :param queued: The queued of this BulkSendBatchSummary. # noqa: E501 + :type: str + """ + + self._queued = queued + + @property + def sent(self): + """Gets the sent of this BulkSendBatchSummary. # noqa: E501 + + # noqa: E501 + + :return: The sent of this BulkSendBatchSummary. # noqa: E501 + :rtype: str + """ + return self._sent + + @sent.setter + def sent(self, sent): + """Sets the sent of this BulkSendBatchSummary. + + # noqa: E501 + + :param sent: The sent of this BulkSendBatchSummary. # noqa: E501 + :type: str + """ + + self._sent = sent + + @property + def submitted_date(self): + """Gets the submitted_date of this BulkSendBatchSummary. # noqa: E501 + + # noqa: E501 + + :return: The submitted_date of this BulkSendBatchSummary. # noqa: E501 + :rtype: str + """ + return self._submitted_date + + @submitted_date.setter + def submitted_date(self, submitted_date): + """Sets the submitted_date of this BulkSendBatchSummary. + + # noqa: E501 + + :param submitted_date: The submitted_date of this BulkSendBatchSummary. # noqa: E501 + :type: str + """ + + self._submitted_date = submitted_date + + 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(BulkSendBatchSummary, 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, BulkSendBatchSummary): + 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_error_status.py b/docusign_esign/models/bulk_send_error_status.py new file mode 100644 index 00000000..2e028750 --- /dev/null +++ b/docusign_esign/models/bulk_send_error_status.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 BulkSendErrorStatus(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 = { + 'created': 'str', + 'error_message': 'str', + 'recipient_emails': 'list[str]' + } + + attribute_map = { + 'created': 'created', + 'error_message': 'errorMessage', + 'recipient_emails': 'recipientEmails' + } + + def __init__(self, created=None, error_message=None, recipient_emails=None): # noqa: E501 + """BulkSendErrorStatus - a model defined in Swagger""" # noqa: E501 + + self._created = None + self._error_message = None + self._recipient_emails = None + self.discriminator = None + + if created is not None: + self.created = created + if error_message is not None: + self.error_message = error_message + if recipient_emails is not None: + self.recipient_emails = recipient_emails + + @property + def created(self): + """Gets the created of this BulkSendErrorStatus. # noqa: E501 + + # noqa: E501 + + :return: The created of this BulkSendErrorStatus. # noqa: E501 + :rtype: str + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this BulkSendErrorStatus. + + # noqa: E501 + + :param created: The created of this BulkSendErrorStatus. # noqa: E501 + :type: str + """ + + self._created = created + + @property + def error_message(self): + """Gets the error_message of this BulkSendErrorStatus. # noqa: E501 + + # noqa: E501 + + :return: The error_message of this BulkSendErrorStatus. # noqa: E501 + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """Sets the error_message of this BulkSendErrorStatus. + + # noqa: E501 + + :param error_message: The error_message of this BulkSendErrorStatus. # noqa: E501 + :type: str + """ + + self._error_message = error_message + + @property + def recipient_emails(self): + """Gets the recipient_emails of this BulkSendErrorStatus. # noqa: E501 + + # noqa: E501 + + :return: The recipient_emails of this BulkSendErrorStatus. # noqa: E501 + :rtype: list[str] + """ + return self._recipient_emails + + @recipient_emails.setter + def recipient_emails(self, recipient_emails): + """Sets the recipient_emails of this BulkSendErrorStatus. + + # noqa: E501 + + :param recipient_emails: The recipient_emails of this BulkSendErrorStatus. # noqa: E501 + :type: list[str] + """ + + self._recipient_emails = recipient_emails + + 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(BulkSendErrorStatus, 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, BulkSendErrorStatus): + 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/conditional_recipient_rule.py b/docusign_esign/models/conditional_recipient_rule.py new file mode 100644 index 00000000..17f1811e --- /dev/null +++ b/docusign_esign/models/conditional_recipient_rule.py @@ -0,0 +1,199 @@ +# 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 ConditionalRecipientRule(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 = { + 'conditions': 'list[ConditionalRecipientRuleCondition]', + 'order': 'str', + 'recipient_group': 'RecipientGroup', + 'recipient_id': 'str' + } + + attribute_map = { + 'conditions': 'conditions', + 'order': 'order', + 'recipient_group': 'recipientGroup', + 'recipient_id': 'recipientId' + } + + def __init__(self, conditions=None, order=None, recipient_group=None, recipient_id=None): # noqa: E501 + """ConditionalRecipientRule - a model defined in Swagger""" # noqa: E501 + + self._conditions = None + self._order = None + self._recipient_group = None + self._recipient_id = None + self.discriminator = None + + if conditions is not None: + self.conditions = conditions + if order is not None: + self.order = order + if recipient_group is not None: + self.recipient_group = recipient_group + if recipient_id is not None: + self.recipient_id = recipient_id + + @property + def conditions(self): + """Gets the conditions of this ConditionalRecipientRule. # noqa: E501 + + # noqa: E501 + + :return: The conditions of this ConditionalRecipientRule. # noqa: E501 + :rtype: list[ConditionalRecipientRuleCondition] + """ + return self._conditions + + @conditions.setter + def conditions(self, conditions): + """Sets the conditions of this ConditionalRecipientRule. + + # noqa: E501 + + :param conditions: The conditions of this ConditionalRecipientRule. # noqa: E501 + :type: list[ConditionalRecipientRuleCondition] + """ + + self._conditions = conditions + + @property + def order(self): + """Gets the order of this ConditionalRecipientRule. # noqa: E501 + + # noqa: E501 + + :return: The order of this ConditionalRecipientRule. # noqa: E501 + :rtype: str + """ + return self._order + + @order.setter + def order(self, order): + """Sets the order of this ConditionalRecipientRule. + + # noqa: E501 + + :param order: The order of this ConditionalRecipientRule. # noqa: E501 + :type: str + """ + + self._order = order + + @property + def recipient_group(self): + """Gets the recipient_group of this ConditionalRecipientRule. # noqa: E501 + + + :return: The recipient_group of this ConditionalRecipientRule. # noqa: E501 + :rtype: RecipientGroup + """ + return self._recipient_group + + @recipient_group.setter + def recipient_group(self, recipient_group): + """Sets the recipient_group of this ConditionalRecipientRule. + + + :param recipient_group: The recipient_group of this ConditionalRecipientRule. # noqa: E501 + :type: RecipientGroup + """ + + self._recipient_group = recipient_group + + @property + def recipient_id(self): + """Gets the recipient_id of this ConditionalRecipientRule. # noqa: E501 + + Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 + + :return: The recipient_id of this ConditionalRecipientRule. # noqa: E501 + :rtype: str + """ + return self._recipient_id + + @recipient_id.setter + def recipient_id(self, recipient_id): + """Sets the recipient_id of this ConditionalRecipientRule. + + Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 + + :param recipient_id: The recipient_id of this ConditionalRecipientRule. # noqa: E501 + :type: str + """ + + self._recipient_id = recipient_id + + 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(ConditionalRecipientRule, 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, ConditionalRecipientRule): + 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/conditional_recipient_rule_condition.py b/docusign_esign/models/conditional_recipient_rule_condition.py new file mode 100644 index 00000000..15d63ec7 --- /dev/null +++ b/docusign_esign/models/conditional_recipient_rule_condition.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 ConditionalRecipientRuleCondition(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 = { + 'filters': 'list[ConditionalRecipientRuleFilter]', + 'order': 'str', + 'recipient_label': 'str' + } + + attribute_map = { + 'filters': 'filters', + 'order': 'order', + 'recipient_label': 'recipientLabel' + } + + def __init__(self, filters=None, order=None, recipient_label=None): # noqa: E501 + """ConditionalRecipientRuleCondition - a model defined in Swagger""" # noqa: E501 + + self._filters = None + self._order = None + self._recipient_label = None + self.discriminator = None + + if filters is not None: + self.filters = filters + if order is not None: + self.order = order + if recipient_label is not None: + self.recipient_label = recipient_label + + @property + def filters(self): + """Gets the filters of this ConditionalRecipientRuleCondition. # noqa: E501 + + # noqa: E501 + + :return: The filters of this ConditionalRecipientRuleCondition. # noqa: E501 + :rtype: list[ConditionalRecipientRuleFilter] + """ + return self._filters + + @filters.setter + def filters(self, filters): + """Sets the filters of this ConditionalRecipientRuleCondition. + + # noqa: E501 + + :param filters: The filters of this ConditionalRecipientRuleCondition. # noqa: E501 + :type: list[ConditionalRecipientRuleFilter] + """ + + self._filters = filters + + @property + def order(self): + """Gets the order of this ConditionalRecipientRuleCondition. # noqa: E501 + + # noqa: E501 + + :return: The order of this ConditionalRecipientRuleCondition. # noqa: E501 + :rtype: str + """ + return self._order + + @order.setter + def order(self, order): + """Sets the order of this ConditionalRecipientRuleCondition. + + # noqa: E501 + + :param order: The order of this ConditionalRecipientRuleCondition. # noqa: E501 + :type: str + """ + + self._order = order + + @property + def recipient_label(self): + """Gets the recipient_label of this ConditionalRecipientRuleCondition. # noqa: E501 + + # noqa: E501 + + :return: The recipient_label of this ConditionalRecipientRuleCondition. # noqa: E501 + :rtype: str + """ + return self._recipient_label + + @recipient_label.setter + def recipient_label(self, recipient_label): + """Sets the recipient_label of this ConditionalRecipientRuleCondition. + + # noqa: E501 + + :param recipient_label: The recipient_label of this ConditionalRecipientRuleCondition. # noqa: E501 + :type: str + """ + + self._recipient_label = recipient_label + + 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(ConditionalRecipientRuleCondition, 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, ConditionalRecipientRuleCondition): + 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/conditional_recipient_rule_filter.py b/docusign_esign/models/conditional_recipient_rule_filter.py new file mode 100644 index 00000000..1e91d495 --- /dev/null +++ b/docusign_esign/models/conditional_recipient_rule_filter.py @@ -0,0 +1,257 @@ +# 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 ConditionalRecipientRuleFilter(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 = { + 'operator': 'str', + 'recipient_id': 'str', + 'scope': 'str', + 'tab_id': 'str', + 'tab_label': 'str', + 'value': 'str' + } + + attribute_map = { + 'operator': 'operator', + 'recipient_id': 'recipientId', + 'scope': 'scope', + 'tab_id': 'tabId', + 'tab_label': 'tabLabel', + 'value': 'value' + } + + def __init__(self, operator=None, recipient_id=None, scope=None, tab_id=None, tab_label=None, value=None): # noqa: E501 + """ConditionalRecipientRuleFilter - a model defined in Swagger""" # noqa: E501 + + self._operator = None + self._recipient_id = None + self._scope = None + self._tab_id = None + self._tab_label = None + self._value = None + self.discriminator = None + + if operator is not None: + self.operator = operator + if recipient_id is not None: + self.recipient_id = recipient_id + if scope is not None: + self.scope = scope + if tab_id is not None: + self.tab_id = tab_id + if tab_label is not None: + self.tab_label = tab_label + if value is not None: + self.value = value + + @property + def operator(self): + """Gets the operator of this ConditionalRecipientRuleFilter. # noqa: E501 + + # noqa: E501 + + :return: The operator of this ConditionalRecipientRuleFilter. # noqa: E501 + :rtype: str + """ + return self._operator + + @operator.setter + def operator(self, operator): + """Sets the operator of this ConditionalRecipientRuleFilter. + + # noqa: E501 + + :param operator: The operator of this ConditionalRecipientRuleFilter. # noqa: E501 + :type: str + """ + + self._operator = operator + + @property + def recipient_id(self): + """Gets the recipient_id of this ConditionalRecipientRuleFilter. # noqa: E501 + + Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 + + :return: The recipient_id of this ConditionalRecipientRuleFilter. # noqa: E501 + :rtype: str + """ + return self._recipient_id + + @recipient_id.setter + def recipient_id(self, recipient_id): + """Sets the recipient_id of this ConditionalRecipientRuleFilter. + + Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 + + :param recipient_id: The recipient_id of this ConditionalRecipientRuleFilter. # noqa: E501 + :type: str + """ + + self._recipient_id = recipient_id + + @property + def scope(self): + """Gets the scope of this ConditionalRecipientRuleFilter. # noqa: E501 + + # noqa: E501 + + :return: The scope of this ConditionalRecipientRuleFilter. # noqa: E501 + :rtype: str + """ + return self._scope + + @scope.setter + def scope(self, scope): + """Sets the scope of this ConditionalRecipientRuleFilter. + + # noqa: E501 + + :param scope: The scope of this ConditionalRecipientRuleFilter. # noqa: E501 + :type: str + """ + + self._scope = scope + + @property + def tab_id(self): + """Gets the tab_id of this ConditionalRecipientRuleFilter. # noqa: E501 + + The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 + + :return: The tab_id of this ConditionalRecipientRuleFilter. # noqa: E501 + :rtype: str + """ + return self._tab_id + + @tab_id.setter + def tab_id(self, tab_id): + """Sets the tab_id of this ConditionalRecipientRuleFilter. + + The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 + + :param tab_id: The tab_id of this ConditionalRecipientRuleFilter. # noqa: E501 + :type: str + """ + + self._tab_id = tab_id + + @property + def tab_label(self): + """Gets the tab_label of this ConditionalRecipientRuleFilter. # noqa: E501 + + The label string associated with the tab. # noqa: E501 + + :return: The tab_label of this ConditionalRecipientRuleFilter. # noqa: E501 + :rtype: str + """ + return self._tab_label + + @tab_label.setter + def tab_label(self, tab_label): + """Sets the tab_label of this ConditionalRecipientRuleFilter. + + The label string associated with the tab. # noqa: E501 + + :param tab_label: The tab_label of this ConditionalRecipientRuleFilter. # noqa: E501 + :type: str + """ + + self._tab_label = tab_label + + @property + def value(self): + """Gets the value of this ConditionalRecipientRuleFilter. # noqa: E501 + + Specifies the value of the tab. # noqa: E501 + + :return: The value of this ConditionalRecipientRuleFilter. # noqa: E501 + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """Sets the value of this ConditionalRecipientRuleFilter. + + Specifies the value of the tab. # noqa: E501 + + :param value: The value of this ConditionalRecipientRuleFilter. # noqa: E501 + :type: str + """ + + self._value = value + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ConditionalRecipientRuleFilter, 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, ConditionalRecipientRuleFilter): + 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/e_note_configuration.py b/docusign_esign/models/e_note_configuration.py index 14b73a6a..fc029d03 100644 --- a/docusign_esign/models/e_note_configuration.py +++ b/docusign_esign/models/e_note_configuration.py @@ -31,6 +31,7 @@ class ENoteConfiguration(object): and the value is json key in definition. """ swagger_types = { + 'api_key': 'str', 'connect_configured': 'str', 'e_note_configured': 'str', 'organization': 'str', @@ -39,6 +40,7 @@ class ENoteConfiguration(object): } attribute_map = { + 'api_key': 'apiKey', 'connect_configured': 'connectConfigured', 'e_note_configured': 'eNoteConfigured', 'organization': 'organization', @@ -46,9 +48,10 @@ class ENoteConfiguration(object): 'user_name': 'userName' } - def __init__(self, connect_configured=None, e_note_configured=None, organization=None, password=None, user_name=None): # noqa: E501 + def __init__(self, api_key=None, connect_configured=None, e_note_configured=None, organization=None, password=None, user_name=None): # noqa: E501 """ENoteConfiguration - a model defined in Swagger""" # noqa: E501 + self._api_key = None self._connect_configured = None self._e_note_configured = None self._organization = None @@ -56,6 +59,8 @@ def __init__(self, connect_configured=None, e_note_configured=None, organization self._user_name = None self.discriminator = None + if api_key is not None: + self.api_key = api_key if connect_configured is not None: self.connect_configured = connect_configured if e_note_configured is not None: @@ -67,6 +72,29 @@ def __init__(self, connect_configured=None, e_note_configured=None, organization if user_name is not None: self.user_name = user_name + @property + def api_key(self): + """Gets the api_key of this ENoteConfiguration. # noqa: E501 + + # noqa: E501 + + :return: The api_key of this ENoteConfiguration. # noqa: E501 + :rtype: str + """ + return self._api_key + + @api_key.setter + def api_key(self, api_key): + """Sets the api_key of this ENoteConfiguration. + + # noqa: E501 + + :param api_key: The api_key of this ENoteConfiguration. # noqa: E501 + :type: str + """ + + self._api_key = api_key + @property def connect_configured(self): """Gets the connect_configured of this ENoteConfiguration. # noqa: E501 diff --git a/docusign_esign/models/envelope.py b/docusign_esign/models/envelope.py index d6ad7389..68507a5c 100644 --- a/docusign_esign/models/envelope.py +++ b/docusign_esign/models/envelope.py @@ -105,7 +105,8 @@ class Envelope(object): 'transaction_id': 'str', 'use_disclosure': 'str', 'voided_date_time': 'str', - 'voided_reason': 'str' + 'voided_reason': 'str', + 'workflow': 'Workflow' } attribute_map = { @@ -183,10 +184,11 @@ class Envelope(object): 'transaction_id': 'transactionId', 'use_disclosure': 'useDisclosure', 'voided_date_time': 'voidedDateTime', - 'voided_reason': 'voidedReason' + 'voided_reason': 'voidedReason', + 'workflow': 'workflow' } - def __init__(self, access_control_list_base64=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, copy_recipient_data=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, disable_responsive_document=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified_date_time=None, location=None, lock_information=None, message_lock=None, notification=None, notification_uri=None, power_form=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sender=None, sent_date_time=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, templates_uri=None, transaction_id=None, use_disclosure=None, voided_date_time=None, voided_reason=None): # noqa: E501 + def __init__(self, access_control_list_base64=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, copy_recipient_data=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, disable_responsive_document=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified_date_time=None, location=None, lock_information=None, message_lock=None, notification=None, notification_uri=None, power_form=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sender=None, sent_date_time=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, templates_uri=None, transaction_id=None, use_disclosure=None, voided_date_time=None, voided_reason=None, workflow=None): # noqa: E501 """Envelope - a model defined in Swagger""" # noqa: E501 self._access_control_list_base64 = None @@ -264,6 +266,7 @@ def __init__(self, access_control_list_base64=None, allow_comments=None, allow_m self._use_disclosure = None self._voided_date_time = None self._voided_reason = None + self._workflow = None self.discriminator = None if access_control_list_base64 is not None: @@ -416,6 +419,8 @@ def __init__(self, access_control_list_base64=None, allow_comments=None, allow_m self.voided_date_time = voided_date_time if voided_reason is not None: self.voided_reason = voided_reason + if workflow is not None: + self.workflow = workflow @property def access_control_list_base64(self): @@ -2126,6 +2131,27 @@ def voided_reason(self, voided_reason): self._voided_reason = voided_reason + @property + def workflow(self): + """Gets the workflow of this Envelope. # noqa: E501 + + + :return: The workflow of this Envelope. # noqa: E501 + :rtype: Workflow + """ + return self._workflow + + @workflow.setter + def workflow(self, workflow): + """Sets the workflow of this Envelope. + + + :param workflow: The workflow of this Envelope. # noqa: E501 + :type: Workflow + """ + + self._workflow = workflow + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/docusign_esign/models/envelope_definition.py b/docusign_esign/models/envelope_definition.py index f4b1c7c7..6a67204d 100644 --- a/docusign_esign/models/envelope_definition.py +++ b/docusign_esign/models/envelope_definition.py @@ -115,7 +115,8 @@ class EnvelopeDefinition(object): 'transaction_id': 'str', 'use_disclosure': 'str', 'voided_date_time': 'str', - 'voided_reason': 'str' + 'voided_reason': 'str', + 'workflow': 'Workflow' } attribute_map = { @@ -203,10 +204,11 @@ class EnvelopeDefinition(object): 'transaction_id': 'transactionId', 'use_disclosure': 'useDisclosure', 'voided_date_time': 'voidedDateTime', - 'voided_reason': 'voidedReason' + 'voided_reason': 'voidedReason', + 'workflow': 'workflow' } - def __init__(self, access_control_list_base64=None, accessibility=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_recipient_recursion=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, composite_templates=None, copy_recipient_data=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, disable_responsive_document=None, documents=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, event_notification=None, event_notifications=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified_date_time=None, location=None, lock_information=None, message_lock=None, notification=None, notification_uri=None, password=None, power_form=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sender=None, sent_date_time=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, template_id=None, template_roles=None, templates_uri=None, transaction_id=None, use_disclosure=None, voided_date_time=None, voided_reason=None): # noqa: E501 + def __init__(self, access_control_list_base64=None, accessibility=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_recipient_recursion=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, composite_templates=None, copy_recipient_data=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, disable_responsive_document=None, documents=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, event_notification=None, event_notifications=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified_date_time=None, location=None, lock_information=None, message_lock=None, notification=None, notification_uri=None, password=None, power_form=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sender=None, sent_date_time=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, template_id=None, template_roles=None, templates_uri=None, transaction_id=None, use_disclosure=None, voided_date_time=None, voided_reason=None, workflow=None): # noqa: E501 """EnvelopeDefinition - a model defined in Swagger""" # noqa: E501 self._access_control_list_base64 = None @@ -294,6 +296,7 @@ def __init__(self, access_control_list_base64=None, accessibility=None, allow_co self._use_disclosure = None self._voided_date_time = None self._voided_reason = None + self._workflow = None self.discriminator = None if access_control_list_base64 is not None: @@ -466,6 +469,8 @@ def __init__(self, access_control_list_base64=None, accessibility=None, allow_co self.voided_date_time = voided_date_time if voided_reason is not None: self.voided_reason = voided_reason + if workflow is not None: + self.workflow = workflow @property def access_control_list_base64(self): @@ -2404,6 +2409,27 @@ def voided_reason(self, voided_reason): self._voided_reason = voided_reason + @property + def workflow(self): + """Gets the workflow of this EnvelopeDefinition. # noqa: E501 + + + :return: The workflow of this EnvelopeDefinition. # noqa: E501 + :rtype: Workflow + """ + return self._workflow + + @workflow.setter + def workflow(self, workflow): + """Sets the workflow of this EnvelopeDefinition. + + + :param workflow: The workflow of this EnvelopeDefinition. # noqa: E501 + :type: Workflow + """ + + self._workflow = workflow + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/docusign_esign/models/envelope_template.py b/docusign_esign/models/envelope_template.py index bca4243d..2f1c8fb4 100644 --- a/docusign_esign/models/envelope_template.py +++ b/docusign_esign/models/envelope_template.py @@ -127,7 +127,8 @@ class EnvelopeTemplate(object): 'uri': 'str', 'use_disclosure': 'str', 'voided_date_time': 'str', - 'voided_reason': 'str' + 'voided_reason': 'str', + 'workflow': 'Workflow' } attribute_map = { @@ -227,10 +228,11 @@ class EnvelopeTemplate(object): 'uri': 'uri', 'use_disclosure': 'useDisclosure', 'voided_date_time': 'voidedDateTime', - 'voided_reason': 'voidedReason' + 'voided_reason': 'voidedReason', + 'workflow': 'workflow' } - def __init__(self, access_control_list_base64=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_match=None, auto_match_specified_by_user=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, copy_recipient_data=None, created=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, description=None, disable_responsive_document=None, documents=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, favorited_by_me=None, folder_id=None, folder_ids=None, folder_name=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified=None, last_modified_by=None, last_modified_date_time=None, last_used=None, location=None, lock_information=None, message_lock=None, name=None, new_password=None, notification=None, notification_uri=None, owner=None, page_count=None, password=None, password_protected=None, power_form=None, power_forms=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sender=None, sent_date_time=None, shared=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, template_id=None, templates_uri=None, transaction_id=None, uri=None, use_disclosure=None, voided_date_time=None, voided_reason=None): # noqa: E501 + def __init__(self, access_control_list_base64=None, allow_comments=None, allow_markup=None, allow_reassign=None, allow_view_history=None, any_signer=None, asynchronous=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_match=None, auto_match_specified_by_user=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, copy_recipient_data=None, created=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, description=None, disable_responsive_document=None, documents=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_attachments=None, envelope_documents=None, envelope_id=None, envelope_id_stamping=None, envelope_location=None, envelope_metadata=None, envelope_uri=None, expire_after=None, expire_date_time=None, expire_enabled=None, external_envelope_id=None, favorited_by_me=None, folder_id=None, folder_ids=None, folder_name=None, folders=None, has_comments=None, has_form_data_changed=None, has_wav_file=None, holder=None, initial_sent_date_time=None, is21_cfr_part11=None, is_dynamic_envelope=None, is_signature_provider_envelope=None, last_modified=None, last_modified_by=None, last_modified_date_time=None, last_used=None, location=None, lock_information=None, message_lock=None, name=None, new_password=None, notification=None, notification_uri=None, owner=None, page_count=None, password=None, password_protected=None, power_form=None, power_forms=None, purge_completed_date=None, purge_request_date=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sender=None, sent_date_time=None, shared=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, status_date_time=None, template_id=None, templates_uri=None, transaction_id=None, uri=None, use_disclosure=None, voided_date_time=None, voided_reason=None, workflow=None): # noqa: E501 """EnvelopeTemplate - a model defined in Swagger""" # noqa: E501 self._access_control_list_base64 = None @@ -330,6 +332,7 @@ def __init__(self, access_control_list_base64=None, allow_comments=None, allow_m self._use_disclosure = None self._voided_date_time = None self._voided_reason = None + self._workflow = None self.discriminator = None if access_control_list_base64 is not None: @@ -526,6 +529,8 @@ def __init__(self, access_control_list_base64=None, allow_comments=None, allow_m self.voided_date_time = voided_date_time if voided_reason is not None: self.voided_reason = voided_reason + if workflow is not None: + self.workflow = workflow @property def access_control_list_base64(self): @@ -2738,6 +2743,27 @@ def voided_reason(self, voided_reason): self._voided_reason = voided_reason + @property + def workflow(self): + """Gets the workflow of this EnvelopeTemplate. # noqa: E501 + + + :return: The workflow of this EnvelopeTemplate. # noqa: E501 + :rtype: Workflow + """ + return self._workflow + + @workflow.setter + def workflow(self, workflow): + """Sets the workflow of this EnvelopeTemplate. + + + :param workflow: The workflow of this EnvelopeTemplate. # noqa: E501 + :type: Workflow + """ + + self._workflow = workflow + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/docusign_esign/models/new_user.py b/docusign_esign/models/new_user.py index 16dbceb2..6cb08563 100644 --- a/docusign_esign/models/new_user.py +++ b/docusign_esign/models/new_user.py @@ -35,6 +35,7 @@ class NewUser(object): 'created_date_time': 'str', 'email': 'str', 'error_details': 'ErrorDetails', + 'membership_id': 'str', 'permission_profile_id': 'str', 'permission_profile_name': 'str', 'uri': 'str', @@ -48,6 +49,7 @@ class NewUser(object): 'created_date_time': 'createdDateTime', 'email': 'email', 'error_details': 'errorDetails', + 'membership_id': 'membershipId', 'permission_profile_id': 'permissionProfileId', 'permission_profile_name': 'permissionProfileName', 'uri': 'uri', @@ -56,13 +58,14 @@ class NewUser(object): 'user_status': 'userStatus' } - def __init__(self, api_password=None, created_date_time=None, email=None, error_details=None, permission_profile_id=None, permission_profile_name=None, uri=None, user_id=None, user_name=None, user_status=None): # noqa: E501 + def __init__(self, api_password=None, created_date_time=None, email=None, error_details=None, membership_id=None, permission_profile_id=None, permission_profile_name=None, uri=None, user_id=None, user_name=None, user_status=None): # noqa: E501 """NewUser - a model defined in Swagger""" # noqa: E501 self._api_password = None self._created_date_time = None self._email = None self._error_details = None + self._membership_id = None self._permission_profile_id = None self._permission_profile_name = None self._uri = None @@ -79,6 +82,8 @@ def __init__(self, api_password=None, created_date_time=None, email=None, error_ self.email = email if error_details is not None: self.error_details = error_details + if membership_id is not None: + self.membership_id = membership_id if permission_profile_id is not None: self.permission_profile_id = permission_profile_id if permission_profile_name is not None: @@ -182,6 +187,29 @@ def error_details(self, error_details): self._error_details = error_details + @property + def membership_id(self): + """Gets the membership_id of this NewUser. # noqa: E501 + + # noqa: E501 + + :return: The membership_id of this NewUser. # noqa: E501 + :rtype: str + """ + return self._membership_id + + @membership_id.setter + def membership_id(self, membership_id): + """Sets the membership_id of this NewUser. + + # noqa: E501 + + :param membership_id: The membership_id of this NewUser. # noqa: E501 + :type: str + """ + + self._membership_id = membership_id + @property def permission_profile_id(self): """Gets the permission_profile_id of this NewUser. # noqa: E501 diff --git a/docusign_esign/models/proof_service_resource_token.py b/docusign_esign/models/proof_service_resource_token.py index dea9cacd..31d6d266 100644 --- a/docusign_esign/models/proof_service_resource_token.py +++ b/docusign_esign/models/proof_service_resource_token.py @@ -31,22 +31,50 @@ class ProofServiceResourceToken(object): and the value is json key in definition. """ swagger_types = { + 'proof_base_uri': 'str', 'resource_token': 'str' } attribute_map = { - 'resource_token': 'ResourceToken' + 'proof_base_uri': 'proofBaseURI', + 'resource_token': 'resourceToken' } - def __init__(self, resource_token=None): # noqa: E501 + def __init__(self, proof_base_uri=None, resource_token=None): # noqa: E501 """ProofServiceResourceToken - a model defined in Swagger""" # noqa: E501 + self._proof_base_uri = None self._resource_token = None self.discriminator = None + if proof_base_uri is not None: + self.proof_base_uri = proof_base_uri if resource_token is not None: self.resource_token = resource_token + @property + def proof_base_uri(self): + """Gets the proof_base_uri of this ProofServiceResourceToken. # noqa: E501 + + # noqa: E501 + + :return: The proof_base_uri of this ProofServiceResourceToken. # noqa: E501 + :rtype: str + """ + return self._proof_base_uri + + @proof_base_uri.setter + def proof_base_uri(self, proof_base_uri): + """Sets the proof_base_uri of this ProofServiceResourceToken. + + # noqa: E501 + + :param proof_base_uri: The proof_base_uri of this ProofServiceResourceToken. # noqa: E501 + :type: str + """ + + self._proof_base_uri = proof_base_uri + @property def resource_token(self): """Gets the resource_token of this ProofServiceResourceToken. # noqa: E501 diff --git a/docusign_esign/models/recipient_additional_notification.py b/docusign_esign/models/recipient_additional_notification.py index edcdad7b..0470189b 100644 --- a/docusign_esign/models/recipient_additional_notification.py +++ b/docusign_esign/models/recipient_additional_notification.py @@ -33,21 +33,24 @@ class RecipientAdditionalNotification(object): swagger_types = { 'phone_number': 'RecipientPhoneNumber', 'secondary_delivery_method': 'str', - 'secondary_delivery_method_metadata': 'PropertyMetadata' + 'secondary_delivery_method_metadata': 'PropertyMetadata', + 'secondary_delivery_status': 'str' } attribute_map = { 'phone_number': 'phoneNumber', 'secondary_delivery_method': 'secondaryDeliveryMethod', - 'secondary_delivery_method_metadata': 'secondaryDeliveryMethodMetadata' + 'secondary_delivery_method_metadata': 'secondaryDeliveryMethodMetadata', + 'secondary_delivery_status': 'secondaryDeliveryStatus' } - def __init__(self, phone_number=None, secondary_delivery_method=None, secondary_delivery_method_metadata=None): # noqa: E501 + def __init__(self, phone_number=None, secondary_delivery_method=None, secondary_delivery_method_metadata=None, secondary_delivery_status=None): # noqa: E501 """RecipientAdditionalNotification - a model defined in Swagger""" # noqa: E501 self._phone_number = None self._secondary_delivery_method = None self._secondary_delivery_method_metadata = None + self._secondary_delivery_status = None self.discriminator = None if phone_number is not None: @@ -56,6 +59,8 @@ def __init__(self, phone_number=None, secondary_delivery_method=None, secondary_ self.secondary_delivery_method = secondary_delivery_method if secondary_delivery_method_metadata is not None: self.secondary_delivery_method_metadata = secondary_delivery_method_metadata + if secondary_delivery_status is not None: + self.secondary_delivery_status = secondary_delivery_status @property def phone_number(self): @@ -122,6 +127,29 @@ def secondary_delivery_method_metadata(self, secondary_delivery_method_metadata) self._secondary_delivery_method_metadata = secondary_delivery_method_metadata + @property + def secondary_delivery_status(self): + """Gets the secondary_delivery_status of this RecipientAdditionalNotification. # noqa: E501 + + # noqa: E501 + + :return: The secondary_delivery_status of this RecipientAdditionalNotification. # noqa: E501 + :rtype: str + """ + return self._secondary_delivery_status + + @secondary_delivery_status.setter + def secondary_delivery_status(self, secondary_delivery_status): + """Sets the secondary_delivery_status of this RecipientAdditionalNotification. + + # noqa: E501 + + :param secondary_delivery_status: The secondary_delivery_status of this RecipientAdditionalNotification. # noqa: E501 + :type: str + """ + + self._secondary_delivery_status = secondary_delivery_status + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/docusign_esign/models/recipient_group.py b/docusign_esign/models/recipient_group.py new file mode 100644 index 00000000..97a748c4 --- /dev/null +++ b/docusign_esign/models/recipient_group.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 RecipientGroup(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 = { + 'group_message': 'str', + 'group_name': 'str', + 'recipients': 'list[RecipientOption]' + } + + attribute_map = { + 'group_message': 'groupMessage', + 'group_name': 'groupName', + 'recipients': 'recipients' + } + + def __init__(self, group_message=None, group_name=None, recipients=None): # noqa: E501 + """RecipientGroup - a model defined in Swagger""" # noqa: E501 + + self._group_message = None + self._group_name = None + self._recipients = None + self.discriminator = None + + if group_message is not None: + self.group_message = group_message + if group_name is not None: + self.group_name = group_name + if recipients is not None: + self.recipients = recipients + + @property + def group_message(self): + """Gets the group_message of this RecipientGroup. # noqa: E501 + + # noqa: E501 + + :return: The group_message of this RecipientGroup. # noqa: E501 + :rtype: str + """ + return self._group_message + + @group_message.setter + def group_message(self, group_message): + """Sets the group_message of this RecipientGroup. + + # noqa: E501 + + :param group_message: The group_message of this RecipientGroup. # noqa: E501 + :type: str + """ + + self._group_message = group_message + + @property + def group_name(self): + """Gets the group_name of this RecipientGroup. # noqa: E501 + + The name of the group. # noqa: E501 + + :return: The group_name of this RecipientGroup. # noqa: E501 + :rtype: str + """ + return self._group_name + + @group_name.setter + def group_name(self, group_name): + """Sets the group_name of this RecipientGroup. + + The name of the group. # noqa: E501 + + :param group_name: The group_name of this RecipientGroup. # noqa: E501 + :type: str + """ + + self._group_name = group_name + + @property + def recipients(self): + """Gets the recipients of this RecipientGroup. # noqa: E501 + + An array of powerform recipients. # noqa: E501 + + :return: The recipients of this RecipientGroup. # noqa: E501 + :rtype: list[RecipientOption] + """ + return self._recipients + + @recipients.setter + def recipients(self, recipients): + """Sets the recipients of this RecipientGroup. + + An array of powerform recipients. # noqa: E501 + + :param recipients: The recipients of this RecipientGroup. # noqa: E501 + :type: list[RecipientOption] + """ + + self._recipients = recipients + + 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(RecipientGroup, 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, RecipientGroup): + 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/recipient_option.py b/docusign_esign/models/recipient_option.py new file mode 100644 index 00000000..922ab09d --- /dev/null +++ b/docusign_esign/models/recipient_option.py @@ -0,0 +1,229 @@ +# 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 RecipientOption(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 = { + 'email': 'str', + 'name': 'str', + 'recipient_label': 'str', + 'role_name': 'str', + 'signing_group_id': 'str' + } + + attribute_map = { + 'email': 'email', + 'name': 'name', + 'recipient_label': 'recipientLabel', + 'role_name': 'roleName', + 'signing_group_id': 'signingGroupId' + } + + def __init__(self, email=None, name=None, recipient_label=None, role_name=None, signing_group_id=None): # noqa: E501 + """RecipientOption - a model defined in Swagger""" # noqa: E501 + + self._email = None + self._name = None + self._recipient_label = None + self._role_name = None + self._signing_group_id = None + self.discriminator = None + + if email is not None: + self.email = email + if name is not None: + self.name = name + if recipient_label is not None: + self.recipient_label = recipient_label + if role_name is not None: + self.role_name = role_name + if signing_group_id is not None: + self.signing_group_id = signing_group_id + + @property + def email(self): + """Gets the email of this RecipientOption. # noqa: E501 + + # noqa: E501 + + :return: The email of this RecipientOption. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this RecipientOption. + + # noqa: E501 + + :param email: The email of this RecipientOption. # noqa: E501 + :type: str + """ + + self._email = email + + @property + def name(self): + """Gets the name of this RecipientOption. # noqa: E501 + + # noqa: E501 + + :return: The name of this RecipientOption. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this RecipientOption. + + # noqa: E501 + + :param name: The name of this RecipientOption. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def recipient_label(self): + """Gets the recipient_label of this RecipientOption. # noqa: E501 + + # noqa: E501 + + :return: The recipient_label of this RecipientOption. # noqa: E501 + :rtype: str + """ + return self._recipient_label + + @recipient_label.setter + def recipient_label(self, recipient_label): + """Sets the recipient_label of this RecipientOption. + + # noqa: E501 + + :param recipient_label: The recipient_label of this RecipientOption. # noqa: E501 + :type: str + """ + + self._recipient_label = recipient_label + + @property + def role_name(self): + """Gets the role_name of this RecipientOption. # noqa: E501 + + Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. # noqa: E501 + + :return: The role_name of this RecipientOption. # noqa: E501 + :rtype: str + """ + return self._role_name + + @role_name.setter + def role_name(self, role_name): + """Sets the role_name of this RecipientOption. + + Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. # noqa: E501 + + :param role_name: The role_name of this RecipientOption. # noqa: E501 + :type: str + """ + + self._role_name = role_name + + @property + def signing_group_id(self): + """Gets the signing_group_id of this RecipientOption. # noqa: E501 + + When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501 + + :return: The signing_group_id of this RecipientOption. # noqa: E501 + :rtype: str + """ + return self._signing_group_id + + @signing_group_id.setter + def signing_group_id(self, signing_group_id): + """Sets the signing_group_id of this RecipientOption. + + When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501 + + :param signing_group_id: The signing_group_id of this RecipientOption. # noqa: E501 + :type: str + """ + + self._signing_group_id = signing_group_id + + 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(RecipientOption, 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, RecipientOption): + 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/recipient_routing.py b/docusign_esign/models/recipient_routing.py new file mode 100644 index 00000000..4523f441 --- /dev/null +++ b/docusign_esign/models/recipient_routing.py @@ -0,0 +1,115 @@ +# 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 RecipientRouting(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 = { + 'rules': 'RecipientRules' + } + + attribute_map = { + 'rules': 'rules' + } + + def __init__(self, rules=None): # noqa: E501 + """RecipientRouting - a model defined in Swagger""" # noqa: E501 + + self._rules = None + self.discriminator = None + + if rules is not None: + self.rules = rules + + @property + def rules(self): + """Gets the rules of this RecipientRouting. # noqa: E501 + + + :return: The rules of this RecipientRouting. # noqa: E501 + :rtype: RecipientRules + """ + return self._rules + + @rules.setter + def rules(self, rules): + """Sets the rules of this RecipientRouting. + + + :param rules: The rules of this RecipientRouting. # noqa: E501 + :type: RecipientRules + """ + + self._rules = rules + + 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(RecipientRouting, 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, RecipientRouting): + 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/recipient_rules.py b/docusign_esign/models/recipient_rules.py new file mode 100644 index 00000000..bfea890d --- /dev/null +++ b/docusign_esign/models/recipient_rules.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 RecipientRules(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 = { + 'conditional_recipients': 'list[ConditionalRecipientRule]' + } + + attribute_map = { + 'conditional_recipients': 'conditionalRecipients' + } + + def __init__(self, conditional_recipients=None): # noqa: E501 + """RecipientRules - a model defined in Swagger""" # noqa: E501 + + self._conditional_recipients = None + self.discriminator = None + + if conditional_recipients is not None: + self.conditional_recipients = conditional_recipients + + @property + def conditional_recipients(self): + """Gets the conditional_recipients of this RecipientRules. # noqa: E501 + + # noqa: E501 + + :return: The conditional_recipients of this RecipientRules. # noqa: E501 + :rtype: list[ConditionalRecipientRule] + """ + return self._conditional_recipients + + @conditional_recipients.setter + def conditional_recipients(self, conditional_recipients): + """Sets the conditional_recipients of this RecipientRules. + + # noqa: E501 + + :param conditional_recipients: The conditional_recipients of this RecipientRules. # noqa: E501 + :type: list[ConditionalRecipientRule] + """ + + self._conditional_recipients = conditional_recipients + + 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(RecipientRules, 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, RecipientRules): + 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/report_in_product_csv_run_request.py b/docusign_esign/models/report_in_product_csv_run_request.py new file mode 100644 index 00000000..49075d6d --- /dev/null +++ b/docusign_esign/models/report_in_product_csv_run_request.py @@ -0,0 +1,817 @@ +# 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 ReportInProductCsvRunRequest(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 = { + 'custom_field_filter': 'str', + 'date_range_custom_from_date': 'str', + 'date_range_custom_to_date': 'str', + 'date_range_filter': 'str', + 'envelope_date_type_filter': 'str', + 'envelope_recipient_name_contains_filter': 'str', + 'envelope_status_filter': 'str', + 'envelope_subject_contains_filter': 'str', + 'fields': 'list[ReportInProductField]', + 'for_download': 'str', + 'is_dashboard': 'str', + 'new_line': 'str', + 'override_timezone_key': 'str', + 'period_length_filter': 'str', + 'quote': 'str', + 'report_customized_id': 'str', + 'report_description': 'str', + 'report_id': 'str', + 'report_invocation_type': 'str', + 'report_name': 'str', + 'sent_by_filter': 'str', + 'sent_by_ids': 'str', + 'separator': 'str', + 'sort_direction': 'str', + 'sort_field': 'str', + 'start_position': 'str' + } + + attribute_map = { + 'custom_field_filter': 'customFieldFilter', + 'date_range_custom_from_date': 'dateRangeCustomFromDate', + 'date_range_custom_to_date': 'dateRangeCustomToDate', + 'date_range_filter': 'dateRangeFilter', + 'envelope_date_type_filter': 'envelopeDateTypeFilter', + 'envelope_recipient_name_contains_filter': 'envelopeRecipientNameContainsFilter', + 'envelope_status_filter': 'envelopeStatusFilter', + 'envelope_subject_contains_filter': 'envelopeSubjectContainsFilter', + 'fields': 'fields', + 'for_download': 'forDownload', + 'is_dashboard': 'isDashboard', + 'new_line': 'newLine', + 'override_timezone_key': 'overrideTimezoneKey', + 'period_length_filter': 'periodLengthFilter', + 'quote': 'quote', + 'report_customized_id': 'reportCustomizedId', + 'report_description': 'reportDescription', + 'report_id': 'reportId', + 'report_invocation_type': 'reportInvocationType', + 'report_name': 'reportName', + 'sent_by_filter': 'sentByFilter', + 'sent_by_ids': 'sentByIds', + 'separator': 'separator', + 'sort_direction': 'sortDirection', + 'sort_field': 'sortField', + 'start_position': 'startPosition' + } + + def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, date_range_custom_to_date=None, date_range_filter=None, envelope_date_type_filter=None, envelope_recipient_name_contains_filter=None, envelope_status_filter=None, envelope_subject_contains_filter=None, fields=None, for_download=None, is_dashboard=None, new_line=None, override_timezone_key=None, period_length_filter=None, quote=None, report_customized_id=None, report_description=None, report_id=None, report_invocation_type=None, report_name=None, sent_by_filter=None, sent_by_ids=None, separator=None, sort_direction=None, sort_field=None, start_position=None): # noqa: E501 + """ReportInProductCsvRunRequest - a model defined in Swagger""" # noqa: E501 + + self._custom_field_filter = None + self._date_range_custom_from_date = None + self._date_range_custom_to_date = None + self._date_range_filter = None + self._envelope_date_type_filter = None + self._envelope_recipient_name_contains_filter = None + self._envelope_status_filter = None + self._envelope_subject_contains_filter = None + self._fields = None + self._for_download = None + self._is_dashboard = None + self._new_line = None + self._override_timezone_key = None + self._period_length_filter = None + self._quote = None + self._report_customized_id = None + self._report_description = None + self._report_id = None + self._report_invocation_type = None + self._report_name = None + self._sent_by_filter = None + self._sent_by_ids = None + self._separator = None + self._sort_direction = None + self._sort_field = None + self._start_position = None + self.discriminator = None + + if custom_field_filter is not None: + self.custom_field_filter = custom_field_filter + if date_range_custom_from_date is not None: + self.date_range_custom_from_date = date_range_custom_from_date + if date_range_custom_to_date is not None: + self.date_range_custom_to_date = date_range_custom_to_date + if date_range_filter is not None: + self.date_range_filter = date_range_filter + if envelope_date_type_filter is not None: + self.envelope_date_type_filter = envelope_date_type_filter + if envelope_recipient_name_contains_filter is not None: + self.envelope_recipient_name_contains_filter = envelope_recipient_name_contains_filter + if envelope_status_filter is not None: + self.envelope_status_filter = envelope_status_filter + if envelope_subject_contains_filter is not None: + self.envelope_subject_contains_filter = envelope_subject_contains_filter + if fields is not None: + self.fields = fields + if for_download is not None: + self.for_download = for_download + if is_dashboard is not None: + self.is_dashboard = is_dashboard + if new_line is not None: + self.new_line = new_line + if override_timezone_key is not None: + self.override_timezone_key = override_timezone_key + if period_length_filter is not None: + self.period_length_filter = period_length_filter + if quote is not None: + self.quote = quote + if report_customized_id is not None: + self.report_customized_id = report_customized_id + if report_description is not None: + self.report_description = report_description + if report_id is not None: + self.report_id = report_id + if report_invocation_type is not None: + self.report_invocation_type = report_invocation_type + if report_name is not None: + self.report_name = report_name + if sent_by_filter is not None: + self.sent_by_filter = sent_by_filter + if sent_by_ids is not None: + self.sent_by_ids = sent_by_ids + if separator is not None: + self.separator = separator + if sort_direction is not None: + self.sort_direction = sort_direction + if sort_field is not None: + self.sort_field = sort_field + if start_position is not None: + self.start_position = start_position + + @property + def custom_field_filter(self): + """Gets the custom_field_filter of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The custom_field_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._custom_field_filter + + @custom_field_filter.setter + def custom_field_filter(self, custom_field_filter): + """Sets the custom_field_filter of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param custom_field_filter: The custom_field_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._custom_field_filter = custom_field_filter + + @property + def date_range_custom_from_date(self): + """Gets the date_range_custom_from_date of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The date_range_custom_from_date of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._date_range_custom_from_date + + @date_range_custom_from_date.setter + def date_range_custom_from_date(self, date_range_custom_from_date): + """Sets the date_range_custom_from_date of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param date_range_custom_from_date: The date_range_custom_from_date of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._date_range_custom_from_date = date_range_custom_from_date + + @property + def date_range_custom_to_date(self): + """Gets the date_range_custom_to_date of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The date_range_custom_to_date of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._date_range_custom_to_date + + @date_range_custom_to_date.setter + def date_range_custom_to_date(self, date_range_custom_to_date): + """Sets the date_range_custom_to_date of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param date_range_custom_to_date: The date_range_custom_to_date of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._date_range_custom_to_date = date_range_custom_to_date + + @property + def date_range_filter(self): + """Gets the date_range_filter of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The date_range_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._date_range_filter + + @date_range_filter.setter + def date_range_filter(self, date_range_filter): + """Sets the date_range_filter of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param date_range_filter: The date_range_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._date_range_filter = date_range_filter + + @property + def envelope_date_type_filter(self): + """Gets the envelope_date_type_filter of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The envelope_date_type_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._envelope_date_type_filter + + @envelope_date_type_filter.setter + def envelope_date_type_filter(self, envelope_date_type_filter): + """Sets the envelope_date_type_filter of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param envelope_date_type_filter: The envelope_date_type_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._envelope_date_type_filter = envelope_date_type_filter + + @property + def envelope_recipient_name_contains_filter(self): + """Gets the envelope_recipient_name_contains_filter of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The envelope_recipient_name_contains_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._envelope_recipient_name_contains_filter + + @envelope_recipient_name_contains_filter.setter + def envelope_recipient_name_contains_filter(self, envelope_recipient_name_contains_filter): + """Sets the envelope_recipient_name_contains_filter of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param envelope_recipient_name_contains_filter: The envelope_recipient_name_contains_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._envelope_recipient_name_contains_filter = envelope_recipient_name_contains_filter + + @property + def envelope_status_filter(self): + """Gets the envelope_status_filter of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The envelope_status_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._envelope_status_filter + + @envelope_status_filter.setter + def envelope_status_filter(self, envelope_status_filter): + """Sets the envelope_status_filter of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param envelope_status_filter: The envelope_status_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._envelope_status_filter = envelope_status_filter + + @property + def envelope_subject_contains_filter(self): + """Gets the envelope_subject_contains_filter of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The envelope_subject_contains_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._envelope_subject_contains_filter + + @envelope_subject_contains_filter.setter + def envelope_subject_contains_filter(self, envelope_subject_contains_filter): + """Sets the envelope_subject_contains_filter of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param envelope_subject_contains_filter: The envelope_subject_contains_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._envelope_subject_contains_filter = envelope_subject_contains_filter + + @property + def fields(self): + """Gets the fields of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The fields of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: list[ReportInProductField] + """ + return self._fields + + @fields.setter + def fields(self, fields): + """Sets the fields of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param fields: The fields of this ReportInProductCsvRunRequest. # noqa: E501 + :type: list[ReportInProductField] + """ + + self._fields = fields + + @property + def for_download(self): + """Gets the for_download of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The for_download of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._for_download + + @for_download.setter + def for_download(self, for_download): + """Sets the for_download of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param for_download: The for_download of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._for_download = for_download + + @property + def is_dashboard(self): + """Gets the is_dashboard of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The is_dashboard of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._is_dashboard + + @is_dashboard.setter + def is_dashboard(self, is_dashboard): + """Sets the is_dashboard of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param is_dashboard: The is_dashboard of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._is_dashboard = is_dashboard + + @property + def new_line(self): + """Gets the new_line of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The new_line of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._new_line + + @new_line.setter + def new_line(self, new_line): + """Sets the new_line of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param new_line: The new_line of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._new_line = new_line + + @property + def override_timezone_key(self): + """Gets the override_timezone_key of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The override_timezone_key of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._override_timezone_key + + @override_timezone_key.setter + def override_timezone_key(self, override_timezone_key): + """Sets the override_timezone_key of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param override_timezone_key: The override_timezone_key of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._override_timezone_key = override_timezone_key + + @property + def period_length_filter(self): + """Gets the period_length_filter of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The period_length_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._period_length_filter + + @period_length_filter.setter + def period_length_filter(self, period_length_filter): + """Sets the period_length_filter of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param period_length_filter: The period_length_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._period_length_filter = period_length_filter + + @property + def quote(self): + """Gets the quote of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The quote of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._quote + + @quote.setter + def quote(self, quote): + """Sets the quote of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param quote: The quote of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._quote = quote + + @property + def report_customized_id(self): + """Gets the report_customized_id of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The report_customized_id of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._report_customized_id + + @report_customized_id.setter + def report_customized_id(self, report_customized_id): + """Sets the report_customized_id of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param report_customized_id: The report_customized_id of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._report_customized_id = report_customized_id + + @property + def report_description(self): + """Gets the report_description of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The report_description of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._report_description + + @report_description.setter + def report_description(self, report_description): + """Sets the report_description of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param report_description: The report_description of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._report_description = report_description + + @property + def report_id(self): + """Gets the report_id of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The report_id of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._report_id + + @report_id.setter + def report_id(self, report_id): + """Sets the report_id of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param report_id: The report_id of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._report_id = report_id + + @property + def report_invocation_type(self): + """Gets the report_invocation_type of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The report_invocation_type of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._report_invocation_type + + @report_invocation_type.setter + def report_invocation_type(self, report_invocation_type): + """Sets the report_invocation_type of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param report_invocation_type: The report_invocation_type of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._report_invocation_type = report_invocation_type + + @property + def report_name(self): + """Gets the report_name of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The report_name of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._report_name + + @report_name.setter + def report_name(self, report_name): + """Sets the report_name of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param report_name: The report_name of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._report_name = report_name + + @property + def sent_by_filter(self): + """Gets the sent_by_filter of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The sent_by_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._sent_by_filter + + @sent_by_filter.setter + def sent_by_filter(self, sent_by_filter): + """Sets the sent_by_filter of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param sent_by_filter: The sent_by_filter of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._sent_by_filter = sent_by_filter + + @property + def sent_by_ids(self): + """Gets the sent_by_ids of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The sent_by_ids of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._sent_by_ids + + @sent_by_ids.setter + def sent_by_ids(self, sent_by_ids): + """Sets the sent_by_ids of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param sent_by_ids: The sent_by_ids of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._sent_by_ids = sent_by_ids + + @property + def separator(self): + """Gets the separator of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The separator of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._separator + + @separator.setter + def separator(self, separator): + """Sets the separator of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param separator: The separator of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._separator = separator + + @property + def sort_direction(self): + """Gets the sort_direction of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The sort_direction of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._sort_direction + + @sort_direction.setter + def sort_direction(self, sort_direction): + """Sets the sort_direction of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param sort_direction: The sort_direction of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._sort_direction = sort_direction + + @property + def sort_field(self): + """Gets the sort_field of this ReportInProductCsvRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The sort_field of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._sort_field + + @sort_field.setter + def sort_field(self, sort_field): + """Sets the sort_field of this ReportInProductCsvRunRequest. + + # noqa: E501 + + :param sort_field: The sort_field of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._sort_field = sort_field + + @property + def start_position(self): + """Gets the start_position of this ReportInProductCsvRunRequest. # noqa: E501 + + Starting position of the current result set. # noqa: E501 + + :return: The start_position of this ReportInProductCsvRunRequest. # noqa: E501 + :rtype: str + """ + return self._start_position + + @start_position.setter + def start_position(self, start_position): + """Sets the start_position of this ReportInProductCsvRunRequest. + + Starting position of the current result set. # noqa: E501 + + :param start_position: The start_position of this ReportInProductCsvRunRequest. # noqa: E501 + :type: str + """ + + self._start_position = start_position + + 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(ReportInProductCsvRunRequest, 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, ReportInProductCsvRunRequest): + 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/report_in_product_field.py b/docusign_esign/models/report_in_product_field.py new file mode 100644 index 00000000..12ea1937 --- /dev/null +++ b/docusign_esign/models/report_in_product_field.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 ReportInProductField(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 = { + 'display_order': 'str', + 'field_version': 'str', + 'name': 'str', + 'selected': 'str' + } + + attribute_map = { + 'display_order': 'displayOrder', + 'field_version': 'fieldVersion', + 'name': 'name', + 'selected': 'selected' + } + + def __init__(self, display_order=None, field_version=None, name=None, selected=None): # noqa: E501 + """ReportInProductField - a model defined in Swagger""" # noqa: E501 + + self._display_order = None + self._field_version = None + self._name = None + self._selected = None + self.discriminator = None + + if display_order is not None: + self.display_order = display_order + if field_version is not None: + self.field_version = field_version + if name is not None: + self.name = name + if selected is not None: + self.selected = selected + + @property + def display_order(self): + """Gets the display_order of this ReportInProductField. # noqa: E501 + + # noqa: E501 + + :return: The display_order of this ReportInProductField. # noqa: E501 + :rtype: str + """ + return self._display_order + + @display_order.setter + def display_order(self, display_order): + """Sets the display_order of this ReportInProductField. + + # noqa: E501 + + :param display_order: The display_order of this ReportInProductField. # noqa: E501 + :type: str + """ + + self._display_order = display_order + + @property + def field_version(self): + """Gets the field_version of this ReportInProductField. # noqa: E501 + + # noqa: E501 + + :return: The field_version of this ReportInProductField. # noqa: E501 + :rtype: str + """ + return self._field_version + + @field_version.setter + def field_version(self, field_version): + """Sets the field_version of this ReportInProductField. + + # noqa: E501 + + :param field_version: The field_version of this ReportInProductField. # noqa: E501 + :type: str + """ + + self._field_version = field_version + + @property + def name(self): + """Gets the name of this ReportInProductField. # noqa: E501 + + # noqa: E501 + + :return: The name of this ReportInProductField. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this ReportInProductField. + + # noqa: E501 + + :param name: The name of this ReportInProductField. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def selected(self): + """Gets the selected of this ReportInProductField. # noqa: E501 + + # noqa: E501 + + :return: The selected of this ReportInProductField. # noqa: E501 + :rtype: str + """ + return self._selected + + @selected.setter + def selected(self, selected): + """Sets the selected of this ReportInProductField. + + # noqa: E501 + + :param selected: The selected of this ReportInProductField. # noqa: E501 + :type: str + """ + + self._selected = selected + + 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(ReportInProductField, 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, ReportInProductField): + 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/report_in_product_get.py b/docusign_esign/models/report_in_product_get.py new file mode 100644 index 00000000..4e4e3050 --- /dev/null +++ b/docusign_esign/models/report_in_product_get.py @@ -0,0 +1,899 @@ +# 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 ReportInProductGet(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 = { + 'custom_field_filter': 'str', + 'date_range_custom_from_date': 'str', + 'date_range_custom_to_date': 'str', + 'date_range_filter': 'str', + 'display_order': 'str', + 'envelope_date_type_filter': 'str', + 'envelope_recipient_name_contains_filter': 'str', + 'envelope_status_filter': 'str', + 'envelope_subject_contains_filter': 'str', + 'fields': 'list[ReportInProductField]', + 'last_scheduled_execution_date': 'str', + 'last_scheduled_execution_success_date': 'str', + 'max_download_rows': 'str', + 'max_grid_rows': 'str', + 'max_scheduled_rows': 'str', + 'period_length_filter': 'str', + 'report_customized_id': 'str', + 'report_description': 'str', + 'report_id': 'str', + 'report_name': 'str', + 'report_type': 'str', + 'run_uri': 'str', + 'save_uri': 'str', + 'schedule_id': 'str', + 'sent_by_details': 'ReportInProductSentByDetails', + 'sent_by_filter': 'str', + 'sent_by_ids': 'str', + 'sort_field_direction': 'str', + 'sort_field_name': 'str' + } + + attribute_map = { + 'custom_field_filter': 'customFieldFilter', + 'date_range_custom_from_date': 'dateRangeCustomFromDate', + 'date_range_custom_to_date': 'dateRangeCustomToDate', + 'date_range_filter': 'dateRangeFilter', + 'display_order': 'displayOrder', + 'envelope_date_type_filter': 'envelopeDateTypeFilter', + 'envelope_recipient_name_contains_filter': 'envelopeRecipientNameContainsFilter', + 'envelope_status_filter': 'envelopeStatusFilter', + 'envelope_subject_contains_filter': 'envelopeSubjectContainsFilter', + 'fields': 'fields', + 'last_scheduled_execution_date': 'lastScheduledExecutionDate', + 'last_scheduled_execution_success_date': 'lastScheduledExecutionSuccessDate', + 'max_download_rows': 'maxDownloadRows', + 'max_grid_rows': 'maxGridRows', + 'max_scheduled_rows': 'maxScheduledRows', + 'period_length_filter': 'periodLengthFilter', + 'report_customized_id': 'reportCustomizedId', + 'report_description': 'reportDescription', + 'report_id': 'reportId', + 'report_name': 'reportName', + 'report_type': 'reportType', + 'run_uri': 'runUri', + 'save_uri': 'saveUri', + 'schedule_id': 'scheduleId', + 'sent_by_details': 'sentByDetails', + 'sent_by_filter': 'sentByFilter', + 'sent_by_ids': 'sentByIds', + 'sort_field_direction': 'sortFieldDirection', + 'sort_field_name': 'sortFieldName' + } + + def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, date_range_custom_to_date=None, date_range_filter=None, display_order=None, envelope_date_type_filter=None, envelope_recipient_name_contains_filter=None, envelope_status_filter=None, envelope_subject_contains_filter=None, fields=None, last_scheduled_execution_date=None, last_scheduled_execution_success_date=None, max_download_rows=None, max_grid_rows=None, max_scheduled_rows=None, period_length_filter=None, report_customized_id=None, report_description=None, report_id=None, report_name=None, report_type=None, run_uri=None, save_uri=None, schedule_id=None, sent_by_details=None, sent_by_filter=None, sent_by_ids=None, sort_field_direction=None, sort_field_name=None): # noqa: E501 + """ReportInProductGet - a model defined in Swagger""" # noqa: E501 + + self._custom_field_filter = None + self._date_range_custom_from_date = None + self._date_range_custom_to_date = None + self._date_range_filter = None + self._display_order = None + self._envelope_date_type_filter = None + self._envelope_recipient_name_contains_filter = None + self._envelope_status_filter = None + self._envelope_subject_contains_filter = None + self._fields = None + self._last_scheduled_execution_date = None + self._last_scheduled_execution_success_date = None + self._max_download_rows = None + self._max_grid_rows = None + self._max_scheduled_rows = None + self._period_length_filter = None + self._report_customized_id = None + self._report_description = None + self._report_id = None + self._report_name = None + self._report_type = None + self._run_uri = None + self._save_uri = None + self._schedule_id = None + self._sent_by_details = None + self._sent_by_filter = None + self._sent_by_ids = None + self._sort_field_direction = None + self._sort_field_name = None + self.discriminator = None + + if custom_field_filter is not None: + self.custom_field_filter = custom_field_filter + if date_range_custom_from_date is not None: + self.date_range_custom_from_date = date_range_custom_from_date + if date_range_custom_to_date is not None: + self.date_range_custom_to_date = date_range_custom_to_date + if date_range_filter is not None: + self.date_range_filter = date_range_filter + if display_order is not None: + self.display_order = display_order + if envelope_date_type_filter is not None: + self.envelope_date_type_filter = envelope_date_type_filter + if envelope_recipient_name_contains_filter is not None: + self.envelope_recipient_name_contains_filter = envelope_recipient_name_contains_filter + if envelope_status_filter is not None: + self.envelope_status_filter = envelope_status_filter + if envelope_subject_contains_filter is not None: + self.envelope_subject_contains_filter = envelope_subject_contains_filter + if fields is not None: + self.fields = fields + if last_scheduled_execution_date is not None: + self.last_scheduled_execution_date = last_scheduled_execution_date + if last_scheduled_execution_success_date is not None: + self.last_scheduled_execution_success_date = last_scheduled_execution_success_date + if max_download_rows is not None: + self.max_download_rows = max_download_rows + if max_grid_rows is not None: + self.max_grid_rows = max_grid_rows + if max_scheduled_rows is not None: + self.max_scheduled_rows = max_scheduled_rows + if period_length_filter is not None: + self.period_length_filter = period_length_filter + if report_customized_id is not None: + self.report_customized_id = report_customized_id + if report_description is not None: + self.report_description = report_description + if report_id is not None: + self.report_id = report_id + if report_name is not None: + self.report_name = report_name + if report_type is not None: + self.report_type = report_type + if run_uri is not None: + self.run_uri = run_uri + if save_uri is not None: + self.save_uri = save_uri + if schedule_id is not None: + self.schedule_id = schedule_id + if sent_by_details is not None: + self.sent_by_details = sent_by_details + if sent_by_filter is not None: + self.sent_by_filter = sent_by_filter + if sent_by_ids is not None: + self.sent_by_ids = sent_by_ids + if sort_field_direction is not None: + self.sort_field_direction = sort_field_direction + if sort_field_name is not None: + self.sort_field_name = sort_field_name + + @property + def custom_field_filter(self): + """Gets the custom_field_filter of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The custom_field_filter of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._custom_field_filter + + @custom_field_filter.setter + def custom_field_filter(self, custom_field_filter): + """Sets the custom_field_filter of this ReportInProductGet. + + # noqa: E501 + + :param custom_field_filter: The custom_field_filter of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._custom_field_filter = custom_field_filter + + @property + def date_range_custom_from_date(self): + """Gets the date_range_custom_from_date of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The date_range_custom_from_date of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._date_range_custom_from_date + + @date_range_custom_from_date.setter + def date_range_custom_from_date(self, date_range_custom_from_date): + """Sets the date_range_custom_from_date of this ReportInProductGet. + + # noqa: E501 + + :param date_range_custom_from_date: The date_range_custom_from_date of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._date_range_custom_from_date = date_range_custom_from_date + + @property + def date_range_custom_to_date(self): + """Gets the date_range_custom_to_date of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The date_range_custom_to_date of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._date_range_custom_to_date + + @date_range_custom_to_date.setter + def date_range_custom_to_date(self, date_range_custom_to_date): + """Sets the date_range_custom_to_date of this ReportInProductGet. + + # noqa: E501 + + :param date_range_custom_to_date: The date_range_custom_to_date of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._date_range_custom_to_date = date_range_custom_to_date + + @property + def date_range_filter(self): + """Gets the date_range_filter of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The date_range_filter of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._date_range_filter + + @date_range_filter.setter + def date_range_filter(self, date_range_filter): + """Sets the date_range_filter of this ReportInProductGet. + + # noqa: E501 + + :param date_range_filter: The date_range_filter of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._date_range_filter = date_range_filter + + @property + def display_order(self): + """Gets the display_order of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The display_order of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._display_order + + @display_order.setter + def display_order(self, display_order): + """Sets the display_order of this ReportInProductGet. + + # noqa: E501 + + :param display_order: The display_order of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._display_order = display_order + + @property + def envelope_date_type_filter(self): + """Gets the envelope_date_type_filter of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The envelope_date_type_filter of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._envelope_date_type_filter + + @envelope_date_type_filter.setter + def envelope_date_type_filter(self, envelope_date_type_filter): + """Sets the envelope_date_type_filter of this ReportInProductGet. + + # noqa: E501 + + :param envelope_date_type_filter: The envelope_date_type_filter of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._envelope_date_type_filter = envelope_date_type_filter + + @property + def envelope_recipient_name_contains_filter(self): + """Gets the envelope_recipient_name_contains_filter of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The envelope_recipient_name_contains_filter of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._envelope_recipient_name_contains_filter + + @envelope_recipient_name_contains_filter.setter + def envelope_recipient_name_contains_filter(self, envelope_recipient_name_contains_filter): + """Sets the envelope_recipient_name_contains_filter of this ReportInProductGet. + + # noqa: E501 + + :param envelope_recipient_name_contains_filter: The envelope_recipient_name_contains_filter of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._envelope_recipient_name_contains_filter = envelope_recipient_name_contains_filter + + @property + def envelope_status_filter(self): + """Gets the envelope_status_filter of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The envelope_status_filter of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._envelope_status_filter + + @envelope_status_filter.setter + def envelope_status_filter(self, envelope_status_filter): + """Sets the envelope_status_filter of this ReportInProductGet. + + # noqa: E501 + + :param envelope_status_filter: The envelope_status_filter of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._envelope_status_filter = envelope_status_filter + + @property + def envelope_subject_contains_filter(self): + """Gets the envelope_subject_contains_filter of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The envelope_subject_contains_filter of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._envelope_subject_contains_filter + + @envelope_subject_contains_filter.setter + def envelope_subject_contains_filter(self, envelope_subject_contains_filter): + """Sets the envelope_subject_contains_filter of this ReportInProductGet. + + # noqa: E501 + + :param envelope_subject_contains_filter: The envelope_subject_contains_filter of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._envelope_subject_contains_filter = envelope_subject_contains_filter + + @property + def fields(self): + """Gets the fields of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The fields of this ReportInProductGet. # noqa: E501 + :rtype: list[ReportInProductField] + """ + return self._fields + + @fields.setter + def fields(self, fields): + """Sets the fields of this ReportInProductGet. + + # noqa: E501 + + :param fields: The fields of this ReportInProductGet. # noqa: E501 + :type: list[ReportInProductField] + """ + + self._fields = fields + + @property + def last_scheduled_execution_date(self): + """Gets the last_scheduled_execution_date of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The last_scheduled_execution_date of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._last_scheduled_execution_date + + @last_scheduled_execution_date.setter + def last_scheduled_execution_date(self, last_scheduled_execution_date): + """Sets the last_scheduled_execution_date of this ReportInProductGet. + + # noqa: E501 + + :param last_scheduled_execution_date: The last_scheduled_execution_date of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._last_scheduled_execution_date = last_scheduled_execution_date + + @property + def last_scheduled_execution_success_date(self): + """Gets the last_scheduled_execution_success_date of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The last_scheduled_execution_success_date of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._last_scheduled_execution_success_date + + @last_scheduled_execution_success_date.setter + def last_scheduled_execution_success_date(self, last_scheduled_execution_success_date): + """Sets the last_scheduled_execution_success_date of this ReportInProductGet. + + # noqa: E501 + + :param last_scheduled_execution_success_date: The last_scheduled_execution_success_date of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._last_scheduled_execution_success_date = last_scheduled_execution_success_date + + @property + def max_download_rows(self): + """Gets the max_download_rows of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The max_download_rows of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._max_download_rows + + @max_download_rows.setter + def max_download_rows(self, max_download_rows): + """Sets the max_download_rows of this ReportInProductGet. + + # noqa: E501 + + :param max_download_rows: The max_download_rows of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._max_download_rows = max_download_rows + + @property + def max_grid_rows(self): + """Gets the max_grid_rows of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The max_grid_rows of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._max_grid_rows + + @max_grid_rows.setter + def max_grid_rows(self, max_grid_rows): + """Sets the max_grid_rows of this ReportInProductGet. + + # noqa: E501 + + :param max_grid_rows: The max_grid_rows of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._max_grid_rows = max_grid_rows + + @property + def max_scheduled_rows(self): + """Gets the max_scheduled_rows of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The max_scheduled_rows of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._max_scheduled_rows + + @max_scheduled_rows.setter + def max_scheduled_rows(self, max_scheduled_rows): + """Sets the max_scheduled_rows of this ReportInProductGet. + + # noqa: E501 + + :param max_scheduled_rows: The max_scheduled_rows of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._max_scheduled_rows = max_scheduled_rows + + @property + def period_length_filter(self): + """Gets the period_length_filter of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The period_length_filter of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._period_length_filter + + @period_length_filter.setter + def period_length_filter(self, period_length_filter): + """Sets the period_length_filter of this ReportInProductGet. + + # noqa: E501 + + :param period_length_filter: The period_length_filter of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._period_length_filter = period_length_filter + + @property + def report_customized_id(self): + """Gets the report_customized_id of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The report_customized_id of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._report_customized_id + + @report_customized_id.setter + def report_customized_id(self, report_customized_id): + """Sets the report_customized_id of this ReportInProductGet. + + # noqa: E501 + + :param report_customized_id: The report_customized_id of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._report_customized_id = report_customized_id + + @property + def report_description(self): + """Gets the report_description of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The report_description of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._report_description + + @report_description.setter + def report_description(self, report_description): + """Sets the report_description of this ReportInProductGet. + + # noqa: E501 + + :param report_description: The report_description of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._report_description = report_description + + @property + def report_id(self): + """Gets the report_id of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The report_id of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._report_id + + @report_id.setter + def report_id(self, report_id): + """Sets the report_id of this ReportInProductGet. + + # noqa: E501 + + :param report_id: The report_id of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._report_id = report_id + + @property + def report_name(self): + """Gets the report_name of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The report_name of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._report_name + + @report_name.setter + def report_name(self, report_name): + """Sets the report_name of this ReportInProductGet. + + # noqa: E501 + + :param report_name: The report_name of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._report_name = report_name + + @property + def report_type(self): + """Gets the report_type of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The report_type of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._report_type + + @report_type.setter + def report_type(self, report_type): + """Sets the report_type of this ReportInProductGet. + + # noqa: E501 + + :param report_type: The report_type of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._report_type = report_type + + @property + def run_uri(self): + """Gets the run_uri of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The run_uri of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._run_uri + + @run_uri.setter + def run_uri(self, run_uri): + """Sets the run_uri of this ReportInProductGet. + + # noqa: E501 + + :param run_uri: The run_uri of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._run_uri = run_uri + + @property + def save_uri(self): + """Gets the save_uri of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The save_uri of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._save_uri + + @save_uri.setter + def save_uri(self, save_uri): + """Sets the save_uri of this ReportInProductGet. + + # noqa: E501 + + :param save_uri: The save_uri of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._save_uri = save_uri + + @property + def schedule_id(self): + """Gets the schedule_id of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The schedule_id of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._schedule_id + + @schedule_id.setter + def schedule_id(self, schedule_id): + """Sets the schedule_id of this ReportInProductGet. + + # noqa: E501 + + :param schedule_id: The schedule_id of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._schedule_id = schedule_id + + @property + def sent_by_details(self): + """Gets the sent_by_details of this ReportInProductGet. # noqa: E501 + + + :return: The sent_by_details of this ReportInProductGet. # noqa: E501 + :rtype: ReportInProductSentByDetails + """ + return self._sent_by_details + + @sent_by_details.setter + def sent_by_details(self, sent_by_details): + """Sets the sent_by_details of this ReportInProductGet. + + + :param sent_by_details: The sent_by_details of this ReportInProductGet. # noqa: E501 + :type: ReportInProductSentByDetails + """ + + self._sent_by_details = sent_by_details + + @property + def sent_by_filter(self): + """Gets the sent_by_filter of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The sent_by_filter of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._sent_by_filter + + @sent_by_filter.setter + def sent_by_filter(self, sent_by_filter): + """Sets the sent_by_filter of this ReportInProductGet. + + # noqa: E501 + + :param sent_by_filter: The sent_by_filter of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._sent_by_filter = sent_by_filter + + @property + def sent_by_ids(self): + """Gets the sent_by_ids of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The sent_by_ids of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._sent_by_ids + + @sent_by_ids.setter + def sent_by_ids(self, sent_by_ids): + """Sets the sent_by_ids of this ReportInProductGet. + + # noqa: E501 + + :param sent_by_ids: The sent_by_ids of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._sent_by_ids = sent_by_ids + + @property + def sort_field_direction(self): + """Gets the sort_field_direction of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The sort_field_direction of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._sort_field_direction + + @sort_field_direction.setter + def sort_field_direction(self, sort_field_direction): + """Sets the sort_field_direction of this ReportInProductGet. + + # noqa: E501 + + :param sort_field_direction: The sort_field_direction of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._sort_field_direction = sort_field_direction + + @property + def sort_field_name(self): + """Gets the sort_field_name of this ReportInProductGet. # noqa: E501 + + # noqa: E501 + + :return: The sort_field_name of this ReportInProductGet. # noqa: E501 + :rtype: str + """ + return self._sort_field_name + + @sort_field_name.setter + def sort_field_name(self, sort_field_name): + """Sets the sort_field_name of this ReportInProductGet. + + # noqa: E501 + + :param sort_field_name: The sort_field_name of this ReportInProductGet. # noqa: E501 + :type: str + """ + + self._sort_field_name = sort_field_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(ReportInProductGet, 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, ReportInProductGet): + 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/report_in_product_list.py b/docusign_esign/models/report_in_product_list.py new file mode 100644 index 00000000..ce9e0cfc --- /dev/null +++ b/docusign_esign/models/report_in_product_list.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 ReportInProductList(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 = { + 'reports': 'list[ReportInProductListItem]' + } + + attribute_map = { + 'reports': 'reports' + } + + def __init__(self, reports=None): # noqa: E501 + """ReportInProductList - a model defined in Swagger""" # noqa: E501 + + self._reports = None + self.discriminator = None + + if reports is not None: + self.reports = reports + + @property + def reports(self): + """Gets the reports of this ReportInProductList. # noqa: E501 + + # noqa: E501 + + :return: The reports of this ReportInProductList. # noqa: E501 + :rtype: list[ReportInProductListItem] + """ + return self._reports + + @reports.setter + def reports(self, reports): + """Sets the reports of this ReportInProductList. + + # noqa: E501 + + :param reports: The reports of this ReportInProductList. # noqa: E501 + :type: list[ReportInProductListItem] + """ + + self._reports = reports + + 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(ReportInProductList, 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, ReportInProductList): + 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/report_in_product_list_item.py b/docusign_esign/models/report_in_product_list_item.py new file mode 100644 index 00000000..8d7a8ddf --- /dev/null +++ b/docusign_esign/models/report_in_product_list_item.py @@ -0,0 +1,481 @@ +# 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 ReportInProductListItem(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 = { + 'get_uri': 'str', + 'last_scheduled_execution_date': 'str', + 'last_scheduled_execution_success_date': 'str', + 'report_customized_id': 'str', + 'report_description': 'str', + 'report_id': 'str', + 'report_name': 'str', + 'report_type': 'str', + 'run_uri': 'str', + 'save_uri': 'str', + 'schedule_create_date': 'str', + 'schedule_end_date': 'str', + 'schedule_id': 'str', + 'schedule_renew_duration_days': 'str' + } + + attribute_map = { + 'get_uri': 'getUri', + 'last_scheduled_execution_date': 'lastScheduledExecutionDate', + 'last_scheduled_execution_success_date': 'lastScheduledExecutionSuccessDate', + 'report_customized_id': 'reportCustomizedId', + 'report_description': 'reportDescription', + 'report_id': 'reportId', + 'report_name': 'reportName', + 'report_type': 'reportType', + 'run_uri': 'runUri', + 'save_uri': 'saveUri', + 'schedule_create_date': 'scheduleCreateDate', + 'schedule_end_date': 'scheduleEndDate', + 'schedule_id': 'scheduleId', + 'schedule_renew_duration_days': 'scheduleRenewDurationDays' + } + + def __init__(self, get_uri=None, last_scheduled_execution_date=None, last_scheduled_execution_success_date=None, report_customized_id=None, report_description=None, report_id=None, report_name=None, report_type=None, run_uri=None, save_uri=None, schedule_create_date=None, schedule_end_date=None, schedule_id=None, schedule_renew_duration_days=None): # noqa: E501 + """ReportInProductListItem - a model defined in Swagger""" # noqa: E501 + + self._get_uri = None + self._last_scheduled_execution_date = None + self._last_scheduled_execution_success_date = None + self._report_customized_id = None + self._report_description = None + self._report_id = None + self._report_name = None + self._report_type = None + self._run_uri = None + self._save_uri = None + self._schedule_create_date = None + self._schedule_end_date = None + self._schedule_id = None + self._schedule_renew_duration_days = None + self.discriminator = None + + if get_uri is not None: + self.get_uri = get_uri + if last_scheduled_execution_date is not None: + self.last_scheduled_execution_date = last_scheduled_execution_date + if last_scheduled_execution_success_date is not None: + self.last_scheduled_execution_success_date = last_scheduled_execution_success_date + if report_customized_id is not None: + self.report_customized_id = report_customized_id + if report_description is not None: + self.report_description = report_description + if report_id is not None: + self.report_id = report_id + if report_name is not None: + self.report_name = report_name + if report_type is not None: + self.report_type = report_type + if run_uri is not None: + self.run_uri = run_uri + if save_uri is not None: + self.save_uri = save_uri + if schedule_create_date is not None: + self.schedule_create_date = schedule_create_date + if schedule_end_date is not None: + self.schedule_end_date = schedule_end_date + if schedule_id is not None: + self.schedule_id = schedule_id + if schedule_renew_duration_days is not None: + self.schedule_renew_duration_days = schedule_renew_duration_days + + @property + def get_uri(self): + """Gets the get_uri of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The get_uri of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._get_uri + + @get_uri.setter + def get_uri(self, get_uri): + """Sets the get_uri of this ReportInProductListItem. + + # noqa: E501 + + :param get_uri: The get_uri of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._get_uri = get_uri + + @property + def last_scheduled_execution_date(self): + """Gets the last_scheduled_execution_date of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The last_scheduled_execution_date of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._last_scheduled_execution_date + + @last_scheduled_execution_date.setter + def last_scheduled_execution_date(self, last_scheduled_execution_date): + """Sets the last_scheduled_execution_date of this ReportInProductListItem. + + # noqa: E501 + + :param last_scheduled_execution_date: The last_scheduled_execution_date of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._last_scheduled_execution_date = last_scheduled_execution_date + + @property + def last_scheduled_execution_success_date(self): + """Gets the last_scheduled_execution_success_date of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The last_scheduled_execution_success_date of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._last_scheduled_execution_success_date + + @last_scheduled_execution_success_date.setter + def last_scheduled_execution_success_date(self, last_scheduled_execution_success_date): + """Sets the last_scheduled_execution_success_date of this ReportInProductListItem. + + # noqa: E501 + + :param last_scheduled_execution_success_date: The last_scheduled_execution_success_date of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._last_scheduled_execution_success_date = last_scheduled_execution_success_date + + @property + def report_customized_id(self): + """Gets the report_customized_id of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The report_customized_id of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._report_customized_id + + @report_customized_id.setter + def report_customized_id(self, report_customized_id): + """Sets the report_customized_id of this ReportInProductListItem. + + # noqa: E501 + + :param report_customized_id: The report_customized_id of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._report_customized_id = report_customized_id + + @property + def report_description(self): + """Gets the report_description of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The report_description of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._report_description + + @report_description.setter + def report_description(self, report_description): + """Sets the report_description of this ReportInProductListItem. + + # noqa: E501 + + :param report_description: The report_description of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._report_description = report_description + + @property + def report_id(self): + """Gets the report_id of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The report_id of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._report_id + + @report_id.setter + def report_id(self, report_id): + """Sets the report_id of this ReportInProductListItem. + + # noqa: E501 + + :param report_id: The report_id of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._report_id = report_id + + @property + def report_name(self): + """Gets the report_name of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The report_name of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._report_name + + @report_name.setter + def report_name(self, report_name): + """Sets the report_name of this ReportInProductListItem. + + # noqa: E501 + + :param report_name: The report_name of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._report_name = report_name + + @property + def report_type(self): + """Gets the report_type of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The report_type of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._report_type + + @report_type.setter + def report_type(self, report_type): + """Sets the report_type of this ReportInProductListItem. + + # noqa: E501 + + :param report_type: The report_type of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._report_type = report_type + + @property + def run_uri(self): + """Gets the run_uri of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The run_uri of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._run_uri + + @run_uri.setter + def run_uri(self, run_uri): + """Sets the run_uri of this ReportInProductListItem. + + # noqa: E501 + + :param run_uri: The run_uri of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._run_uri = run_uri + + @property + def save_uri(self): + """Gets the save_uri of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The save_uri of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._save_uri + + @save_uri.setter + def save_uri(self, save_uri): + """Sets the save_uri of this ReportInProductListItem. + + # noqa: E501 + + :param save_uri: The save_uri of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._save_uri = save_uri + + @property + def schedule_create_date(self): + """Gets the schedule_create_date of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The schedule_create_date of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._schedule_create_date + + @schedule_create_date.setter + def schedule_create_date(self, schedule_create_date): + """Sets the schedule_create_date of this ReportInProductListItem. + + # noqa: E501 + + :param schedule_create_date: The schedule_create_date of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._schedule_create_date = schedule_create_date + + @property + def schedule_end_date(self): + """Gets the schedule_end_date of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The schedule_end_date of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._schedule_end_date + + @schedule_end_date.setter + def schedule_end_date(self, schedule_end_date): + """Sets the schedule_end_date of this ReportInProductListItem. + + # noqa: E501 + + :param schedule_end_date: The schedule_end_date of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._schedule_end_date = schedule_end_date + + @property + def schedule_id(self): + """Gets the schedule_id of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The schedule_id of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._schedule_id + + @schedule_id.setter + def schedule_id(self, schedule_id): + """Sets the schedule_id of this ReportInProductListItem. + + # noqa: E501 + + :param schedule_id: The schedule_id of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._schedule_id = schedule_id + + @property + def schedule_renew_duration_days(self): + """Gets the schedule_renew_duration_days of this ReportInProductListItem. # noqa: E501 + + # noqa: E501 + + :return: The schedule_renew_duration_days of this ReportInProductListItem. # noqa: E501 + :rtype: str + """ + return self._schedule_renew_duration_days + + @schedule_renew_duration_days.setter + def schedule_renew_duration_days(self, schedule_renew_duration_days): + """Sets the schedule_renew_duration_days of this ReportInProductListItem. + + # noqa: E501 + + :param schedule_renew_duration_days: The schedule_renew_duration_days of this ReportInProductListItem. # noqa: E501 + :type: str + """ + + self._schedule_renew_duration_days = schedule_renew_duration_days + + 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(ReportInProductListItem, 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, ReportInProductListItem): + 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/report_in_product_run_request.py b/docusign_esign/models/report_in_product_run_request.py new file mode 100644 index 00000000..754bad42 --- /dev/null +++ b/docusign_esign/models/report_in_product_run_request.py @@ -0,0 +1,705 @@ +# 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 ReportInProductRunRequest(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 = { + 'custom_field_filter': 'str', + 'date_range_custom_from_date': 'str', + 'date_range_custom_to_date': 'str', + 'date_range_filter': 'str', + 'envelope_date_type_filter': 'str', + 'envelope_recipient_name_contains_filter': 'str', + 'envelope_status_filter': 'str', + 'envelope_subject_contains_filter': 'str', + 'fields': 'list[ReportInProductField]', + 'for_download': 'str', + 'is_dashboard': 'str', + 'period_length_filter': 'str', + 'report_customized_id': 'str', + 'report_description': 'str', + 'report_id': 'str', + 'report_invocation_type': 'str', + 'report_name': 'str', + 'sent_by_filter': 'str', + 'sent_by_ids': 'str', + 'sort_direction': 'str', + 'sort_field': 'str', + 'start_position': 'str' + } + + attribute_map = { + 'custom_field_filter': 'customFieldFilter', + 'date_range_custom_from_date': 'dateRangeCustomFromDate', + 'date_range_custom_to_date': 'dateRangeCustomToDate', + 'date_range_filter': 'dateRangeFilter', + 'envelope_date_type_filter': 'envelopeDateTypeFilter', + 'envelope_recipient_name_contains_filter': 'envelopeRecipientNameContainsFilter', + 'envelope_status_filter': 'envelopeStatusFilter', + 'envelope_subject_contains_filter': 'envelopeSubjectContainsFilter', + 'fields': 'fields', + 'for_download': 'forDownload', + 'is_dashboard': 'isDashboard', + 'period_length_filter': 'periodLengthFilter', + 'report_customized_id': 'reportCustomizedId', + 'report_description': 'reportDescription', + 'report_id': 'reportId', + 'report_invocation_type': 'reportInvocationType', + 'report_name': 'reportName', + 'sent_by_filter': 'sentByFilter', + 'sent_by_ids': 'sentByIds', + 'sort_direction': 'sortDirection', + 'sort_field': 'sortField', + 'start_position': 'startPosition' + } + + def __init__(self, custom_field_filter=None, date_range_custom_from_date=None, date_range_custom_to_date=None, date_range_filter=None, envelope_date_type_filter=None, envelope_recipient_name_contains_filter=None, envelope_status_filter=None, envelope_subject_contains_filter=None, fields=None, for_download=None, is_dashboard=None, period_length_filter=None, report_customized_id=None, report_description=None, report_id=None, report_invocation_type=None, report_name=None, sent_by_filter=None, sent_by_ids=None, sort_direction=None, sort_field=None, start_position=None): # noqa: E501 + """ReportInProductRunRequest - a model defined in Swagger""" # noqa: E501 + + self._custom_field_filter = None + self._date_range_custom_from_date = None + self._date_range_custom_to_date = None + self._date_range_filter = None + self._envelope_date_type_filter = None + self._envelope_recipient_name_contains_filter = None + self._envelope_status_filter = None + self._envelope_subject_contains_filter = None + self._fields = None + self._for_download = None + self._is_dashboard = None + self._period_length_filter = None + self._report_customized_id = None + self._report_description = None + self._report_id = None + self._report_invocation_type = None + self._report_name = None + self._sent_by_filter = None + self._sent_by_ids = None + self._sort_direction = None + self._sort_field = None + self._start_position = None + self.discriminator = None + + if custom_field_filter is not None: + self.custom_field_filter = custom_field_filter + if date_range_custom_from_date is not None: + self.date_range_custom_from_date = date_range_custom_from_date + if date_range_custom_to_date is not None: + self.date_range_custom_to_date = date_range_custom_to_date + if date_range_filter is not None: + self.date_range_filter = date_range_filter + if envelope_date_type_filter is not None: + self.envelope_date_type_filter = envelope_date_type_filter + if envelope_recipient_name_contains_filter is not None: + self.envelope_recipient_name_contains_filter = envelope_recipient_name_contains_filter + if envelope_status_filter is not None: + self.envelope_status_filter = envelope_status_filter + if envelope_subject_contains_filter is not None: + self.envelope_subject_contains_filter = envelope_subject_contains_filter + if fields is not None: + self.fields = fields + if for_download is not None: + self.for_download = for_download + if is_dashboard is not None: + self.is_dashboard = is_dashboard + if period_length_filter is not None: + self.period_length_filter = period_length_filter + if report_customized_id is not None: + self.report_customized_id = report_customized_id + if report_description is not None: + self.report_description = report_description + if report_id is not None: + self.report_id = report_id + if report_invocation_type is not None: + self.report_invocation_type = report_invocation_type + if report_name is not None: + self.report_name = report_name + if sent_by_filter is not None: + self.sent_by_filter = sent_by_filter + if sent_by_ids is not None: + self.sent_by_ids = sent_by_ids + if sort_direction is not None: + self.sort_direction = sort_direction + if sort_field is not None: + self.sort_field = sort_field + if start_position is not None: + self.start_position = start_position + + @property + def custom_field_filter(self): + """Gets the custom_field_filter of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The custom_field_filter of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._custom_field_filter + + @custom_field_filter.setter + def custom_field_filter(self, custom_field_filter): + """Sets the custom_field_filter of this ReportInProductRunRequest. + + # noqa: E501 + + :param custom_field_filter: The custom_field_filter of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._custom_field_filter = custom_field_filter + + @property + def date_range_custom_from_date(self): + """Gets the date_range_custom_from_date of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The date_range_custom_from_date of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._date_range_custom_from_date + + @date_range_custom_from_date.setter + def date_range_custom_from_date(self, date_range_custom_from_date): + """Sets the date_range_custom_from_date of this ReportInProductRunRequest. + + # noqa: E501 + + :param date_range_custom_from_date: The date_range_custom_from_date of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._date_range_custom_from_date = date_range_custom_from_date + + @property + def date_range_custom_to_date(self): + """Gets the date_range_custom_to_date of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The date_range_custom_to_date of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._date_range_custom_to_date + + @date_range_custom_to_date.setter + def date_range_custom_to_date(self, date_range_custom_to_date): + """Sets the date_range_custom_to_date of this ReportInProductRunRequest. + + # noqa: E501 + + :param date_range_custom_to_date: The date_range_custom_to_date of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._date_range_custom_to_date = date_range_custom_to_date + + @property + def date_range_filter(self): + """Gets the date_range_filter of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The date_range_filter of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._date_range_filter + + @date_range_filter.setter + def date_range_filter(self, date_range_filter): + """Sets the date_range_filter of this ReportInProductRunRequest. + + # noqa: E501 + + :param date_range_filter: The date_range_filter of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._date_range_filter = date_range_filter + + @property + def envelope_date_type_filter(self): + """Gets the envelope_date_type_filter of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The envelope_date_type_filter of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._envelope_date_type_filter + + @envelope_date_type_filter.setter + def envelope_date_type_filter(self, envelope_date_type_filter): + """Sets the envelope_date_type_filter of this ReportInProductRunRequest. + + # noqa: E501 + + :param envelope_date_type_filter: The envelope_date_type_filter of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._envelope_date_type_filter = envelope_date_type_filter + + @property + def envelope_recipient_name_contains_filter(self): + """Gets the envelope_recipient_name_contains_filter of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The envelope_recipient_name_contains_filter of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._envelope_recipient_name_contains_filter + + @envelope_recipient_name_contains_filter.setter + def envelope_recipient_name_contains_filter(self, envelope_recipient_name_contains_filter): + """Sets the envelope_recipient_name_contains_filter of this ReportInProductRunRequest. + + # noqa: E501 + + :param envelope_recipient_name_contains_filter: The envelope_recipient_name_contains_filter of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._envelope_recipient_name_contains_filter = envelope_recipient_name_contains_filter + + @property + def envelope_status_filter(self): + """Gets the envelope_status_filter of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The envelope_status_filter of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._envelope_status_filter + + @envelope_status_filter.setter + def envelope_status_filter(self, envelope_status_filter): + """Sets the envelope_status_filter of this ReportInProductRunRequest. + + # noqa: E501 + + :param envelope_status_filter: The envelope_status_filter of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._envelope_status_filter = envelope_status_filter + + @property + def envelope_subject_contains_filter(self): + """Gets the envelope_subject_contains_filter of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The envelope_subject_contains_filter of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._envelope_subject_contains_filter + + @envelope_subject_contains_filter.setter + def envelope_subject_contains_filter(self, envelope_subject_contains_filter): + """Sets the envelope_subject_contains_filter of this ReportInProductRunRequest. + + # noqa: E501 + + :param envelope_subject_contains_filter: The envelope_subject_contains_filter of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._envelope_subject_contains_filter = envelope_subject_contains_filter + + @property + def fields(self): + """Gets the fields of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The fields of this ReportInProductRunRequest. # noqa: E501 + :rtype: list[ReportInProductField] + """ + return self._fields + + @fields.setter + def fields(self, fields): + """Sets the fields of this ReportInProductRunRequest. + + # noqa: E501 + + :param fields: The fields of this ReportInProductRunRequest. # noqa: E501 + :type: list[ReportInProductField] + """ + + self._fields = fields + + @property + def for_download(self): + """Gets the for_download of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The for_download of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._for_download + + @for_download.setter + def for_download(self, for_download): + """Sets the for_download of this ReportInProductRunRequest. + + # noqa: E501 + + :param for_download: The for_download of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._for_download = for_download + + @property + def is_dashboard(self): + """Gets the is_dashboard of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The is_dashboard of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._is_dashboard + + @is_dashboard.setter + def is_dashboard(self, is_dashboard): + """Sets the is_dashboard of this ReportInProductRunRequest. + + # noqa: E501 + + :param is_dashboard: The is_dashboard of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._is_dashboard = is_dashboard + + @property + def period_length_filter(self): + """Gets the period_length_filter of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The period_length_filter of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._period_length_filter + + @period_length_filter.setter + def period_length_filter(self, period_length_filter): + """Sets the period_length_filter of this ReportInProductRunRequest. + + # noqa: E501 + + :param period_length_filter: The period_length_filter of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._period_length_filter = period_length_filter + + @property + def report_customized_id(self): + """Gets the report_customized_id of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The report_customized_id of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._report_customized_id + + @report_customized_id.setter + def report_customized_id(self, report_customized_id): + """Sets the report_customized_id of this ReportInProductRunRequest. + + # noqa: E501 + + :param report_customized_id: The report_customized_id of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._report_customized_id = report_customized_id + + @property + def report_description(self): + """Gets the report_description of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The report_description of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._report_description + + @report_description.setter + def report_description(self, report_description): + """Sets the report_description of this ReportInProductRunRequest. + + # noqa: E501 + + :param report_description: The report_description of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._report_description = report_description + + @property + def report_id(self): + """Gets the report_id of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The report_id of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._report_id + + @report_id.setter + def report_id(self, report_id): + """Sets the report_id of this ReportInProductRunRequest. + + # noqa: E501 + + :param report_id: The report_id of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._report_id = report_id + + @property + def report_invocation_type(self): + """Gets the report_invocation_type of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The report_invocation_type of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._report_invocation_type + + @report_invocation_type.setter + def report_invocation_type(self, report_invocation_type): + """Sets the report_invocation_type of this ReportInProductRunRequest. + + # noqa: E501 + + :param report_invocation_type: The report_invocation_type of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._report_invocation_type = report_invocation_type + + @property + def report_name(self): + """Gets the report_name of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The report_name of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._report_name + + @report_name.setter + def report_name(self, report_name): + """Sets the report_name of this ReportInProductRunRequest. + + # noqa: E501 + + :param report_name: The report_name of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._report_name = report_name + + @property + def sent_by_filter(self): + """Gets the sent_by_filter of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The sent_by_filter of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._sent_by_filter + + @sent_by_filter.setter + def sent_by_filter(self, sent_by_filter): + """Sets the sent_by_filter of this ReportInProductRunRequest. + + # noqa: E501 + + :param sent_by_filter: The sent_by_filter of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._sent_by_filter = sent_by_filter + + @property + def sent_by_ids(self): + """Gets the sent_by_ids of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The sent_by_ids of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._sent_by_ids + + @sent_by_ids.setter + def sent_by_ids(self, sent_by_ids): + """Sets the sent_by_ids of this ReportInProductRunRequest. + + # noqa: E501 + + :param sent_by_ids: The sent_by_ids of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._sent_by_ids = sent_by_ids + + @property + def sort_direction(self): + """Gets the sort_direction of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The sort_direction of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._sort_direction + + @sort_direction.setter + def sort_direction(self, sort_direction): + """Sets the sort_direction of this ReportInProductRunRequest. + + # noqa: E501 + + :param sort_direction: The sort_direction of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._sort_direction = sort_direction + + @property + def sort_field(self): + """Gets the sort_field of this ReportInProductRunRequest. # noqa: E501 + + # noqa: E501 + + :return: The sort_field of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._sort_field + + @sort_field.setter + def sort_field(self, sort_field): + """Sets the sort_field of this ReportInProductRunRequest. + + # noqa: E501 + + :param sort_field: The sort_field of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._sort_field = sort_field + + @property + def start_position(self): + """Gets the start_position of this ReportInProductRunRequest. # noqa: E501 + + Starting position of the current result set. # noqa: E501 + + :return: The start_position of this ReportInProductRunRequest. # noqa: E501 + :rtype: str + """ + return self._start_position + + @start_position.setter + def start_position(self, start_position): + """Sets the start_position of this ReportInProductRunRequest. + + Starting position of the current result set. # noqa: E501 + + :param start_position: The start_position of this ReportInProductRunRequest. # noqa: E501 + :type: str + """ + + self._start_position = start_position + + 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(ReportInProductRunRequest, 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, ReportInProductRunRequest): + 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/report_in_product_run_response.py b/docusign_esign/models/report_in_product_run_response.py new file mode 100644 index 00000000..08aabaf8 --- /dev/null +++ b/docusign_esign/models/report_in_product_run_response.py @@ -0,0 +1,285 @@ +# 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 ReportInProductRunResponse(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 = { + 'end_position': 'str', + 'exceeded_max_results': 'str', + 'last_warehouse_refresh_date_time': 'str', + 'result_set_size': 'str', + 'rows': 'list[ReportInProductRunResponseRow]', + 'start_position': 'str', + 'total_set_size': 'str' + } + + attribute_map = { + 'end_position': 'endPosition', + 'exceeded_max_results': 'exceededMaxResults', + 'last_warehouse_refresh_date_time': 'lastWarehouseRefreshDateTime', + 'result_set_size': 'resultSetSize', + 'rows': 'rows', + 'start_position': 'startPosition', + 'total_set_size': 'totalSetSize' + } + + def __init__(self, end_position=None, exceeded_max_results=None, last_warehouse_refresh_date_time=None, result_set_size=None, rows=None, start_position=None, total_set_size=None): # noqa: E501 + """ReportInProductRunResponse - a model defined in Swagger""" # noqa: E501 + + self._end_position = None + self._exceeded_max_results = None + self._last_warehouse_refresh_date_time = None + self._result_set_size = None + self._rows = None + self._start_position = None + self._total_set_size = None + self.discriminator = None + + if end_position is not None: + self.end_position = end_position + if exceeded_max_results is not None: + self.exceeded_max_results = exceeded_max_results + if last_warehouse_refresh_date_time is not None: + self.last_warehouse_refresh_date_time = last_warehouse_refresh_date_time + if result_set_size is not None: + self.result_set_size = result_set_size + if rows is not None: + self.rows = rows + if start_position is not None: + self.start_position = start_position + if total_set_size is not None: + self.total_set_size = total_set_size + + @property + def end_position(self): + """Gets the end_position of this ReportInProductRunResponse. # noqa: E501 + + The last position in the result set. # noqa: E501 + + :return: The end_position of this ReportInProductRunResponse. # noqa: E501 + :rtype: str + """ + return self._end_position + + @end_position.setter + def end_position(self, end_position): + """Sets the end_position of this ReportInProductRunResponse. + + The last position in the result set. # noqa: E501 + + :param end_position: The end_position of this ReportInProductRunResponse. # noqa: E501 + :type: str + """ + + self._end_position = end_position + + @property + def exceeded_max_results(self): + """Gets the exceeded_max_results of this ReportInProductRunResponse. # noqa: E501 + + # noqa: E501 + + :return: The exceeded_max_results of this ReportInProductRunResponse. # noqa: E501 + :rtype: str + """ + return self._exceeded_max_results + + @exceeded_max_results.setter + def exceeded_max_results(self, exceeded_max_results): + """Sets the exceeded_max_results of this ReportInProductRunResponse. + + # noqa: E501 + + :param exceeded_max_results: The exceeded_max_results of this ReportInProductRunResponse. # noqa: E501 + :type: str + """ + + self._exceeded_max_results = exceeded_max_results + + @property + def last_warehouse_refresh_date_time(self): + """Gets the last_warehouse_refresh_date_time of this ReportInProductRunResponse. # noqa: E501 + + # noqa: E501 + + :return: The last_warehouse_refresh_date_time of this ReportInProductRunResponse. # noqa: E501 + :rtype: str + """ + return self._last_warehouse_refresh_date_time + + @last_warehouse_refresh_date_time.setter + def last_warehouse_refresh_date_time(self, last_warehouse_refresh_date_time): + """Sets the last_warehouse_refresh_date_time of this ReportInProductRunResponse. + + # noqa: E501 + + :param last_warehouse_refresh_date_time: The last_warehouse_refresh_date_time of this ReportInProductRunResponse. # noqa: E501 + :type: str + """ + + self._last_warehouse_refresh_date_time = last_warehouse_refresh_date_time + + @property + def result_set_size(self): + """Gets the result_set_size of this ReportInProductRunResponse. # noqa: E501 + + The number of results returned in this response. # noqa: E501 + + :return: The result_set_size of this ReportInProductRunResponse. # noqa: E501 + :rtype: str + """ + return self._result_set_size + + @result_set_size.setter + def result_set_size(self, result_set_size): + """Sets the result_set_size of this ReportInProductRunResponse. + + The number of results returned in this response. # noqa: E501 + + :param result_set_size: The result_set_size of this ReportInProductRunResponse. # noqa: E501 + :type: str + """ + + self._result_set_size = result_set_size + + @property + def rows(self): + """Gets the rows of this ReportInProductRunResponse. # noqa: E501 + + # noqa: E501 + + :return: The rows of this ReportInProductRunResponse. # noqa: E501 + :rtype: list[ReportInProductRunResponseRow] + """ + return self._rows + + @rows.setter + def rows(self, rows): + """Sets the rows of this ReportInProductRunResponse. + + # noqa: E501 + + :param rows: The rows of this ReportInProductRunResponse. # noqa: E501 + :type: list[ReportInProductRunResponseRow] + """ + + self._rows = rows + + @property + def start_position(self): + """Gets the start_position of this ReportInProductRunResponse. # noqa: E501 + + Starting position of the current result set. # noqa: E501 + + :return: The start_position of this ReportInProductRunResponse. # noqa: E501 + :rtype: str + """ + return self._start_position + + @start_position.setter + def start_position(self, start_position): + """Sets the start_position of this ReportInProductRunResponse. + + Starting position of the current result set. # noqa: E501 + + :param start_position: The start_position of this ReportInProductRunResponse. # noqa: E501 + :type: str + """ + + self._start_position = start_position + + @property + def total_set_size(self): + """Gets the total_set_size of this ReportInProductRunResponse. # noqa: E501 + + The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. # noqa: E501 + + :return: The total_set_size of this ReportInProductRunResponse. # noqa: E501 + :rtype: str + """ + return self._total_set_size + + @total_set_size.setter + def total_set_size(self, total_set_size): + """Sets the total_set_size of this ReportInProductRunResponse. + + The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. # noqa: E501 + + :param total_set_size: The total_set_size of this ReportInProductRunResponse. # noqa: E501 + :type: str + """ + + self._total_set_size = total_set_size + + 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(ReportInProductRunResponse, 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, ReportInProductRunResponse): + 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/report_in_product_run_response_row.py b/docusign_esign/models/report_in_product_run_response_row.py new file mode 100644 index 00000000..5156f9cb --- /dev/null +++ b/docusign_esign/models/report_in_product_run_response_row.py @@ -0,0 +1,143 @@ +# 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 ReportInProductRunResponseRow(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 = { + 'envelope_id': 'str', + 'fields': 'ReportInProductRunResponseRowFields' + } + + attribute_map = { + 'envelope_id': 'envelopeId', + 'fields': 'fields' + } + + def __init__(self, envelope_id=None, fields=None): # noqa: E501 + """ReportInProductRunResponseRow - a model defined in Swagger""" # noqa: E501 + + self._envelope_id = None + self._fields = None + self.discriminator = None + + if envelope_id is not None: + self.envelope_id = envelope_id + if fields is not None: + self.fields = fields + + @property + def envelope_id(self): + """Gets the envelope_id of this ReportInProductRunResponseRow. # noqa: E501 + + The envelope ID of the envelope status that failed to post. # noqa: E501 + + :return: The envelope_id of this ReportInProductRunResponseRow. # noqa: E501 + :rtype: str + """ + return self._envelope_id + + @envelope_id.setter + def envelope_id(self, envelope_id): + """Sets the envelope_id of this ReportInProductRunResponseRow. + + The envelope ID of the envelope status that failed to post. # noqa: E501 + + :param envelope_id: The envelope_id of this ReportInProductRunResponseRow. # noqa: E501 + :type: str + """ + + self._envelope_id = envelope_id + + @property + def fields(self): + """Gets the fields of this ReportInProductRunResponseRow. # noqa: E501 + + + :return: The fields of this ReportInProductRunResponseRow. # noqa: E501 + :rtype: ReportInProductRunResponseRowFields + """ + return self._fields + + @fields.setter + def fields(self, fields): + """Sets the fields of this ReportInProductRunResponseRow. + + + :param fields: The fields of this ReportInProductRunResponseRow. # noqa: E501 + :type: ReportInProductRunResponseRowFields + """ + + self._fields = fields + + 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(ReportInProductRunResponseRow, 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, ReportInProductRunResponseRow): + 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/report_in_product_run_response_row_fields.py b/docusign_esign/models/report_in_product_run_response_row_fields.py new file mode 100644 index 00000000..95cb4c74 --- /dev/null +++ b/docusign_esign/models/report_in_product_run_response_row_fields.py @@ -0,0 +1,3505 @@ +# 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 ReportInProductRunResponseRowFields(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 = { + 'access_code_required': 'str', + 'access_codes_attempted': 'str', + 'access_codes_failed': 'str', + 'account_id': 'str', + 'authentication_category': 'str', + 'authentication_success': 'str', + 'authentication_type': 'str', + 'average_time_to_complete_seconds': 'str', + 'avg_complete_seconds': 'str', + 'completed': 'str', + 'completed_ts': 'str', + 'created_date': 'str', + 'custom_field': 'str', + 'declined_date': 'str', + 'declined_reason': 'str', + 'delivered_date': 'str', + 'envelope_count': 'str', + 'envelope_creator': 'str', + 'envelope_id': 'str', + 'envelope_initial_send_ts': 'str', + 'envelopes_billed': 'str', + 'envelopes_completed': 'str', + 'envelopes_completed_count': 'str', + 'envelopes_declined': 'str', + 'envelopes_sent': 'str', + 'envelopes_sent_count': 'str', + 'envelopes_voided': 'str', + 'envelope_voided_reason': 'str', + 'eod_document_description': 'str', + 'eod_document_name': 'str', + 'eod_document_profile_id': 'str', + 'eod_transaction_id': 'str', + 'eod_transaction_name': 'str', + 'event_date': 'str', + 'expiration_date': 'str', + 'expired_ts': 'str', + 'failures': 'str', + 'failure_vendor_code': 'str', + 'failure_vendor_reason': 'str', + 'first_send_ts': 'str', + 'group_id': 'str', + 'group_name': 'str', + 'hours_to_complete_end': 'str', + 'hours_to_complete_start': 'str', + 'id_checks_attempted': 'str', + 'id_checks_failed': 'str', + 'initial_send_ts': 'str', + 'ip_address': 'str', + 'last_activity': 'str', + 'last_activity_date': 'str', + 'last_sent_date': 'str', + 'not_signed': 'str', + 'number_of_authenticated_recipients': 'str', + 'number_of_completed_signatures': 'str', + 'number_of_documents': 'str', + 'number_of_pages': 'str', + 'number_of_recipients': 'str', + 'number_of_sends': 'str', + 'number_of_signers': 'str', + 'number_of_total_documents': 'str', + 'number_of_total_pages': 'str', + 'number_of_total_signers': 'str', + 'number_of_unique_senders': 'str', + 'number_total_recipients': 'str', + 'period_end': 'str', + 'period_start': 'str', + 'phone_calls_attempted': 'str', + 'phone_calls_failed': 'str', + 'reason_for_declining': 'str', + 'reason_for_voiding': 'str', + 'reassign_reason': 'str', + 'received': 'str', + 'recipient': 'str', + 'recipient_action': 'str', + 'recipient_company_name': 'str', + 'recipient_country': 'str', + 'recipient_email': 'str', + 'recipient_id': 'str', + 'recipient_name': 'str', + 'recipient_template_role_name': 'str', + 'recipient_title': 'str', + 'recipient_type': 'str', + 'recipient_user_id': 'str', + 'remaining_signatures': 'str', + 'routing_order': 'str', + 'sender_account_id': 'str', + 'sender_company_name': 'str', + 'sender_country': 'str', + 'sender_email': 'str', + 'sender_ip_address': 'str', + 'sender_job_title': 'str', + 'sender_name': 'str', + 'sender_user_id': 'str', + 'sign_date': 'str', + 'signed': 'str', + 'signed_date': 'str', + 'signed_on_mobile': 'str', + 'signed_on_paper': 'str', + 'signer_list': 'str', + 'status': 'str', + 'status_changed_date': 'str', + 'status_changed_ts': 'str', + 'subject': 'str', + 'successes': 'str', + 'templates_created': 'str', + 'templates_created_count': 'str', + 'terminal_status_date': 'str', + 'time_to_complete_seconds': 'str', + 'time_to_deliver': 'str', + 'total_documents': 'str', + 'total_envelopes': 'str', + 'total_pages': 'str', + 'total_recipients': 'str', + 'total_signers': 'str', + 'unique_senders': 'str', + 'user_account_email': 'str', + 'user_account_name': 'str', + 'user_account_status': 'str', + 'user_count': 'str', + 'user_id': 'str', + 'view_date': 'str', + 'voided_ts': 'str' + } + + attribute_map = { + 'access_code_required': 'accessCodeRequired', + 'access_codes_attempted': 'accessCodesAttempted', + 'access_codes_failed': 'accessCodesFailed', + 'account_id': 'accountId', + 'authentication_category': 'authenticationCategory', + 'authentication_success': 'authenticationSuccess', + 'authentication_type': 'authenticationType', + 'average_time_to_complete_seconds': 'averageTimeToCompleteSeconds', + 'avg_complete_seconds': 'avgCompleteSeconds', + 'completed': 'completed', + 'completed_ts': 'completedTs', + 'created_date': 'createdDate', + 'custom_field': 'customField', + 'declined_date': 'declinedDate', + 'declined_reason': 'declinedReason', + 'delivered_date': 'deliveredDate', + 'envelope_count': 'envelopeCount', + 'envelope_creator': 'envelopeCreator', + 'envelope_id': 'envelopeId', + 'envelope_initial_send_ts': 'envelopeInitialSendTs', + 'envelopes_billed': 'envelopesBilled', + 'envelopes_completed': 'envelopesCompleted', + 'envelopes_completed_count': 'envelopesCompletedCount', + 'envelopes_declined': 'envelopesDeclined', + 'envelopes_sent': 'envelopesSent', + 'envelopes_sent_count': 'envelopesSentCount', + 'envelopes_voided': 'envelopesVoided', + 'envelope_voided_reason': 'envelopeVoidedReason', + 'eod_document_description': 'eodDocumentDescription', + 'eod_document_name': 'eodDocumentName', + 'eod_document_profile_id': 'eodDocumentProfileId', + 'eod_transaction_id': 'eodTransactionId', + 'eod_transaction_name': 'eodTransactionName', + 'event_date': 'eventDate', + 'expiration_date': 'expirationDate', + 'expired_ts': 'expiredTs', + 'failures': 'failures', + 'failure_vendor_code': 'failureVendorCode', + 'failure_vendor_reason': 'failureVendorReason', + 'first_send_ts': 'firstSendTs', + 'group_id': 'groupId', + 'group_name': 'groupName', + 'hours_to_complete_end': 'hoursToCompleteEnd', + 'hours_to_complete_start': 'hoursToCompleteStart', + 'id_checks_attempted': 'idChecksAttempted', + 'id_checks_failed': 'idChecksFailed', + 'initial_send_ts': 'initialSendTs', + 'ip_address': 'ipAddress', + 'last_activity': 'lastActivity', + 'last_activity_date': 'lastActivityDate', + 'last_sent_date': 'lastSentDate', + 'not_signed': 'notSigned', + 'number_of_authenticated_recipients': 'numberOfAuthenticatedRecipients', + 'number_of_completed_signatures': 'numberOfCompletedSignatures', + 'number_of_documents': 'numberOfDocuments', + 'number_of_pages': 'numberOfPages', + 'number_of_recipients': 'numberOfRecipients', + 'number_of_sends': 'numberOfSends', + 'number_of_signers': 'numberOfSigners', + 'number_of_total_documents': 'numberOfTotalDocuments', + 'number_of_total_pages': 'numberOfTotalPages', + 'number_of_total_signers': 'numberOfTotalSigners', + 'number_of_unique_senders': 'numberOfUniqueSenders', + 'number_total_recipients': 'numberTotalRecipients', + 'period_end': 'periodEnd', + 'period_start': 'periodStart', + 'phone_calls_attempted': 'phoneCallsAttempted', + 'phone_calls_failed': 'phoneCallsFailed', + 'reason_for_declining': 'reasonForDeclining', + 'reason_for_voiding': 'reasonForVoiding', + 'reassign_reason': 'reassignReason', + 'received': 'received', + 'recipient': 'recipient', + 'recipient_action': 'recipientAction', + 'recipient_company_name': 'recipientCompanyName', + 'recipient_country': 'recipientCountry', + 'recipient_email': 'recipientEmail', + 'recipient_id': 'recipientId', + 'recipient_name': 'recipientName', + 'recipient_template_role_name': 'recipientTemplateRoleName', + 'recipient_title': 'recipientTitle', + 'recipient_type': 'recipientType', + 'recipient_user_id': 'recipientUserId', + 'remaining_signatures': 'remainingSignatures', + 'routing_order': 'routingOrder', + 'sender_account_id': 'senderAccountId', + 'sender_company_name': 'senderCompanyName', + 'sender_country': 'senderCountry', + 'sender_email': 'senderEmail', + 'sender_ip_address': 'senderIPAddress', + 'sender_job_title': 'senderJobTitle', + 'sender_name': 'senderName', + 'sender_user_id': 'senderUserId', + 'sign_date': 'signDate', + 'signed': 'signed', + 'signed_date': 'signedDate', + 'signed_on_mobile': 'signedOnMobile', + 'signed_on_paper': 'signedOnPaper', + 'signer_list': 'signerList', + 'status': 'status', + 'status_changed_date': 'statusChangedDate', + 'status_changed_ts': 'statusChangedTs', + 'subject': 'subject', + 'successes': 'successes', + 'templates_created': 'templatesCreated', + 'templates_created_count': 'templatesCreatedCount', + 'terminal_status_date': 'terminalStatusDate', + 'time_to_complete_seconds': 'timeToCompleteSeconds', + 'time_to_deliver': 'timeToDeliver', + 'total_documents': 'totalDocuments', + 'total_envelopes': 'totalEnvelopes', + 'total_pages': 'totalPages', + 'total_recipients': 'totalRecipients', + 'total_signers': 'totalSigners', + 'unique_senders': 'uniqueSenders', + 'user_account_email': 'userAccountEmail', + 'user_account_name': 'userAccountName', + 'user_account_status': 'userAccountStatus', + 'user_count': 'userCount', + 'user_id': 'userId', + 'view_date': 'viewDate', + 'voided_ts': 'voidedTs' + } + + def __init__(self, access_code_required=None, access_codes_attempted=None, access_codes_failed=None, account_id=None, authentication_category=None, authentication_success=None, authentication_type=None, average_time_to_complete_seconds=None, avg_complete_seconds=None, completed=None, completed_ts=None, created_date=None, custom_field=None, declined_date=None, declined_reason=None, delivered_date=None, envelope_count=None, envelope_creator=None, envelope_id=None, envelope_initial_send_ts=None, envelopes_billed=None, envelopes_completed=None, envelopes_completed_count=None, envelopes_declined=None, envelopes_sent=None, envelopes_sent_count=None, envelopes_voided=None, envelope_voided_reason=None, eod_document_description=None, eod_document_name=None, eod_document_profile_id=None, eod_transaction_id=None, eod_transaction_name=None, event_date=None, expiration_date=None, expired_ts=None, failures=None, failure_vendor_code=None, failure_vendor_reason=None, first_send_ts=None, group_id=None, group_name=None, hours_to_complete_end=None, hours_to_complete_start=None, id_checks_attempted=None, id_checks_failed=None, initial_send_ts=None, ip_address=None, last_activity=None, last_activity_date=None, last_sent_date=None, not_signed=None, number_of_authenticated_recipients=None, number_of_completed_signatures=None, number_of_documents=None, number_of_pages=None, number_of_recipients=None, number_of_sends=None, number_of_signers=None, number_of_total_documents=None, number_of_total_pages=None, number_of_total_signers=None, number_of_unique_senders=None, number_total_recipients=None, period_end=None, period_start=None, phone_calls_attempted=None, phone_calls_failed=None, reason_for_declining=None, reason_for_voiding=None, reassign_reason=None, received=None, recipient=None, recipient_action=None, recipient_company_name=None, recipient_country=None, recipient_email=None, recipient_id=None, recipient_name=None, recipient_template_role_name=None, recipient_title=None, recipient_type=None, recipient_user_id=None, remaining_signatures=None, routing_order=None, sender_account_id=None, sender_company_name=None, sender_country=None, sender_email=None, sender_ip_address=None, sender_job_title=None, sender_name=None, sender_user_id=None, sign_date=None, signed=None, signed_date=None, signed_on_mobile=None, signed_on_paper=None, signer_list=None, status=None, status_changed_date=None, status_changed_ts=None, subject=None, successes=None, templates_created=None, templates_created_count=None, terminal_status_date=None, time_to_complete_seconds=None, time_to_deliver=None, total_documents=None, total_envelopes=None, total_pages=None, total_recipients=None, total_signers=None, unique_senders=None, user_account_email=None, user_account_name=None, user_account_status=None, user_count=None, user_id=None, view_date=None, voided_ts=None): # noqa: E501 + """ReportInProductRunResponseRowFields - a model defined in Swagger""" # noqa: E501 + + self._access_code_required = None + self._access_codes_attempted = None + self._access_codes_failed = None + self._account_id = None + self._authentication_category = None + self._authentication_success = None + self._authentication_type = None + self._average_time_to_complete_seconds = None + self._avg_complete_seconds = None + self._completed = None + self._completed_ts = None + self._created_date = None + self._custom_field = None + self._declined_date = None + self._declined_reason = None + self._delivered_date = None + self._envelope_count = None + self._envelope_creator = None + self._envelope_id = None + self._envelope_initial_send_ts = None + self._envelopes_billed = None + self._envelopes_completed = None + self._envelopes_completed_count = None + self._envelopes_declined = None + self._envelopes_sent = None + self._envelopes_sent_count = None + self._envelopes_voided = None + self._envelope_voided_reason = None + self._eod_document_description = None + self._eod_document_name = None + self._eod_document_profile_id = None + self._eod_transaction_id = None + self._eod_transaction_name = None + self._event_date = None + self._expiration_date = None + self._expired_ts = None + self._failures = None + self._failure_vendor_code = None + self._failure_vendor_reason = None + self._first_send_ts = None + self._group_id = None + self._group_name = None + self._hours_to_complete_end = None + self._hours_to_complete_start = None + self._id_checks_attempted = None + self._id_checks_failed = None + self._initial_send_ts = None + self._ip_address = None + self._last_activity = None + self._last_activity_date = None + self._last_sent_date = None + self._not_signed = None + self._number_of_authenticated_recipients = None + self._number_of_completed_signatures = None + self._number_of_documents = None + self._number_of_pages = None + self._number_of_recipients = None + self._number_of_sends = None + self._number_of_signers = None + self._number_of_total_documents = None + self._number_of_total_pages = None + self._number_of_total_signers = None + self._number_of_unique_senders = None + self._number_total_recipients = None + self._period_end = None + self._period_start = None + self._phone_calls_attempted = None + self._phone_calls_failed = None + self._reason_for_declining = None + self._reason_for_voiding = None + self._reassign_reason = None + self._received = None + self._recipient = None + self._recipient_action = None + self._recipient_company_name = None + self._recipient_country = None + self._recipient_email = None + self._recipient_id = None + self._recipient_name = None + self._recipient_template_role_name = None + self._recipient_title = None + self._recipient_type = None + self._recipient_user_id = None + self._remaining_signatures = None + self._routing_order = None + self._sender_account_id = None + self._sender_company_name = None + self._sender_country = None + self._sender_email = None + self._sender_ip_address = None + self._sender_job_title = None + self._sender_name = None + self._sender_user_id = None + self._sign_date = None + self._signed = None + self._signed_date = None + self._signed_on_mobile = None + self._signed_on_paper = None + self._signer_list = None + self._status = None + self._status_changed_date = None + self._status_changed_ts = None + self._subject = None + self._successes = None + self._templates_created = None + self._templates_created_count = None + self._terminal_status_date = None + self._time_to_complete_seconds = None + self._time_to_deliver = None + self._total_documents = None + self._total_envelopes = None + self._total_pages = None + self._total_recipients = None + self._total_signers = None + self._unique_senders = None + self._user_account_email = None + self._user_account_name = None + self._user_account_status = None + self._user_count = None + self._user_id = None + self._view_date = None + self._voided_ts = None + self.discriminator = None + + if access_code_required is not None: + self.access_code_required = access_code_required + if access_codes_attempted is not None: + self.access_codes_attempted = access_codes_attempted + if access_codes_failed is not None: + self.access_codes_failed = access_codes_failed + if account_id is not None: + self.account_id = account_id + if authentication_category is not None: + self.authentication_category = authentication_category + if authentication_success is not None: + self.authentication_success = authentication_success + if authentication_type is not None: + self.authentication_type = authentication_type + if average_time_to_complete_seconds is not None: + self.average_time_to_complete_seconds = average_time_to_complete_seconds + if avg_complete_seconds is not None: + self.avg_complete_seconds = avg_complete_seconds + if completed is not None: + self.completed = completed + if completed_ts is not None: + self.completed_ts = completed_ts + if created_date is not None: + self.created_date = created_date + if custom_field is not None: + self.custom_field = custom_field + if declined_date is not None: + self.declined_date = declined_date + if declined_reason is not None: + self.declined_reason = declined_reason + if delivered_date is not None: + self.delivered_date = delivered_date + if envelope_count is not None: + self.envelope_count = envelope_count + if envelope_creator is not None: + self.envelope_creator = envelope_creator + if envelope_id is not None: + self.envelope_id = envelope_id + if envelope_initial_send_ts is not None: + self.envelope_initial_send_ts = envelope_initial_send_ts + if envelopes_billed is not None: + self.envelopes_billed = envelopes_billed + if envelopes_completed is not None: + self.envelopes_completed = envelopes_completed + if envelopes_completed_count is not None: + self.envelopes_completed_count = envelopes_completed_count + if envelopes_declined is not None: + self.envelopes_declined = envelopes_declined + if envelopes_sent is not None: + self.envelopes_sent = envelopes_sent + if envelopes_sent_count is not None: + self.envelopes_sent_count = envelopes_sent_count + if envelopes_voided is not None: + self.envelopes_voided = envelopes_voided + if envelope_voided_reason is not None: + self.envelope_voided_reason = envelope_voided_reason + if eod_document_description is not None: + self.eod_document_description = eod_document_description + if eod_document_name is not None: + self.eod_document_name = eod_document_name + if eod_document_profile_id is not None: + self.eod_document_profile_id = eod_document_profile_id + if eod_transaction_id is not None: + self.eod_transaction_id = eod_transaction_id + if eod_transaction_name is not None: + self.eod_transaction_name = eod_transaction_name + if event_date is not None: + self.event_date = event_date + if expiration_date is not None: + self.expiration_date = expiration_date + if expired_ts is not None: + self.expired_ts = expired_ts + if failures is not None: + self.failures = failures + if failure_vendor_code is not None: + self.failure_vendor_code = failure_vendor_code + if failure_vendor_reason is not None: + self.failure_vendor_reason = failure_vendor_reason + if first_send_ts is not None: + self.first_send_ts = first_send_ts + if group_id is not None: + self.group_id = group_id + if group_name is not None: + self.group_name = group_name + if hours_to_complete_end is not None: + self.hours_to_complete_end = hours_to_complete_end + if hours_to_complete_start is not None: + self.hours_to_complete_start = hours_to_complete_start + if id_checks_attempted is not None: + self.id_checks_attempted = id_checks_attempted + if id_checks_failed is not None: + self.id_checks_failed = id_checks_failed + if initial_send_ts is not None: + self.initial_send_ts = initial_send_ts + if ip_address is not None: + self.ip_address = ip_address + if last_activity is not None: + self.last_activity = last_activity + if last_activity_date is not None: + self.last_activity_date = last_activity_date + if last_sent_date is not None: + self.last_sent_date = last_sent_date + if not_signed is not None: + self.not_signed = not_signed + if number_of_authenticated_recipients is not None: + self.number_of_authenticated_recipients = number_of_authenticated_recipients + if number_of_completed_signatures is not None: + self.number_of_completed_signatures = number_of_completed_signatures + if number_of_documents is not None: + self.number_of_documents = number_of_documents + if number_of_pages is not None: + self.number_of_pages = number_of_pages + if number_of_recipients is not None: + self.number_of_recipients = number_of_recipients + if number_of_sends is not None: + self.number_of_sends = number_of_sends + if number_of_signers is not None: + self.number_of_signers = number_of_signers + if number_of_total_documents is not None: + self.number_of_total_documents = number_of_total_documents + if number_of_total_pages is not None: + self.number_of_total_pages = number_of_total_pages + if number_of_total_signers is not None: + self.number_of_total_signers = number_of_total_signers + if number_of_unique_senders is not None: + self.number_of_unique_senders = number_of_unique_senders + if number_total_recipients is not None: + self.number_total_recipients = number_total_recipients + if period_end is not None: + self.period_end = period_end + if period_start is not None: + self.period_start = period_start + if phone_calls_attempted is not None: + self.phone_calls_attempted = phone_calls_attempted + if phone_calls_failed is not None: + self.phone_calls_failed = phone_calls_failed + if reason_for_declining is not None: + self.reason_for_declining = reason_for_declining + if reason_for_voiding is not None: + self.reason_for_voiding = reason_for_voiding + if reassign_reason is not None: + self.reassign_reason = reassign_reason + if received is not None: + self.received = received + if recipient is not None: + self.recipient = recipient + if recipient_action is not None: + self.recipient_action = recipient_action + if recipient_company_name is not None: + self.recipient_company_name = recipient_company_name + if recipient_country is not None: + self.recipient_country = recipient_country + if recipient_email is not None: + self.recipient_email = recipient_email + if recipient_id is not None: + self.recipient_id = recipient_id + if recipient_name is not None: + self.recipient_name = recipient_name + if recipient_template_role_name is not None: + self.recipient_template_role_name = recipient_template_role_name + if recipient_title is not None: + self.recipient_title = recipient_title + if recipient_type is not None: + self.recipient_type = recipient_type + if recipient_user_id is not None: + self.recipient_user_id = recipient_user_id + if remaining_signatures is not None: + self.remaining_signatures = remaining_signatures + if routing_order is not None: + self.routing_order = routing_order + if sender_account_id is not None: + self.sender_account_id = sender_account_id + if sender_company_name is not None: + self.sender_company_name = sender_company_name + if sender_country is not None: + self.sender_country = sender_country + if sender_email is not None: + self.sender_email = sender_email + if sender_ip_address is not None: + self.sender_ip_address = sender_ip_address + if sender_job_title is not None: + self.sender_job_title = sender_job_title + if sender_name is not None: + self.sender_name = sender_name + if sender_user_id is not None: + self.sender_user_id = sender_user_id + if sign_date is not None: + self.sign_date = sign_date + if signed is not None: + self.signed = signed + if signed_date is not None: + self.signed_date = signed_date + if signed_on_mobile is not None: + self.signed_on_mobile = signed_on_mobile + if signed_on_paper is not None: + self.signed_on_paper = signed_on_paper + if signer_list is not None: + self.signer_list = signer_list + if status is not None: + self.status = status + if status_changed_date is not None: + self.status_changed_date = status_changed_date + if status_changed_ts is not None: + self.status_changed_ts = status_changed_ts + if subject is not None: + self.subject = subject + if successes is not None: + self.successes = successes + if templates_created is not None: + self.templates_created = templates_created + if templates_created_count is not None: + self.templates_created_count = templates_created_count + if terminal_status_date is not None: + self.terminal_status_date = terminal_status_date + if time_to_complete_seconds is not None: + self.time_to_complete_seconds = time_to_complete_seconds + if time_to_deliver is not None: + self.time_to_deliver = time_to_deliver + if total_documents is not None: + self.total_documents = total_documents + if total_envelopes is not None: + self.total_envelopes = total_envelopes + if total_pages is not None: + self.total_pages = total_pages + if total_recipients is not None: + self.total_recipients = total_recipients + if total_signers is not None: + self.total_signers = total_signers + if unique_senders is not None: + self.unique_senders = unique_senders + if user_account_email is not None: + self.user_account_email = user_account_email + if user_account_name is not None: + self.user_account_name = user_account_name + if user_account_status is not None: + self.user_account_status = user_account_status + if user_count is not None: + self.user_count = user_count + if user_id is not None: + self.user_id = user_id + if view_date is not None: + self.view_date = view_date + if voided_ts is not None: + self.voided_ts = voided_ts + + @property + def access_code_required(self): + """Gets the access_code_required of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The access_code_required of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._access_code_required + + @access_code_required.setter + def access_code_required(self, access_code_required): + """Sets the access_code_required of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param access_code_required: The access_code_required of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._access_code_required = access_code_required + + @property + def access_codes_attempted(self): + """Gets the access_codes_attempted of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The access_codes_attempted of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._access_codes_attempted + + @access_codes_attempted.setter + def access_codes_attempted(self, access_codes_attempted): + """Sets the access_codes_attempted of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param access_codes_attempted: The access_codes_attempted of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._access_codes_attempted = access_codes_attempted + + @property + def access_codes_failed(self): + """Gets the access_codes_failed of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The access_codes_failed of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._access_codes_failed + + @access_codes_failed.setter + def access_codes_failed(self, access_codes_failed): + """Sets the access_codes_failed of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param access_codes_failed: The access_codes_failed of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._access_codes_failed = access_codes_failed + + @property + def account_id(self): + """Gets the account_id of this ReportInProductRunResponseRowFields. # noqa: E501 + + The account ID associated with the envelope. # noqa: E501 + + :return: The account_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this ReportInProductRunResponseRowFields. + + The account ID associated with the envelope. # noqa: E501 + + :param account_id: The account_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def authentication_category(self): + """Gets the authentication_category of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The authentication_category of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._authentication_category + + @authentication_category.setter + def authentication_category(self, authentication_category): + """Sets the authentication_category of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param authentication_category: The authentication_category of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._authentication_category = authentication_category + + @property + def authentication_success(self): + """Gets the authentication_success of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The authentication_success of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._authentication_success + + @authentication_success.setter + def authentication_success(self, authentication_success): + """Sets the authentication_success of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param authentication_success: The authentication_success of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._authentication_success = authentication_success + + @property + def authentication_type(self): + """Gets the authentication_type of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The authentication_type of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._authentication_type + + @authentication_type.setter + def authentication_type(self, authentication_type): + """Sets the authentication_type of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param authentication_type: The authentication_type of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._authentication_type = authentication_type + + @property + def average_time_to_complete_seconds(self): + """Gets the average_time_to_complete_seconds of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The average_time_to_complete_seconds of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._average_time_to_complete_seconds + + @average_time_to_complete_seconds.setter + def average_time_to_complete_seconds(self, average_time_to_complete_seconds): + """Sets the average_time_to_complete_seconds of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param average_time_to_complete_seconds: The average_time_to_complete_seconds of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._average_time_to_complete_seconds = average_time_to_complete_seconds + + @property + def avg_complete_seconds(self): + """Gets the avg_complete_seconds of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The avg_complete_seconds of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._avg_complete_seconds + + @avg_complete_seconds.setter + def avg_complete_seconds(self, avg_complete_seconds): + """Sets the avg_complete_seconds of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param avg_complete_seconds: The avg_complete_seconds of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._avg_complete_seconds = avg_complete_seconds + + @property + def completed(self): + """Gets the completed of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The completed of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._completed + + @completed.setter + def completed(self, completed): + """Sets the completed of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param completed: The completed of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._completed = completed + + @property + def completed_ts(self): + """Gets the completed_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The completed_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._completed_ts + + @completed_ts.setter + def completed_ts(self, completed_ts): + """Sets the completed_ts of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param completed_ts: The completed_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._completed_ts = completed_ts + + @property + def created_date(self): + """Gets the created_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The created_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._created_date + + @created_date.setter + def created_date(self, created_date): + """Sets the created_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param created_date: The created_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._created_date = created_date + + @property + def custom_field(self): + """Gets the custom_field of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The custom_field of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._custom_field + + @custom_field.setter + def custom_field(self, custom_field): + """Sets the custom_field of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param custom_field: The custom_field of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._custom_field = custom_field + + @property + def declined_date(self): + """Gets the declined_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The declined_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._declined_date + + @declined_date.setter + def declined_date(self, declined_date): + """Sets the declined_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param declined_date: The declined_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._declined_date = declined_date + + @property + def declined_reason(self): + """Gets the declined_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + + The reason the recipient declined the document. # noqa: E501 + + :return: The declined_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._declined_reason + + @declined_reason.setter + def declined_reason(self, declined_reason): + """Sets the declined_reason of this ReportInProductRunResponseRowFields. + + The reason the recipient declined the document. # noqa: E501 + + :param declined_reason: The declined_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._declined_reason = declined_reason + + @property + def delivered_date(self): + """Gets the delivered_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The delivered_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._delivered_date + + @delivered_date.setter + def delivered_date(self, delivered_date): + """Sets the delivered_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param delivered_date: The delivered_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._delivered_date = delivered_date + + @property + def envelope_count(self): + """Gets the envelope_count of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The envelope_count of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelope_count + + @envelope_count.setter + def envelope_count(self, envelope_count): + """Sets the envelope_count of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param envelope_count: The envelope_count of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelope_count = envelope_count + + @property + def envelope_creator(self): + """Gets the envelope_creator of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The envelope_creator of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelope_creator + + @envelope_creator.setter + def envelope_creator(self, envelope_creator): + """Sets the envelope_creator of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param envelope_creator: The envelope_creator of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelope_creator = envelope_creator + + @property + def envelope_id(self): + """Gets the envelope_id of this ReportInProductRunResponseRowFields. # noqa: E501 + + The envelope ID of the envelope status that failed to post. # noqa: E501 + + :return: The envelope_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelope_id + + @envelope_id.setter + def envelope_id(self, envelope_id): + """Sets the envelope_id of this ReportInProductRunResponseRowFields. + + The envelope ID of the envelope status that failed to post. # noqa: E501 + + :param envelope_id: The envelope_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelope_id = envelope_id + + @property + def envelope_initial_send_ts(self): + """Gets the envelope_initial_send_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The envelope_initial_send_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelope_initial_send_ts + + @envelope_initial_send_ts.setter + def envelope_initial_send_ts(self, envelope_initial_send_ts): + """Sets the envelope_initial_send_ts of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param envelope_initial_send_ts: The envelope_initial_send_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelope_initial_send_ts = envelope_initial_send_ts + + @property + def envelopes_billed(self): + """Gets the envelopes_billed of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The envelopes_billed of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelopes_billed + + @envelopes_billed.setter + def envelopes_billed(self, envelopes_billed): + """Sets the envelopes_billed of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param envelopes_billed: The envelopes_billed of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelopes_billed = envelopes_billed + + @property + def envelopes_completed(self): + """Gets the envelopes_completed of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The envelopes_completed of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelopes_completed + + @envelopes_completed.setter + def envelopes_completed(self, envelopes_completed): + """Sets the envelopes_completed of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param envelopes_completed: The envelopes_completed of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelopes_completed = envelopes_completed + + @property + def envelopes_completed_count(self): + """Gets the envelopes_completed_count of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The envelopes_completed_count of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelopes_completed_count + + @envelopes_completed_count.setter + def envelopes_completed_count(self, envelopes_completed_count): + """Sets the envelopes_completed_count of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param envelopes_completed_count: The envelopes_completed_count of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelopes_completed_count = envelopes_completed_count + + @property + def envelopes_declined(self): + """Gets the envelopes_declined of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The envelopes_declined of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelopes_declined + + @envelopes_declined.setter + def envelopes_declined(self, envelopes_declined): + """Sets the envelopes_declined of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param envelopes_declined: The envelopes_declined of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelopes_declined = envelopes_declined + + @property + def envelopes_sent(self): + """Gets the envelopes_sent of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The envelopes_sent of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelopes_sent + + @envelopes_sent.setter + def envelopes_sent(self, envelopes_sent): + """Sets the envelopes_sent of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param envelopes_sent: The envelopes_sent of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelopes_sent = envelopes_sent + + @property + def envelopes_sent_count(self): + """Gets the envelopes_sent_count of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The envelopes_sent_count of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelopes_sent_count + + @envelopes_sent_count.setter + def envelopes_sent_count(self, envelopes_sent_count): + """Sets the envelopes_sent_count of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param envelopes_sent_count: The envelopes_sent_count of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelopes_sent_count = envelopes_sent_count + + @property + def envelopes_voided(self): + """Gets the envelopes_voided of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The envelopes_voided of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelopes_voided + + @envelopes_voided.setter + def envelopes_voided(self, envelopes_voided): + """Sets the envelopes_voided of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param envelopes_voided: The envelopes_voided of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelopes_voided = envelopes_voided + + @property + def envelope_voided_reason(self): + """Gets the envelope_voided_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The envelope_voided_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._envelope_voided_reason + + @envelope_voided_reason.setter + def envelope_voided_reason(self, envelope_voided_reason): + """Sets the envelope_voided_reason of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param envelope_voided_reason: The envelope_voided_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._envelope_voided_reason = envelope_voided_reason + + @property + def eod_document_description(self): + """Gets the eod_document_description of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The eod_document_description of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._eod_document_description + + @eod_document_description.setter + def eod_document_description(self, eod_document_description): + """Sets the eod_document_description of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param eod_document_description: The eod_document_description of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._eod_document_description = eod_document_description + + @property + def eod_document_name(self): + """Gets the eod_document_name of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The eod_document_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._eod_document_name + + @eod_document_name.setter + def eod_document_name(self, eod_document_name): + """Sets the eod_document_name of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param eod_document_name: The eod_document_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._eod_document_name = eod_document_name + + @property + def eod_document_profile_id(self): + """Gets the eod_document_profile_id of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The eod_document_profile_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._eod_document_profile_id + + @eod_document_profile_id.setter + def eod_document_profile_id(self, eod_document_profile_id): + """Sets the eod_document_profile_id of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param eod_document_profile_id: The eod_document_profile_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._eod_document_profile_id = eod_document_profile_id + + @property + def eod_transaction_id(self): + """Gets the eod_transaction_id of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The eod_transaction_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._eod_transaction_id + + @eod_transaction_id.setter + def eod_transaction_id(self, eod_transaction_id): + """Sets the eod_transaction_id of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param eod_transaction_id: The eod_transaction_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._eod_transaction_id = eod_transaction_id + + @property + def eod_transaction_name(self): + """Gets the eod_transaction_name of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The eod_transaction_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._eod_transaction_name + + @eod_transaction_name.setter + def eod_transaction_name(self, eod_transaction_name): + """Sets the eod_transaction_name of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param eod_transaction_name: The eod_transaction_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._eod_transaction_name = eod_transaction_name + + @property + def event_date(self): + """Gets the event_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The event_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._event_date + + @event_date.setter + def event_date(self, event_date): + """Sets the event_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param event_date: The event_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._event_date = event_date + + @property + def expiration_date(self): + """Gets the expiration_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The expiration_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._expiration_date + + @expiration_date.setter + def expiration_date(self, expiration_date): + """Sets the expiration_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param expiration_date: The expiration_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._expiration_date = expiration_date + + @property + def expired_ts(self): + """Gets the expired_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The expired_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._expired_ts + + @expired_ts.setter + def expired_ts(self, expired_ts): + """Sets the expired_ts of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param expired_ts: The expired_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._expired_ts = expired_ts + + @property + def failures(self): + """Gets the failures of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The failures of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._failures + + @failures.setter + def failures(self, failures): + """Sets the failures of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param failures: The failures of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._failures = failures + + @property + def failure_vendor_code(self): + """Gets the failure_vendor_code of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The failure_vendor_code of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._failure_vendor_code + + @failure_vendor_code.setter + def failure_vendor_code(self, failure_vendor_code): + """Sets the failure_vendor_code of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param failure_vendor_code: The failure_vendor_code of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._failure_vendor_code = failure_vendor_code + + @property + def failure_vendor_reason(self): + """Gets the failure_vendor_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The failure_vendor_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._failure_vendor_reason + + @failure_vendor_reason.setter + def failure_vendor_reason(self, failure_vendor_reason): + """Sets the failure_vendor_reason of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param failure_vendor_reason: The failure_vendor_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._failure_vendor_reason = failure_vendor_reason + + @property + def first_send_ts(self): + """Gets the first_send_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The first_send_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._first_send_ts + + @first_send_ts.setter + def first_send_ts(self, first_send_ts): + """Sets the first_send_ts of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param first_send_ts: The first_send_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._first_send_ts = first_send_ts + + @property + def group_id(self): + """Gets the group_id of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The group_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """Sets the group_id of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param group_id: The group_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._group_id = group_id + + @property + def group_name(self): + """Gets the group_name of this ReportInProductRunResponseRowFields. # noqa: E501 + + The name of the group. # noqa: E501 + + :return: The group_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._group_name + + @group_name.setter + def group_name(self, group_name): + """Sets the group_name of this ReportInProductRunResponseRowFields. + + The name of the group. # noqa: E501 + + :param group_name: The group_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._group_name = group_name + + @property + def hours_to_complete_end(self): + """Gets the hours_to_complete_end of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The hours_to_complete_end of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._hours_to_complete_end + + @hours_to_complete_end.setter + def hours_to_complete_end(self, hours_to_complete_end): + """Sets the hours_to_complete_end of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param hours_to_complete_end: The hours_to_complete_end of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._hours_to_complete_end = hours_to_complete_end + + @property + def hours_to_complete_start(self): + """Gets the hours_to_complete_start of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The hours_to_complete_start of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._hours_to_complete_start + + @hours_to_complete_start.setter + def hours_to_complete_start(self, hours_to_complete_start): + """Sets the hours_to_complete_start of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param hours_to_complete_start: The hours_to_complete_start of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._hours_to_complete_start = hours_to_complete_start + + @property + def id_checks_attempted(self): + """Gets the id_checks_attempted of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The id_checks_attempted of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._id_checks_attempted + + @id_checks_attempted.setter + def id_checks_attempted(self, id_checks_attempted): + """Sets the id_checks_attempted of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param id_checks_attempted: The id_checks_attempted of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._id_checks_attempted = id_checks_attempted + + @property + def id_checks_failed(self): + """Gets the id_checks_failed of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The id_checks_failed of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._id_checks_failed + + @id_checks_failed.setter + def id_checks_failed(self, id_checks_failed): + """Sets the id_checks_failed of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param id_checks_failed: The id_checks_failed of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._id_checks_failed = id_checks_failed + + @property + def initial_send_ts(self): + """Gets the initial_send_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The initial_send_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._initial_send_ts + + @initial_send_ts.setter + def initial_send_ts(self, initial_send_ts): + """Sets the initial_send_ts of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param initial_send_ts: The initial_send_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._initial_send_ts = initial_send_ts + + @property + def ip_address(self): + """Gets the ip_address of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The ip_address of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._ip_address + + @ip_address.setter + def ip_address(self, ip_address): + """Sets the ip_address of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param ip_address: The ip_address of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._ip_address = ip_address + + @property + def last_activity(self): + """Gets the last_activity of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The last_activity of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._last_activity + + @last_activity.setter + def last_activity(self, last_activity): + """Sets the last_activity of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param last_activity: The last_activity of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._last_activity = last_activity + + @property + def last_activity_date(self): + """Gets the last_activity_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The last_activity_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._last_activity_date + + @last_activity_date.setter + def last_activity_date(self, last_activity_date): + """Sets the last_activity_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param last_activity_date: The last_activity_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._last_activity_date = last_activity_date + + @property + def last_sent_date(self): + """Gets the last_sent_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The last_sent_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._last_sent_date + + @last_sent_date.setter + def last_sent_date(self, last_sent_date): + """Sets the last_sent_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param last_sent_date: The last_sent_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._last_sent_date = last_sent_date + + @property + def not_signed(self): + """Gets the not_signed of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The not_signed of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._not_signed + + @not_signed.setter + def not_signed(self, not_signed): + """Sets the not_signed of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param not_signed: The not_signed of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._not_signed = not_signed + + @property + def number_of_authenticated_recipients(self): + """Gets the number_of_authenticated_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_of_authenticated_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_of_authenticated_recipients + + @number_of_authenticated_recipients.setter + def number_of_authenticated_recipients(self, number_of_authenticated_recipients): + """Sets the number_of_authenticated_recipients of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_of_authenticated_recipients: The number_of_authenticated_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_of_authenticated_recipients = number_of_authenticated_recipients + + @property + def number_of_completed_signatures(self): + """Gets the number_of_completed_signatures of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_of_completed_signatures of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_of_completed_signatures + + @number_of_completed_signatures.setter + def number_of_completed_signatures(self, number_of_completed_signatures): + """Sets the number_of_completed_signatures of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_of_completed_signatures: The number_of_completed_signatures of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_of_completed_signatures = number_of_completed_signatures + + @property + def number_of_documents(self): + """Gets the number_of_documents of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_of_documents of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_of_documents + + @number_of_documents.setter + def number_of_documents(self, number_of_documents): + """Sets the number_of_documents of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_of_documents: The number_of_documents of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_of_documents = number_of_documents + + @property + def number_of_pages(self): + """Gets the number_of_pages of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_of_pages of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_of_pages + + @number_of_pages.setter + def number_of_pages(self, number_of_pages): + """Sets the number_of_pages of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_of_pages: The number_of_pages of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_of_pages = number_of_pages + + @property + def number_of_recipients(self): + """Gets the number_of_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_of_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_of_recipients + + @number_of_recipients.setter + def number_of_recipients(self, number_of_recipients): + """Sets the number_of_recipients of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_of_recipients: The number_of_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_of_recipients = number_of_recipients + + @property + def number_of_sends(self): + """Gets the number_of_sends of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_of_sends of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_of_sends + + @number_of_sends.setter + def number_of_sends(self, number_of_sends): + """Sets the number_of_sends of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_of_sends: The number_of_sends of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_of_sends = number_of_sends + + @property + def number_of_signers(self): + """Gets the number_of_signers of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_of_signers of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_of_signers + + @number_of_signers.setter + def number_of_signers(self, number_of_signers): + """Sets the number_of_signers of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_of_signers: The number_of_signers of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_of_signers = number_of_signers + + @property + def number_of_total_documents(self): + """Gets the number_of_total_documents of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_of_total_documents of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_of_total_documents + + @number_of_total_documents.setter + def number_of_total_documents(self, number_of_total_documents): + """Sets the number_of_total_documents of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_of_total_documents: The number_of_total_documents of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_of_total_documents = number_of_total_documents + + @property + def number_of_total_pages(self): + """Gets the number_of_total_pages of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_of_total_pages of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_of_total_pages + + @number_of_total_pages.setter + def number_of_total_pages(self, number_of_total_pages): + """Sets the number_of_total_pages of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_of_total_pages: The number_of_total_pages of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_of_total_pages = number_of_total_pages + + @property + def number_of_total_signers(self): + """Gets the number_of_total_signers of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_of_total_signers of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_of_total_signers + + @number_of_total_signers.setter + def number_of_total_signers(self, number_of_total_signers): + """Sets the number_of_total_signers of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_of_total_signers: The number_of_total_signers of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_of_total_signers = number_of_total_signers + + @property + def number_of_unique_senders(self): + """Gets the number_of_unique_senders of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_of_unique_senders of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_of_unique_senders + + @number_of_unique_senders.setter + def number_of_unique_senders(self, number_of_unique_senders): + """Sets the number_of_unique_senders of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_of_unique_senders: The number_of_unique_senders of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_of_unique_senders = number_of_unique_senders + + @property + def number_total_recipients(self): + """Gets the number_total_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The number_total_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._number_total_recipients + + @number_total_recipients.setter + def number_total_recipients(self, number_total_recipients): + """Sets the number_total_recipients of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param number_total_recipients: The number_total_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._number_total_recipients = number_total_recipients + + @property + def period_end(self): + """Gets the period_end of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The period_end of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._period_end + + @period_end.setter + def period_end(self, period_end): + """Sets the period_end of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param period_end: The period_end of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._period_end = period_end + + @property + def period_start(self): + """Gets the period_start of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The period_start of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._period_start + + @period_start.setter + def period_start(self, period_start): + """Sets the period_start of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param period_start: The period_start of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._period_start = period_start + + @property + def phone_calls_attempted(self): + """Gets the phone_calls_attempted of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The phone_calls_attempted of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._phone_calls_attempted + + @phone_calls_attempted.setter + def phone_calls_attempted(self, phone_calls_attempted): + """Sets the phone_calls_attempted of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param phone_calls_attempted: The phone_calls_attempted of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._phone_calls_attempted = phone_calls_attempted + + @property + def phone_calls_failed(self): + """Gets the phone_calls_failed of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The phone_calls_failed of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._phone_calls_failed + + @phone_calls_failed.setter + def phone_calls_failed(self, phone_calls_failed): + """Sets the phone_calls_failed of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param phone_calls_failed: The phone_calls_failed of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._phone_calls_failed = phone_calls_failed + + @property + def reason_for_declining(self): + """Gets the reason_for_declining of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The reason_for_declining of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._reason_for_declining + + @reason_for_declining.setter + def reason_for_declining(self, reason_for_declining): + """Sets the reason_for_declining of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param reason_for_declining: The reason_for_declining of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._reason_for_declining = reason_for_declining + + @property + def reason_for_voiding(self): + """Gets the reason_for_voiding of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The reason_for_voiding of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._reason_for_voiding + + @reason_for_voiding.setter + def reason_for_voiding(self, reason_for_voiding): + """Sets the reason_for_voiding of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param reason_for_voiding: The reason_for_voiding of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._reason_for_voiding = reason_for_voiding + + @property + def reassign_reason(self): + """Gets the reassign_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The reassign_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._reassign_reason + + @reassign_reason.setter + def reassign_reason(self, reassign_reason): + """Sets the reassign_reason of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param reassign_reason: The reassign_reason of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._reassign_reason = reassign_reason + + @property + def received(self): + """Gets the received of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The received of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._received + + @received.setter + def received(self, received): + """Sets the received of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param received: The received of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._received = received + + @property + def recipient(self): + """Gets the recipient of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The recipient of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._recipient + + @recipient.setter + def recipient(self, recipient): + """Sets the recipient of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param recipient: The recipient of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._recipient = recipient + + @property + def recipient_action(self): + """Gets the recipient_action of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The recipient_action of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._recipient_action + + @recipient_action.setter + def recipient_action(self, recipient_action): + """Sets the recipient_action of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param recipient_action: The recipient_action of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._recipient_action = recipient_action + + @property + def recipient_company_name(self): + """Gets the recipient_company_name of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The recipient_company_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._recipient_company_name + + @recipient_company_name.setter + def recipient_company_name(self, recipient_company_name): + """Sets the recipient_company_name of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param recipient_company_name: The recipient_company_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._recipient_company_name = recipient_company_name + + @property + def recipient_country(self): + """Gets the recipient_country of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The recipient_country of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._recipient_country + + @recipient_country.setter + def recipient_country(self, recipient_country): + """Sets the recipient_country of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param recipient_country: The recipient_country of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._recipient_country = recipient_country + + @property + def recipient_email(self): + """Gets the recipient_email of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The recipient_email of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._recipient_email + + @recipient_email.setter + def recipient_email(self, recipient_email): + """Sets the recipient_email of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param recipient_email: The recipient_email of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._recipient_email = recipient_email + + @property + def recipient_id(self): + """Gets the recipient_id of this ReportInProductRunResponseRowFields. # noqa: E501 + + Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 + + :return: The recipient_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._recipient_id + + @recipient_id.setter + def recipient_id(self, recipient_id): + """Sets the recipient_id of this ReportInProductRunResponseRowFields. + + Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 + + :param recipient_id: The recipient_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._recipient_id = recipient_id + + @property + def recipient_name(self): + """Gets the recipient_name of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The recipient_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._recipient_name + + @recipient_name.setter + def recipient_name(self, recipient_name): + """Sets the recipient_name of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param recipient_name: The recipient_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._recipient_name = recipient_name + + @property + def recipient_template_role_name(self): + """Gets the recipient_template_role_name of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The recipient_template_role_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._recipient_template_role_name + + @recipient_template_role_name.setter + def recipient_template_role_name(self, recipient_template_role_name): + """Sets the recipient_template_role_name of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param recipient_template_role_name: The recipient_template_role_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._recipient_template_role_name = recipient_template_role_name + + @property + def recipient_title(self): + """Gets the recipient_title of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The recipient_title of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._recipient_title + + @recipient_title.setter + def recipient_title(self, recipient_title): + """Sets the recipient_title of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param recipient_title: The recipient_title of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._recipient_title = recipient_title + + @property + def recipient_type(self): + """Gets the recipient_type of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The recipient_type of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._recipient_type + + @recipient_type.setter + def recipient_type(self, recipient_type): + """Sets the recipient_type of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param recipient_type: The recipient_type of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._recipient_type = recipient_type + + @property + def recipient_user_id(self): + """Gets the recipient_user_id of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The recipient_user_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._recipient_user_id + + @recipient_user_id.setter + def recipient_user_id(self, recipient_user_id): + """Sets the recipient_user_id of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param recipient_user_id: The recipient_user_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._recipient_user_id = recipient_user_id + + @property + def remaining_signatures(self): + """Gets the remaining_signatures of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The remaining_signatures of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._remaining_signatures + + @remaining_signatures.setter + def remaining_signatures(self, remaining_signatures): + """Sets the remaining_signatures of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param remaining_signatures: The remaining_signatures of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._remaining_signatures = remaining_signatures + + @property + def routing_order(self): + """Gets the routing_order of this ReportInProductRunResponseRowFields. # noqa: E501 + + Specifies the routing order of the recipient in the envelope. # noqa: E501 + + :return: The routing_order of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._routing_order + + @routing_order.setter + def routing_order(self, routing_order): + """Sets the routing_order of this ReportInProductRunResponseRowFields. + + Specifies the routing order of the recipient in the envelope. # noqa: E501 + + :param routing_order: The routing_order of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._routing_order = routing_order + + @property + def sender_account_id(self): + """Gets the sender_account_id of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The sender_account_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._sender_account_id + + @sender_account_id.setter + def sender_account_id(self, sender_account_id): + """Sets the sender_account_id of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param sender_account_id: The sender_account_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._sender_account_id = sender_account_id + + @property + def sender_company_name(self): + """Gets the sender_company_name of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The sender_company_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._sender_company_name + + @sender_company_name.setter + def sender_company_name(self, sender_company_name): + """Sets the sender_company_name of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param sender_company_name: The sender_company_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._sender_company_name = sender_company_name + + @property + def sender_country(self): + """Gets the sender_country of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The sender_country of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._sender_country + + @sender_country.setter + def sender_country(self, sender_country): + """Sets the sender_country of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param sender_country: The sender_country of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._sender_country = sender_country + + @property + def sender_email(self): + """Gets the sender_email of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The sender_email of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._sender_email + + @sender_email.setter + def sender_email(self, sender_email): + """Sets the sender_email of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param sender_email: The sender_email of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._sender_email = sender_email + + @property + def sender_ip_address(self): + """Gets the sender_ip_address of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The sender_ip_address of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._sender_ip_address + + @sender_ip_address.setter + def sender_ip_address(self, sender_ip_address): + """Sets the sender_ip_address of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param sender_ip_address: The sender_ip_address of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._sender_ip_address = sender_ip_address + + @property + def sender_job_title(self): + """Gets the sender_job_title of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The sender_job_title of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._sender_job_title + + @sender_job_title.setter + def sender_job_title(self, sender_job_title): + """Sets the sender_job_title of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param sender_job_title: The sender_job_title of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._sender_job_title = sender_job_title + + @property + def sender_name(self): + """Gets the sender_name of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The sender_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._sender_name + + @sender_name.setter + def sender_name(self, sender_name): + """Sets the sender_name of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param sender_name: The sender_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._sender_name = sender_name + + @property + def sender_user_id(self): + """Gets the sender_user_id of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The sender_user_id of this ReportInProductRunResponseRowFields. # 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 ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param sender_user_id: The sender_user_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._sender_user_id = sender_user_id + + @property + def sign_date(self): + """Gets the sign_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The sign_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._sign_date + + @sign_date.setter + def sign_date(self, sign_date): + """Sets the sign_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param sign_date: The sign_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._sign_date = sign_date + + @property + def signed(self): + """Gets the signed of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The signed of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._signed + + @signed.setter + def signed(self, signed): + """Sets the signed of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param signed: The signed of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._signed = signed + + @property + def signed_date(self): + """Gets the signed_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The signed_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._signed_date + + @signed_date.setter + def signed_date(self, signed_date): + """Sets the signed_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param signed_date: The signed_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._signed_date = signed_date + + @property + def signed_on_mobile(self): + """Gets the signed_on_mobile of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The signed_on_mobile of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._signed_on_mobile + + @signed_on_mobile.setter + def signed_on_mobile(self, signed_on_mobile): + """Sets the signed_on_mobile of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param signed_on_mobile: The signed_on_mobile of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._signed_on_mobile = signed_on_mobile + + @property + def signed_on_paper(self): + """Gets the signed_on_paper of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The signed_on_paper of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._signed_on_paper + + @signed_on_paper.setter + def signed_on_paper(self, signed_on_paper): + """Sets the signed_on_paper of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param signed_on_paper: The signed_on_paper of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._signed_on_paper = signed_on_paper + + @property + def signer_list(self): + """Gets the signer_list of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The signer_list of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._signer_list + + @signer_list.setter + def signer_list(self, signer_list): + """Sets the signer_list of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param signer_list: The signer_list of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._signer_list = signer_list + + @property + def status(self): + """Gets the status of this ReportInProductRunResponseRowFields. # 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 ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this ReportInProductRunResponseRowFields. + + 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 ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def status_changed_date(self): + """Gets the status_changed_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The status_changed_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._status_changed_date + + @status_changed_date.setter + def status_changed_date(self, status_changed_date): + """Sets the status_changed_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param status_changed_date: The status_changed_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._status_changed_date = status_changed_date + + @property + def status_changed_ts(self): + """Gets the status_changed_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The status_changed_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._status_changed_ts + + @status_changed_ts.setter + def status_changed_ts(self, status_changed_ts): + """Sets the status_changed_ts of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param status_changed_ts: The status_changed_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._status_changed_ts = status_changed_ts + + @property + def subject(self): + """Gets the subject of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The subject of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """Sets the subject of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param subject: The subject of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._subject = subject + + @property + def successes(self): + """Gets the successes of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The successes of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._successes + + @successes.setter + def successes(self, successes): + """Sets the successes of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param successes: The successes of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._successes = successes + + @property + def templates_created(self): + """Gets the templates_created of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The templates_created of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._templates_created + + @templates_created.setter + def templates_created(self, templates_created): + """Sets the templates_created of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param templates_created: The templates_created of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._templates_created = templates_created + + @property + def templates_created_count(self): + """Gets the templates_created_count of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The templates_created_count of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._templates_created_count + + @templates_created_count.setter + def templates_created_count(self, templates_created_count): + """Sets the templates_created_count of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param templates_created_count: The templates_created_count of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._templates_created_count = templates_created_count + + @property + def terminal_status_date(self): + """Gets the terminal_status_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The terminal_status_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._terminal_status_date + + @terminal_status_date.setter + def terminal_status_date(self, terminal_status_date): + """Sets the terminal_status_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param terminal_status_date: The terminal_status_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._terminal_status_date = terminal_status_date + + @property + def time_to_complete_seconds(self): + """Gets the time_to_complete_seconds of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The time_to_complete_seconds of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._time_to_complete_seconds + + @time_to_complete_seconds.setter + def time_to_complete_seconds(self, time_to_complete_seconds): + """Sets the time_to_complete_seconds of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param time_to_complete_seconds: The time_to_complete_seconds of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._time_to_complete_seconds = time_to_complete_seconds + + @property + def time_to_deliver(self): + """Gets the time_to_deliver of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The time_to_deliver of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._time_to_deliver + + @time_to_deliver.setter + def time_to_deliver(self, time_to_deliver): + """Sets the time_to_deliver of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param time_to_deliver: The time_to_deliver of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._time_to_deliver = time_to_deliver + + @property + def total_documents(self): + """Gets the total_documents of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The total_documents of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._total_documents + + @total_documents.setter + def total_documents(self, total_documents): + """Sets the total_documents of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param total_documents: The total_documents of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._total_documents = total_documents + + @property + def total_envelopes(self): + """Gets the total_envelopes of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The total_envelopes of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._total_envelopes + + @total_envelopes.setter + def total_envelopes(self, total_envelopes): + """Sets the total_envelopes of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param total_envelopes: The total_envelopes of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._total_envelopes = total_envelopes + + @property + def total_pages(self): + """Gets the total_pages of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The total_pages of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._total_pages + + @total_pages.setter + def total_pages(self, total_pages): + """Sets the total_pages of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param total_pages: The total_pages of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._total_pages = total_pages + + @property + def total_recipients(self): + """Gets the total_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The total_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._total_recipients + + @total_recipients.setter + def total_recipients(self, total_recipients): + """Sets the total_recipients of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param total_recipients: The total_recipients of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._total_recipients = total_recipients + + @property + def total_signers(self): + """Gets the total_signers of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The total_signers of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._total_signers + + @total_signers.setter + def total_signers(self, total_signers): + """Sets the total_signers of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param total_signers: The total_signers of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._total_signers = total_signers + + @property + def unique_senders(self): + """Gets the unique_senders of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The unique_senders of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._unique_senders + + @unique_senders.setter + def unique_senders(self, unique_senders): + """Sets the unique_senders of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param unique_senders: The unique_senders of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._unique_senders = unique_senders + + @property + def user_account_email(self): + """Gets the user_account_email of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The user_account_email of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._user_account_email + + @user_account_email.setter + def user_account_email(self, user_account_email): + """Sets the user_account_email of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param user_account_email: The user_account_email of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._user_account_email = user_account_email + + @property + def user_account_name(self): + """Gets the user_account_name of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The user_account_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._user_account_name + + @user_account_name.setter + def user_account_name(self, user_account_name): + """Sets the user_account_name of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param user_account_name: The user_account_name of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._user_account_name = user_account_name + + @property + def user_account_status(self): + """Gets the user_account_status of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The user_account_status of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._user_account_status + + @user_account_status.setter + def user_account_status(self, user_account_status): + """Sets the user_account_status of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param user_account_status: The user_account_status of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._user_account_status = user_account_status + + @property + def user_count(self): + """Gets the user_count of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The user_count of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._user_count + + @user_count.setter + def user_count(self, user_count): + """Sets the user_count of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param user_count: The user_count of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._user_count = user_count + + @property + def user_id(self): + """Gets the user_id of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The user_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._user_id + + @user_id.setter + def user_id(self, user_id): + """Sets the user_id of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param user_id: The user_id of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._user_id = user_id + + @property + def view_date(self): + """Gets the view_date of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The view_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._view_date + + @view_date.setter + def view_date(self, view_date): + """Sets the view_date of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param view_date: The view_date of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._view_date = view_date + + @property + def voided_ts(self): + """Gets the voided_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + + # noqa: E501 + + :return: The voided_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :rtype: str + """ + return self._voided_ts + + @voided_ts.setter + def voided_ts(self, voided_ts): + """Sets the voided_ts of this ReportInProductRunResponseRowFields. + + # noqa: E501 + + :param voided_ts: The voided_ts of this ReportInProductRunResponseRowFields. # noqa: E501 + :type: str + """ + + self._voided_ts = voided_ts + + 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(ReportInProductRunResponseRowFields, 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, ReportInProductRunResponseRowFields): + 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/report_in_product_save_response.py b/docusign_esign/models/report_in_product_save_response.py new file mode 100644 index 00000000..e57c8689 --- /dev/null +++ b/docusign_esign/models/report_in_product_save_response.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 ReportInProductSaveResponse(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 = { + 'report_customized_id': 'str' + } + + attribute_map = { + 'report_customized_id': 'reportCustomizedId' + } + + def __init__(self, report_customized_id=None): # noqa: E501 + """ReportInProductSaveResponse - a model defined in Swagger""" # noqa: E501 + + self._report_customized_id = None + self.discriminator = None + + if report_customized_id is not None: + self.report_customized_id = report_customized_id + + @property + def report_customized_id(self): + """Gets the report_customized_id of this ReportInProductSaveResponse. # noqa: E501 + + # noqa: E501 + + :return: The report_customized_id of this ReportInProductSaveResponse. # noqa: E501 + :rtype: str + """ + return self._report_customized_id + + @report_customized_id.setter + def report_customized_id(self, report_customized_id): + """Sets the report_customized_id of this ReportInProductSaveResponse. + + # noqa: E501 + + :param report_customized_id: The report_customized_id of this ReportInProductSaveResponse. # noqa: E501 + :type: str + """ + + self._report_customized_id = report_customized_id + + 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(ReportInProductSaveResponse, 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, ReportInProductSaveResponse): + 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/report_in_product_sent_by_details.py b/docusign_esign/models/report_in_product_sent_by_details.py new file mode 100644 index 00000000..906ca210 --- /dev/null +++ b/docusign_esign/models/report_in_product_sent_by_details.py @@ -0,0 +1,145 @@ +# 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 ReportInProductSentByDetails(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 = { + 'groups': 'list[Group]', + 'users': 'list[UserInfo]' + } + + attribute_map = { + 'groups': 'groups', + 'users': 'users' + } + + def __init__(self, groups=None, users=None): # noqa: E501 + """ReportInProductSentByDetails - a model defined in Swagger""" # noqa: E501 + + self._groups = None + self._users = None + self.discriminator = None + + if groups is not None: + self.groups = groups + if users is not None: + self.users = users + + @property + def groups(self): + """Gets the groups of this ReportInProductSentByDetails. # noqa: E501 + + A collection group objects containing information about the groups returned. # noqa: E501 + + :return: The groups of this ReportInProductSentByDetails. # noqa: E501 + :rtype: list[Group] + """ + return self._groups + + @groups.setter + def groups(self, groups): + """Sets the groups of this ReportInProductSentByDetails. + + A collection group objects containing information about the groups returned. # noqa: E501 + + :param groups: The groups of this ReportInProductSentByDetails. # noqa: E501 + :type: list[Group] + """ + + self._groups = groups + + @property + def users(self): + """Gets the users of this ReportInProductSentByDetails. # noqa: E501 + + # noqa: E501 + + :return: The users of this ReportInProductSentByDetails. # noqa: E501 + :rtype: list[UserInfo] + """ + return self._users + + @users.setter + def users(self, users): + """Sets the users of this ReportInProductSentByDetails. + + # noqa: E501 + + :param users: The users of this ReportInProductSentByDetails. # noqa: E501 + :type: list[UserInfo] + """ + + self._users = users + + 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(ReportInProductSentByDetails, 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, ReportInProductSentByDetails): + 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/sender_email_notifications.py b/docusign_esign/models/sender_email_notifications.py index a6a8cf38..c382db88 100644 --- a/docusign_esign/models/sender_email_notifications.py +++ b/docusign_esign/models/sender_email_notifications.py @@ -37,6 +37,7 @@ class SenderEmailNotifications(object): 'delivery_failed': 'str', 'envelope_complete': 'str', 'offline_signing_failed': 'str', + 'powerform_responses_limit_notification_email': 'str', 'purge_documents': 'str', 'recipient_viewed': 'str', 'sender_envelope_declined': 'str', @@ -50,13 +51,14 @@ class SenderEmailNotifications(object): 'delivery_failed': 'deliveryFailed', 'envelope_complete': 'envelopeComplete', 'offline_signing_failed': 'offlineSigningFailed', + 'powerform_responses_limit_notification_email': 'powerformResponsesLimitNotificationEmail', 'purge_documents': 'purgeDocuments', 'recipient_viewed': 'recipientViewed', 'sender_envelope_declined': 'senderEnvelopeDeclined', 'withdrawn_consent': 'withdrawnConsent' } - def __init__(self, changed_signer=None, comments_only_private_and_mention=None, comments_receive_all=None, delivery_failed=None, envelope_complete=None, offline_signing_failed=None, purge_documents=None, recipient_viewed=None, sender_envelope_declined=None, withdrawn_consent=None): # noqa: E501 + def __init__(self, changed_signer=None, comments_only_private_and_mention=None, comments_receive_all=None, delivery_failed=None, envelope_complete=None, offline_signing_failed=None, powerform_responses_limit_notification_email=None, purge_documents=None, recipient_viewed=None, sender_envelope_declined=None, withdrawn_consent=None): # noqa: E501 """SenderEmailNotifications - a model defined in Swagger""" # noqa: E501 self._changed_signer = None @@ -65,6 +67,7 @@ def __init__(self, changed_signer=None, comments_only_private_and_mention=None, self._delivery_failed = None self._envelope_complete = None self._offline_signing_failed = None + self._powerform_responses_limit_notification_email = None self._purge_documents = None self._recipient_viewed = None self._sender_envelope_declined = None @@ -83,6 +86,8 @@ def __init__(self, changed_signer=None, comments_only_private_and_mention=None, self.envelope_complete = envelope_complete if offline_signing_failed is not None: self.offline_signing_failed = offline_signing_failed + if powerform_responses_limit_notification_email is not None: + self.powerform_responses_limit_notification_email = powerform_responses_limit_notification_email if purge_documents is not None: self.purge_documents = purge_documents if recipient_viewed is not None: @@ -230,6 +235,29 @@ def offline_signing_failed(self, offline_signing_failed): self._offline_signing_failed = offline_signing_failed + @property + def powerform_responses_limit_notification_email(self): + """Gets the powerform_responses_limit_notification_email of this SenderEmailNotifications. # noqa: E501 + + # noqa: E501 + + :return: The powerform_responses_limit_notification_email of this SenderEmailNotifications. # noqa: E501 + :rtype: str + """ + return self._powerform_responses_limit_notification_email + + @powerform_responses_limit_notification_email.setter + def powerform_responses_limit_notification_email(self, powerform_responses_limit_notification_email): + """Sets the powerform_responses_limit_notification_email of this SenderEmailNotifications. + + # noqa: E501 + + :param powerform_responses_limit_notification_email: The powerform_responses_limit_notification_email of this SenderEmailNotifications. # noqa: E501 + :type: str + """ + + self._powerform_responses_limit_notification_email = powerform_responses_limit_notification_email + @property def purge_documents(self): """Gets the purge_documents of this SenderEmailNotifications. # noqa: E501 diff --git a/docusign_esign/models/tab_metadata.py b/docusign_esign/models/tab_metadata.py index 47d97a2f..5d81f4de 100644 --- a/docusign_esign/models/tab_metadata.py +++ b/docusign_esign/models/tab_metadata.py @@ -65,7 +65,9 @@ class TabMetadata(object): 'payment_item_code': 'str', 'payment_item_description': 'str', 'payment_item_name': 'str', + 'require_all': 'str', 'required': 'str', + 'require_initial_on_shared_change': 'str', 'scale_value': 'str', 'selected': 'str', 'shared': 'str', @@ -114,7 +116,9 @@ class TabMetadata(object): 'payment_item_code': 'paymentItemCode', 'payment_item_description': 'paymentItemDescription', 'payment_item_name': 'paymentItemName', + 'require_all': 'requireAll', 'required': 'required', + 'require_initial_on_shared_change': 'requireInitialOnSharedChange', 'scale_value': 'scaleValue', 'selected': 'selected', 'shared': 'shared', @@ -128,7 +132,7 @@ class TabMetadata(object): 'width': 'width' } - def __init__(self, anchor=None, anchor_case_sensitive=None, anchor_horizontal_alignment=None, anchor_ignore_if_not_present=None, anchor_match_whole_word=None, anchor_units=None, anchor_x_offset=None, anchor_y_offset=None, bold=None, collaborative=None, conceal_value_on_document=None, created_by_display_name=None, created_by_user_id=None, custom_tab_id=None, disable_auto_size=None, editable=None, font=None, font_color=None, font_size=None, height=None, included_in_email=None, initial_value=None, italic=None, items=None, last_modified=None, last_modified_by_display_name=None, last_modified_by_user_id=None, locked=None, maximum_length=None, merge_field=None, name=None, payment_item_code=None, payment_item_description=None, payment_item_name=None, required=None, scale_value=None, selected=None, shared=None, stamp_type=None, stamp_type_metadata=None, tab_label=None, type=None, underline=None, validation_message=None, validation_pattern=None, width=None): # noqa: E501 + def __init__(self, anchor=None, anchor_case_sensitive=None, anchor_horizontal_alignment=None, anchor_ignore_if_not_present=None, anchor_match_whole_word=None, anchor_units=None, anchor_x_offset=None, anchor_y_offset=None, bold=None, collaborative=None, conceal_value_on_document=None, created_by_display_name=None, created_by_user_id=None, custom_tab_id=None, disable_auto_size=None, editable=None, font=None, font_color=None, font_size=None, height=None, included_in_email=None, initial_value=None, italic=None, items=None, last_modified=None, last_modified_by_display_name=None, last_modified_by_user_id=None, locked=None, maximum_length=None, merge_field=None, name=None, payment_item_code=None, payment_item_description=None, payment_item_name=None, require_all=None, required=None, require_initial_on_shared_change=None, scale_value=None, selected=None, shared=None, stamp_type=None, stamp_type_metadata=None, tab_label=None, type=None, underline=None, validation_message=None, validation_pattern=None, width=None): # noqa: E501 """TabMetadata - a model defined in Swagger""" # noqa: E501 self._anchor = None @@ -165,7 +169,9 @@ def __init__(self, anchor=None, anchor_case_sensitive=None, anchor_horizontal_al self._payment_item_code = None self._payment_item_description = None self._payment_item_name = None + self._require_all = None self._required = None + self._require_initial_on_shared_change = None self._scale_value = None self._selected = None self._shared = None @@ -247,8 +253,12 @@ def __init__(self, anchor=None, anchor_case_sensitive=None, anchor_horizontal_al self.payment_item_description = payment_item_description if payment_item_name is not None: self.payment_item_name = payment_item_name + if require_all is not None: + self.require_all = require_all if required is not None: self.required = required + if require_initial_on_shared_change is not None: + self.require_initial_on_shared_change = require_initial_on_shared_change if scale_value is not None: self.scale_value = scale_value if selected is not None: @@ -1052,6 +1062,29 @@ def payment_item_name(self, payment_item_name): self._payment_item_name = payment_item_name + @property + def require_all(self): + """Gets the require_all of this TabMetadata. # noqa: E501 + + When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 + + :return: The require_all of this TabMetadata. # noqa: E501 + :rtype: str + """ + return self._require_all + + @require_all.setter + def require_all(self, require_all): + """Sets the require_all of this TabMetadata. + + When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 + + :param require_all: The require_all of this TabMetadata. # noqa: E501 + :type: str + """ + + self._require_all = require_all + @property def required(self): """Gets the required of this TabMetadata. # noqa: E501 @@ -1075,6 +1108,29 @@ def required(self, required): self._required = required + @property + def require_initial_on_shared_change(self): + """Gets the require_initial_on_shared_change of this TabMetadata. # noqa: E501 + + Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 + + :return: The require_initial_on_shared_change of this TabMetadata. # noqa: E501 + :rtype: str + """ + return self._require_initial_on_shared_change + + @require_initial_on_shared_change.setter + def require_initial_on_shared_change(self, require_initial_on_shared_change): + """Sets the require_initial_on_shared_change of this TabMetadata. + + Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 + + :param require_initial_on_shared_change: The require_initial_on_shared_change of this TabMetadata. # noqa: E501 + :type: str + """ + + self._require_initial_on_shared_change = require_initial_on_shared_change + @property def scale_value(self): """Gets the scale_value of this TabMetadata. # noqa: E501 diff --git a/docusign_esign/models/workflow.py b/docusign_esign/models/workflow.py new file mode 100644 index 00000000..787c21ac --- /dev/null +++ b/docusign_esign/models/workflow.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 Workflow(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 = { + 'current_workflow_step_id': 'str', + 'workflow_status': 'str', + 'workflow_steps': 'list[WorkflowStep]' + } + + attribute_map = { + 'current_workflow_step_id': 'currentWorkflowStepId', + 'workflow_status': 'workflowStatus', + 'workflow_steps': 'workflowSteps' + } + + def __init__(self, current_workflow_step_id=None, workflow_status=None, workflow_steps=None): # noqa: E501 + """Workflow - a model defined in Swagger""" # noqa: E501 + + self._current_workflow_step_id = None + self._workflow_status = None + self._workflow_steps = None + self.discriminator = None + + if current_workflow_step_id is not None: + self.current_workflow_step_id = current_workflow_step_id + if workflow_status is not None: + self.workflow_status = workflow_status + if workflow_steps is not None: + self.workflow_steps = workflow_steps + + @property + def current_workflow_step_id(self): + """Gets the current_workflow_step_id of this Workflow. # noqa: E501 + + # noqa: E501 + + :return: The current_workflow_step_id of this Workflow. # noqa: E501 + :rtype: str + """ + return self._current_workflow_step_id + + @current_workflow_step_id.setter + def current_workflow_step_id(self, current_workflow_step_id): + """Sets the current_workflow_step_id of this Workflow. + + # noqa: E501 + + :param current_workflow_step_id: The current_workflow_step_id of this Workflow. # noqa: E501 + :type: str + """ + + self._current_workflow_step_id = current_workflow_step_id + + @property + def workflow_status(self): + """Gets the workflow_status of this Workflow. # noqa: E501 + + # noqa: E501 + + :return: The workflow_status of this Workflow. # noqa: E501 + :rtype: str + """ + return self._workflow_status + + @workflow_status.setter + def workflow_status(self, workflow_status): + """Sets the workflow_status of this Workflow. + + # noqa: E501 + + :param workflow_status: The workflow_status of this Workflow. # noqa: E501 + :type: str + """ + + self._workflow_status = workflow_status + + @property + def workflow_steps(self): + """Gets the workflow_steps of this Workflow. # noqa: E501 + + # noqa: E501 + + :return: The workflow_steps of this Workflow. # noqa: E501 + :rtype: list[WorkflowStep] + """ + return self._workflow_steps + + @workflow_steps.setter + def workflow_steps(self, workflow_steps): + """Sets the workflow_steps of this Workflow. + + # noqa: E501 + + :param workflow_steps: The workflow_steps of this Workflow. # noqa: E501 + :type: list[WorkflowStep] + """ + + self._workflow_steps = workflow_steps + + 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(Workflow, 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, Workflow): + 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/workflow_step.py b/docusign_esign/models/workflow_step.py new file mode 100644 index 00000000..811727a5 --- /dev/null +++ b/docusign_esign/models/workflow_step.py @@ -0,0 +1,311 @@ +# 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 WorkflowStep(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 = { + 'action': 'str', + 'completed_date': 'str', + 'item_id': 'str', + 'recipient_routing': 'RecipientRouting', + 'status': 'str', + 'triggered_date': 'str', + 'trigger_on_item': 'str', + 'workflow_step_id': 'str' + } + + attribute_map = { + 'action': 'action', + 'completed_date': 'completedDate', + 'item_id': 'itemId', + 'recipient_routing': 'recipientRouting', + 'status': 'status', + 'triggered_date': 'triggeredDate', + 'trigger_on_item': 'triggerOnItem', + 'workflow_step_id': 'workflowStepId' + } + + def __init__(self, action=None, completed_date=None, item_id=None, recipient_routing=None, status=None, triggered_date=None, trigger_on_item=None, workflow_step_id=None): # noqa: E501 + """WorkflowStep - a model defined in Swagger""" # noqa: E501 + + self._action = None + self._completed_date = None + self._item_id = None + self._recipient_routing = None + self._status = None + self._triggered_date = None + self._trigger_on_item = None + self._workflow_step_id = None + self.discriminator = None + + if action is not None: + self.action = action + if completed_date is not None: + self.completed_date = completed_date + if item_id is not None: + self.item_id = item_id + if recipient_routing is not None: + self.recipient_routing = recipient_routing + if status is not None: + self.status = status + if triggered_date is not None: + self.triggered_date = triggered_date + if trigger_on_item is not None: + self.trigger_on_item = trigger_on_item + if workflow_step_id is not None: + self.workflow_step_id = workflow_step_id + + @property + def action(self): + """Gets the action of this WorkflowStep. # noqa: E501 + + # noqa: E501 + + :return: The action of this WorkflowStep. # noqa: E501 + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """Sets the action of this WorkflowStep. + + # noqa: E501 + + :param action: The action of this WorkflowStep. # noqa: E501 + :type: str + """ + + self._action = action + + @property + def completed_date(self): + """Gets the completed_date of this WorkflowStep. # noqa: E501 + + # noqa: E501 + + :return: The completed_date of this WorkflowStep. # noqa: E501 + :rtype: str + """ + return self._completed_date + + @completed_date.setter + def completed_date(self, completed_date): + """Sets the completed_date of this WorkflowStep. + + # noqa: E501 + + :param completed_date: The completed_date of this WorkflowStep. # noqa: E501 + :type: str + """ + + self._completed_date = completed_date + + @property + def item_id(self): + """Gets the item_id of this WorkflowStep. # noqa: E501 + + # noqa: E501 + + :return: The item_id of this WorkflowStep. # noqa: E501 + :rtype: str + """ + return self._item_id + + @item_id.setter + def item_id(self, item_id): + """Sets the item_id of this WorkflowStep. + + # noqa: E501 + + :param item_id: The item_id of this WorkflowStep. # noqa: E501 + :type: str + """ + + self._item_id = item_id + + @property + def recipient_routing(self): + """Gets the recipient_routing of this WorkflowStep. # noqa: E501 + + + :return: The recipient_routing of this WorkflowStep. # noqa: E501 + :rtype: RecipientRouting + """ + return self._recipient_routing + + @recipient_routing.setter + def recipient_routing(self, recipient_routing): + """Sets the recipient_routing of this WorkflowStep. + + + :param recipient_routing: The recipient_routing of this WorkflowStep. # noqa: E501 + :type: RecipientRouting + """ + + self._recipient_routing = recipient_routing + + @property + def status(self): + """Gets the status of this WorkflowStep. # 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 WorkflowStep. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this WorkflowStep. + + 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 WorkflowStep. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def triggered_date(self): + """Gets the triggered_date of this WorkflowStep. # noqa: E501 + + # noqa: E501 + + :return: The triggered_date of this WorkflowStep. # noqa: E501 + :rtype: str + """ + return self._triggered_date + + @triggered_date.setter + def triggered_date(self, triggered_date): + """Sets the triggered_date of this WorkflowStep. + + # noqa: E501 + + :param triggered_date: The triggered_date of this WorkflowStep. # noqa: E501 + :type: str + """ + + self._triggered_date = triggered_date + + @property + def trigger_on_item(self): + """Gets the trigger_on_item of this WorkflowStep. # noqa: E501 + + # noqa: E501 + + :return: The trigger_on_item of this WorkflowStep. # noqa: E501 + :rtype: str + """ + return self._trigger_on_item + + @trigger_on_item.setter + def trigger_on_item(self, trigger_on_item): + """Sets the trigger_on_item of this WorkflowStep. + + # noqa: E501 + + :param trigger_on_item: The trigger_on_item of this WorkflowStep. # noqa: E501 + :type: str + """ + + self._trigger_on_item = trigger_on_item + + @property + def workflow_step_id(self): + """Gets the workflow_step_id of this WorkflowStep. # noqa: E501 + + # noqa: E501 + + :return: The workflow_step_id of this WorkflowStep. # noqa: E501 + :rtype: str + """ + return self._workflow_step_id + + @workflow_step_id.setter + def workflow_step_id(self, workflow_step_id): + """Sets the workflow_step_id of this WorkflowStep. + + # noqa: E501 + + :param workflow_step_id: The workflow_step_id of this WorkflowStep. # noqa: E501 + :type: str + """ + + self._workflow_step_id = workflow_step_id + + 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(WorkflowStep, 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, WorkflowStep): + 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/setup.py b/setup.py index 43c0ca6f..2eab554c 100644 --- a/setup.py +++ b/setup.py @@ -14,7 +14,7 @@ from setuptools import setup, find_packages, Command, os # noqa: H301 NAME = "docusign-esign" -VERSION = "3.4.0" +VERSION = "3.5.0rc1" # To install the library, run the following # # python setup.py install @@ -44,10 +44,10 @@ def run(self): install_requires=REQUIRES, packages=find_packages(), include_package_data=True, - cmdclass={ - 'clean': CleanCommand, + cmdclass={ + 'clean': CleanCommand, }, long_description="""\ - 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 """ )