diff --git a/docusign_esign/apis/accounts_api.py b/docusign_esign/apis/accounts_api.py index 75a692c5..dbbd0f69 100644 --- a/docusign_esign/apis/accounts_api.py +++ b/docusign_esign/apis/accounts_api.py @@ -144,6 +144,115 @@ def create_with_http_info(self, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def create_account_signatures(self, account_id, **kwargs): + """ + Adds/updates one or more account signatures. This request may include images in multi-part format. + This method makes a synchronous HTTP request by default. To make 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_account_signatures(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 decode_only: + :param AccountSignaturesInformation account_signatures_information: + :return: AccountSignaturesInformation + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.create_account_signatures_with_http_info(account_id, **kwargs) + else: + (data) = self.create_account_signatures_with_http_info(account_id, **kwargs) + return data + + def create_account_signatures_with_http_info(self, account_id, **kwargs): + """ + Adds/updates one or more account signatures. This request may include images in multi-part format. + This method makes a synchronous HTTP request by default. To make 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_account_signatures_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 decode_only: + :param AccountSignaturesInformation account_signatures_information: + :return: AccountSignaturesInformation + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'decode_only', 'account_signatures_information'] + 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_account_signatures" % 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_account_signatures`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/signatures'.replace('{format}', 'json') + path_params = {} + if 'account_id' in params: + path_params['accountId'] = params['account_id'] + + query_params = {} + if 'decode_only' in params: + query_params['decode_only'] = params['decode_only'] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'account_signatures_information' in params: + body_params = params['account_signatures_information'] + # 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='AccountSignaturesInformation', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def create_brand(self, account_id, **kwargs): """ Creates one or more brand profile files for the account. @@ -677,53 +786,53 @@ def delete_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_brand(self, account_id, brand_id, **kwargs): + def delete_account_signature(self, account_id, signature_id, **kwargs): """ - Removes a brand. + Close the specified signature by Id. This method makes a synchronous HTTP request by default. To make 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_brand(account_id, brand_id, callback=callback_function) + >>> thread = api.delete_account_signature(account_id, signature_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str brand_id: The unique identifier of a brand. (required) + :param str signature_id: The ID of the signature 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_brand_with_http_info(account_id, brand_id, **kwargs) + return self.delete_account_signature_with_http_info(account_id, signature_id, **kwargs) else: - (data) = self.delete_brand_with_http_info(account_id, brand_id, **kwargs) + (data) = self.delete_account_signature_with_http_info(account_id, signature_id, **kwargs) return data - def delete_brand_with_http_info(self, account_id, brand_id, **kwargs): + def delete_account_signature_with_http_info(self, account_id, signature_id, **kwargs): """ - Removes a brand. + Close the specified signature by Id. This method makes a synchronous HTTP request by default. To make 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_brand_with_http_info(account_id, brand_id, callback=callback_function) + >>> thread = api.delete_account_signature_with_http_info(account_id, signature_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str brand_id: The unique identifier of a brand. (required) + :param str signature_id: The ID of the signature being accessed. (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'brand_id'] + all_params = ['account_id', 'signature_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -734,26 +843,26 @@ def delete_brand_with_http_info(self, account_id, brand_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_brand" % key + " to method delete_account_signature" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `delete_brand`") - # verify the required parameter 'brand_id' is set - if ('brand_id' not in params) or (params['brand_id'] is None): - raise ValueError("Missing the required parameter `brand_id` when calling `delete_brand`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_account_signature`") + # verify the required parameter 'signature_id' is set + if ('signature_id' not in params) or (params['signature_id'] is None): + raise ValueError("Missing the required parameter `signature_id` when calling `delete_account_signature`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/signatures/{signatureId}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'brand_id' in params: - path_params['brandId'] = params['brand_id'] + if 'signature_id' in params: + path_params['signatureId'] = params['signature_id'] query_params = {} @@ -785,55 +894,55 @@ def delete_brand_with_http_info(self, account_id, brand_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_brand_logo_by_type(self, account_id, brand_id, logo_type, **kwargs): + def delete_account_signature_image(self, account_id, image_type, signature_id, **kwargs): """ - Delete one branding logo. + Deletes a signature, initials, or stamps image. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.delete_brand_logo_by_type(account_id, brand_id, logo_type, callback=callback_function) + >>> thread = api.delete_account_signature_image(account_id, image_type, signature_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str brand_id: The unique identifier of a brand. (required) - :param str logo_type: One of **Primary**, **Secondary** or **Email**. (required) - :return: None + :param str image_type: One of **signature_image** or **initials_image**. (required) + :param str signature_id: The ID of the signature being accessed. (required) + :return: AccountSignature If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, **kwargs) + return self.delete_account_signature_image_with_http_info(account_id, image_type, signature_id, **kwargs) else: - (data) = self.delete_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, **kwargs) + (data) = self.delete_account_signature_image_with_http_info(account_id, image_type, signature_id, **kwargs) return data - def delete_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_type, **kwargs): + def delete_account_signature_image_with_http_info(self, account_id, image_type, signature_id, **kwargs): """ - Delete one branding logo. + Deletes a signature, initials, or stamps image. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.delete_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, callback=callback_function) + >>> thread = api.delete_account_signature_image_with_http_info(account_id, image_type, signature_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str brand_id: The unique identifier of a brand. (required) - :param str logo_type: One of **Primary**, **Secondary** or **Email**. (required) - :return: None + :param str image_type: One of **signature_image** or **initials_image**. (required) + :param str signature_id: The ID of the signature being accessed. (required) + :return: AccountSignature If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'brand_id', 'logo_type'] + all_params = ['account_id', 'image_type', 'signature_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -844,31 +953,31 @@ def delete_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_ty if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_brand_logo_by_type" % key + " to method delete_account_signature_image" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `delete_brand_logo_by_type`") - # verify the required parameter 'brand_id' is set - if ('brand_id' not in params) or (params['brand_id'] is None): - raise ValueError("Missing the required parameter `brand_id` when calling `delete_brand_logo_by_type`") - # verify the required parameter 'logo_type' is set - if ('logo_type' not in params) or (params['logo_type'] is None): - raise ValueError("Missing the required parameter `logo_type` when calling `delete_brand_logo_by_type`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_account_signature_image`") + # verify the required parameter 'image_type' is set + if ('image_type' not in params) or (params['image_type'] is None): + raise ValueError("Missing the required parameter `image_type` when calling `delete_account_signature_image`") + # verify the required parameter 'signature_id' is set + if ('signature_id' not in params) or (params['signature_id'] is None): + raise ValueError("Missing the required parameter `signature_id` when calling `delete_account_signature_image`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'brand_id' in params: - path_params['brandId'] = params['brand_id'] - if 'logo_type' in params: - path_params['logoType'] = params['logo_type'] + if 'image_type' in params: + path_params['imageType'] = params['image_type'] + if 'signature_id' in params: + path_params['signatureId'] = params['signature_id'] query_params = {} @@ -892,7 +1001,7 @@ def delete_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_ty body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='AccountSignature', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -900,55 +1009,53 @@ def delete_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_ty _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_brands(self, account_id, **kwargs): + def delete_brand(self, account_id, brand_id, **kwargs): """ - Deletes one or more brand profiles. - Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** to use this call. + Removes a brand. This method makes a synchronous HTTP request by default. To make 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_brands(account_id, callback=callback_function) + >>> thread = api.delete_brand(account_id, brand_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param BrandsRequest brands_request: - :return: BrandsResponse + :param str brand_id: The unique identifier of a brand. (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_brands_with_http_info(account_id, **kwargs) + return self.delete_brand_with_http_info(account_id, brand_id, **kwargs) else: - (data) = self.delete_brands_with_http_info(account_id, **kwargs) + (data) = self.delete_brand_with_http_info(account_id, brand_id, **kwargs) return data - def delete_brands_with_http_info(self, account_id, **kwargs): + def delete_brand_with_http_info(self, account_id, brand_id, **kwargs): """ - Deletes one or more brand profiles. - Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** to use this call. + Removes a brand. This method makes a synchronous HTTP request by default. To make 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_brands_with_http_info(account_id, callback=callback_function) + >>> thread = api.delete_brand_with_http_info(account_id, brand_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param BrandsRequest brands_request: - :return: BrandsResponse + :param str brand_id: The unique identifier of a brand. (required) + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'brands_request'] + all_params = ['account_id', 'brand_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -959,21 +1066,26 @@ def delete_brands_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_brands" % key + " to method delete_brand" % 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_brands`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_brand`") + # verify the required parameter 'brand_id' is set + if ('brand_id' not in params) or (params['brand_id'] is None): + raise ValueError("Missing the required parameter `brand_id` when calling `delete_brand`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/brands'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] + if 'brand_id' in params: + path_params['brandId'] = params['brand_id'] query_params = {} @@ -983,8 +1095,6 @@ def delete_brands_with_http_info(self, account_id, **kwargs): local_var_files = {} body_params = None - if 'brands_request' in params: - body_params = params['brands_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -999,7 +1109,7 @@ def delete_brands_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='BrandsResponse', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1007,57 +1117,55 @@ def delete_brands_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_captive_recipient(self, account_id, recipient_part, **kwargs): + def delete_brand_logo_by_type(self, account_id, brand_id, logo_type, **kwargs): """ - Deletes the signature for one or more captive recipient records. - Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used. + Delete one branding logo. This method makes a synchronous HTTP request by default. To make 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_captive_recipient(account_id, recipient_part, callback=callback_function) + >>> thread = api.delete_brand_logo_by_type(account_id, brand_id, logo_type, callback=callback_function) :param callback 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_part: (required) - :param CaptiveRecipientInformation captive_recipient_information: - :return: CaptiveRecipientInformation + :param str brand_id: The unique identifier of a brand. (required) + :param str logo_type: One of **Primary**, **Secondary** or **Email**. (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_captive_recipient_with_http_info(account_id, recipient_part, **kwargs) + return self.delete_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, **kwargs) else: - (data) = self.delete_captive_recipient_with_http_info(account_id, recipient_part, **kwargs) + (data) = self.delete_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, **kwargs) return data - def delete_captive_recipient_with_http_info(self, account_id, recipient_part, **kwargs): + def delete_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_type, **kwargs): """ - Deletes the signature for one or more captive recipient records. - Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used. + Delete one branding logo. This method makes a synchronous HTTP request by default. To make 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_captive_recipient_with_http_info(account_id, recipient_part, callback=callback_function) + >>> thread = api.delete_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, callback=callback_function) :param callback 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_part: (required) - :param CaptiveRecipientInformation captive_recipient_information: - :return: CaptiveRecipientInformation + :param str brand_id: The unique identifier of a brand. (required) + :param str logo_type: One of **Primary**, **Secondary** or **Email**. (required) + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'recipient_part', 'captive_recipient_information'] + all_params = ['account_id', 'brand_id', 'logo_type'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1068,26 +1176,31 @@ def delete_captive_recipient_with_http_info(self, account_id, recipient_part, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_captive_recipient" % key + " to method delete_brand_logo_by_type" % 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_captive_recipient`") - # verify the required parameter 'recipient_part' is set - if ('recipient_part' not in params) or (params['recipient_part'] is None): - raise ValueError("Missing the required parameter `recipient_part` when calling `delete_captive_recipient`") + raise ValueError("Missing the required parameter `account_id` when calling `delete_brand_logo_by_type`") + # verify the required parameter 'brand_id' is set + if ('brand_id' not in params) or (params['brand_id'] is None): + raise ValueError("Missing the required parameter `brand_id` when calling `delete_brand_logo_by_type`") + # verify the required parameter 'logo_type' is set + if ('logo_type' not in params) or (params['logo_type'] is None): + raise ValueError("Missing the required parameter `logo_type` when calling `delete_brand_logo_by_type`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'recipient_part' in params: - path_params['recipientPart'] = params['recipient_part'] + if 'brand_id' in params: + path_params['brandId'] = params['brand_id'] + if 'logo_type' in params: + path_params['logoType'] = params['logo_type'] query_params = {} @@ -1097,8 +1210,6 @@ def delete_captive_recipient_with_http_info(self, account_id, recipient_part, ** local_var_files = {} body_params = None - if 'captive_recipient_information' in params: - body_params = params['captive_recipient_information'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -1113,7 +1224,7 @@ def delete_captive_recipient_with_http_info(self, account_id, recipient_part, ** body=body_params, post_params=form_params, files=local_var_files, - response_type='CaptiveRecipientInformation', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1121,43 +1232,264 @@ def delete_captive_recipient_with_http_info(self, account_id, recipient_part, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_custom_field(self, account_id, custom_field_id, **kwargs): + def delete_brands(self, account_id, **kwargs): """ - Delete an existing account custom field. + Deletes one or more brand profiles. + Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** 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.delete_custom_field(account_id, custom_field_id, callback=callback_function) + >>> thread = api.delete_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 custom_field_id: (required) - :param str apply_to_templates: - :return: None + :param BrandsRequest brands_request: + :return: BrandsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_custom_field_with_http_info(account_id, custom_field_id, **kwargs) + return self.delete_brands_with_http_info(account_id, **kwargs) else: - (data) = self.delete_custom_field_with_http_info(account_id, custom_field_id, **kwargs) + (data) = self.delete_brands_with_http_info(account_id, **kwargs) return data - def delete_custom_field_with_http_info(self, account_id, custom_field_id, **kwargs): + def delete_brands_with_http_info(self, account_id, **kwargs): """ - Delete an existing account custom field. + Deletes one or more brand profiles. + Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** 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.delete_custom_field_with_http_info(account_id, custom_field_id, callback=callback_function) + >>> thread = api.delete_brands_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 BrandsRequest brands_request: + :return: BrandsResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'brands_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 delete_brands" % 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_brands`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/brands'.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 'brands_request' in params: + body_params = params['brands_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, 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='BrandsResponse', + 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_captive_recipient(self, account_id, recipient_part, **kwargs): + """ + Deletes the signature for one or more captive recipient records. + Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used. + This method makes a synchronous HTTP request by default. To make 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_captive_recipient(account_id, recipient_part, callback=callback_function) + + :param callback 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_part: (required) + :param CaptiveRecipientInformation captive_recipient_information: + :return: CaptiveRecipientInformation + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_captive_recipient_with_http_info(account_id, recipient_part, **kwargs) + else: + (data) = self.delete_captive_recipient_with_http_info(account_id, recipient_part, **kwargs) + return data + + def delete_captive_recipient_with_http_info(self, account_id, recipient_part, **kwargs): + """ + Deletes the signature for one or more captive recipient records. + Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used. + This method makes a synchronous HTTP request by default. To make 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_captive_recipient_with_http_info(account_id, recipient_part, callback=callback_function) + + :param callback 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_part: (required) + :param CaptiveRecipientInformation captive_recipient_information: + :return: CaptiveRecipientInformation + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'recipient_part', 'captive_recipient_information'] + 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_captive_recipient" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `delete_captive_recipient`") + # verify the required parameter 'recipient_part' is set + if ('recipient_part' not in params) or (params['recipient_part'] is None): + raise ValueError("Missing the required parameter `recipient_part` when calling `delete_captive_recipient`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}'.replace('{format}', 'json') + path_params = {} + if 'account_id' in params: + path_params['accountId'] = params['account_id'] + if 'recipient_part' in params: + path_params['recipientPart'] = params['recipient_part'] + + query_params = {} + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'captive_recipient_information' in params: + body_params = params['captive_recipient_information'] + # 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='CaptiveRecipientInformation', + 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_custom_field(self, account_id, custom_field_id, **kwargs): + """ + Delete an existing account custom field. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.delete_custom_field(account_id, custom_field_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str custom_field_id: (required) + :param str apply_to_templates: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_custom_field_with_http_info(account_id, custom_field_id, **kwargs) + else: + (data) = self.delete_custom_field_with_http_info(account_id, custom_field_id, **kwargs) + return data + + def delete_custom_field_with_http_info(self, account_id, custom_field_id, **kwargs): + """ + Delete an existing account custom field. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.delete_custom_field_with_http_info(account_id, custom_field_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -1762,51 +2094,53 @@ def get_account_information_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_account_tab_settings(self, account_id, **kwargs): + def get_account_signature(self, account_id, signature_id, **kwargs): """ - Returns tab settings list for specified account + Returns information about a single signature by specifed signatureId. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_account_tab_settings(account_id, callback=callback_function) + >>> thread = api.get_account_signature(account_id, signature_id, callback=callback_function) :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: TabAccountSettings + :param str signature_id: The ID of the signature being accessed. (required) + :return: AccountSignature If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_account_tab_settings_with_http_info(account_id, **kwargs) + return self.get_account_signature_with_http_info(account_id, signature_id, **kwargs) else: - (data) = self.get_account_tab_settings_with_http_info(account_id, **kwargs) + (data) = self.get_account_signature_with_http_info(account_id, signature_id, **kwargs) return data - def get_account_tab_settings_with_http_info(self, account_id, **kwargs): + def get_account_signature_with_http_info(self, account_id, signature_id, **kwargs): """ - Returns tab settings list for specified account + Returns information about a single signature by specifed signatureId. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_account_tab_settings_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_account_signature_with_http_info(account_id, signature_id, callback=callback_function) :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: TabAccountSettings + :param str signature_id: The ID of the signature being accessed. (required) + :return: AccountSignature If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id'] + all_params = ['account_id', 'signature_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1817,21 +2151,26 @@ def get_account_tab_settings_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_account_tab_settings" % key + " to method get_account_signature" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_account_tab_settings`") + raise ValueError("Missing the required parameter `account_id` when calling `get_account_signature`") + # verify the required parameter 'signature_id' is set + if ('signature_id' not in params) or (params['signature_id'] is None): + raise ValueError("Missing the required parameter `signature_id` when calling `get_account_signature`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/settings/tabs'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/signatures/{signatureId}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] + if 'signature_id' in params: + path_params['signatureId'] = params['signature_id'] query_params = {} @@ -1855,7 +2194,7 @@ def get_account_tab_settings_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='TabAccountSettings', + response_type='AccountSignature', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1863,51 +2202,57 @@ def get_account_tab_settings_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_all_payment_gateway_accounts(self, account_id, **kwargs): + def get_account_signature_image(self, account_id, image_type, signature_id, **kwargs): """ - Get all payment gateway account for the provided accountId + Returns a signature, initials, or stamps image. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_all_payment_gateway_accounts(account_id, callback=callback_function) + >>> thread = api.get_account_signature_image(account_id, image_type, signature_id, callback=callback_function) :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: PaymentGatewayAccountsInfo + :param str image_type: One of **signature_image** or **initials_image**. (required) + :param str signature_id: The ID of the signature being accessed. (required) + :param str include_chrome: + :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_all_payment_gateway_accounts_with_http_info(account_id, **kwargs) + return self.get_account_signature_image_with_http_info(account_id, image_type, signature_id, **kwargs) else: - (data) = self.get_all_payment_gateway_accounts_with_http_info(account_id, **kwargs) + (data) = self.get_account_signature_image_with_http_info(account_id, image_type, signature_id, **kwargs) return data - def get_all_payment_gateway_accounts_with_http_info(self, account_id, **kwargs): + def get_account_signature_image_with_http_info(self, account_id, image_type, signature_id, **kwargs): """ - Get all payment gateway account for the provided accountId + Returns a signature, initials, or stamps image. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_all_payment_gateway_accounts_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_account_signature_image_with_http_info(account_id, image_type, signature_id, callback=callback_function) :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: PaymentGatewayAccountsInfo + :param str image_type: One of **signature_image** or **initials_image**. (required) + :param str signature_id: The ID of the signature being accessed. (required) + :param str include_chrome: + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id'] + all_params = ['account_id', 'image_type', 'signature_id', 'include_chrome'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1918,23 +2263,35 @@ def get_all_payment_gateway_accounts_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_all_payment_gateway_accounts" % key + " to method get_account_signature_image" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_all_payment_gateway_accounts`") + raise ValueError("Missing the required parameter `account_id` when calling `get_account_signature_image`") + # verify the required parameter 'image_type' is set + if ('image_type' not in params) or (params['image_type'] is None): + raise ValueError("Missing the required parameter `image_type` when calling `get_account_signature_image`") + # verify the required parameter 'signature_id' is set + if ('signature_id' not in params) or (params['signature_id'] is None): + raise ValueError("Missing the required parameter `signature_id` when calling `get_account_signature_image`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/payment_gateway_accounts'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] + if 'image_type' in params: + path_params['imageType'] = params['image_type'] + if 'signature_id' in params: + path_params['signatureId'] = params['signature_id'] query_params = {} + if 'include_chrome' in params: + query_params['include_chrome'] = params['include_chrome'] header_params = {} @@ -1944,7 +2301,7 @@ def get_all_payment_gateway_accounts_with_http_info(self, account_id, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['image/gif']) # Authentication setting auth_settings = [] @@ -1956,7 +2313,7 @@ def get_all_payment_gateway_accounts_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='PaymentGatewayAccountsInfo', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1964,55 +2321,57 @@ def get_all_payment_gateway_accounts_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_billing_charges(self, account_id, **kwargs): + def get_account_signatures(self, account_id, **kwargs): """ - Gets list of recurring and usage charges for the account. - Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator + Returns the managed signature definitions for the account This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_billing_charges(account_id, callback=callback_function) + >>> thread = api.get_account_signatures(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 include_charges: Specifies which billing charges to return. Valid values are: * envelopes * seats - :return: BillingChargeResponse + :param str stamp_format: + :param str stamp_name: + :param str stamp_type: + :return: AccountSignaturesInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_billing_charges_with_http_info(account_id, **kwargs) + return self.get_account_signatures_with_http_info(account_id, **kwargs) else: - (data) = self.get_billing_charges_with_http_info(account_id, **kwargs) + (data) = self.get_account_signatures_with_http_info(account_id, **kwargs) return data - def get_billing_charges_with_http_info(self, account_id, **kwargs): + def get_account_signatures_with_http_info(self, account_id, **kwargs): """ - Gets list of recurring and usage charges for the account. - Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator + Returns the managed signature definitions for the account This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_billing_charges_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_account_signatures_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 include_charges: Specifies which billing charges to return. Valid values are: * envelopes * seats - :return: BillingChargeResponse + :param str stamp_format: + :param str stamp_name: + :param str stamp_type: + :return: AccountSignaturesInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'include_charges'] + all_params = ['account_id', 'stamp_format', 'stamp_name', 'stamp_type'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2023,25 +2382,29 @@ def get_billing_charges_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_billing_charges" % key + " to method get_account_signatures" % 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_billing_charges`") + raise ValueError("Missing the required parameter `account_id` when calling `get_account_signatures`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/billing_charges'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/signatures'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] query_params = {} - if 'include_charges' in params: - query_params['include_charges'] = params['include_charges'] + if 'stamp_format' in params: + query_params['stamp_format'] = params['stamp_format'] + if 'stamp_name' in params: + query_params['stamp_name'] = params['stamp_name'] + if 'stamp_type' in params: + query_params['stamp_type'] = params['stamp_type'] header_params = {} @@ -2063,7 +2426,7 @@ def get_billing_charges_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='BillingChargeResponse', + response_type='AccountSignaturesInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2071,57 +2434,51 @@ def get_billing_charges_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_brand(self, account_id, brand_id, **kwargs): + def get_account_tab_settings(self, account_id, **kwargs): """ - Get information for a specific brand. + Returns tab settings list for specified account This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_brand(account_id, brand_id, callback=callback_function) + >>> thread = api.get_account_tab_settings(account_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str brand_id: The unique identifier of a brand. (required) - :param str include_external_references: - :param str include_logos: - :return: Brand + :return: TabAccountSettings If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_brand_with_http_info(account_id, brand_id, **kwargs) + return self.get_account_tab_settings_with_http_info(account_id, **kwargs) else: - (data) = self.get_brand_with_http_info(account_id, brand_id, **kwargs) + (data) = self.get_account_tab_settings_with_http_info(account_id, **kwargs) return data - def get_brand_with_http_info(self, account_id, brand_id, **kwargs): + def get_account_tab_settings_with_http_info(self, account_id, **kwargs): """ - Get information for a specific brand. + Returns tab settings list for specified account This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_brand_with_http_info(account_id, brand_id, callback=callback_function) + >>> thread = api.get_account_tab_settings_with_http_info(account_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str brand_id: The unique identifier of a brand. (required) - :param str include_external_references: - :param str include_logos: - :return: Brand + :return: TabAccountSettings If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'brand_id', 'include_external_references', 'include_logos'] + all_params = ['account_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2132,32 +2489,23 @@ def get_brand_with_http_info(self, account_id, brand_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_brand" % key + " to method get_account_tab_settings" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_brand`") - # verify the required parameter 'brand_id' is set - if ('brand_id' not in params) or (params['brand_id'] is None): - raise ValueError("Missing the required parameter `brand_id` when calling `get_brand`") + raise ValueError("Missing the required parameter `account_id` when calling `get_account_tab_settings`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/settings/tabs'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'brand_id' in params: - path_params['brandId'] = params['brand_id'] query_params = {} - if 'include_external_references' in params: - query_params['include_external_references'] = params['include_external_references'] - if 'include_logos' in params: - query_params['include_logos'] = params['include_logos'] header_params = {} @@ -2179,7 +2527,7 @@ def get_brand_with_http_info(self, account_id, brand_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='Brand', + response_type='TabAccountSettings', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2187,53 +2535,51 @@ def get_brand_with_http_info(self, account_id, brand_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_brand_export_file(self, account_id, brand_id, **kwargs): + def get_all_payment_gateway_accounts(self, account_id, **kwargs): """ - Export a specific brand. + Get all payment gateway account for the provided accountId This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_brand_export_file(account_id, brand_id, callback=callback_function) + >>> thread = api.get_all_payment_gateway_accounts(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 brand_id: The unique identifier of a brand. (required) - :return: None + :return: PaymentGatewayAccountsInfo If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_brand_export_file_with_http_info(account_id, brand_id, **kwargs) + return self.get_all_payment_gateway_accounts_with_http_info(account_id, **kwargs) else: - (data) = self.get_brand_export_file_with_http_info(account_id, brand_id, **kwargs) + (data) = self.get_all_payment_gateway_accounts_with_http_info(account_id, **kwargs) return data - def get_brand_export_file_with_http_info(self, account_id, brand_id, **kwargs): + def get_all_payment_gateway_accounts_with_http_info(self, account_id, **kwargs): """ - Export a specific brand. + Get all payment gateway account for the provided accountId This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_brand_export_file_with_http_info(account_id, brand_id, callback=callback_function) + >>> thread = api.get_all_payment_gateway_accounts_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 brand_id: The unique identifier of a brand. (required) - :return: None + :return: PaymentGatewayAccountsInfo If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'brand_id'] + all_params = ['account_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2244,26 +2590,21 @@ def get_brand_export_file_with_http_info(self, account_id, brand_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_brand_export_file" % key + " to method get_all_payment_gateway_accounts" % 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_brand_export_file`") - # verify the required parameter 'brand_id' is set - if ('brand_id' not in params) or (params['brand_id'] is None): - raise ValueError("Missing the required parameter `brand_id` when calling `get_brand_export_file`") + raise ValueError("Missing the required parameter `account_id` when calling `get_all_payment_gateway_accounts`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}/file'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/payment_gateway_accounts'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'brand_id' in params: - path_params['brandId'] = params['brand_id'] query_params = {} @@ -2287,7 +2628,7 @@ def get_brand_export_file_with_http_info(self, account_id, brand_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type=None, + response_type='PaymentGatewayAccountsInfo', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2295,55 +2636,55 @@ def get_brand_export_file_with_http_info(self, account_id, brand_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_brand_logo_by_type(self, account_id, brand_id, logo_type, **kwargs): + def get_billing_charges(self, account_id, **kwargs): """ - Obtains the specified image for a brand. + Gets list of recurring and usage charges for the account. + Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator This method makes a synchronous HTTP request by default. To make 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_brand_logo_by_type(account_id, brand_id, logo_type, callback=callback_function) + >>> thread = api.get_billing_charges(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 brand_id: The unique identifier of a brand. (required) - :param str logo_type: One of **Primary**, **Secondary** or **Email**. (required) - :return: file + :param str include_charges: Specifies which billing charges to return. Valid values are: * envelopes * seats + :return: BillingChargeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, **kwargs) + return self.get_billing_charges_with_http_info(account_id, **kwargs) else: - (data) = self.get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, **kwargs) + (data) = self.get_billing_charges_with_http_info(account_id, **kwargs) return data - def get_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_type, **kwargs): + def get_billing_charges_with_http_info(self, account_id, **kwargs): """ - Obtains the specified image for a brand. + Gets list of recurring and usage charges for the account. + Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator This method makes a synchronous HTTP request by default. To make 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_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, callback=callback_function) + >>> thread = api.get_billing_charges_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 brand_id: The unique identifier of a brand. (required) - :param str logo_type: One of **Primary**, **Secondary** or **Email**. (required) - :return: file + :param str include_charges: Specifies which billing charges to return. Valid values are: * envelopes * seats + :return: BillingChargeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'brand_id', 'logo_type'] + all_params = ['account_id', 'include_charges'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2354,33 +2695,25 @@ def get_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_type, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_brand_logo_by_type" % key + " to method get_billing_charges" % 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_brand_logo_by_type`") - # verify the required parameter 'brand_id' is set - if ('brand_id' not in params) or (params['brand_id'] is None): - raise ValueError("Missing the required parameter `brand_id` when calling `get_brand_logo_by_type`") - # verify the required parameter 'logo_type' is set - if ('logo_type' not in params) or (params['logo_type'] is None): - raise ValueError("Missing the required parameter `logo_type` when calling `get_brand_logo_by_type`") + raise ValueError("Missing the required parameter `account_id` when calling `get_billing_charges`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/billing_charges'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'brand_id' in params: - path_params['brandId'] = params['brand_id'] - if 'logo_type' in params: - path_params['logoType'] = params['logo_type'] query_params = {} + if 'include_charges' in params: + query_params['include_charges'] = params['include_charges'] header_params = {} @@ -2390,7 +2723,7 @@ def get_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_type, body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['image/png']) + select_header_accept(['application/json']) # Authentication setting auth_settings = [] @@ -2402,7 +2735,7 @@ def get_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_type, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='BillingChargeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2410,53 +2743,57 @@ def get_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_type, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_brand_resources(self, account_id, brand_id, **kwargs): + def get_brand(self, account_id, brand_id, **kwargs): """ - Returns the specified account's list of branding resources (metadata). + Get information for a specific brand. This method makes a synchronous HTTP request by default. To make 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_brand_resources(account_id, brand_id, callback=callback_function) + >>> thread = api.get_brand(account_id, brand_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str brand_id: The unique identifier of a brand. (required) - :return: BrandResourcesList + :param str include_external_references: + :param str include_logos: + :return: Brand If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_brand_resources_with_http_info(account_id, brand_id, **kwargs) + return self.get_brand_with_http_info(account_id, brand_id, **kwargs) else: - (data) = self.get_brand_resources_with_http_info(account_id, brand_id, **kwargs) + (data) = self.get_brand_with_http_info(account_id, brand_id, **kwargs) return data - def get_brand_resources_with_http_info(self, account_id, brand_id, **kwargs): + def get_brand_with_http_info(self, account_id, brand_id, **kwargs): """ - Returns the specified account's list of branding resources (metadata). + Get information for a specific brand. This method makes a synchronous HTTP request by default. To make 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_brand_resources_with_http_info(account_id, brand_id, callback=callback_function) + >>> thread = api.get_brand_with_http_info(account_id, brand_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str brand_id: The unique identifier of a brand. (required) - :return: BrandResourcesList + :param str include_external_references: + :param str include_logos: + :return: Brand If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'brand_id'] + all_params = ['account_id', 'brand_id', 'include_external_references', 'include_logos'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2467,21 +2804,21 @@ def get_brand_resources_with_http_info(self, account_id, brand_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_brand_resources" % key + " to method get_brand" % 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_brand_resources`") + raise ValueError("Missing the required parameter `account_id` when calling `get_brand`") # verify the required parameter 'brand_id' is set if ('brand_id' not in params) or (params['brand_id'] is None): - raise ValueError("Missing the required parameter `brand_id` when calling `get_brand_resources`") + raise ValueError("Missing the required parameter `brand_id` when calling `get_brand`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}/resources'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -2489,6 +2826,10 @@ def get_brand_resources_with_http_info(self, account_id, brand_id, **kwargs): path_params['brandId'] = params['brand_id'] query_params = {} + if 'include_external_references' in params: + query_params['include_external_references'] = params['include_external_references'] + if 'include_logos' in params: + query_params['include_logos'] = params['include_logos'] header_params = {} @@ -2510,7 +2851,7 @@ def get_brand_resources_with_http_info(self, account_id, brand_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='BrandResourcesList', + response_type='Brand', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2518,59 +2859,53 @@ def get_brand_resources_with_http_info(self, account_id, brand_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_brand_resources_by_content_type(self, account_id, brand_id, resource_content_type, **kwargs): + def get_brand_export_file(self, account_id, brand_id, **kwargs): """ - Returns the specified branding resource file. + Export a specific brand. This method makes a synchronous HTTP request by default. To make 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_brand_resources_by_content_type(account_id, brand_id, resource_content_type, callback=callback_function) + >>> thread = api.get_brand_export_file(account_id, brand_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str brand_id: The unique identifier of a brand. (required) - :param str resource_content_type: (required) - :param str langcode: - :param str return_master: :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_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type, **kwargs) + return self.get_brand_export_file_with_http_info(account_id, brand_id, **kwargs) else: - (data) = self.get_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type, **kwargs) + (data) = self.get_brand_export_file_with_http_info(account_id, brand_id, **kwargs) return data - def get_brand_resources_by_content_type_with_http_info(self, account_id, brand_id, resource_content_type, **kwargs): + def get_brand_export_file_with_http_info(self, account_id, brand_id, **kwargs): """ - Returns the specified branding resource file. + Export a specific brand. This method makes a synchronous HTTP request by default. To make 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_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type, callback=callback_function) + >>> thread = api.get_brand_export_file_with_http_info(account_id, brand_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str brand_id: The unique identifier of a brand. (required) - :param str resource_content_type: (required) - :param str langcode: - :param str return_master: :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'brand_id', 'resource_content_type', 'langcode', 'return_master'] + all_params = ['account_id', 'brand_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2581,37 +2916,28 @@ def get_brand_resources_by_content_type_with_http_info(self, account_id, brand_i if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_brand_resources_by_content_type" % key + " to method get_brand_export_file" % 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_brand_resources_by_content_type`") + raise ValueError("Missing the required parameter `account_id` when calling `get_brand_export_file`") # verify the required parameter 'brand_id' is set if ('brand_id' not in params) or (params['brand_id'] is None): - raise ValueError("Missing the required parameter `brand_id` when calling `get_brand_resources_by_content_type`") - # verify the required parameter 'resource_content_type' is set - if ('resource_content_type' not in params) or (params['resource_content_type'] is None): - raise ValueError("Missing the required parameter `resource_content_type` when calling `get_brand_resources_by_content_type`") + raise ValueError("Missing the required parameter `brand_id` when calling `get_brand_export_file`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}/file'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] if 'brand_id' in params: path_params['brandId'] = params['brand_id'] - if 'resource_content_type' in params: - path_params['resourceContentType'] = params['resource_content_type'] query_params = {} - if 'langcode' in params: - query_params['langcode'] = params['langcode'] - if 'return_master' in params: - query_params['return_master'] = params['return_master'] header_params = {} @@ -2641,55 +2967,55 @@ def get_brand_resources_by_content_type_with_http_info(self, account_id, brand_i _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_consumer_disclosure(self, account_id, lang_code, **kwargs): + def get_brand_logo_by_type(self, account_id, brand_id, logo_type, **kwargs): """ - Gets the Electronic Record and Signature Disclosure. - Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure. + Obtains the specified image for a brand. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_consumer_disclosure(account_id, lang_code, callback=callback_function) + >>> thread = api.get_brand_logo_by_type(account_id, brand_id, logo_type, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) - :return: ConsumerDisclosure + :param str brand_id: The unique identifier of a brand. (required) + :param str logo_type: One of **Primary**, **Secondary** or **Email**. (required) + :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_consumer_disclosure_with_http_info(account_id, lang_code, **kwargs) + return self.get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, **kwargs) else: - (data) = self.get_consumer_disclosure_with_http_info(account_id, lang_code, **kwargs) + (data) = self.get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, **kwargs) return data - def get_consumer_disclosure_with_http_info(self, account_id, lang_code, **kwargs): + def get_brand_logo_by_type_with_http_info(self, account_id, brand_id, logo_type, **kwargs): """ - Gets the Electronic Record and Signature Disclosure. - Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure. + Obtains the specified image for a brand. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_consumer_disclosure_with_http_info(account_id, lang_code, callback=callback_function) + >>> thread = api.get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) - :return: ConsumerDisclosure + :param str brand_id: The unique identifier of a brand. (required) + :param str logo_type: One of **Primary**, **Secondary** or **Email**. (required) + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'lang_code'] + all_params = ['account_id', 'brand_id', 'logo_type'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2700,26 +3026,31 @@ def get_consumer_disclosure_with_http_info(self, account_id, lang_code, **kwargs if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_consumer_disclosure" % key + " to method get_brand_logo_by_type" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_consumer_disclosure`") - # verify the required parameter 'lang_code' is set - if ('lang_code' not in params) or (params['lang_code'] is None): - raise ValueError("Missing the required parameter `lang_code` when calling `get_consumer_disclosure`") + raise ValueError("Missing the required parameter `account_id` when calling `get_brand_logo_by_type`") + # verify the required parameter 'brand_id' is set + if ('brand_id' not in params) or (params['brand_id'] is None): + raise ValueError("Missing the required parameter `brand_id` when calling `get_brand_logo_by_type`") + # verify the required parameter 'logo_type' is set + if ('logo_type' not in params) or (params['logo_type'] is None): + raise ValueError("Missing the required parameter `logo_type` when calling `get_brand_logo_by_type`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] - if 'lang_code' in params: - path_params['langCode'] = params['lang_code'] + if 'brand_id' in params: + path_params['brandId'] = params['brand_id'] + if 'logo_type' in params: + path_params['logoType'] = params['logo_type'] query_params = {} @@ -2731,7 +3062,7 @@ def get_consumer_disclosure_with_http_info(self, account_id, lang_code, **kwargs body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['image/png']) # Authentication setting auth_settings = [] @@ -2743,7 +3074,7 @@ def get_consumer_disclosure_with_http_info(self, account_id, lang_code, **kwargs body=body_params, post_params=form_params, files=local_var_files, - response_type='ConsumerDisclosure', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2751,55 +3082,53 @@ def get_consumer_disclosure_with_http_info(self, account_id, lang_code, **kwargs _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_consumer_disclosure_default(self, account_id, **kwargs): + def get_brand_resources(self, account_id, brand_id, **kwargs): """ - Gets the Electronic Record and Signature Disclosure for the account. - Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure. + Returns the specified account's list of branding resources (metadata). This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_consumer_disclosure_default(account_id, callback=callback_function) + >>> thread = api.get_brand_resources(account_id, brand_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str lang_code: Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). Additionally, the value can be set to `browser` to automatically detect the browser language being used by the viewer and display the disclosure in that language. - :return: ConsumerDisclosure + :param str brand_id: The unique identifier of a brand. (required) + :return: BrandResourcesList If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_consumer_disclosure_default_with_http_info(account_id, **kwargs) + return self.get_brand_resources_with_http_info(account_id, brand_id, **kwargs) else: - (data) = self.get_consumer_disclosure_default_with_http_info(account_id, **kwargs) + (data) = self.get_brand_resources_with_http_info(account_id, brand_id, **kwargs) return data - def get_consumer_disclosure_default_with_http_info(self, account_id, **kwargs): + def get_brand_resources_with_http_info(self, account_id, brand_id, **kwargs): """ - Gets the Electronic Record and Signature Disclosure for the account. - Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure. + Returns the specified account's list of branding resources (metadata). This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_consumer_disclosure_default_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_brand_resources_with_http_info(account_id, brand_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str lang_code: Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). Additionally, the value can be set to `browser` to automatically detect the browser language being used by the viewer and display the disclosure in that language. - :return: ConsumerDisclosure + :param str brand_id: The unique identifier of a brand. (required) + :return: BrandResourcesList If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'lang_code'] + all_params = ['account_id', 'brand_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2810,25 +3139,28 @@ def get_consumer_disclosure_default_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_consumer_disclosure_default" % key + " to method get_brand_resources" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_consumer_disclosure_default`") + raise ValueError("Missing the required parameter `account_id` when calling `get_brand_resources`") + # verify the required parameter 'brand_id' is set + if ('brand_id' not in params) or (params['brand_id'] is None): + raise ValueError("Missing the required parameter `brand_id` when calling `get_brand_resources`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/consumer_disclosure'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}/resources'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] + if 'brand_id' in params: + path_params['brandId'] = params['brand_id'] query_params = {} - if 'lang_code' in params: - query_params['langCode'] = params['lang_code'] header_params = {} @@ -2850,7 +3182,7 @@ def get_consumer_disclosure_default_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='ConsumerDisclosure', + response_type='BrandResourcesList', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2858,51 +3190,59 @@ def get_consumer_disclosure_default_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_e_note_configuration(self, account_id, **kwargs): + def get_brand_resources_by_content_type(self, account_id, brand_id, resource_content_type, **kwargs): """ - Returns the configuration information for the eNote eOriginal integration. + Returns the specified branding resource file. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_e_note_configuration(account_id, callback=callback_function) + >>> thread = api.get_brand_resources_by_content_type(account_id, brand_id, resource_content_type, callback=callback_function) :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: ENoteConfiguration + :param str brand_id: The unique identifier of a brand. (required) + :param str resource_content_type: (required) + :param str langcode: + :param str return_master: + :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_e_note_configuration_with_http_info(account_id, **kwargs) + return self.get_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type, **kwargs) else: - (data) = self.get_e_note_configuration_with_http_info(account_id, **kwargs) + (data) = self.get_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type, **kwargs) return data - def get_e_note_configuration_with_http_info(self, account_id, **kwargs): + def get_brand_resources_by_content_type_with_http_info(self, account_id, brand_id, resource_content_type, **kwargs): """ - Returns the configuration information for the eNote eOriginal integration. + Returns the specified branding resource file. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_e_note_configuration_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type, callback=callback_function) :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: ENoteConfiguration + :param str brand_id: The unique identifier of a brand. (required) + :param str resource_content_type: (required) + :param str langcode: + :param str return_master: + :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id'] + all_params = ['account_id', 'brand_id', 'resource_content_type', 'langcode', 'return_master'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2913,23 +3253,37 @@ def get_e_note_configuration_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_e_note_configuration" % key + " to method get_brand_resources_by_content_type" % 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_e_note_configuration`") + raise ValueError("Missing the required parameter `account_id` when calling `get_brand_resources_by_content_type`") + # verify the required parameter 'brand_id' is set + if ('brand_id' not in params) or (params['brand_id'] is None): + raise ValueError("Missing the required parameter `brand_id` when calling `get_brand_resources_by_content_type`") + # verify the required parameter 'resource_content_type' is set + if ('resource_content_type' not in params) or (params['resource_content_type'] is None): + raise ValueError("Missing the required parameter `resource_content_type` when calling `get_brand_resources_by_content_type`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/settings/enote_configuration'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] + if 'brand_id' in params: + path_params['brandId'] = params['brand_id'] + if 'resource_content_type' in params: + path_params['resourceContentType'] = params['resource_content_type'] query_params = {} + if 'langcode' in params: + query_params['langcode'] = params['langcode'] + if 'return_master' in params: + query_params['return_master'] = params['return_master'] header_params = {} @@ -2951,7 +3305,7 @@ def get_e_note_configuration_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='ENoteConfiguration', + response_type=None, auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2959,51 +3313,55 @@ def get_e_note_configuration_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_envelope_purge_configuration(self, account_id, **kwargs): + def get_consumer_disclosure(self, account_id, lang_code, **kwargs): """ - Select envelope purge configuration. + Gets the Electronic Record and Signature Disclosure. + Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_envelope_purge_configuration(account_id, callback=callback_function) + >>> thread = api.get_consumer_disclosure(account_id, lang_code, callback=callback_function) :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: EnvelopePurgeConfiguration + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :return: ConsumerDisclosure If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_envelope_purge_configuration_with_http_info(account_id, **kwargs) + return self.get_consumer_disclosure_with_http_info(account_id, lang_code, **kwargs) else: - (data) = self.get_envelope_purge_configuration_with_http_info(account_id, **kwargs) + (data) = self.get_consumer_disclosure_with_http_info(account_id, lang_code, **kwargs) return data - def get_envelope_purge_configuration_with_http_info(self, account_id, **kwargs): + def get_consumer_disclosure_with_http_info(self, account_id, lang_code, **kwargs): """ - Select envelope purge configuration. + Gets the Electronic Record and Signature Disclosure. + Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_envelope_purge_configuration_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_consumer_disclosure_with_http_info(account_id, lang_code, callback=callback_function) :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: EnvelopePurgeConfiguration + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :return: ConsumerDisclosure If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id'] + all_params = ['account_id', 'lang_code'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3014,21 +3372,26 @@ def get_envelope_purge_configuration_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_envelope_purge_configuration" % key + " to method get_consumer_disclosure" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_envelope_purge_configuration`") + raise ValueError("Missing the required parameter `account_id` when calling `get_consumer_disclosure`") + # verify the required parameter 'lang_code' is set + if ('lang_code' not in params) or (params['lang_code'] is None): + raise ValueError("Missing the required parameter `lang_code` when calling `get_consumer_disclosure`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/settings/envelope_purge_configuration'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] + if 'lang_code' in params: + path_params['langCode'] = params['lang_code'] query_params = {} @@ -3052,7 +3415,7 @@ def get_envelope_purge_configuration_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='EnvelopePurgeConfiguration', + response_type='ConsumerDisclosure', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3060,51 +3423,55 @@ def get_envelope_purge_configuration_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_favorite_templates(self, account_id, **kwargs): + def get_consumer_disclosure_default(self, account_id, **kwargs): """ - Retrieves the list of favorited templates for this caller + Gets the Electronic Record and Signature Disclosure for the account. + Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_favorite_templates(account_id, callback=callback_function) + >>> thread = api.get_consumer_disclosure_default(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: FavoriteTemplatesInfo + :param str lang_code: Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). Additionally, the value can be set to `browser` to automatically detect the browser language being used by the viewer and display the disclosure in that language. + :return: ConsumerDisclosure If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_favorite_templates_with_http_info(account_id, **kwargs) + return self.get_consumer_disclosure_default_with_http_info(account_id, **kwargs) else: - (data) = self.get_favorite_templates_with_http_info(account_id, **kwargs) + (data) = self.get_consumer_disclosure_default_with_http_info(account_id, **kwargs) return data - def get_favorite_templates_with_http_info(self, account_id, **kwargs): + def get_consumer_disclosure_default_with_http_info(self, account_id, **kwargs): """ - Retrieves the list of favorited templates for this caller + Gets the Electronic Record and Signature Disclosure for the account. + Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_favorite_templates_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_consumer_disclosure_default_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: FavoriteTemplatesInfo + :param str lang_code: Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). Additionally, the value can be set to `browser` to automatically detect the browser language being used by the viewer and display the disclosure in that language. + :return: ConsumerDisclosure If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id'] + all_params = ['account_id', 'lang_code'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3115,23 +3482,25 @@ def get_favorite_templates_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_favorite_templates" % key + " to method get_consumer_disclosure_default" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_favorite_templates`") + raise ValueError("Missing the required parameter `account_id` when calling `get_consumer_disclosure_default`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/favorite_templates'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/consumer_disclosure'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] query_params = {} + if 'lang_code' in params: + query_params['langCode'] = params['lang_code'] header_params = {} @@ -3153,7 +3522,7 @@ def get_favorite_templates_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='FavoriteTemplatesInfo', + response_type='ConsumerDisclosure', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3161,46 +3530,46 @@ def get_favorite_templates_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_notification_defaults(self, account_id, **kwargs): + def get_e_note_configuration(self, account_id, **kwargs): """ - Returns default user level settings for a specified account + Returns the configuration information for the eNote eOriginal integration. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_notification_defaults(account_id, callback=callback_function) + >>> thread = api.get_e_note_configuration(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: NotificationDefaults + :return: ENoteConfiguration If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_notification_defaults_with_http_info(account_id, **kwargs) + return self.get_e_note_configuration_with_http_info(account_id, **kwargs) else: - (data) = self.get_notification_defaults_with_http_info(account_id, **kwargs) + (data) = self.get_e_note_configuration_with_http_info(account_id, **kwargs) return data - def get_notification_defaults_with_http_info(self, account_id, **kwargs): + def get_e_note_configuration_with_http_info(self, account_id, **kwargs): """ - Returns default user level settings for a specified account + Returns the configuration information for the eNote eOriginal integration. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_notification_defaults_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_e_note_configuration_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: NotificationDefaults + :return: ENoteConfiguration If the method is called asynchronously, returns the request thread. """ @@ -3216,18 +3585,18 @@ def get_notification_defaults_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_notification_defaults" % key + " to method get_e_note_configuration" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_notification_defaults`") + raise ValueError("Missing the required parameter `account_id` when calling `get_e_note_configuration`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/settings/notification_defaults'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/settings/enote_configuration'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -3254,7 +3623,7 @@ def get_notification_defaults_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='NotificationDefaults', + response_type='ENoteConfiguration', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3262,46 +3631,46 @@ def get_notification_defaults_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_password_rules(self, account_id, **kwargs): + def get_envelope_purge_configuration(self, account_id, **kwargs): """ - Get the password rules + Select envelope purge configuration. This method makes a synchronous HTTP request by default. To make 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_password_rules(account_id, callback=callback_function) + >>> thread = api.get_envelope_purge_configuration(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: AccountPasswordRules + :return: EnvelopePurgeConfiguration If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_password_rules_with_http_info(account_id, **kwargs) + return self.get_envelope_purge_configuration_with_http_info(account_id, **kwargs) else: - (data) = self.get_password_rules_with_http_info(account_id, **kwargs) + (data) = self.get_envelope_purge_configuration_with_http_info(account_id, **kwargs) return data - def get_password_rules_with_http_info(self, account_id, **kwargs): + def get_envelope_purge_configuration_with_http_info(self, account_id, **kwargs): """ - Get the password rules + Select envelope purge configuration. This method makes a synchronous HTTP request by default. To make 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_password_rules_with_http_info(account_id, callback=callback_function) + >>> thread = api.get_envelope_purge_configuration_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: AccountPasswordRules + :return: EnvelopePurgeConfiguration If the method is called asynchronously, returns the request thread. """ @@ -3317,18 +3686,18 @@ def get_password_rules_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_password_rules" % key + " to method get_envelope_purge_configuration" % 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_password_rules`") + raise ValueError("Missing the required parameter `account_id` when calling `get_envelope_purge_configuration`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/settings/password_rules'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/settings/envelope_purge_configuration'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -3355,7 +3724,310 @@ def get_password_rules_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='AccountPasswordRules', + response_type='EnvelopePurgeConfiguration', + 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_favorite_templates(self, account_id, **kwargs): + """ + Retrieves the list of favorited templates for this caller + This method makes a synchronous HTTP request by default. To make 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_favorite_templates(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: FavoriteTemplatesInfo + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_favorite_templates_with_http_info(account_id, **kwargs) + else: + (data) = self.get_favorite_templates_with_http_info(account_id, **kwargs) + return data + + def get_favorite_templates_with_http_info(self, account_id, **kwargs): + """ + Retrieves the list of favorited templates for this caller + This method makes a synchronous HTTP request by default. To make 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_favorite_templates_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: FavoriteTemplatesInfo + 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_favorite_templates" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_favorite_templates`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/favorite_templates'.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='FavoriteTemplatesInfo', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_notification_defaults(self, account_id, **kwargs): + """ + Returns default user level settings for a specified account + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_notification_defaults(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: NotificationDefaults + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_notification_defaults_with_http_info(account_id, **kwargs) + else: + (data) = self.get_notification_defaults_with_http_info(account_id, **kwargs) + return data + + def get_notification_defaults_with_http_info(self, account_id, **kwargs): + """ + Returns default user level settings for a specified account + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_notification_defaults_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: NotificationDefaults + 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_notification_defaults" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_notification_defaults`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/settings/notification_defaults'.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='NotificationDefaults', + 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_password_rules(self, account_id, **kwargs): + """ + Get the password rules + This method makes a synchronous HTTP request by default. To make 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_password_rules(account_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :return: AccountPasswordRules + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_password_rules_with_http_info(account_id, **kwargs) + else: + (data) = self.get_password_rules_with_http_info(account_id, **kwargs) + return data + + def get_password_rules_with_http_info(self, account_id, **kwargs): + """ + Get the password rules + This method makes a synchronous HTTP request by default. To make 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_password_rules_with_http_info(account_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :return: AccountPasswordRules + 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_password_rules" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_password_rules`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/settings/password_rules'.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='AccountPasswordRules', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3365,42 +4037,249 @@ def get_password_rules_with_http_info(self, account_id, **kwargs): def get_password_rules_0(self, **kwargs): """ - Get membership account password rules + Get membership account password rules + This method makes a synchronous HTTP request by default. To make 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_password_rules_0(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: UserPasswordRules + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_password_rules_0_with_http_info(**kwargs) + else: + (data) = self.get_password_rules_0_with_http_info(**kwargs) + return data + + def get_password_rules_0_with_http_info(self, **kwargs): + """ + Get membership account password rules + This method makes a synchronous HTTP request by default. To make 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_password_rules_0_with_http_info(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: UserPasswordRules + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_password_rules_0" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + resource_path = '/v2.1/current_user/password_rules'.replace('{format}', 'json') + path_params = {} + + query_params = {} + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(resource_path, 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='UserPasswordRules', + 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_permission_profile(self, account_id, permission_profile_id, **kwargs): + """ + Returns a permissions profile in the specified account. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_permission_profile(account_id, permission_profile_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str permission_profile_id: (required) + :param str include: + :return: PermissionProfile + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_permission_profile_with_http_info(account_id, permission_profile_id, **kwargs) + else: + (data) = self.get_permission_profile_with_http_info(account_id, permission_profile_id, **kwargs) + return data + + def get_permission_profile_with_http_info(self, account_id, permission_profile_id, **kwargs): + """ + Returns a permissions profile in the specified account. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_permission_profile_with_http_info(account_id, permission_profile_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str permission_profile_id: (required) + :param str include: + :return: PermissionProfile + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'permission_profile_id', 'include'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_permission_profile" % 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_permission_profile`") + # verify the required parameter 'permission_profile_id' is set + if ('permission_profile_id' not in params) or (params['permission_profile_id'] is None): + raise ValueError("Missing the required parameter `permission_profile_id` when calling `get_permission_profile`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}'.replace('{format}', 'json') + path_params = {} + if 'account_id' in params: + path_params['accountId'] = params['account_id'] + if 'permission_profile_id' in params: + path_params['permissionProfileId'] = params['permission_profile_id'] + + query_params = {} + if 'include' in params: + query_params['include'] = params['include'] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(resource_path, 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='PermissionProfile', + 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_provisioning(self, **kwargs): + """ + Retrieves the account provisioning information for the account. + Retrieves the account provisioning information for the account. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_password_rules_0(callback=callback_function) + >>> thread = api.get_provisioning(callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :return: UserPasswordRules + :return: ProvisioningInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_password_rules_0_with_http_info(**kwargs) + return self.get_provisioning_with_http_info(**kwargs) else: - (data) = self.get_password_rules_0_with_http_info(**kwargs) + (data) = self.get_provisioning_with_http_info(**kwargs) return data - def get_password_rules_0_with_http_info(self, **kwargs): + def get_provisioning_with_http_info(self, **kwargs): """ - Get membership account password rules + Retrieves the account provisioning information for the account. + Retrieves the account provisioning information for the account. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_password_rules_0_with_http_info(callback=callback_function) + >>> thread = api.get_provisioning_with_http_info(callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :return: UserPasswordRules + :return: ProvisioningInformation If the method is called asynchronously, returns the request thread. """ @@ -3416,14 +4295,14 @@ def get_password_rules_0_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_password_rules_0" % key + " to method get_provisioning" % key ) params[key] = val del params['kwargs'] collection_formats = {} - resource_path = '/v2.1/current_user/password_rules'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/provisioning'.replace('{format}', 'json') path_params = {} query_params = {} @@ -3448,7 +4327,7 @@ def get_password_rules_0_with_http_info(self, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='UserPasswordRules', + response_type='ProvisioningInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3456,55 +4335,53 @@ def get_password_rules_0_with_http_info(self, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_permission_profile(self, account_id, permission_profile_id, **kwargs): + def get_report_in_product(self, account_id, id, **kwargs): """ - Returns a permissions profile in the specified account. + 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_permission_profile(account_id, permission_profile_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) - :param str permission_profile_id: (required) - :param str include: - :return: PermissionProfile + :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_permission_profile_with_http_info(account_id, permission_profile_id, **kwargs) + return self.get_report_in_product_with_http_info(account_id, id, **kwargs) else: - (data) = self.get_permission_profile_with_http_info(account_id, permission_profile_id, **kwargs) + (data) = self.get_report_in_product_with_http_info(account_id, id, **kwargs) return data - def get_permission_profile_with_http_info(self, account_id, permission_profile_id, **kwargs): + def get_report_in_product_with_http_info(self, account_id, id, **kwargs): """ - Returns a permissions profile in the specified account. + 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_permission_profile_with_http_info(account_id, permission_profile_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) - :param str permission_profile_id: (required) - :param str include: - :return: PermissionProfile + :param str id: (required) + :return: ReportInProductGet If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'permission_profile_id', 'include'] + all_params = ['account_id', 'id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3515,30 +4392,28 @@ def get_permission_profile_with_http_info(self, account_id, permission_profile_i if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_permission_profile" % 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_permission_profile`") - # verify the required parameter 'permission_profile_id' is set - if ('permission_profile_id' not in params) or (params['permission_profile_id'] is None): - raise ValueError("Missing the required parameter `permission_profile_id` when calling `get_permission_profile`") + 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}/permission_profiles/{permissionProfileId}'.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 'permission_profile_id' in params: - path_params['permissionProfileId'] = params['permission_profile_id'] + if 'id' in params: + path_params['id'] = params['id'] query_params = {} - if 'include' in params: - query_params['include'] = params['include'] header_params = {} @@ -3560,7 +4435,7 @@ def get_permission_profile_with_http_info(self, account_id, permission_profile_i body=body_params, post_params=form_params, files=local_var_files, - response_type='PermissionProfile', + response_type='ReportInProductGet', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3568,51 +4443,51 @@ def get_permission_profile_with_http_info(self, account_id, permission_profile_i _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_provisioning(self, **kwargs): + def get_report_in_product_list(self, account_id, **kwargs): """ - Retrieves the account provisioning information for the account. - Retrieves the account provisioning information for the account. + 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_provisioning(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) - :return: ProvisioningInformation + :param str account_id: The external account number (int) or account ID Guid. (required) + :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_provisioning_with_http_info(**kwargs) + return self.get_report_in_product_list_with_http_info(account_id, **kwargs) else: - (data) = self.get_provisioning_with_http_info(**kwargs) + (data) = self.get_report_in_product_list_with_http_info(account_id, **kwargs) return data - def get_provisioning_with_http_info(self, **kwargs): + def get_report_in_product_list_with_http_info(self, account_id, **kwargs): """ - Retrieves the account provisioning information for the account. - Retrieves the account provisioning information for the account. + 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_provisioning_with_http_info(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) - :return: ProvisioningInformation + :param str account_id: The external account number (int) or account ID Guid. (required) + :return: ReportInProductList If the method is called asynchronously, returns the request thread. """ - all_params = [] + all_params = ['account_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3623,15 +4498,122 @@ def get_provisioning_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_provisioning" % 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_report_in_product_list`") + + + 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 + # 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='ReportInProductList', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_supported_languages(self, account_id, **kwargs): + """ + Gets list of supported languages for recipient language setting. + This method makes a synchronous HTTP request by default. To make 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) + + :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 + 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) + else: + (data) = self.get_supported_languages_with_http_info(account_id, **kwargs) + return data + + def get_supported_languages_with_http_info(self, account_id, **kwargs): + """ + 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_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) + :return: SupportedLanguages + 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_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_supported_languages`") + collection_formats = {} - resource_path = '/v2.1/accounts/provisioning'.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'] query_params = {} @@ -3655,7 +4637,7 @@ def get_provisioning_with_http_info(self, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='ProvisioningInformation', + response_type='SupportedLanguages', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3663,53 +4645,51 @@ def get_provisioning_with_http_info(self, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_report_in_product(self, account_id, id, **kwargs): + def get_watermark(self, account_id, **kwargs): """ - Gets the specified report + 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_report_in_product(account_id, 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 id: (required) - :return: ReportInProductGet + :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_report_in_product_with_http_info(account_id, id, **kwargs) + return self.get_watermark_with_http_info(account_id, **kwargs) else: - (data) = self.get_report_in_product_with_http_info(account_id, id, **kwargs) + (data) = self.get_watermark_with_http_info(account_id, **kwargs) return data - def get_report_in_product_with_http_info(self, account_id, id, **kwargs): + def get_watermark_with_http_info(self, account_id, **kwargs): """ - Gets the specified report + 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_report_in_product_with_http_info(account_id, id, callback=callback_function) + >>> 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) - :param str id: (required) - :return: ReportInProductGet + :return: Watermark If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'id'] + all_params = ['account_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3720,26 +4700,21 @@ def get_report_in_product_with_http_info(self, account_id, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_report_in_product" % key + " 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_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`") + raise ValueError("Missing the required parameter `account_id` when calling `get_watermark`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/reports/{id}'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/watermark'.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 = {} @@ -3763,7 +4738,7 @@ def get_report_in_product_with_http_info(self, account_id, id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='ReportInProductGet', + response_type='Watermark', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3771,51 +4746,53 @@ def get_report_in_product_with_http_info(self, account_id, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_report_in_product_list(self, account_id, **kwargs): + def get_watermark_preview(self, account_id, **kwargs): """ - Gets the descriptors for all of an account's active reports (for listings) + 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_report_in_product_list(account_id, callback=callback_function) + >>> 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) - :return: ReportInProductList + :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_report_in_product_list_with_http_info(account_id, **kwargs) + return self.get_watermark_preview_with_http_info(account_id, **kwargs) else: - (data) = self.get_report_in_product_list_with_http_info(account_id, **kwargs) + (data) = self.get_watermark_preview_with_http_info(account_id, **kwargs) return data - def get_report_in_product_list_with_http_info(self, account_id, **kwargs): + def get_watermark_preview_with_http_info(self, account_id, **kwargs): """ - Gets the descriptors for all of an account's active reports (for listings) + 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_report_in_product_list_with_http_info(account_id, callback=callback_function) + >>> 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) - :return: ReportInProductList + :param Watermark watermark: + :return: Watermark If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id'] + all_params = ['account_id', 'watermark'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3826,18 +4803,18 @@ def get_report_in_product_list_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_report_in_product_list" % key + " 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_report_in_product_list`") + raise ValueError("Missing the required parameter `account_id` when calling `get_watermark_preview`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/reports'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/watermark/preview'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -3850,6 +4827,8 @@ def get_report_in_product_list_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']) @@ -3857,14 +4836,14 @@ def get_report_in_product_list_with_http_info(self, account_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + return self.api_client.call_api(resource_path, 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ReportInProductList', + response_type='Watermark', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3872,51 +4851,57 @@ def get_report_in_product_list_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_supported_languages(self, account_id, **kwargs): + def list_brands(self, account_id, **kwargs): """ - Gets list of supported languages for recipient language setting. + 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.get_supported_languages(account_id, callback=callback_function) + >>> 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) - :return: SupportedLanguages + :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.get_supported_languages_with_http_info(account_id, **kwargs) + return self.list_brands_with_http_info(account_id, **kwargs) else: - (data) = self.get_supported_languages_with_http_info(account_id, **kwargs) + (data) = self.list_brands_with_http_info(account_id, **kwargs) return data - def get_supported_languages_with_http_info(self, account_id, **kwargs): + def list_brands_with_http_info(self, account_id, **kwargs): """ - Gets list of supported languages for recipient language setting. + 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.get_supported_languages_with_http_info(account_id, callback=callback_function) + >>> thread = api.list_brands_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: SupportedLanguages + :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. """ - all_params = ['account_id'] + all_params = ['account_id', 'exclude_distributor_brand', 'include_logos'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3927,23 +4912,27 @@ 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 list_brands" % 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 `list_brands`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/supported_languages'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/brands'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] query_params = {} + if 'exclude_distributor_brand' in params: + query_params['exclude_distributor_brand'] = params['exclude_distributor_brand'] + if 'include_logos' in params: + query_params['include_logos'] = params['include_logos'] header_params = {} @@ -3965,7 +4954,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='BrandsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3973,46 +4962,48 @@ 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 list_custom_fields(self, account_id, **kwargs): """ - Get watermark information. + Gets a list of custom fields associated with the account. + Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide. This method makes a synchronous HTTP request by default. To make 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.list_custom_fields(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: CustomFields 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.list_custom_fields_with_http_info(account_id, **kwargs) else: - (data) = self.get_watermark_with_http_info(account_id, **kwargs) + (data) = self.list_custom_fields_with_http_info(account_id, **kwargs) return data - def get_watermark_with_http_info(self, account_id, **kwargs): + def list_custom_fields_with_http_info(self, account_id, **kwargs): """ - Get watermark information. + Gets a list of custom fields associated with the account. + Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide. This method makes a synchronous HTTP request by default. To make 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.list_custom_fields_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: CustomFields If the method is called asynchronously, returns the request thread. """ @@ -4028,18 +5019,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 list_custom_fields" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_watermark`") + raise ValueError("Missing the required parameter `account_id` when calling `list_custom_fields`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/watermark'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/custom_fields'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -4066,7 +5057,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='CustomFields', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4074,53 +5065,55 @@ 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 list_permissions(self, account_id, **kwargs): """ - Get watermark preview. + Gets a list of permission profiles. + Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console. This method makes a synchronous HTTP request by default. To make 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.list_permissions(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 + :param str include: + :return: PermissionProfileInformation 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.list_permissions_with_http_info(account_id, **kwargs) else: - (data) = self.get_watermark_preview_with_http_info(account_id, **kwargs) + (data) = self.list_permissions_with_http_info(account_id, **kwargs) return data - def get_watermark_preview_with_http_info(self, account_id, **kwargs): + def list_permissions_with_http_info(self, account_id, **kwargs): """ - Get watermark preview. + Gets a list of permission profiles. + Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console. This method makes a synchronous HTTP request by default. To make 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.list_permissions_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 + :param str include: + :return: PermissionProfileInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'watermark'] + all_params = ['account_id', 'include'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4131,23 +5124,25 @@ 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 list_permissions" % 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 `list_permissions`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/watermark/preview'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/permission_profiles'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] query_params = {} + if 'include' in params: + query_params['include'] = params['include'] header_params = {} @@ -4155,8 +5150,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']) @@ -4164,14 +5157,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='PermissionProfileInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4179,57 +5172,55 @@ 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 list_recipient_names_by_email(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. + Gets recipient names associated with an email address. + Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query 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.list_brands(account_id, callback=callback_function) + >>> thread = api.list_recipient_names_by_email(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 + :param str email: The email address for the user + :return: RecipientNamesResponse 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.list_recipient_names_by_email_with_http_info(account_id, **kwargs) else: - (data) = self.list_brands_with_http_info(account_id, **kwargs) + (data) = self.list_recipient_names_by_email_with_http_info(account_id, **kwargs) return data - def list_brands_with_http_info(self, account_id, **kwargs): + def list_recipient_names_by_email_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. + Gets recipient names associated with an email address. + Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query 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.list_brands_with_http_info(account_id, callback=callback_function) + >>> thread = api.list_recipient_names_by_email_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 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 + :param str email: The email address for the user + :return: RecipientNamesResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'exclude_distributor_brand', 'include_logos'] + all_params = ['account_id', 'email'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4240,27 +5231,25 @@ def list_brands_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_brands" % key + " to method list_recipient_names_by_email" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `list_brands`") + raise ValueError("Missing the required parameter `account_id` when calling `list_recipient_names_by_email`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/brands'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/recipient_names'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] query_params = {} - if 'exclude_distributor_brand' in params: - query_params['exclude_distributor_brand'] = params['exclude_distributor_brand'] - if 'include_logos' in params: - query_params['include_logos'] = params['include_logos'] + if 'email' in params: + query_params['email'] = params['email'] header_params = {} @@ -4282,7 +5271,7 @@ def list_brands_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='BrandsResponse', + response_type='RecipientNamesResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4290,48 +5279,48 @@ def list_brands_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_custom_fields(self, account_id, **kwargs): + def list_settings(self, account_id, **kwargs): """ - Gets a list of custom fields associated with the account. - Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide. + Gets account settings information. + Retrieves the account settings information for the specified account. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.list_custom_fields(account_id, callback=callback_function) + >>> thread = api.list_settings(account_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :return: CustomFields + :return: AccountSettingsInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.list_custom_fields_with_http_info(account_id, **kwargs) + return self.list_settings_with_http_info(account_id, **kwargs) else: - (data) = self.list_custom_fields_with_http_info(account_id, **kwargs) + (data) = self.list_settings_with_http_info(account_id, **kwargs) return data - def list_custom_fields_with_http_info(self, account_id, **kwargs): + def list_settings_with_http_info(self, account_id, **kwargs): """ - Gets a list of custom fields associated with the account. - Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide. + Gets account settings information. + Retrieves the account settings information for the specified account. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.list_custom_fields_with_http_info(account_id, callback=callback_function) + >>> thread = api.list_settings_with_http_info(account_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :return: CustomFields + :return: AccountSettingsInformation If the method is called asynchronously, returns the request thread. """ @@ -4347,18 +5336,18 @@ def list_custom_fields_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_custom_fields" % key + " to method list_settings" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `list_custom_fields`") + raise ValueError("Missing the required parameter `account_id` when calling `list_settings`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/custom_fields'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/settings'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -4385,7 +5374,7 @@ def list_custom_fields_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='CustomFields', + response_type='AccountSettingsInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4393,55 +5382,69 @@ def list_custom_fields_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_permissions(self, account_id, **kwargs): + def list_shared_access(self, account_id, **kwargs): """ - Gets a list of permission profiles. - Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console. + Reserved: Gets the shared item status for one or more users. + Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from. This method makes a synchronous HTTP request by default. To make 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_permissions(account_id, callback=callback_function) + >>> thread = api.list_shared_access(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 include: - :return: PermissionProfileInformation + :param str count: Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000. + :param str envelopes_not_shared_user_status: + :param str folder_ids: + :param str item_type: Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users. + :param str search_text: This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string. + :param str shared: Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user + :param str start_position: If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0. + :param str user_ids: A comma separated list of userIds for whom the shared item information is being requested. + :return: AccountSharedAccess If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.list_permissions_with_http_info(account_id, **kwargs) + return self.list_shared_access_with_http_info(account_id, **kwargs) else: - (data) = self.list_permissions_with_http_info(account_id, **kwargs) + (data) = self.list_shared_access_with_http_info(account_id, **kwargs) return data - def list_permissions_with_http_info(self, account_id, **kwargs): + def list_shared_access_with_http_info(self, account_id, **kwargs): """ - Gets a list of permission profiles. - Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console. + Reserved: Gets the shared item status for one or more users. + Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from. This method makes a synchronous HTTP request by default. To make 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_permissions_with_http_info(account_id, callback=callback_function) + >>> thread = api.list_shared_access_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 include: - :return: PermissionProfileInformation + :param str count: Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000. + :param str envelopes_not_shared_user_status: + :param str folder_ids: + :param str item_type: Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users. + :param str search_text: This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string. + :param str shared: Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user + :param str start_position: If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0. + :param str user_ids: A comma separated list of userIds for whom the shared item information is being requested. + :return: AccountSharedAccess If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'include'] + all_params = ['account_id', 'count', 'envelopes_not_shared_user_status', 'folder_ids', 'item_type', 'search_text', 'shared', 'start_position', 'user_ids'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4452,25 +5455,39 @@ def list_permissions_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_permissions" % key + " to method list_shared_access" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `list_permissions`") + raise ValueError("Missing the required parameter `account_id` when calling `list_shared_access`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/permission_profiles'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/shared_access'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] query_params = {} - if 'include' in params: - query_params['include'] = params['include'] + if 'count' in params: + query_params['count'] = params['count'] + if 'envelopes_not_shared_user_status' in params: + query_params['envelopes_not_shared_user_status'] = params['envelopes_not_shared_user_status'] + if 'folder_ids' in params: + query_params['folder_ids'] = params['folder_ids'] + if 'item_type' in params: + query_params['item_type'] = params['item_type'] + if 'search_text' in params: + query_params['search_text'] = params['search_text'] + if 'shared' in params: + query_params['shared'] = params['shared'] + if 'start_position' in params: + query_params['start_position'] = params['start_position'] + if 'user_ids' in params: + query_params['user_ids'] = params['user_ids'] header_params = {} @@ -4492,7 +5509,7 @@ def list_permissions_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='PermissionProfileInformation', + response_type='AccountSharedAccess', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4500,55 +5517,51 @@ def list_permissions_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_recipient_names_by_email(self, account_id, **kwargs): + def list_signature_providers(self, account_id, **kwargs): """ - Gets recipient names associated with an email address. - Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string. + Returns Account available signature providers for specified account. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.list_recipient_names_by_email(account_id, callback=callback_function) + >>> thread = api.list_signature_providers(account_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str email: The email address for the user - :return: RecipientNamesResponse + :return: AccountSignatureProviders If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.list_recipient_names_by_email_with_http_info(account_id, **kwargs) + return self.list_signature_providers_with_http_info(account_id, **kwargs) else: - (data) = self.list_recipient_names_by_email_with_http_info(account_id, **kwargs) + (data) = self.list_signature_providers_with_http_info(account_id, **kwargs) return data - def list_recipient_names_by_email_with_http_info(self, account_id, **kwargs): + def list_signature_providers_with_http_info(self, account_id, **kwargs): """ - Gets recipient names associated with an email address. - Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string. + Returns Account available signature providers for specified account. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.list_recipient_names_by_email_with_http_info(account_id, callback=callback_function) + >>> thread = api.list_signature_providers_with_http_info(account_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str email: The email address for the user - :return: RecipientNamesResponse + :return: AccountSignatureProviders If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'email'] + all_params = ['account_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4559,25 +5572,23 @@ def list_recipient_names_by_email_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_recipient_names_by_email" % key + " to method list_signature_providers" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `list_recipient_names_by_email`") + raise ValueError("Missing the required parameter `account_id` when calling `list_signature_providers`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/recipient_names'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/signatureProviders'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] query_params = {} - if 'email' in params: - query_params['email'] = params['email'] header_params = {} @@ -4599,7 +5610,7 @@ def list_recipient_names_by_email_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='RecipientNamesResponse', + response_type='AccountSignatureProviders', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4607,48 +5618,48 @@ def list_recipient_names_by_email_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_settings(self, account_id, **kwargs): + def list_unsupported_file_types(self, account_id, **kwargs): """ - Gets account settings information. - Retrieves the account settings information for the specified account. + Gets a list of unsupported file types. + Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system. This method makes a synchronous HTTP request by default. To make 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_settings(account_id, callback=callback_function) + >>> thread = api.list_unsupported_file_types(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: AccountSettingsInformation + :return: FileTypeList If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.list_settings_with_http_info(account_id, **kwargs) + return self.list_unsupported_file_types_with_http_info(account_id, **kwargs) else: - (data) = self.list_settings_with_http_info(account_id, **kwargs) + (data) = self.list_unsupported_file_types_with_http_info(account_id, **kwargs) return data - def list_settings_with_http_info(self, account_id, **kwargs): + def list_unsupported_file_types_with_http_info(self, account_id, **kwargs): """ - Gets account settings information. - Retrieves the account settings information for the specified account. + Gets a list of unsupported file types. + Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system. This method makes a synchronous HTTP request by default. To make 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_settings_with_http_info(account_id, callback=callback_function) + >>> thread = api.list_unsupported_file_types_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: AccountSettingsInformation + :return: FileTypeList If the method is called asynchronously, returns the request thread. """ @@ -4664,18 +5675,18 @@ def list_settings_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_settings" % key + " to method list_unsupported_file_types" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `list_settings`") + raise ValueError("Missing the required parameter `account_id` when calling `list_unsupported_file_types`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/settings'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/unsupported_file_types'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -4702,7 +5713,7 @@ def list_settings_with_http_info(self, account_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='AccountSettingsInformation', + response_type='FileTypeList', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4710,69 +5721,53 @@ def list_settings_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_shared_access(self, account_id, **kwargs): + def un_favorite_template(self, account_id, **kwargs): """ - Reserved: Gets the shared item status for one or more users. - Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from. + Unfavorite 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.list_shared_access(account_id, callback=callback_function) + >>> thread = api.un_favorite_template(account_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str count: Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000. - :param str envelopes_not_shared_user_status: - :param str folder_ids: - :param str item_type: Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users. - :param str search_text: This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string. - :param str shared: Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user - :param str start_position: If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0. - :param str user_ids: A comma separated list of userIds for whom the shared item information is being requested. - :return: AccountSharedAccess + :param FavoriteTemplatesInfo favorite_templates_info: + :return: FavoriteTemplatesInfo If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.list_shared_access_with_http_info(account_id, **kwargs) + return self.un_favorite_template_with_http_info(account_id, **kwargs) else: - (data) = self.list_shared_access_with_http_info(account_id, **kwargs) + (data) = self.un_favorite_template_with_http_info(account_id, **kwargs) return data - def list_shared_access_with_http_info(self, account_id, **kwargs): + def un_favorite_template_with_http_info(self, account_id, **kwargs): """ - Reserved: Gets the shared item status for one or more users. - Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from. + Unfavorite 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.list_shared_access_with_http_info(account_id, callback=callback_function) + >>> thread = api.un_favorite_template_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 count: Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000. - :param str envelopes_not_shared_user_status: - :param str folder_ids: - :param str item_type: Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users. - :param str search_text: This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string. - :param str shared: Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user - :param str start_position: If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0. - :param str user_ids: A comma separated list of userIds for whom the shared item information is being requested. - :return: AccountSharedAccess + :param FavoriteTemplatesInfo favorite_templates_info: + :return: FavoriteTemplatesInfo If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'count', 'envelopes_not_shared_user_status', 'folder_ids', 'item_type', 'search_text', 'shared', 'start_position', 'user_ids'] + all_params = ['account_id', 'favorite_templates_info'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4783,39 +5778,23 @@ def list_shared_access_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_shared_access" % key + " to method un_favorite_template" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `list_shared_access`") + raise ValueError("Missing the required parameter `account_id` when calling `un_favorite_template`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/shared_access'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/favorite_templates'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] query_params = {} - if 'count' in params: - query_params['count'] = params['count'] - if 'envelopes_not_shared_user_status' in params: - query_params['envelopes_not_shared_user_status'] = params['envelopes_not_shared_user_status'] - if 'folder_ids' in params: - query_params['folder_ids'] = params['folder_ids'] - if 'item_type' in params: - query_params['item_type'] = params['item_type'] - if 'search_text' in params: - query_params['search_text'] = params['search_text'] - if 'shared' in params: - query_params['shared'] = params['shared'] - if 'start_position' in params: - query_params['start_position'] = params['start_position'] - if 'user_ids' in params: - query_params['user_ids'] = params['user_ids'] header_params = {} @@ -4823,6 +5802,8 @@ def list_shared_access_with_http_info(self, account_id, **kwargs): local_var_files = {} body_params = None + if 'favorite_templates_info' in params: + body_params = params['favorite_templates_info'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -4830,14 +5811,14 @@ def list_shared_access_with_http_info(self, account_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + return self.api_client.call_api(resource_path, 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AccountSharedAccess', + response_type='FavoriteTemplatesInfo', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4845,51 +5826,53 @@ def list_shared_access_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_signature_providers(self, account_id, **kwargs): + def update_account_signature(self, account_id, **kwargs): """ - Returns Account available signature providers for specified account. + Updates a account signature. This method makes a synchronous HTTP request by default. To make 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_signature_providers(account_id, callback=callback_function) + >>> thread = api.update_account_signature(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: AccountSignatureProviders + :param AccountSignaturesInformation account_signatures_information: + :return: AccountSignaturesInformation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.list_signature_providers_with_http_info(account_id, **kwargs) + return self.update_account_signature_with_http_info(account_id, **kwargs) else: - (data) = self.list_signature_providers_with_http_info(account_id, **kwargs) + (data) = self.update_account_signature_with_http_info(account_id, **kwargs) return data - def list_signature_providers_with_http_info(self, account_id, **kwargs): + def update_account_signature_with_http_info(self, account_id, **kwargs): """ - Returns Account available signature providers for specified account. + Updates a account signature. This method makes a synchronous HTTP request by default. To make 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_signature_providers_with_http_info(account_id, callback=callback_function) + >>> thread = api.update_account_signature_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: AccountSignatureProviders + :param AccountSignaturesInformation account_signatures_information: + :return: AccountSignaturesInformation If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id'] + all_params = ['account_id', 'account_signatures_information'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4900,18 +5883,18 @@ def list_signature_providers_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_signature_providers" % key + " to method update_account_signature" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `list_signature_providers`") + raise ValueError("Missing the required parameter `account_id` when calling `update_account_signature`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/signatureProviders'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/signatures'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] @@ -4924,6 +5907,8 @@ def list_signature_providers_with_http_info(self, account_id, **kwargs): local_var_files = {} body_params = None + if 'account_signatures_information' in params: + body_params = params['account_signatures_information'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -4931,14 +5916,14 @@ def list_signature_providers_with_http_info(self, account_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + return self.api_client.call_api(resource_path, 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AccountSignatureProviders', + response_type='AccountSignaturesInformation', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4946,53 +5931,57 @@ def list_signature_providers_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list_unsupported_file_types(self, account_id, **kwargs): + def update_account_signature_by_id(self, account_id, signature_id, **kwargs): """ - Gets a list of unsupported file types. - Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system. + Updates a account signature. This method makes a synchronous HTTP request by default. To make 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_unsupported_file_types(account_id, callback=callback_function) + >>> thread = api.update_account_signature_by_id(account_id, signature_id, callback=callback_function) :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: FileTypeList + :param str signature_id: The ID of the signature being accessed. (required) + :param str close_existing_signature: + :param AccountSignatureDefinition account_signature_definition: + :return: AccountSignature If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.list_unsupported_file_types_with_http_info(account_id, **kwargs) + return self.update_account_signature_by_id_with_http_info(account_id, signature_id, **kwargs) else: - (data) = self.list_unsupported_file_types_with_http_info(account_id, **kwargs) + (data) = self.update_account_signature_by_id_with_http_info(account_id, signature_id, **kwargs) return data - def list_unsupported_file_types_with_http_info(self, account_id, **kwargs): + def update_account_signature_by_id_with_http_info(self, account_id, signature_id, **kwargs): """ - Gets a list of unsupported file types. - Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system. + Updates a account signature. This method makes a synchronous HTTP request by default. To make 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_unsupported_file_types_with_http_info(account_id, callback=callback_function) + >>> thread = api.update_account_signature_by_id_with_http_info(account_id, signature_id, callback=callback_function) :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: FileTypeList + :param str signature_id: The ID of the signature being accessed. (required) + :param str close_existing_signature: + :param AccountSignatureDefinition account_signature_definition: + :return: AccountSignature If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id'] + all_params = ['account_id', 'signature_id', 'close_existing_signature', 'account_signature_definition'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5003,23 +5992,30 @@ def list_unsupported_file_types_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list_unsupported_file_types" % key + " to method update_account_signature_by_id" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `list_unsupported_file_types`") + raise ValueError("Missing the required parameter `account_id` when calling `update_account_signature_by_id`") + # verify the required parameter 'signature_id' is set + if ('signature_id' not in params) or (params['signature_id'] is None): + raise ValueError("Missing the required parameter `signature_id` when calling `update_account_signature_by_id`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/unsupported_file_types'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/signatures/{signatureId}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] + if 'signature_id' in params: + path_params['signatureId'] = params['signature_id'] query_params = {} + if 'close_existing_signature' in params: + query_params['close_existing_signature'] = params['close_existing_signature'] header_params = {} @@ -5027,6 +6023,8 @@ def list_unsupported_file_types_with_http_info(self, account_id, **kwargs): local_var_files = {} body_params = None + if 'account_signature_definition' in params: + body_params = params['account_signature_definition'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -5034,14 +6032,14 @@ def list_unsupported_file_types_with_http_info(self, account_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'GET', + return self.api_client.call_api(resource_path, 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FileTypeList', + response_type='AccountSignature', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5049,53 +6047,57 @@ def list_unsupported_file_types_with_http_info(self, account_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def un_favorite_template(self, account_id, **kwargs): + def update_account_signature_image(self, account_id, image_type, signature_id, **kwargs): """ - Unfavorite a template + Sets a signature, initials, or stamps image. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.un_favorite_template(account_id, callback=callback_function) + >>> thread = api.update_account_signature_image(account_id, image_type, signature_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param FavoriteTemplatesInfo favorite_templates_info: - :return: FavoriteTemplatesInfo + :param str image_type: One of **signature_image** or **initials_image**. (required) + :param str signature_id: The ID of the signature being accessed. (required) + :param str transparent_png: + :return: AccountSignature If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.un_favorite_template_with_http_info(account_id, **kwargs) + return self.update_account_signature_image_with_http_info(account_id, image_type, signature_id, **kwargs) else: - (data) = self.un_favorite_template_with_http_info(account_id, **kwargs) + (data) = self.update_account_signature_image_with_http_info(account_id, image_type, signature_id, **kwargs) return data - def un_favorite_template_with_http_info(self, account_id, **kwargs): + def update_account_signature_image_with_http_info(self, account_id, image_type, signature_id, **kwargs): """ - Unfavorite a template + Sets a signature, initials, or stamps image. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.un_favorite_template_with_http_info(account_id, callback=callback_function) + >>> thread = api.update_account_signature_image_with_http_info(account_id, image_type, signature_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param FavoriteTemplatesInfo favorite_templates_info: - :return: FavoriteTemplatesInfo + :param str image_type: One of **signature_image** or **initials_image**. (required) + :param str signature_id: The ID of the signature being accessed. (required) + :param str transparent_png: + :return: AccountSignature If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'favorite_templates_info'] + all_params = ['account_id', 'image_type', 'signature_id', 'transparent_png'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5106,23 +6108,35 @@ def un_favorite_template_with_http_info(self, account_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method un_favorite_template" % key + " to method update_account_signature_image" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'account_id' is set if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `un_favorite_template`") + raise ValueError("Missing the required parameter `account_id` when calling `update_account_signature_image`") + # verify the required parameter 'image_type' is set + if ('image_type' not in params) or (params['image_type'] is None): + raise ValueError("Missing the required parameter `image_type` when calling `update_account_signature_image`") + # verify the required parameter 'signature_id' is set + if ('signature_id' not in params) or (params['signature_id'] is None): + raise ValueError("Missing the required parameter `signature_id` when calling `update_account_signature_image`") collection_formats = {} - resource_path = '/v2.1/accounts/{accountId}/favorite_templates'.replace('{format}', 'json') + resource_path = '/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}'.replace('{format}', 'json') path_params = {} if 'account_id' in params: path_params['accountId'] = params['account_id'] + if 'image_type' in params: + path_params['imageType'] = params['image_type'] + if 'signature_id' in params: + path_params['signatureId'] = params['signature_id'] query_params = {} + if 'transparent_png' in params: + query_params['transparent_png'] = params['transparent_png'] header_params = {} @@ -5130,23 +6144,25 @@ def un_favorite_template_with_http_info(self, account_id, **kwargs): local_var_files = {} body_params = None - if 'favorite_templates_info' in params: - body_params = params['favorite_templates_info'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['image/gif']) + # Authentication setting auth_settings = [] - return self.api_client.call_api(resource_path, 'DELETE', + 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='FavoriteTemplatesInfo', + response_type='AccountSignature', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5626,7 +6642,7 @@ def update_consumer_disclosure(self, account_id, lang_code, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) :param str include_metadata: :param ConsumerDisclosure consumer_disclosure: :return: ConsumerDisclosure @@ -5654,7 +6670,7 @@ def update_consumer_disclosure_with_http_info(self, account_id, lang_code, **kwa :param callback function: The callback function for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) :param str include_metadata: :param ConsumerDisclosure consumer_disclosure: :return: ConsumerDisclosure diff --git a/docusign_esign/apis/envelopes_api.py b/docusign_esign/apis/envelopes_api.py index d5198663..38b84275 100644 --- a/docusign_esign/apis/envelopes_api.py +++ b/docusign_esign/apis/envelopes_api.py @@ -3730,6 +3730,118 @@ def delete_email_settings_with_http_info(self, account_id, envelope_id, **kwargs _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def delete_envelope_correct_view(self, account_id, envelope_id, **kwargs): + """ + Revokes the correction view URL to the Envelope UI + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.delete_envelope_correct_view(account_id, envelope_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param CorrectViewRequest correct_view_request: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_envelope_correct_view_with_http_info(account_id, envelope_id, **kwargs) + else: + (data) = self.delete_envelope_correct_view_with_http_info(account_id, envelope_id, **kwargs) + return data + + def delete_envelope_correct_view_with_http_info(self, account_id, envelope_id, **kwargs): + """ + Revokes the correction view URL to the Envelope UI + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.delete_envelope_correct_view_with_http_info(account_id, envelope_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str account_id: The external account number (int) or account ID Guid. (required) + :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) + :param CorrectViewRequest correct_view_request: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'envelope_id', 'correct_view_request'] + all_params.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_correct_view" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params) or (params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `delete_envelope_correct_view`") + # verify the required parameter 'envelope_id' is set + if ('envelope_id' not in params) or (params['envelope_id'] is None): + raise ValueError("Missing the required parameter `envelope_id` when calling `delete_envelope_correct_view`") + + + collection_formats = {} + + resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct'.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 'correct_view_request' in params: + body_params = params['correct_view_request'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # 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_envelope_transfer_rules(self, account_id, envelope_transfer_rule_id, **kwargs): """ Delete envelope transfer rules for an account. @@ -5103,7 +5215,7 @@ def get_consumer_disclosure(self, account_id, envelope_id, lang_code, recipient_ for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) :param str recipient_id: The ID of the recipient being accessed. (required) :param str lang_code2: :return: ConsumerDisclosure @@ -5133,7 +5245,7 @@ def get_consumer_disclosure_with_http_info(self, account_id, envelope_id, lang_c for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) + :param str lang_code: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required) :param str recipient_id: The ID of the recipient being accessed. (required) :param str lang_code2: :return: ConsumerDisclosure diff --git a/docusign_esign/models/__init__.py b/docusign_esign/models/__init__.py index 1c9a353f..940eaf05 100644 --- a/docusign_esign/models/__init__.py +++ b/docusign_esign/models/__init__.py @@ -38,9 +38,12 @@ from docusign_esign.models.account_seals import AccountSeals from docusign_esign.models.account_settings_information import AccountSettingsInformation from docusign_esign.models.account_shared_access import AccountSharedAccess +from docusign_esign.models.account_signature import AccountSignature +from docusign_esign.models.account_signature_definition import AccountSignatureDefinition from docusign_esign.models.account_signature_provider import AccountSignatureProvider from docusign_esign.models.account_signature_provider_option import AccountSignatureProviderOption from docusign_esign.models.account_signature_providers import AccountSignatureProviders +from docusign_esign.models.account_signatures_information import AccountSignaturesInformation from docusign_esign.models.account_ui_settings import AccountUISettings from docusign_esign.models.add_on import AddOn from docusign_esign.models.address_information import AddressInformation @@ -281,6 +284,7 @@ from docusign_esign.models.new_users_summary import NewUsersSummary from docusign_esign.models.notarize import Notarize from docusign_esign.models.notary import Notary +from docusign_esign.models.notary_certificate import NotaryCertificate from docusign_esign.models.notary_host import NotaryHost from docusign_esign.models.notary_journal import NotaryJournal from docusign_esign.models.notary_journal_credible_witness import NotaryJournalCredibleWitness @@ -288,7 +292,9 @@ from docusign_esign.models.notary_journal_meta_data import NotaryJournalMetaData from docusign_esign.models.notary_jurisdiction import NotaryJurisdiction from docusign_esign.models.notary_jurisdiction_list import NotaryJurisdictionList +from docusign_esign.models.notary_recipient import NotaryRecipient from docusign_esign.models.notary_result import NotaryResult +from docusign_esign.models.notary_seal import NotarySeal from docusign_esign.models.note import Note from docusign_esign.models.notification import Notification from docusign_esign.models.notification_default_settings import NotificationDefaultSettings @@ -380,8 +386,12 @@ from docusign_esign.models.settings_metadata import SettingsMetadata from docusign_esign.models.shared_item import SharedItem from docusign_esign.models.sign_here import SignHere +from docusign_esign.models.signature_group import SignatureGroup +from docusign_esign.models.signature_group_def import SignatureGroupDef from docusign_esign.models.signature_provider_required_option import SignatureProviderRequiredOption from docusign_esign.models.signature_type import SignatureType +from docusign_esign.models.signature_user import SignatureUser +from docusign_esign.models.signature_user_def import SignatureUserDef from docusign_esign.models.signer import Signer from docusign_esign.models.signer_attachment import SignerAttachment from docusign_esign.models.signer_email_notifications import SignerEmailNotifications diff --git a/docusign_esign/models/account_settings_information.py b/docusign_esign/models/account_settings_information.py index cce3333a..97aa7037 100644 --- a/docusign_esign/models/account_settings_information.py +++ b/docusign_esign/models/account_settings_information.py @@ -34,6 +34,8 @@ class AccountSettingsInformation(object): 'access_code_format': 'AccessCodeFormat', 'account_date_time_format': 'str', 'account_date_time_format_metadata': 'SettingsMetadata', + 'account_default_language': 'str', + 'account_default_language_metadata': 'SettingsMetadata', 'account_name': 'str', 'account_name_metadata': 'SettingsMetadata', 'account_notification': 'AccountNotification', @@ -552,6 +554,8 @@ class AccountSettingsInformation(object): 'access_code_format': 'accessCodeFormat', 'account_date_time_format': 'accountDateTimeFormat', 'account_date_time_format_metadata': 'accountDateTimeFormatMetadata', + 'account_default_language': 'accountDefaultLanguage', + 'account_default_language_metadata': 'accountDefaultLanguageMetadata', 'account_name': 'accountName', 'account_name_metadata': 'accountNameMetadata', 'account_notification': 'accountNotification', @@ -1072,6 +1076,8 @@ def __init__(self, **kwargs): self._access_code_format = None self._account_date_time_format = None self._account_date_time_format_metadata = None + self._account_default_language = None + self._account_default_language_metadata = None self._account_name = None self._account_name_metadata = None self._account_notification = None @@ -1655,6 +1661,50 @@ def account_date_time_format_metadata(self, account_date_time_format_metadata): self._account_date_time_format_metadata = account_date_time_format_metadata + @property + def account_default_language(self): + """Gets the account_default_language of this AccountSettingsInformation. # noqa: E501 + + # noqa: E501 + + :return: The account_default_language of this AccountSettingsInformation. # noqa: E501 + :rtype: str + """ + return self._account_default_language + + @account_default_language.setter + def account_default_language(self, account_default_language): + """Sets the account_default_language of this AccountSettingsInformation. + + # noqa: E501 + + :param account_default_language: The account_default_language of this AccountSettingsInformation. # noqa: E501 + :type: str + """ + + self._account_default_language = account_default_language + + @property + def account_default_language_metadata(self): + """Gets the account_default_language_metadata of this AccountSettingsInformation. # noqa: E501 + + + :return: The account_default_language_metadata of this AccountSettingsInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._account_default_language_metadata + + @account_default_language_metadata.setter + def account_default_language_metadata(self, account_default_language_metadata): + """Sets the account_default_language_metadata of this AccountSettingsInformation. + + + :param account_default_language_metadata: The account_default_language_metadata of this AccountSettingsInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._account_default_language_metadata = account_default_language_metadata + @property def account_name(self): """Gets the account_name of this AccountSettingsInformation. # noqa: E501 diff --git a/docusign_esign/models/account_signature.py b/docusign_esign/models/account_signature.py new file mode 100644 index 00000000..47f7aa30 --- /dev/null +++ b/docusign_esign/models/account_signature.py @@ -0,0 +1,981 @@ +# 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 AccountSignature(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 = { + 'adopted_date_time': 'str', + 'created_date_time': 'str', + 'custom_field': 'str', + 'date_stamp_properties': 'DateStampProperties', + 'disallow_user_resize_stamp': 'str', + 'error_details': 'ErrorDetails', + 'external_id': 'str', + 'image_base64': 'str', + 'image_type': 'str', + 'initials150_image_id': 'str', + 'initials_image_uri': 'str', + 'is_default': 'str', + 'last_modified_date_time': 'str', + 'nrds_id': 'str', + 'nrds_last_name': 'str', + 'nrds_status': 'str', + 'phonetic_name': 'str', + 'signature150_image_id': 'str', + 'signature_font': 'str', + 'signature_groups': 'list[SignatureGroup]', + 'signature_id': 'str', + 'signature_image_uri': 'str', + 'signature_initials': 'str', + 'signature_name': 'str', + 'signature_rights': 'str', + 'signature_type': 'str', + 'signature_users': 'list[SignatureUser]', + 'stamp_format': 'str', + 'stamp_image_uri': 'str', + 'stamp_size_mm': 'str', + 'stamp_type': 'str', + 'status': 'str' + } + + attribute_map = { + 'adopted_date_time': 'adoptedDateTime', + 'created_date_time': 'createdDateTime', + 'custom_field': 'customField', + 'date_stamp_properties': 'dateStampProperties', + 'disallow_user_resize_stamp': 'disallowUserResizeStamp', + 'error_details': 'errorDetails', + 'external_id': 'externalID', + 'image_base64': 'imageBase64', + 'image_type': 'imageType', + 'initials150_image_id': 'initials150ImageId', + 'initials_image_uri': 'initialsImageUri', + 'is_default': 'isDefault', + 'last_modified_date_time': 'lastModifiedDateTime', + 'nrds_id': 'nrdsId', + 'nrds_last_name': 'nrdsLastName', + 'nrds_status': 'nrdsStatus', + 'phonetic_name': 'phoneticName', + 'signature150_image_id': 'signature150ImageId', + 'signature_font': 'signatureFont', + 'signature_groups': 'signatureGroups', + 'signature_id': 'signatureId', + 'signature_image_uri': 'signatureImageUri', + 'signature_initials': 'signatureInitials', + 'signature_name': 'signatureName', + 'signature_rights': 'signatureRights', + 'signature_type': 'signatureType', + 'signature_users': 'signatureUsers', + 'stamp_format': 'stampFormat', + 'stamp_image_uri': 'stampImageUri', + 'stamp_size_mm': 'stampSizeMM', + 'stamp_type': 'stampType', + 'status': 'status' + } + + def __init__(self, adopted_date_time=None, created_date_time=None, custom_field=None, date_stamp_properties=None, disallow_user_resize_stamp=None, error_details=None, external_id=None, image_base64=None, image_type=None, initials150_image_id=None, initials_image_uri=None, is_default=None, last_modified_date_time=None, nrds_id=None, nrds_last_name=None, nrds_status=None, phonetic_name=None, signature150_image_id=None, signature_font=None, signature_groups=None, signature_id=None, signature_image_uri=None, signature_initials=None, signature_name=None, signature_rights=None, signature_type=None, signature_users=None, stamp_format=None, stamp_image_uri=None, stamp_size_mm=None, stamp_type=None, status=None): # noqa: E501 + """AccountSignature - a model defined in Swagger""" # noqa: E501 + + self._adopted_date_time = None + self._created_date_time = None + self._custom_field = None + self._date_stamp_properties = None + self._disallow_user_resize_stamp = None + self._error_details = None + self._external_id = None + self._image_base64 = None + self._image_type = None + self._initials150_image_id = None + self._initials_image_uri = None + self._is_default = None + self._last_modified_date_time = None + self._nrds_id = None + self._nrds_last_name = None + self._nrds_status = None + self._phonetic_name = None + self._signature150_image_id = None + self._signature_font = None + self._signature_groups = None + self._signature_id = None + self._signature_image_uri = None + self._signature_initials = None + self._signature_name = None + self._signature_rights = None + self._signature_type = None + self._signature_users = None + self._stamp_format = None + self._stamp_image_uri = None + self._stamp_size_mm = None + self._stamp_type = None + self._status = None + self.discriminator = None + + if adopted_date_time is not None: + self.adopted_date_time = adopted_date_time + if created_date_time is not None: + self.created_date_time = created_date_time + if custom_field is not None: + self.custom_field = custom_field + if date_stamp_properties is not None: + self.date_stamp_properties = date_stamp_properties + if disallow_user_resize_stamp is not None: + self.disallow_user_resize_stamp = disallow_user_resize_stamp + if error_details is not None: + self.error_details = error_details + if external_id is not None: + self.external_id = external_id + if image_base64 is not None: + self.image_base64 = image_base64 + if image_type is not None: + self.image_type = image_type + if initials150_image_id is not None: + self.initials150_image_id = initials150_image_id + if initials_image_uri is not None: + self.initials_image_uri = initials_image_uri + if is_default is not None: + self.is_default = is_default + if last_modified_date_time is not None: + self.last_modified_date_time = last_modified_date_time + if nrds_id is not None: + self.nrds_id = nrds_id + if nrds_last_name is not None: + self.nrds_last_name = nrds_last_name + if nrds_status is not None: + self.nrds_status = nrds_status + if phonetic_name is not None: + self.phonetic_name = phonetic_name + if signature150_image_id is not None: + self.signature150_image_id = signature150_image_id + if signature_font is not None: + self.signature_font = signature_font + if signature_groups is not None: + self.signature_groups = signature_groups + if signature_id is not None: + self.signature_id = signature_id + if signature_image_uri is not None: + self.signature_image_uri = signature_image_uri + if signature_initials is not None: + self.signature_initials = signature_initials + if signature_name is not None: + self.signature_name = signature_name + if signature_rights is not None: + self.signature_rights = signature_rights + if signature_type is not None: + self.signature_type = signature_type + if signature_users is not None: + self.signature_users = signature_users + if stamp_format is not None: + self.stamp_format = stamp_format + if stamp_image_uri is not None: + self.stamp_image_uri = stamp_image_uri + if stamp_size_mm is not None: + self.stamp_size_mm = stamp_size_mm + if stamp_type is not None: + self.stamp_type = stamp_type + if status is not None: + self.status = status + + @property + def adopted_date_time(self): + """Gets the adopted_date_time of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The adopted_date_time of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._adopted_date_time + + @adopted_date_time.setter + def adopted_date_time(self, adopted_date_time): + """Sets the adopted_date_time of this AccountSignature. + + # noqa: E501 + + :param adopted_date_time: The adopted_date_time of this AccountSignature. # noqa: E501 + :type: str + """ + + self._adopted_date_time = adopted_date_time + + @property + def created_date_time(self): + """Gets the created_date_time of this AccountSignature. # noqa: E501 + + Indicates the date and time the item was created. # noqa: E501 + + :return: The created_date_time of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._created_date_time + + @created_date_time.setter + def created_date_time(self, created_date_time): + """Sets the created_date_time of this AccountSignature. + + Indicates the date and time the item was created. # noqa: E501 + + :param created_date_time: The created_date_time of this AccountSignature. # noqa: E501 + :type: str + """ + + self._created_date_time = created_date_time + + @property + def custom_field(self): + """Gets the custom_field of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The custom_field of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._custom_field + + @custom_field.setter + def custom_field(self, custom_field): + """Sets the custom_field of this AccountSignature. + + # noqa: E501 + + :param custom_field: The custom_field of this AccountSignature. # noqa: E501 + :type: str + """ + + self._custom_field = custom_field + + @property + def date_stamp_properties(self): + """Gets the date_stamp_properties of this AccountSignature. # noqa: E501 + + + :return: The date_stamp_properties of this AccountSignature. # noqa: E501 + :rtype: DateStampProperties + """ + return self._date_stamp_properties + + @date_stamp_properties.setter + def date_stamp_properties(self, date_stamp_properties): + """Sets the date_stamp_properties of this AccountSignature. + + + :param date_stamp_properties: The date_stamp_properties of this AccountSignature. # noqa: E501 + :type: DateStampProperties + """ + + self._date_stamp_properties = date_stamp_properties + + @property + def disallow_user_resize_stamp(self): + """Gets the disallow_user_resize_stamp of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The disallow_user_resize_stamp of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._disallow_user_resize_stamp + + @disallow_user_resize_stamp.setter + def disallow_user_resize_stamp(self, disallow_user_resize_stamp): + """Sets the disallow_user_resize_stamp of this AccountSignature. + + # noqa: E501 + + :param disallow_user_resize_stamp: The disallow_user_resize_stamp of this AccountSignature. # noqa: E501 + :type: str + """ + + self._disallow_user_resize_stamp = disallow_user_resize_stamp + + @property + def error_details(self): + """Gets the error_details of this AccountSignature. # noqa: E501 + + + :return: The error_details of this AccountSignature. # noqa: E501 + :rtype: ErrorDetails + """ + return self._error_details + + @error_details.setter + def error_details(self, error_details): + """Sets the error_details of this AccountSignature. + + + :param error_details: The error_details of this AccountSignature. # noqa: E501 + :type: ErrorDetails + """ + + self._error_details = error_details + + @property + def external_id(self): + """Gets the external_id of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The external_id of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._external_id + + @external_id.setter + def external_id(self, external_id): + """Sets the external_id of this AccountSignature. + + # noqa: E501 + + :param external_id: The external_id of this AccountSignature. # noqa: E501 + :type: str + """ + + self._external_id = external_id + + @property + def image_base64(self): + """Gets the image_base64 of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The image_base64 of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._image_base64 + + @image_base64.setter + def image_base64(self, image_base64): + """Sets the image_base64 of this AccountSignature. + + # noqa: E501 + + :param image_base64: The image_base64 of this AccountSignature. # noqa: E501 + :type: str + """ + + self._image_base64 = image_base64 + + @property + def image_type(self): + """Gets the image_type of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The image_type of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._image_type + + @image_type.setter + def image_type(self, image_type): + """Sets the image_type of this AccountSignature. + + # noqa: E501 + + :param image_type: The image_type of this AccountSignature. # noqa: E501 + :type: str + """ + + self._image_type = image_type + + @property + def initials150_image_id(self): + """Gets the initials150_image_id of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The initials150_image_id of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._initials150_image_id + + @initials150_image_id.setter + def initials150_image_id(self, initials150_image_id): + """Sets the initials150_image_id of this AccountSignature. + + # noqa: E501 + + :param initials150_image_id: The initials150_image_id of this AccountSignature. # noqa: E501 + :type: str + """ + + self._initials150_image_id = initials150_image_id + + @property + def initials_image_uri(self): + """Gets the initials_image_uri of this AccountSignature. # noqa: E501 + + Contains the URI for an endpoint that you can use to retrieve the initials image. # noqa: E501 + + :return: The initials_image_uri of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._initials_image_uri + + @initials_image_uri.setter + def initials_image_uri(self, initials_image_uri): + """Sets the initials_image_uri of this AccountSignature. + + Contains the URI for an endpoint that you can use to retrieve the initials image. # noqa: E501 + + :param initials_image_uri: The initials_image_uri of this AccountSignature. # noqa: E501 + :type: str + """ + + self._initials_image_uri = initials_image_uri + + @property + def is_default(self): + """Gets the is_default of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The is_default of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._is_default + + @is_default.setter + def is_default(self, is_default): + """Sets the is_default of this AccountSignature. + + # noqa: E501 + + :param is_default: The is_default of this AccountSignature. # noqa: E501 + :type: str + """ + + self._is_default = is_default + + @property + def last_modified_date_time(self): + """Gets the last_modified_date_time of this AccountSignature. # noqa: E501 + + The date and time the item was last modified. # noqa: E501 + + :return: The last_modified_date_time of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._last_modified_date_time + + @last_modified_date_time.setter + def last_modified_date_time(self, last_modified_date_time): + """Sets the last_modified_date_time of this AccountSignature. + + The date and time the item was last modified. # noqa: E501 + + :param last_modified_date_time: The last_modified_date_time of this AccountSignature. # noqa: E501 + :type: str + """ + + self._last_modified_date_time = last_modified_date_time + + @property + def nrds_id(self): + """Gets the nrds_id of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The nrds_id of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._nrds_id + + @nrds_id.setter + def nrds_id(self, nrds_id): + """Sets the nrds_id of this AccountSignature. + + # noqa: E501 + + :param nrds_id: The nrds_id of this AccountSignature. # noqa: E501 + :type: str + """ + + self._nrds_id = nrds_id + + @property + def nrds_last_name(self): + """Gets the nrds_last_name of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The nrds_last_name of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._nrds_last_name + + @nrds_last_name.setter + def nrds_last_name(self, nrds_last_name): + """Sets the nrds_last_name of this AccountSignature. + + # noqa: E501 + + :param nrds_last_name: The nrds_last_name of this AccountSignature. # noqa: E501 + :type: str + """ + + self._nrds_last_name = nrds_last_name + + @property + def nrds_status(self): + """Gets the nrds_status of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The nrds_status of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._nrds_status + + @nrds_status.setter + def nrds_status(self, nrds_status): + """Sets the nrds_status of this AccountSignature. + + # noqa: E501 + + :param nrds_status: The nrds_status of this AccountSignature. # noqa: E501 + :type: str + """ + + self._nrds_status = nrds_status + + @property + def phonetic_name(self): + """Gets the phonetic_name of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The phonetic_name of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._phonetic_name + + @phonetic_name.setter + def phonetic_name(self, phonetic_name): + """Sets the phonetic_name of this AccountSignature. + + # noqa: E501 + + :param phonetic_name: The phonetic_name of this AccountSignature. # noqa: E501 + :type: str + """ + + self._phonetic_name = phonetic_name + + @property + def signature150_image_id(self): + """Gets the signature150_image_id of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The signature150_image_id of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._signature150_image_id + + @signature150_image_id.setter + def signature150_image_id(self, signature150_image_id): + """Sets the signature150_image_id of this AccountSignature. + + # noqa: E501 + + :param signature150_image_id: The signature150_image_id of this AccountSignature. # noqa: E501 + :type: str + """ + + self._signature150_image_id = signature150_image_id + + @property + def signature_font(self): + """Gets the signature_font of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The signature_font of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._signature_font + + @signature_font.setter + def signature_font(self, signature_font): + """Sets the signature_font of this AccountSignature. + + # noqa: E501 + + :param signature_font: The signature_font of this AccountSignature. # noqa: E501 + :type: str + """ + + self._signature_font = signature_font + + @property + def signature_groups(self): + """Gets the signature_groups of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The signature_groups of this AccountSignature. # noqa: E501 + :rtype: list[SignatureGroup] + """ + return self._signature_groups + + @signature_groups.setter + def signature_groups(self, signature_groups): + """Sets the signature_groups of this AccountSignature. + + # noqa: E501 + + :param signature_groups: The signature_groups of this AccountSignature. # noqa: E501 + :type: list[SignatureGroup] + """ + + self._signature_groups = signature_groups + + @property + def signature_id(self): + """Gets the signature_id of this AccountSignature. # noqa: E501 + + Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. # noqa: E501 + + :return: The signature_id of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._signature_id + + @signature_id.setter + def signature_id(self, signature_id): + """Sets the signature_id of this AccountSignature. + + Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. # noqa: E501 + + :param signature_id: The signature_id of this AccountSignature. # noqa: E501 + :type: str + """ + + self._signature_id = signature_id + + @property + def signature_image_uri(self): + """Gets the signature_image_uri of this AccountSignature. # noqa: E501 + + Contains the URI for an endpoint that you can use to retrieve the signature image. # noqa: E501 + + :return: The signature_image_uri of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._signature_image_uri + + @signature_image_uri.setter + def signature_image_uri(self, signature_image_uri): + """Sets the signature_image_uri of this AccountSignature. + + Contains the URI for an endpoint that you can use to retrieve the signature image. # noqa: E501 + + :param signature_image_uri: The signature_image_uri of this AccountSignature. # noqa: E501 + :type: str + """ + + self._signature_image_uri = signature_image_uri + + @property + def signature_initials(self): + """Gets the signature_initials of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The signature_initials of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._signature_initials + + @signature_initials.setter + def signature_initials(self, signature_initials): + """Sets the signature_initials of this AccountSignature. + + # noqa: E501 + + :param signature_initials: The signature_initials of this AccountSignature. # noqa: E501 + :type: str + """ + + self._signature_initials = signature_initials + + @property + def signature_name(self): + """Gets the signature_name of this AccountSignature. # noqa: E501 + + Specifies the user signature name. # noqa: E501 + + :return: The signature_name of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._signature_name + + @signature_name.setter + def signature_name(self, signature_name): + """Sets the signature_name of this AccountSignature. + + Specifies the user signature name. # noqa: E501 + + :param signature_name: The signature_name of this AccountSignature. # noqa: E501 + :type: str + """ + + self._signature_name = signature_name + + @property + def signature_rights(self): + """Gets the signature_rights of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The signature_rights of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._signature_rights + + @signature_rights.setter + def signature_rights(self, signature_rights): + """Sets the signature_rights of this AccountSignature. + + # noqa: E501 + + :param signature_rights: The signature_rights of this AccountSignature. # noqa: E501 + :type: str + """ + + self._signature_rights = signature_rights + + @property + def signature_type(self): + """Gets the signature_type of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The signature_type of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._signature_type + + @signature_type.setter + def signature_type(self, signature_type): + """Sets the signature_type of this AccountSignature. + + # noqa: E501 + + :param signature_type: The signature_type of this AccountSignature. # noqa: E501 + :type: str + """ + + self._signature_type = signature_type + + @property + def signature_users(self): + """Gets the signature_users of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The signature_users of this AccountSignature. # noqa: E501 + :rtype: list[SignatureUser] + """ + return self._signature_users + + @signature_users.setter + def signature_users(self, signature_users): + """Sets the signature_users of this AccountSignature. + + # noqa: E501 + + :param signature_users: The signature_users of this AccountSignature. # noqa: E501 + :type: list[SignatureUser] + """ + + self._signature_users = signature_users + + @property + def stamp_format(self): + """Gets the stamp_format of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The stamp_format of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._stamp_format + + @stamp_format.setter + def stamp_format(self, stamp_format): + """Sets the stamp_format of this AccountSignature. + + # noqa: E501 + + :param stamp_format: The stamp_format of this AccountSignature. # noqa: E501 + :type: str + """ + + self._stamp_format = stamp_format + + @property + def stamp_image_uri(self): + """Gets the stamp_image_uri of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The stamp_image_uri of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._stamp_image_uri + + @stamp_image_uri.setter + def stamp_image_uri(self, stamp_image_uri): + """Sets the stamp_image_uri of this AccountSignature. + + # noqa: E501 + + :param stamp_image_uri: The stamp_image_uri of this AccountSignature. # noqa: E501 + :type: str + """ + + self._stamp_image_uri = stamp_image_uri + + @property + def stamp_size_mm(self): + """Gets the stamp_size_mm of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The stamp_size_mm of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._stamp_size_mm + + @stamp_size_mm.setter + def stamp_size_mm(self, stamp_size_mm): + """Sets the stamp_size_mm of this AccountSignature. + + # noqa: E501 + + :param stamp_size_mm: The stamp_size_mm of this AccountSignature. # noqa: E501 + :type: str + """ + + self._stamp_size_mm = stamp_size_mm + + @property + def stamp_type(self): + """Gets the stamp_type of this AccountSignature. # noqa: E501 + + # noqa: E501 + + :return: The stamp_type of this AccountSignature. # noqa: E501 + :rtype: str + """ + return self._stamp_type + + @stamp_type.setter + def stamp_type(self, stamp_type): + """Sets the stamp_type of this AccountSignature. + + # noqa: E501 + + :param stamp_type: The stamp_type of this AccountSignature. # noqa: E501 + :type: str + """ + + self._stamp_type = stamp_type + + @property + def status(self): + """Gets the status of this AccountSignature. # 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 AccountSignature. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this AccountSignature. + + 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 AccountSignature. # noqa: E501 + :type: str + """ + + self._status = status + + 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(AccountSignature, 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, AccountSignature): + 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/account_signature_definition.py b/docusign_esign/models/account_signature_definition.py new file mode 100644 index 00000000..f8741fd0 --- /dev/null +++ b/docusign_esign/models/account_signature_definition.py @@ -0,0 +1,535 @@ +# 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 AccountSignatureDefinition(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 = { + 'date_stamp_properties': 'DateStampProperties', + 'disallow_user_resize_stamp': 'str', + 'external_id': 'str', + 'image_type': 'str', + 'is_default': 'str', + 'nrds_id': 'str', + 'nrds_last_name': 'str', + 'phonetic_name': 'str', + 'signature_font': 'str', + 'signature_groups': 'list[SignatureGroupDef]', + 'signature_id': 'str', + 'signature_initials': 'str', + 'signature_name': 'str', + 'signature_users': 'list[SignatureUserDef]', + 'stamp_format': 'str', + 'stamp_size_mm': 'str' + } + + attribute_map = { + 'date_stamp_properties': 'dateStampProperties', + 'disallow_user_resize_stamp': 'disallowUserResizeStamp', + 'external_id': 'externalID', + 'image_type': 'imageType', + 'is_default': 'isDefault', + 'nrds_id': 'nrdsId', + 'nrds_last_name': 'nrdsLastName', + 'phonetic_name': 'phoneticName', + 'signature_font': 'signatureFont', + 'signature_groups': 'signatureGroups', + 'signature_id': 'signatureId', + 'signature_initials': 'signatureInitials', + 'signature_name': 'signatureName', + 'signature_users': 'signatureUsers', + 'stamp_format': 'stampFormat', + 'stamp_size_mm': 'stampSizeMM' + } + + def __init__(self, date_stamp_properties=None, disallow_user_resize_stamp=None, external_id=None, image_type=None, is_default=None, nrds_id=None, nrds_last_name=None, phonetic_name=None, signature_font=None, signature_groups=None, signature_id=None, signature_initials=None, signature_name=None, signature_users=None, stamp_format=None, stamp_size_mm=None): # noqa: E501 + """AccountSignatureDefinition - a model defined in Swagger""" # noqa: E501 + + self._date_stamp_properties = None + self._disallow_user_resize_stamp = None + self._external_id = None + self._image_type = None + self._is_default = None + self._nrds_id = None + self._nrds_last_name = None + self._phonetic_name = None + self._signature_font = None + self._signature_groups = None + self._signature_id = None + self._signature_initials = None + self._signature_name = None + self._signature_users = None + self._stamp_format = None + self._stamp_size_mm = None + self.discriminator = None + + if date_stamp_properties is not None: + self.date_stamp_properties = date_stamp_properties + if disallow_user_resize_stamp is not None: + self.disallow_user_resize_stamp = disallow_user_resize_stamp + if external_id is not None: + self.external_id = external_id + if image_type is not None: + self.image_type = image_type + if is_default is not None: + self.is_default = is_default + if nrds_id is not None: + self.nrds_id = nrds_id + if nrds_last_name is not None: + self.nrds_last_name = nrds_last_name + if phonetic_name is not None: + self.phonetic_name = phonetic_name + if signature_font is not None: + self.signature_font = signature_font + if signature_groups is not None: + self.signature_groups = signature_groups + if signature_id is not None: + self.signature_id = signature_id + if signature_initials is not None: + self.signature_initials = signature_initials + if signature_name is not None: + self.signature_name = signature_name + if signature_users is not None: + self.signature_users = signature_users + if stamp_format is not None: + self.stamp_format = stamp_format + if stamp_size_mm is not None: + self.stamp_size_mm = stamp_size_mm + + @property + def date_stamp_properties(self): + """Gets the date_stamp_properties of this AccountSignatureDefinition. # noqa: E501 + + + :return: The date_stamp_properties of this AccountSignatureDefinition. # noqa: E501 + :rtype: DateStampProperties + """ + return self._date_stamp_properties + + @date_stamp_properties.setter + def date_stamp_properties(self, date_stamp_properties): + """Sets the date_stamp_properties of this AccountSignatureDefinition. + + + :param date_stamp_properties: The date_stamp_properties of this AccountSignatureDefinition. # noqa: E501 + :type: DateStampProperties + """ + + self._date_stamp_properties = date_stamp_properties + + @property + def disallow_user_resize_stamp(self): + """Gets the disallow_user_resize_stamp of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The disallow_user_resize_stamp of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._disallow_user_resize_stamp + + @disallow_user_resize_stamp.setter + def disallow_user_resize_stamp(self, disallow_user_resize_stamp): + """Sets the disallow_user_resize_stamp of this AccountSignatureDefinition. + + # noqa: E501 + + :param disallow_user_resize_stamp: The disallow_user_resize_stamp of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._disallow_user_resize_stamp = disallow_user_resize_stamp + + @property + def external_id(self): + """Gets the external_id of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The external_id of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._external_id + + @external_id.setter + def external_id(self, external_id): + """Sets the external_id of this AccountSignatureDefinition. + + # noqa: E501 + + :param external_id: The external_id of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._external_id = external_id + + @property + def image_type(self): + """Gets the image_type of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The image_type of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._image_type + + @image_type.setter + def image_type(self, image_type): + """Sets the image_type of this AccountSignatureDefinition. + + # noqa: E501 + + :param image_type: The image_type of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._image_type = image_type + + @property + def is_default(self): + """Gets the is_default of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The is_default of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._is_default + + @is_default.setter + def is_default(self, is_default): + """Sets the is_default of this AccountSignatureDefinition. + + # noqa: E501 + + :param is_default: The is_default of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._is_default = is_default + + @property + def nrds_id(self): + """Gets the nrds_id of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The nrds_id of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._nrds_id + + @nrds_id.setter + def nrds_id(self, nrds_id): + """Sets the nrds_id of this AccountSignatureDefinition. + + # noqa: E501 + + :param nrds_id: The nrds_id of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._nrds_id = nrds_id + + @property + def nrds_last_name(self): + """Gets the nrds_last_name of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The nrds_last_name of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._nrds_last_name + + @nrds_last_name.setter + def nrds_last_name(self, nrds_last_name): + """Sets the nrds_last_name of this AccountSignatureDefinition. + + # noqa: E501 + + :param nrds_last_name: The nrds_last_name of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._nrds_last_name = nrds_last_name + + @property + def phonetic_name(self): + """Gets the phonetic_name of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The phonetic_name of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._phonetic_name + + @phonetic_name.setter + def phonetic_name(self, phonetic_name): + """Sets the phonetic_name of this AccountSignatureDefinition. + + # noqa: E501 + + :param phonetic_name: The phonetic_name of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._phonetic_name = phonetic_name + + @property + def signature_font(self): + """Gets the signature_font of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The signature_font of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._signature_font + + @signature_font.setter + def signature_font(self, signature_font): + """Sets the signature_font of this AccountSignatureDefinition. + + # noqa: E501 + + :param signature_font: The signature_font of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._signature_font = signature_font + + @property + def signature_groups(self): + """Gets the signature_groups of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The signature_groups of this AccountSignatureDefinition. # noqa: E501 + :rtype: list[SignatureGroupDef] + """ + return self._signature_groups + + @signature_groups.setter + def signature_groups(self, signature_groups): + """Sets the signature_groups of this AccountSignatureDefinition. + + # noqa: E501 + + :param signature_groups: The signature_groups of this AccountSignatureDefinition. # noqa: E501 + :type: list[SignatureGroupDef] + """ + + self._signature_groups = signature_groups + + @property + def signature_id(self): + """Gets the signature_id of this AccountSignatureDefinition. # noqa: E501 + + Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. # noqa: E501 + + :return: The signature_id of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._signature_id + + @signature_id.setter + def signature_id(self, signature_id): + """Sets the signature_id of this AccountSignatureDefinition. + + Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. # noqa: E501 + + :param signature_id: The signature_id of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._signature_id = signature_id + + @property + def signature_initials(self): + """Gets the signature_initials of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The signature_initials of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._signature_initials + + @signature_initials.setter + def signature_initials(self, signature_initials): + """Sets the signature_initials of this AccountSignatureDefinition. + + # noqa: E501 + + :param signature_initials: The signature_initials of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._signature_initials = signature_initials + + @property + def signature_name(self): + """Gets the signature_name of this AccountSignatureDefinition. # noqa: E501 + + Specifies the user signature name. # noqa: E501 + + :return: The signature_name of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._signature_name + + @signature_name.setter + def signature_name(self, signature_name): + """Sets the signature_name of this AccountSignatureDefinition. + + Specifies the user signature name. # noqa: E501 + + :param signature_name: The signature_name of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._signature_name = signature_name + + @property + def signature_users(self): + """Gets the signature_users of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The signature_users of this AccountSignatureDefinition. # noqa: E501 + :rtype: list[SignatureUserDef] + """ + return self._signature_users + + @signature_users.setter + def signature_users(self, signature_users): + """Sets the signature_users of this AccountSignatureDefinition. + + # noqa: E501 + + :param signature_users: The signature_users of this AccountSignatureDefinition. # noqa: E501 + :type: list[SignatureUserDef] + """ + + self._signature_users = signature_users + + @property + def stamp_format(self): + """Gets the stamp_format of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The stamp_format of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._stamp_format + + @stamp_format.setter + def stamp_format(self, stamp_format): + """Sets the stamp_format of this AccountSignatureDefinition. + + # noqa: E501 + + :param stamp_format: The stamp_format of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._stamp_format = stamp_format + + @property + def stamp_size_mm(self): + """Gets the stamp_size_mm of this AccountSignatureDefinition. # noqa: E501 + + # noqa: E501 + + :return: The stamp_size_mm of this AccountSignatureDefinition. # noqa: E501 + :rtype: str + """ + return self._stamp_size_mm + + @stamp_size_mm.setter + def stamp_size_mm(self, stamp_size_mm): + """Sets the stamp_size_mm of this AccountSignatureDefinition. + + # noqa: E501 + + :param stamp_size_mm: The stamp_size_mm of this AccountSignatureDefinition. # noqa: E501 + :type: str + """ + + self._stamp_size_mm = stamp_size_mm + + 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(AccountSignatureDefinition, 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, AccountSignatureDefinition): + 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/account_signatures_information.py b/docusign_esign/models/account_signatures_information.py new file mode 100644 index 00000000..f7e138a3 --- /dev/null +++ b/docusign_esign/models/account_signatures_information.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 AccountSignaturesInformation(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 = { + 'account_signatures': 'list[AccountSignature]' + } + + attribute_map = { + 'account_signatures': 'accountSignatures' + } + + def __init__(self, account_signatures=None): # noqa: E501 + """AccountSignaturesInformation - a model defined in Swagger""" # noqa: E501 + + self._account_signatures = None + self.discriminator = None + + if account_signatures is not None: + self.account_signatures = account_signatures + + @property + def account_signatures(self): + """Gets the account_signatures of this AccountSignaturesInformation. # noqa: E501 + + # noqa: E501 + + :return: The account_signatures of this AccountSignaturesInformation. # noqa: E501 + :rtype: list[AccountSignature] + """ + return self._account_signatures + + @account_signatures.setter + def account_signatures(self, account_signatures): + """Sets the account_signatures of this AccountSignaturesInformation. + + # noqa: E501 + + :param account_signatures: The account_signatures of this AccountSignaturesInformation. # noqa: E501 + :type: list[AccountSignature] + """ + + self._account_signatures = account_signatures + + 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(AccountSignaturesInformation, 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, AccountSignaturesInformation): + 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/correct_view_request.py b/docusign_esign/models/correct_view_request.py index 656e708c..e28878cc 100644 --- a/docusign_esign/models/correct_view_request.py +++ b/docusign_esign/models/correct_view_request.py @@ -32,25 +32,30 @@ class CorrectViewRequest(object): """ swagger_types = { 'return_url': 'str', - 'suppress_navigation': 'str' + 'suppress_navigation': 'str', + 'view_url': 'str' } attribute_map = { 'return_url': 'returnUrl', - 'suppress_navigation': 'suppressNavigation' + 'suppress_navigation': 'suppressNavigation', + 'view_url': 'viewUrl' } - def __init__(self, return_url=None, suppress_navigation=None): # noqa: E501 + def __init__(self, return_url=None, suppress_navigation=None, view_url=None): # noqa: E501 """CorrectViewRequest - a model defined in Swagger""" # noqa: E501 self._return_url = None self._suppress_navigation = None + self._view_url = None self.discriminator = None if return_url is not None: self.return_url = return_url if suppress_navigation is not None: self.suppress_navigation = suppress_navigation + if view_url is not None: + self.view_url = view_url @property def return_url(self): @@ -98,6 +103,29 @@ def suppress_navigation(self, suppress_navigation): self._suppress_navigation = suppress_navigation + @property + def view_url(self): + """Gets the view_url of this CorrectViewRequest. # noqa: E501 + + # noqa: E501 + + :return: The view_url of this CorrectViewRequest. # noqa: E501 + :rtype: str + """ + return self._view_url + + @view_url.setter + def view_url(self, view_url): + """Sets the view_url of this CorrectViewRequest. + + # noqa: E501 + + :param view_url: The view_url of this CorrectViewRequest. # noqa: E501 + :type: str + """ + + self._view_url = view_url + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/docusign_esign/models/in_person_signer.py b/docusign_esign/models/in_person_signer.py index b226f987..204905fc 100644 --- a/docusign_esign/models/in_person_signer.py +++ b/docusign_esign/models/in_person_signer.py @@ -74,6 +74,7 @@ class InPersonSigner(object): 'name': 'str', 'name_metadata': 'PropertyMetadata', 'notary_host': 'NotaryHost', + 'notary_id': 'str', 'note': 'str', 'note_metadata': 'PropertyMetadata', 'offline_attributes': 'OfflineAttributes', @@ -168,6 +169,7 @@ class InPersonSigner(object): 'name': 'name', 'name_metadata': 'nameMetadata', 'notary_host': 'notaryHost', + 'notary_id': 'notaryId', 'note': 'note', 'note_metadata': 'noteMetadata', 'offline_attributes': 'offlineAttributes', @@ -218,7 +220,7 @@ class InPersonSigner(object): 'user_id': 'userId' } - def __init__(self, access_code=None, access_code_metadata=None, add_access_code_to_email=None, allow_system_override_for_locked_recipient=None, auto_navigation=None, can_sign_offline=None, client_user_id=None, completed_count=None, creation_reason=None, custom_fields=None, declined_date_time=None, declined_reason=None, default_recipient=None, delivered_date_time=None, delivery_method=None, delivery_method_metadata=None, designator_id=None, designator_id_guid=None, document_visibility=None, email=None, email_metadata=None, email_notification=None, embedded_recipient_start_url=None, error_details=None, excluded_documents=None, fax_number=None, fax_number_metadata=None, host_email=None, host_email_metadata=None, host_name=None, host_name_metadata=None, id_check_configuration_name=None, id_check_configuration_name_metadata=None, id_check_information_input=None, identity_verification=None, inherit_email_notification_configuration=None, in_person_signing_type=None, in_person_signing_type_metadata=None, locked_recipient_phone_auth_editable=None, locked_recipient_sms_editable=None, name=None, name_metadata=None, notary_host=None, note=None, note_metadata=None, offline_attributes=None, phone_authentication=None, recipient_attachments=None, recipient_authentication_status=None, recipient_feature_metadata=None, recipient_id=None, recipient_id_guid=None, recipient_signature_providers=None, recipient_supplies_tabs=None, recipient_type=None, recipient_type_metadata=None, require_id_lookup=None, require_id_lookup_metadata=None, require_signer_certificate=None, require_sign_on_paper=None, require_upload_signature=None, role_name=None, routing_order=None, routing_order_metadata=None, sent_date_time=None, signature_info=None, signed_date_time=None, signer_email=None, signer_email_metadata=None, signer_first_name=None, signer_first_name_metadata=None, signer_last_name=None, signer_last_name_metadata=None, signer_name=None, signer_name_metadata=None, sign_in_each_location=None, sign_in_each_location_metadata=None, signing_group_id=None, signing_group_id_metadata=None, signing_group_name=None, signing_group_users=None, sms_authentication=None, social_authentications=None, status=None, status_code=None, suppress_emails=None, tabs=None, template_locked=None, template_required=None, total_tab_count=None, user_id=None): # noqa: E501 + def __init__(self, access_code=None, access_code_metadata=None, add_access_code_to_email=None, allow_system_override_for_locked_recipient=None, auto_navigation=None, can_sign_offline=None, client_user_id=None, completed_count=None, creation_reason=None, custom_fields=None, declined_date_time=None, declined_reason=None, default_recipient=None, delivered_date_time=None, delivery_method=None, delivery_method_metadata=None, designator_id=None, designator_id_guid=None, document_visibility=None, email=None, email_metadata=None, email_notification=None, embedded_recipient_start_url=None, error_details=None, excluded_documents=None, fax_number=None, fax_number_metadata=None, host_email=None, host_email_metadata=None, host_name=None, host_name_metadata=None, id_check_configuration_name=None, id_check_configuration_name_metadata=None, id_check_information_input=None, identity_verification=None, inherit_email_notification_configuration=None, in_person_signing_type=None, in_person_signing_type_metadata=None, locked_recipient_phone_auth_editable=None, locked_recipient_sms_editable=None, name=None, name_metadata=None, notary_host=None, notary_id=None, note=None, note_metadata=None, offline_attributes=None, phone_authentication=None, recipient_attachments=None, recipient_authentication_status=None, recipient_feature_metadata=None, recipient_id=None, recipient_id_guid=None, recipient_signature_providers=None, recipient_supplies_tabs=None, recipient_type=None, recipient_type_metadata=None, require_id_lookup=None, require_id_lookup_metadata=None, require_signer_certificate=None, require_sign_on_paper=None, require_upload_signature=None, role_name=None, routing_order=None, routing_order_metadata=None, sent_date_time=None, signature_info=None, signed_date_time=None, signer_email=None, signer_email_metadata=None, signer_first_name=None, signer_first_name_metadata=None, signer_last_name=None, signer_last_name_metadata=None, signer_name=None, signer_name_metadata=None, sign_in_each_location=None, sign_in_each_location_metadata=None, signing_group_id=None, signing_group_id_metadata=None, signing_group_name=None, signing_group_users=None, sms_authentication=None, social_authentications=None, status=None, status_code=None, suppress_emails=None, tabs=None, template_locked=None, template_required=None, total_tab_count=None, user_id=None): # noqa: E501 """InPersonSigner - a model defined in Swagger""" # noqa: E501 self._access_code = None @@ -264,6 +266,7 @@ def __init__(self, access_code=None, access_code_metadata=None, add_access_code_ self._name = None self._name_metadata = None self._notary_host = None + self._notary_id = None self._note = None self._note_metadata = None self._offline_attributes = None @@ -400,6 +403,8 @@ def __init__(self, access_code=None, access_code_metadata=None, add_access_code_ self.name_metadata = name_metadata if notary_host is not None: self.notary_host = notary_host + if notary_id is not None: + self.notary_id = notary_id if note is not None: self.note = note if note_metadata is not None: @@ -1458,6 +1463,29 @@ def notary_host(self, notary_host): self._notary_host = notary_host + @property + def notary_id(self): + """Gets the notary_id of this InPersonSigner. # noqa: E501 + + # noqa: E501 + + :return: The notary_id of this InPersonSigner. # noqa: E501 + :rtype: str + """ + return self._notary_id + + @notary_id.setter + def notary_id(self, notary_id): + """Sets the notary_id of this InPersonSigner. + + # noqa: E501 + + :param notary_id: The notary_id of this InPersonSigner. # noqa: E501 + :type: str + """ + + self._notary_id = notary_id + @property def note(self): """Gets the note of this InPersonSigner. # noqa: E501 diff --git a/docusign_esign/models/notary_certificate.py b/docusign_esign/models/notary_certificate.py new file mode 100644 index 00000000..ab2b112f --- /dev/null +++ b/docusign_esign/models/notary_certificate.py @@ -0,0 +1,2057 @@ +# 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 NotaryCertificate(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 = { + 'anchor_allow_white_space_in_characters': 'str', + 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', + 'anchor_case_sensitive': 'str', + 'anchor_case_sensitive_metadata': 'PropertyMetadata', + 'anchor_horizontal_alignment': 'str', + 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', + 'anchor_ignore_if_not_present': 'str', + 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', + 'anchor_match_whole_word': 'str', + 'anchor_match_whole_word_metadata': 'PropertyMetadata', + 'anchor_string': 'str', + 'anchor_string_metadata': 'PropertyMetadata', + 'anchor_tab_processor_version': 'str', + 'anchor_tab_processor_version_metadata': 'PropertyMetadata', + 'anchor_units': 'str', + 'anchor_units_metadata': 'PropertyMetadata', + 'anchor_x_offset': 'str', + 'anchor_x_offset_metadata': 'PropertyMetadata', + 'anchor_y_offset': 'str', + 'anchor_y_offset_metadata': 'PropertyMetadata', + 'conditional_parent_label': 'str', + 'conditional_parent_label_metadata': 'PropertyMetadata', + 'conditional_parent_value': 'str', + 'conditional_parent_value_metadata': 'PropertyMetadata', + 'custom_tab_id': 'str', + 'custom_tab_id_metadata': 'PropertyMetadata', + 'document_id': 'str', + 'document_id_metadata': 'PropertyMetadata', + 'error_details': 'ErrorDetails', + 'form_order': 'str', + 'form_order_metadata': 'PropertyMetadata', + 'form_page_label': 'str', + 'form_page_label_metadata': 'PropertyMetadata', + 'form_page_number': 'str', + 'form_page_number_metadata': 'PropertyMetadata', + 'height': 'str', + 'height_metadata': 'PropertyMetadata', + 'locked': 'str', + 'locked_metadata': 'PropertyMetadata', + 'merge_field': 'MergeField', + 'merge_field_xml': 'str', + 'page_number': 'str', + 'page_number_metadata': 'PropertyMetadata', + 'recipient_id': 'str', + 'recipient_id_guid': 'str', + 'recipient_id_guid_metadata': 'PropertyMetadata', + 'recipient_id_metadata': 'PropertyMetadata', + 'required': 'str', + 'required_metadata': 'PropertyMetadata', + 'smart_contract_information': 'SmartContractInformation', + 'status': 'str', + 'status_metadata': 'PropertyMetadata', + 'tab_group_labels': 'list[str]', + 'tab_group_labels_metadata': 'PropertyMetadata', + 'tab_id': 'str', + 'tab_id_metadata': 'PropertyMetadata', + 'tab_label_metadata': 'PropertyMetadata', + 'tab_order': 'str', + 'tab_order_metadata': 'PropertyMetadata', + 'tab_type': 'str', + 'tab_type_metadata': 'PropertyMetadata', + 'template_locked': 'str', + 'template_locked_metadata': 'PropertyMetadata', + 'template_required': 'str', + 'template_required_metadata': 'PropertyMetadata', + 'tooltip': 'str', + 'tool_tip_metadata': 'PropertyMetadata', + 'width': 'str', + 'width_metadata': 'PropertyMetadata', + 'x_position': 'str', + 'x_position_metadata': 'PropertyMetadata', + 'y_position': 'str', + 'y_position_metadata': 'PropertyMetadata' + } + + attribute_map = { + 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', + 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', + 'anchor_case_sensitive': 'anchorCaseSensitive', + 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', + 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', + 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', + 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', + 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', + 'anchor_match_whole_word': 'anchorMatchWholeWord', + 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', + 'anchor_string': 'anchorString', + 'anchor_string_metadata': 'anchorStringMetadata', + 'anchor_tab_processor_version': 'anchorTabProcessorVersion', + 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', + 'anchor_units': 'anchorUnits', + 'anchor_units_metadata': 'anchorUnitsMetadata', + 'anchor_x_offset': 'anchorXOffset', + 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', + 'anchor_y_offset': 'anchorYOffset', + 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', + 'conditional_parent_label': 'conditionalParentLabel', + 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', + 'conditional_parent_value': 'conditionalParentValue', + 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', + 'custom_tab_id': 'customTabId', + 'custom_tab_id_metadata': 'customTabIdMetadata', + 'document_id': 'documentId', + 'document_id_metadata': 'documentIdMetadata', + 'error_details': 'errorDetails', + 'form_order': 'formOrder', + 'form_order_metadata': 'formOrderMetadata', + 'form_page_label': 'formPageLabel', + 'form_page_label_metadata': 'formPageLabelMetadata', + 'form_page_number': 'formPageNumber', + 'form_page_number_metadata': 'formPageNumberMetadata', + 'height': 'height', + 'height_metadata': 'heightMetadata', + 'locked': 'locked', + 'locked_metadata': 'lockedMetadata', + 'merge_field': 'mergeField', + 'merge_field_xml': 'mergeFieldXml', + 'page_number': 'pageNumber', + 'page_number_metadata': 'pageNumberMetadata', + 'recipient_id': 'recipientId', + 'recipient_id_guid': 'recipientIdGuid', + 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', + 'recipient_id_metadata': 'recipientIdMetadata', + 'required': 'required', + 'required_metadata': 'requiredMetadata', + 'smart_contract_information': 'smartContractInformation', + 'status': 'status', + 'status_metadata': 'statusMetadata', + 'tab_group_labels': 'tabGroupLabels', + 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', + 'tab_id': 'tabId', + 'tab_id_metadata': 'tabIdMetadata', + 'tab_label_metadata': 'tabLabelMetadata', + 'tab_order': 'tabOrder', + 'tab_order_metadata': 'tabOrderMetadata', + 'tab_type': 'tabType', + 'tab_type_metadata': 'tabTypeMetadata', + 'template_locked': 'templateLocked', + 'template_locked_metadata': 'templateLockedMetadata', + 'template_required': 'templateRequired', + 'template_required_metadata': 'templateRequiredMetadata', + 'tooltip': 'tooltip', + 'tool_tip_metadata': 'toolTipMetadata', + 'width': 'width', + 'width_metadata': 'widthMetadata', + 'x_position': 'xPosition', + 'x_position_metadata': 'xPositionMetadata', + 'y_position': 'yPosition', + 'y_position_metadata': 'yPositionMetadata' + } + + def __init__(self, anchor_allow_white_space_in_characters=None, anchor_allow_white_space_in_characters_metadata=None, anchor_case_sensitive=None, anchor_case_sensitive_metadata=None, anchor_horizontal_alignment=None, anchor_horizontal_alignment_metadata=None, anchor_ignore_if_not_present=None, anchor_ignore_if_not_present_metadata=None, anchor_match_whole_word=None, anchor_match_whole_word_metadata=None, anchor_string=None, anchor_string_metadata=None, anchor_tab_processor_version=None, anchor_tab_processor_version_metadata=None, anchor_units=None, anchor_units_metadata=None, anchor_x_offset=None, anchor_x_offset_metadata=None, anchor_y_offset=None, anchor_y_offset_metadata=None, conditional_parent_label=None, conditional_parent_label_metadata=None, conditional_parent_value=None, conditional_parent_value_metadata=None, custom_tab_id=None, custom_tab_id_metadata=None, document_id=None, document_id_metadata=None, error_details=None, form_order=None, form_order_metadata=None, form_page_label=None, form_page_label_metadata=None, form_page_number=None, form_page_number_metadata=None, height=None, height_metadata=None, locked=None, locked_metadata=None, merge_field=None, merge_field_xml=None, page_number=None, page_number_metadata=None, recipient_id=None, recipient_id_guid=None, recipient_id_guid_metadata=None, recipient_id_metadata=None, required=None, required_metadata=None, smart_contract_information=None, status=None, status_metadata=None, tab_group_labels=None, tab_group_labels_metadata=None, tab_id=None, tab_id_metadata=None, tab_label_metadata=None, tab_order=None, tab_order_metadata=None, tab_type=None, tab_type_metadata=None, template_locked=None, template_locked_metadata=None, template_required=None, template_required_metadata=None, tooltip=None, tool_tip_metadata=None, width=None, width_metadata=None, x_position=None, x_position_metadata=None, y_position=None, y_position_metadata=None): # noqa: E501 + """NotaryCertificate - a model defined in Swagger""" # noqa: E501 + + self._anchor_allow_white_space_in_characters = None + self._anchor_allow_white_space_in_characters_metadata = None + self._anchor_case_sensitive = None + self._anchor_case_sensitive_metadata = None + self._anchor_horizontal_alignment = None + self._anchor_horizontal_alignment_metadata = None + self._anchor_ignore_if_not_present = None + self._anchor_ignore_if_not_present_metadata = None + self._anchor_match_whole_word = None + self._anchor_match_whole_word_metadata = None + self._anchor_string = None + self._anchor_string_metadata = None + self._anchor_tab_processor_version = None + self._anchor_tab_processor_version_metadata = None + self._anchor_units = None + self._anchor_units_metadata = None + self._anchor_x_offset = None + self._anchor_x_offset_metadata = None + self._anchor_y_offset = None + self._anchor_y_offset_metadata = None + self._conditional_parent_label = None + self._conditional_parent_label_metadata = None + self._conditional_parent_value = None + self._conditional_parent_value_metadata = None + self._custom_tab_id = None + self._custom_tab_id_metadata = None + self._document_id = None + self._document_id_metadata = None + self._error_details = None + self._form_order = None + self._form_order_metadata = None + self._form_page_label = None + self._form_page_label_metadata = None + self._form_page_number = None + self._form_page_number_metadata = None + self._height = None + self._height_metadata = None + self._locked = None + self._locked_metadata = None + self._merge_field = None + self._merge_field_xml = None + self._page_number = None + self._page_number_metadata = None + self._recipient_id = None + self._recipient_id_guid = None + self._recipient_id_guid_metadata = None + self._recipient_id_metadata = None + self._required = None + self._required_metadata = None + self._smart_contract_information = None + self._status = None + self._status_metadata = None + self._tab_group_labels = None + self._tab_group_labels_metadata = None + self._tab_id = None + self._tab_id_metadata = None + self._tab_label_metadata = None + self._tab_order = None + self._tab_order_metadata = None + self._tab_type = None + self._tab_type_metadata = None + self._template_locked = None + self._template_locked_metadata = None + self._template_required = None + self._template_required_metadata = None + self._tooltip = None + self._tool_tip_metadata = None + self._width = None + self._width_metadata = None + self._x_position = None + self._x_position_metadata = None + self._y_position = None + self._y_position_metadata = None + self.discriminator = None + + if anchor_allow_white_space_in_characters is not None: + self.anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters + if anchor_allow_white_space_in_characters_metadata is not None: + self.anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata + if anchor_case_sensitive is not None: + self.anchor_case_sensitive = anchor_case_sensitive + if anchor_case_sensitive_metadata is not None: + self.anchor_case_sensitive_metadata = anchor_case_sensitive_metadata + if anchor_horizontal_alignment is not None: + self.anchor_horizontal_alignment = anchor_horizontal_alignment + if anchor_horizontal_alignment_metadata is not None: + self.anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata + if anchor_ignore_if_not_present is not None: + self.anchor_ignore_if_not_present = anchor_ignore_if_not_present + if anchor_ignore_if_not_present_metadata is not None: + self.anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata + if anchor_match_whole_word is not None: + self.anchor_match_whole_word = anchor_match_whole_word + if anchor_match_whole_word_metadata is not None: + self.anchor_match_whole_word_metadata = anchor_match_whole_word_metadata + if anchor_string is not None: + self.anchor_string = anchor_string + if anchor_string_metadata is not None: + self.anchor_string_metadata = anchor_string_metadata + if anchor_tab_processor_version is not None: + self.anchor_tab_processor_version = anchor_tab_processor_version + if anchor_tab_processor_version_metadata is not None: + self.anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata + if anchor_units is not None: + self.anchor_units = anchor_units + if anchor_units_metadata is not None: + self.anchor_units_metadata = anchor_units_metadata + if anchor_x_offset is not None: + self.anchor_x_offset = anchor_x_offset + if anchor_x_offset_metadata is not None: + self.anchor_x_offset_metadata = anchor_x_offset_metadata + if anchor_y_offset is not None: + self.anchor_y_offset = anchor_y_offset + if anchor_y_offset_metadata is not None: + self.anchor_y_offset_metadata = anchor_y_offset_metadata + if conditional_parent_label is not None: + self.conditional_parent_label = conditional_parent_label + if conditional_parent_label_metadata is not None: + self.conditional_parent_label_metadata = conditional_parent_label_metadata + if conditional_parent_value is not None: + self.conditional_parent_value = conditional_parent_value + if conditional_parent_value_metadata is not None: + self.conditional_parent_value_metadata = conditional_parent_value_metadata + if custom_tab_id is not None: + self.custom_tab_id = custom_tab_id + if custom_tab_id_metadata is not None: + self.custom_tab_id_metadata = custom_tab_id_metadata + if document_id is not None: + self.document_id = document_id + if document_id_metadata is not None: + self.document_id_metadata = document_id_metadata + if error_details is not None: + self.error_details = error_details + if form_order is not None: + self.form_order = form_order + if form_order_metadata is not None: + self.form_order_metadata = form_order_metadata + if form_page_label is not None: + self.form_page_label = form_page_label + if form_page_label_metadata is not None: + self.form_page_label_metadata = form_page_label_metadata + if form_page_number is not None: + self.form_page_number = form_page_number + if form_page_number_metadata is not None: + self.form_page_number_metadata = form_page_number_metadata + if height is not None: + self.height = height + if height_metadata is not None: + self.height_metadata = height_metadata + if locked is not None: + self.locked = locked + if locked_metadata is not None: + self.locked_metadata = locked_metadata + if merge_field is not None: + self.merge_field = merge_field + if merge_field_xml is not None: + self.merge_field_xml = merge_field_xml + if page_number is not None: + self.page_number = page_number + if page_number_metadata is not None: + self.page_number_metadata = page_number_metadata + if recipient_id is not None: + self.recipient_id = recipient_id + if recipient_id_guid is not None: + self.recipient_id_guid = recipient_id_guid + if recipient_id_guid_metadata is not None: + self.recipient_id_guid_metadata = recipient_id_guid_metadata + if recipient_id_metadata is not None: + self.recipient_id_metadata = recipient_id_metadata + if required is not None: + self.required = required + if required_metadata is not None: + self.required_metadata = required_metadata + if smart_contract_information is not None: + self.smart_contract_information = smart_contract_information + if status is not None: + self.status = status + if status_metadata is not None: + self.status_metadata = status_metadata + if tab_group_labels is not None: + self.tab_group_labels = tab_group_labels + if tab_group_labels_metadata is not None: + self.tab_group_labels_metadata = tab_group_labels_metadata + if tab_id is not None: + self.tab_id = tab_id + if tab_id_metadata is not None: + self.tab_id_metadata = tab_id_metadata + if tab_label_metadata is not None: + self.tab_label_metadata = tab_label_metadata + if tab_order is not None: + self.tab_order = tab_order + if tab_order_metadata is not None: + self.tab_order_metadata = tab_order_metadata + if tab_type is not None: + self.tab_type = tab_type + if tab_type_metadata is not None: + self.tab_type_metadata = tab_type_metadata + if template_locked is not None: + self.template_locked = template_locked + if template_locked_metadata is not None: + self.template_locked_metadata = template_locked_metadata + if template_required is not None: + self.template_required = template_required + if template_required_metadata is not None: + self.template_required_metadata = template_required_metadata + if tooltip is not None: + self.tooltip = tooltip + if tool_tip_metadata is not None: + self.tool_tip_metadata = tool_tip_metadata + if width is not None: + self.width = width + if width_metadata is not None: + self.width_metadata = width_metadata + if x_position is not None: + self.x_position = x_position + if x_position_metadata is not None: + self.x_position_metadata = x_position_metadata + if y_position is not None: + self.y_position = y_position + if y_position_metadata is not None: + self.y_position_metadata = y_position_metadata + + @property + def anchor_allow_white_space_in_characters(self): + """Gets the anchor_allow_white_space_in_characters of this NotaryCertificate. # noqa: E501 + + # noqa: E501 + + :return: The anchor_allow_white_space_in_characters of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._anchor_allow_white_space_in_characters + + @anchor_allow_white_space_in_characters.setter + def anchor_allow_white_space_in_characters(self, anchor_allow_white_space_in_characters): + """Sets the anchor_allow_white_space_in_characters of this NotaryCertificate. + + # noqa: E501 + + :param anchor_allow_white_space_in_characters: The anchor_allow_white_space_in_characters of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters + + @property + def anchor_allow_white_space_in_characters_metadata(self): + """Gets the anchor_allow_white_space_in_characters_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The anchor_allow_white_space_in_characters_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_allow_white_space_in_characters_metadata + + @anchor_allow_white_space_in_characters_metadata.setter + def anchor_allow_white_space_in_characters_metadata(self, anchor_allow_white_space_in_characters_metadata): + """Sets the anchor_allow_white_space_in_characters_metadata of this NotaryCertificate. + + + :param anchor_allow_white_space_in_characters_metadata: The anchor_allow_white_space_in_characters_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata + + @property + def anchor_case_sensitive(self): + """Gets the anchor_case_sensitive of this NotaryCertificate. # noqa: E501 + + When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 + + :return: The anchor_case_sensitive of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._anchor_case_sensitive + + @anchor_case_sensitive.setter + def anchor_case_sensitive(self, anchor_case_sensitive): + """Sets the anchor_case_sensitive of this NotaryCertificate. + + When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 + + :param anchor_case_sensitive: The anchor_case_sensitive of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._anchor_case_sensitive = anchor_case_sensitive + + @property + def anchor_case_sensitive_metadata(self): + """Gets the anchor_case_sensitive_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The anchor_case_sensitive_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_case_sensitive_metadata + + @anchor_case_sensitive_metadata.setter + def anchor_case_sensitive_metadata(self, anchor_case_sensitive_metadata): + """Sets the anchor_case_sensitive_metadata of this NotaryCertificate. + + + :param anchor_case_sensitive_metadata: The anchor_case_sensitive_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_case_sensitive_metadata = anchor_case_sensitive_metadata + + @property + def anchor_horizontal_alignment(self): + """Gets the anchor_horizontal_alignment of this NotaryCertificate. # noqa: E501 + + Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 + + :return: The anchor_horizontal_alignment of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._anchor_horizontal_alignment + + @anchor_horizontal_alignment.setter + def anchor_horizontal_alignment(self, anchor_horizontal_alignment): + """Sets the anchor_horizontal_alignment of this NotaryCertificate. + + Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 + + :param anchor_horizontal_alignment: The anchor_horizontal_alignment of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._anchor_horizontal_alignment = anchor_horizontal_alignment + + @property + def anchor_horizontal_alignment_metadata(self): + """Gets the anchor_horizontal_alignment_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The anchor_horizontal_alignment_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_horizontal_alignment_metadata + + @anchor_horizontal_alignment_metadata.setter + def anchor_horizontal_alignment_metadata(self, anchor_horizontal_alignment_metadata): + """Sets the anchor_horizontal_alignment_metadata of this NotaryCertificate. + + + :param anchor_horizontal_alignment_metadata: The anchor_horizontal_alignment_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata + + @property + def anchor_ignore_if_not_present(self): + """Gets the anchor_ignore_if_not_present of this NotaryCertificate. # noqa: E501 + + When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 + + :return: The anchor_ignore_if_not_present of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._anchor_ignore_if_not_present + + @anchor_ignore_if_not_present.setter + def anchor_ignore_if_not_present(self, anchor_ignore_if_not_present): + """Sets the anchor_ignore_if_not_present of this NotaryCertificate. + + When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 + + :param anchor_ignore_if_not_present: The anchor_ignore_if_not_present of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._anchor_ignore_if_not_present = anchor_ignore_if_not_present + + @property + def anchor_ignore_if_not_present_metadata(self): + """Gets the anchor_ignore_if_not_present_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The anchor_ignore_if_not_present_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_ignore_if_not_present_metadata + + @anchor_ignore_if_not_present_metadata.setter + def anchor_ignore_if_not_present_metadata(self, anchor_ignore_if_not_present_metadata): + """Sets the anchor_ignore_if_not_present_metadata of this NotaryCertificate. + + + :param anchor_ignore_if_not_present_metadata: The anchor_ignore_if_not_present_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata + + @property + def anchor_match_whole_word(self): + """Gets the anchor_match_whole_word of this NotaryCertificate. # noqa: E501 + + When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. # noqa: E501 + + :return: The anchor_match_whole_word of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._anchor_match_whole_word + + @anchor_match_whole_word.setter + def anchor_match_whole_word(self, anchor_match_whole_word): + """Sets the anchor_match_whole_word of this NotaryCertificate. + + When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. # noqa: E501 + + :param anchor_match_whole_word: The anchor_match_whole_word of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._anchor_match_whole_word = anchor_match_whole_word + + @property + def anchor_match_whole_word_metadata(self): + """Gets the anchor_match_whole_word_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The anchor_match_whole_word_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_match_whole_word_metadata + + @anchor_match_whole_word_metadata.setter + def anchor_match_whole_word_metadata(self, anchor_match_whole_word_metadata): + """Sets the anchor_match_whole_word_metadata of this NotaryCertificate. + + + :param anchor_match_whole_word_metadata: The anchor_match_whole_word_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_match_whole_word_metadata = anchor_match_whole_word_metadata + + @property + def anchor_string(self): + """Gets the anchor_string of this NotaryCertificate. # noqa: E501 + + Anchor text information for a radio button. # noqa: E501 + + :return: The anchor_string of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._anchor_string + + @anchor_string.setter + def anchor_string(self, anchor_string): + """Sets the anchor_string of this NotaryCertificate. + + Anchor text information for a radio button. # noqa: E501 + + :param anchor_string: The anchor_string of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._anchor_string = anchor_string + + @property + def anchor_string_metadata(self): + """Gets the anchor_string_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The anchor_string_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_string_metadata + + @anchor_string_metadata.setter + def anchor_string_metadata(self, anchor_string_metadata): + """Sets the anchor_string_metadata of this NotaryCertificate. + + + :param anchor_string_metadata: The anchor_string_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_string_metadata = anchor_string_metadata + + @property + def anchor_tab_processor_version(self): + """Gets the anchor_tab_processor_version of this NotaryCertificate. # noqa: E501 + + # noqa: E501 + + :return: The anchor_tab_processor_version of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._anchor_tab_processor_version + + @anchor_tab_processor_version.setter + def anchor_tab_processor_version(self, anchor_tab_processor_version): + """Sets the anchor_tab_processor_version of this NotaryCertificate. + + # noqa: E501 + + :param anchor_tab_processor_version: The anchor_tab_processor_version of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._anchor_tab_processor_version = anchor_tab_processor_version + + @property + def anchor_tab_processor_version_metadata(self): + """Gets the anchor_tab_processor_version_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The anchor_tab_processor_version_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_tab_processor_version_metadata + + @anchor_tab_processor_version_metadata.setter + def anchor_tab_processor_version_metadata(self, anchor_tab_processor_version_metadata): + """Sets the anchor_tab_processor_version_metadata of this NotaryCertificate. + + + :param anchor_tab_processor_version_metadata: The anchor_tab_processor_version_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata + + @property + def anchor_units(self): + """Gets the anchor_units of this NotaryCertificate. # noqa: E501 + + Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 + + :return: The anchor_units of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._anchor_units + + @anchor_units.setter + def anchor_units(self, anchor_units): + """Sets the anchor_units of this NotaryCertificate. + + Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 + + :param anchor_units: The anchor_units of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._anchor_units = anchor_units + + @property + def anchor_units_metadata(self): + """Gets the anchor_units_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The anchor_units_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_units_metadata + + @anchor_units_metadata.setter + def anchor_units_metadata(self, anchor_units_metadata): + """Sets the anchor_units_metadata of this NotaryCertificate. + + + :param anchor_units_metadata: The anchor_units_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_units_metadata = anchor_units_metadata + + @property + def anchor_x_offset(self): + """Gets the anchor_x_offset of this NotaryCertificate. # noqa: E501 + + Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 + + :return: The anchor_x_offset of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._anchor_x_offset + + @anchor_x_offset.setter + def anchor_x_offset(self, anchor_x_offset): + """Sets the anchor_x_offset of this NotaryCertificate. + + Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 + + :param anchor_x_offset: The anchor_x_offset of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._anchor_x_offset = anchor_x_offset + + @property + def anchor_x_offset_metadata(self): + """Gets the anchor_x_offset_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The anchor_x_offset_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_x_offset_metadata + + @anchor_x_offset_metadata.setter + def anchor_x_offset_metadata(self, anchor_x_offset_metadata): + """Sets the anchor_x_offset_metadata of this NotaryCertificate. + + + :param anchor_x_offset_metadata: The anchor_x_offset_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_x_offset_metadata = anchor_x_offset_metadata + + @property + def anchor_y_offset(self): + """Gets the anchor_y_offset of this NotaryCertificate. # noqa: E501 + + Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 + + :return: The anchor_y_offset of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._anchor_y_offset + + @anchor_y_offset.setter + def anchor_y_offset(self, anchor_y_offset): + """Sets the anchor_y_offset of this NotaryCertificate. + + Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 + + :param anchor_y_offset: The anchor_y_offset of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._anchor_y_offset = anchor_y_offset + + @property + def anchor_y_offset_metadata(self): + """Gets the anchor_y_offset_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The anchor_y_offset_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_y_offset_metadata + + @anchor_y_offset_metadata.setter + def anchor_y_offset_metadata(self, anchor_y_offset_metadata): + """Sets the anchor_y_offset_metadata of this NotaryCertificate. + + + :param anchor_y_offset_metadata: The anchor_y_offset_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_y_offset_metadata = anchor_y_offset_metadata + + @property + def conditional_parent_label(self): + """Gets the conditional_parent_label of this NotaryCertificate. # noqa: E501 + + For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 + + :return: The conditional_parent_label of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._conditional_parent_label + + @conditional_parent_label.setter + def conditional_parent_label(self, conditional_parent_label): + """Sets the conditional_parent_label of this NotaryCertificate. + + For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 + + :param conditional_parent_label: The conditional_parent_label of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._conditional_parent_label = conditional_parent_label + + @property + def conditional_parent_label_metadata(self): + """Gets the conditional_parent_label_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The conditional_parent_label_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._conditional_parent_label_metadata + + @conditional_parent_label_metadata.setter + def conditional_parent_label_metadata(self, conditional_parent_label_metadata): + """Sets the conditional_parent_label_metadata of this NotaryCertificate. + + + :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._conditional_parent_label_metadata = conditional_parent_label_metadata + + @property + def conditional_parent_value(self): + """Gets the conditional_parent_value of this NotaryCertificate. # noqa: E501 + + For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 + + :return: The conditional_parent_value of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._conditional_parent_value + + @conditional_parent_value.setter + def conditional_parent_value(self, conditional_parent_value): + """Sets the conditional_parent_value of this NotaryCertificate. + + For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 + + :param conditional_parent_value: The conditional_parent_value of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._conditional_parent_value = conditional_parent_value + + @property + def conditional_parent_value_metadata(self): + """Gets the conditional_parent_value_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The conditional_parent_value_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._conditional_parent_value_metadata + + @conditional_parent_value_metadata.setter + def conditional_parent_value_metadata(self, conditional_parent_value_metadata): + """Sets the conditional_parent_value_metadata of this NotaryCertificate. + + + :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._conditional_parent_value_metadata = conditional_parent_value_metadata + + @property + def custom_tab_id(self): + """Gets the custom_tab_id of this NotaryCertificate. # noqa: E501 + + The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. # noqa: E501 + + :return: The custom_tab_id of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._custom_tab_id + + @custom_tab_id.setter + def custom_tab_id(self, custom_tab_id): + """Sets the custom_tab_id of this NotaryCertificate. + + The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. # noqa: E501 + + :param custom_tab_id: The custom_tab_id of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._custom_tab_id = custom_tab_id + + @property + def custom_tab_id_metadata(self): + """Gets the custom_tab_id_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The custom_tab_id_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._custom_tab_id_metadata + + @custom_tab_id_metadata.setter + def custom_tab_id_metadata(self, custom_tab_id_metadata): + """Sets the custom_tab_id_metadata of this NotaryCertificate. + + + :param custom_tab_id_metadata: The custom_tab_id_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._custom_tab_id_metadata = custom_tab_id_metadata + + @property + def document_id(self): + """Gets the document_id of this NotaryCertificate. # noqa: E501 + + Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 + + :return: The document_id of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._document_id + + @document_id.setter + def document_id(self, document_id): + """Sets the document_id of this NotaryCertificate. + + Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 + + :param document_id: The document_id of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._document_id = document_id + + @property + def document_id_metadata(self): + """Gets the document_id_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The document_id_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._document_id_metadata + + @document_id_metadata.setter + def document_id_metadata(self, document_id_metadata): + """Sets the document_id_metadata of this NotaryCertificate. + + + :param document_id_metadata: The document_id_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._document_id_metadata = document_id_metadata + + @property + def error_details(self): + """Gets the error_details of this NotaryCertificate. # noqa: E501 + + + :return: The error_details of this NotaryCertificate. # noqa: E501 + :rtype: ErrorDetails + """ + return self._error_details + + @error_details.setter + def error_details(self, error_details): + """Sets the error_details of this NotaryCertificate. + + + :param error_details: The error_details of this NotaryCertificate. # noqa: E501 + :type: ErrorDetails + """ + + self._error_details = error_details + + @property + def form_order(self): + """Gets the form_order of this NotaryCertificate. # noqa: E501 + + # noqa: E501 + + :return: The form_order of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._form_order + + @form_order.setter + def form_order(self, form_order): + """Sets the form_order of this NotaryCertificate. + + # noqa: E501 + + :param form_order: The form_order of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._form_order = form_order + + @property + def form_order_metadata(self): + """Gets the form_order_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The form_order_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._form_order_metadata + + @form_order_metadata.setter + def form_order_metadata(self, form_order_metadata): + """Sets the form_order_metadata of this NotaryCertificate. + + + :param form_order_metadata: The form_order_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._form_order_metadata = form_order_metadata + + @property + def form_page_label(self): + """Gets the form_page_label of this NotaryCertificate. # noqa: E501 + + # noqa: E501 + + :return: The form_page_label of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._form_page_label + + @form_page_label.setter + def form_page_label(self, form_page_label): + """Sets the form_page_label of this NotaryCertificate. + + # noqa: E501 + + :param form_page_label: The form_page_label of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._form_page_label = form_page_label + + @property + def form_page_label_metadata(self): + """Gets the form_page_label_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The form_page_label_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._form_page_label_metadata + + @form_page_label_metadata.setter + def form_page_label_metadata(self, form_page_label_metadata): + """Sets the form_page_label_metadata of this NotaryCertificate. + + + :param form_page_label_metadata: The form_page_label_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._form_page_label_metadata = form_page_label_metadata + + @property + def form_page_number(self): + """Gets the form_page_number of this NotaryCertificate. # noqa: E501 + + # noqa: E501 + + :return: The form_page_number of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._form_page_number + + @form_page_number.setter + def form_page_number(self, form_page_number): + """Sets the form_page_number of this NotaryCertificate. + + # noqa: E501 + + :param form_page_number: The form_page_number of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._form_page_number = form_page_number + + @property + def form_page_number_metadata(self): + """Gets the form_page_number_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The form_page_number_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._form_page_number_metadata + + @form_page_number_metadata.setter + def form_page_number_metadata(self, form_page_number_metadata): + """Sets the form_page_number_metadata of this NotaryCertificate. + + + :param form_page_number_metadata: The form_page_number_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._form_page_number_metadata = form_page_number_metadata + + @property + def height(self): + """Gets the height of this NotaryCertificate. # noqa: E501 + + Height of the tab in pixels. # noqa: E501 + + :return: The height of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._height + + @height.setter + def height(self, height): + """Sets the height of this NotaryCertificate. + + Height of the tab in pixels. # noqa: E501 + + :param height: The height of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._height = height + + @property + def height_metadata(self): + """Gets the height_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The height_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._height_metadata + + @height_metadata.setter + def height_metadata(self, height_metadata): + """Sets the height_metadata of this NotaryCertificate. + + + :param height_metadata: The height_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._height_metadata = height_metadata + + @property + def locked(self): + """Gets the locked of this NotaryCertificate. # noqa: E501 + + When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 + + :return: The locked of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._locked + + @locked.setter + def locked(self, locked): + """Sets the locked of this NotaryCertificate. + + When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 + + :param locked: The locked of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._locked = locked + + @property + def locked_metadata(self): + """Gets the locked_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The locked_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._locked_metadata + + @locked_metadata.setter + def locked_metadata(self, locked_metadata): + """Sets the locked_metadata of this NotaryCertificate. + + + :param locked_metadata: The locked_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._locked_metadata = locked_metadata + + @property + def merge_field(self): + """Gets the merge_field of this NotaryCertificate. # noqa: E501 + + + :return: The merge_field of this NotaryCertificate. # noqa: E501 + :rtype: MergeField + """ + return self._merge_field + + @merge_field.setter + def merge_field(self, merge_field): + """Sets the merge_field of this NotaryCertificate. + + + :param merge_field: The merge_field of this NotaryCertificate. # noqa: E501 + :type: MergeField + """ + + self._merge_field = merge_field + + @property + def merge_field_xml(self): + """Gets the merge_field_xml of this NotaryCertificate. # noqa: E501 + + # noqa: E501 + + :return: The merge_field_xml of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._merge_field_xml + + @merge_field_xml.setter + def merge_field_xml(self, merge_field_xml): + """Sets the merge_field_xml of this NotaryCertificate. + + # noqa: E501 + + :param merge_field_xml: The merge_field_xml of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._merge_field_xml = merge_field_xml + + @property + def page_number(self): + """Gets the page_number of this NotaryCertificate. # noqa: E501 + + Specifies the page number on which the tab is located. # noqa: E501 + + :return: The page_number of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._page_number + + @page_number.setter + def page_number(self, page_number): + """Sets the page_number of this NotaryCertificate. + + Specifies the page number on which the tab is located. # noqa: E501 + + :param page_number: The page_number of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._page_number = page_number + + @property + def page_number_metadata(self): + """Gets the page_number_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The page_number_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._page_number_metadata + + @page_number_metadata.setter + def page_number_metadata(self, page_number_metadata): + """Sets the page_number_metadata of this NotaryCertificate. + + + :param page_number_metadata: The page_number_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._page_number_metadata = page_number_metadata + + @property + def recipient_id(self): + """Gets the recipient_id of this NotaryCertificate. # 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 NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._recipient_id + + @recipient_id.setter + def recipient_id(self, recipient_id): + """Sets the recipient_id of this NotaryCertificate. + + 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 NotaryCertificate. # noqa: E501 + :type: str + """ + + self._recipient_id = recipient_id + + @property + def recipient_id_guid(self): + """Gets the recipient_id_guid of this NotaryCertificate. # noqa: E501 + + # noqa: E501 + + :return: The recipient_id_guid of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._recipient_id_guid + + @recipient_id_guid.setter + def recipient_id_guid(self, recipient_id_guid): + """Sets the recipient_id_guid of this NotaryCertificate. + + # noqa: E501 + + :param recipient_id_guid: The recipient_id_guid of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._recipient_id_guid = recipient_id_guid + + @property + def recipient_id_guid_metadata(self): + """Gets the recipient_id_guid_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The recipient_id_guid_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._recipient_id_guid_metadata + + @recipient_id_guid_metadata.setter + def recipient_id_guid_metadata(self, recipient_id_guid_metadata): + """Sets the recipient_id_guid_metadata of this NotaryCertificate. + + + :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._recipient_id_guid_metadata = recipient_id_guid_metadata + + @property + def recipient_id_metadata(self): + """Gets the recipient_id_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The recipient_id_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._recipient_id_metadata + + @recipient_id_metadata.setter + def recipient_id_metadata(self, recipient_id_metadata): + """Sets the recipient_id_metadata of this NotaryCertificate. + + + :param recipient_id_metadata: The recipient_id_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._recipient_id_metadata = recipient_id_metadata + + @property + def required(self): + """Gets the required of this NotaryCertificate. # noqa: E501 + + When set to **true**, the signer is required to fill out this tab # noqa: E501 + + :return: The required of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._required + + @required.setter + def required(self, required): + """Sets the required of this NotaryCertificate. + + When set to **true**, the signer is required to fill out this tab # noqa: E501 + + :param required: The required of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._required = required + + @property + def required_metadata(self): + """Gets the required_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The required_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._required_metadata + + @required_metadata.setter + def required_metadata(self, required_metadata): + """Sets the required_metadata of this NotaryCertificate. + + + :param required_metadata: The required_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._required_metadata = required_metadata + + @property + def smart_contract_information(self): + """Gets the smart_contract_information of this NotaryCertificate. # noqa: E501 + + + :return: The smart_contract_information of this NotaryCertificate. # noqa: E501 + :rtype: SmartContractInformation + """ + return self._smart_contract_information + + @smart_contract_information.setter + def smart_contract_information(self, smart_contract_information): + """Sets the smart_contract_information of this NotaryCertificate. + + + :param smart_contract_information: The smart_contract_information of this NotaryCertificate. # noqa: E501 + :type: SmartContractInformation + """ + + self._smart_contract_information = smart_contract_information + + @property + def status(self): + """Gets the status of this NotaryCertificate. # 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 NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this NotaryCertificate. + + 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 NotaryCertificate. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def status_metadata(self): + """Gets the status_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The status_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._status_metadata + + @status_metadata.setter + def status_metadata(self, status_metadata): + """Sets the status_metadata of this NotaryCertificate. + + + :param status_metadata: The status_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._status_metadata = status_metadata + + @property + def tab_group_labels(self): + """Gets the tab_group_labels of this NotaryCertificate. # noqa: E501 + + # noqa: E501 + + :return: The tab_group_labels of this NotaryCertificate. # noqa: E501 + :rtype: list[str] + """ + return self._tab_group_labels + + @tab_group_labels.setter + def tab_group_labels(self, tab_group_labels): + """Sets the tab_group_labels of this NotaryCertificate. + + # noqa: E501 + + :param tab_group_labels: The tab_group_labels of this NotaryCertificate. # noqa: E501 + :type: list[str] + """ + + self._tab_group_labels = tab_group_labels + + @property + def tab_group_labels_metadata(self): + """Gets the tab_group_labels_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The tab_group_labels_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tab_group_labels_metadata + + @tab_group_labels_metadata.setter + def tab_group_labels_metadata(self, tab_group_labels_metadata): + """Sets the tab_group_labels_metadata of this NotaryCertificate. + + + :param tab_group_labels_metadata: The tab_group_labels_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._tab_group_labels_metadata = tab_group_labels_metadata + + @property + def tab_id(self): + """Gets the tab_id of this NotaryCertificate. # 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 NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._tab_id + + @tab_id.setter + def tab_id(self, tab_id): + """Sets the tab_id of this NotaryCertificate. + + 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 NotaryCertificate. # noqa: E501 + :type: str + """ + + self._tab_id = tab_id + + @property + def tab_id_metadata(self): + """Gets the tab_id_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The tab_id_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tab_id_metadata + + @tab_id_metadata.setter + def tab_id_metadata(self, tab_id_metadata): + """Sets the tab_id_metadata of this NotaryCertificate. + + + :param tab_id_metadata: The tab_id_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._tab_id_metadata = tab_id_metadata + + @property + def tab_label_metadata(self): + """Gets the tab_label_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The tab_label_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tab_label_metadata + + @tab_label_metadata.setter + def tab_label_metadata(self, tab_label_metadata): + """Sets the tab_label_metadata of this NotaryCertificate. + + + :param tab_label_metadata: The tab_label_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._tab_label_metadata = tab_label_metadata + + @property + def tab_order(self): + """Gets the tab_order of this NotaryCertificate. # noqa: E501 + + # noqa: E501 + + :return: The tab_order of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._tab_order + + @tab_order.setter + def tab_order(self, tab_order): + """Sets the tab_order of this NotaryCertificate. + + # noqa: E501 + + :param tab_order: The tab_order of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._tab_order = tab_order + + @property + def tab_order_metadata(self): + """Gets the tab_order_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The tab_order_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tab_order_metadata + + @tab_order_metadata.setter + def tab_order_metadata(self, tab_order_metadata): + """Sets the tab_order_metadata of this NotaryCertificate. + + + :param tab_order_metadata: The tab_order_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._tab_order_metadata = tab_order_metadata + + @property + def tab_type(self): + """Gets the tab_type of this NotaryCertificate. # noqa: E501 + + # noqa: E501 + + :return: The tab_type of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._tab_type + + @tab_type.setter + def tab_type(self, tab_type): + """Sets the tab_type of this NotaryCertificate. + + # noqa: E501 + + :param tab_type: The tab_type of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._tab_type = tab_type + + @property + def tab_type_metadata(self): + """Gets the tab_type_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The tab_type_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tab_type_metadata + + @tab_type_metadata.setter + def tab_type_metadata(self, tab_type_metadata): + """Sets the tab_type_metadata of this NotaryCertificate. + + + :param tab_type_metadata: The tab_type_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._tab_type_metadata = tab_type_metadata + + @property + def template_locked(self): + """Gets the template_locked of this NotaryCertificate. # noqa: E501 + + When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 + + :return: The template_locked of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._template_locked + + @template_locked.setter + def template_locked(self, template_locked): + """Sets the template_locked of this NotaryCertificate. + + When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 + + :param template_locked: The template_locked of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._template_locked = template_locked + + @property + def template_locked_metadata(self): + """Gets the template_locked_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The template_locked_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._template_locked_metadata + + @template_locked_metadata.setter + def template_locked_metadata(self, template_locked_metadata): + """Sets the template_locked_metadata of this NotaryCertificate. + + + :param template_locked_metadata: The template_locked_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._template_locked_metadata = template_locked_metadata + + @property + def template_required(self): + """Gets the template_required of this NotaryCertificate. # noqa: E501 + + When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 + + :return: The template_required of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._template_required + + @template_required.setter + def template_required(self, template_required): + """Sets the template_required of this NotaryCertificate. + + When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 + + :param template_required: The template_required of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._template_required = template_required + + @property + def template_required_metadata(self): + """Gets the template_required_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The template_required_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._template_required_metadata + + @template_required_metadata.setter + def template_required_metadata(self, template_required_metadata): + """Sets the template_required_metadata of this NotaryCertificate. + + + :param template_required_metadata: The template_required_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._template_required_metadata = template_required_metadata + + @property + def tooltip(self): + """Gets the tooltip of this NotaryCertificate. # noqa: E501 + + # noqa: E501 + + :return: The tooltip of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._tooltip + + @tooltip.setter + def tooltip(self, tooltip): + """Sets the tooltip of this NotaryCertificate. + + # noqa: E501 + + :param tooltip: The tooltip of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._tooltip = tooltip + + @property + def tool_tip_metadata(self): + """Gets the tool_tip_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The tool_tip_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tool_tip_metadata + + @tool_tip_metadata.setter + def tool_tip_metadata(self, tool_tip_metadata): + """Sets the tool_tip_metadata of this NotaryCertificate. + + + :param tool_tip_metadata: The tool_tip_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._tool_tip_metadata = tool_tip_metadata + + @property + def width(self): + """Gets the width of this NotaryCertificate. # noqa: E501 + + Width of the tab in pixels. # noqa: E501 + + :return: The width of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._width + + @width.setter + def width(self, width): + """Sets the width of this NotaryCertificate. + + Width of the tab in pixels. # noqa: E501 + + :param width: The width of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._width = width + + @property + def width_metadata(self): + """Gets the width_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The width_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._width_metadata + + @width_metadata.setter + def width_metadata(self, width_metadata): + """Sets the width_metadata of this NotaryCertificate. + + + :param width_metadata: The width_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._width_metadata = width_metadata + + @property + def x_position(self): + """Gets the x_position of this NotaryCertificate. # noqa: E501 + + This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 + + :return: The x_position of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._x_position + + @x_position.setter + def x_position(self, x_position): + """Sets the x_position of this NotaryCertificate. + + This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 + + :param x_position: The x_position of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._x_position = x_position + + @property + def x_position_metadata(self): + """Gets the x_position_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The x_position_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._x_position_metadata + + @x_position_metadata.setter + def x_position_metadata(self, x_position_metadata): + """Sets the x_position_metadata of this NotaryCertificate. + + + :param x_position_metadata: The x_position_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._x_position_metadata = x_position_metadata + + @property + def y_position(self): + """Gets the y_position of this NotaryCertificate. # noqa: E501 + + This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 + + :return: The y_position of this NotaryCertificate. # noqa: E501 + :rtype: str + """ + return self._y_position + + @y_position.setter + def y_position(self, y_position): + """Sets the y_position of this NotaryCertificate. + + This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 + + :param y_position: The y_position of this NotaryCertificate. # noqa: E501 + :type: str + """ + + self._y_position = y_position + + @property + def y_position_metadata(self): + """Gets the y_position_metadata of this NotaryCertificate. # noqa: E501 + + + :return: The y_position_metadata of this NotaryCertificate. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._y_position_metadata + + @y_position_metadata.setter + def y_position_metadata(self, y_position_metadata): + """Sets the y_position_metadata of this NotaryCertificate. + + + :param y_position_metadata: The y_position_metadata of this NotaryCertificate. # noqa: E501 + :type: PropertyMetadata + """ + + self._y_position_metadata = y_position_metadata + + 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(NotaryCertificate, 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, NotaryCertificate): + 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/notary_recipient.py b/docusign_esign/models/notary_recipient.py new file mode 100644 index 00000000..fa9f787d --- /dev/null +++ b/docusign_esign/models/notary_recipient.py @@ -0,0 +1,2637 @@ +# 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 NotaryRecipient(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': 'str', + 'access_code_metadata': 'PropertyMetadata', + 'add_access_code_to_email': 'str', + 'additional_notifications': 'list[RecipientAdditionalNotification]', + 'additional_notifications_metadata': 'PropertyMetadata', + 'agent_can_edit_email': 'str', + 'agent_can_edit_name': 'str', + 'allow_system_override_for_locked_recipient': 'str', + 'auto_navigation': 'str', + 'bulk_recipients_uri': 'str', + 'can_sign_offline': 'str', + 'client_user_id': 'str', + 'completed_count': 'str', + 'creation_reason': 'str', + 'custom_fields': 'list[str]', + 'declined_date_time': 'str', + 'declined_reason': 'str', + 'default_recipient': 'str', + 'delivered_date_time': 'str', + 'delivery_method': 'str', + 'delivery_method_metadata': 'PropertyMetadata', + 'designator_id': 'str', + 'designator_id_guid': 'str', + 'document_visibility': 'list[DocumentVisibility]', + 'email': 'str', + 'email_metadata': 'PropertyMetadata', + 'email_notification': 'RecipientEmailNotification', + 'embedded_recipient_start_url': 'str', + 'error_details': 'ErrorDetails', + 'excluded_documents': 'list[str]', + 'fax_number': 'str', + 'fax_number_metadata': 'PropertyMetadata', + 'first_name': 'str', + 'first_name_metadata': 'PropertyMetadata', + 'full_name': 'str', + 'full_name_metadata': 'PropertyMetadata', + 'id_check_configuration_name': 'str', + 'id_check_configuration_name_metadata': 'PropertyMetadata', + 'id_check_information_input': 'IdCheckInformationInput', + 'identity_verification': 'RecipientIdentityVerification', + 'inherit_email_notification_configuration': 'str', + 'is_bulk_recipient': 'str', + 'is_bulk_recipient_metadata': 'PropertyMetadata', + 'last_name': 'str', + 'last_name_metadata': 'PropertyMetadata', + 'locked_recipient_phone_auth_editable': 'str', + 'locked_recipient_sms_editable': 'str', + 'name': 'str', + 'name_metadata': 'PropertyMetadata', + 'notary_id': 'str', + 'notary_signers': 'list[str]', + 'notary_type': 'str', + 'note': 'str', + 'note_metadata': 'PropertyMetadata', + 'offline_attributes': 'OfflineAttributes', + 'phone_authentication': 'RecipientPhoneAuthentication', + 'proof_file': 'RecipientProofFile', + 'recipient_attachments': 'list[RecipientAttachment]', + 'recipient_authentication_status': 'AuthenticationStatus', + 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]', + 'recipient_id': 'str', + 'recipient_id_guid': 'str', + 'recipient_signature_providers': 'list[RecipientSignatureProvider]', + 'recipient_supplies_tabs': 'str', + 'recipient_type': 'str', + 'recipient_type_metadata': 'PropertyMetadata', + 'require_id_lookup': 'str', + 'require_id_lookup_metadata': 'PropertyMetadata', + 'require_signer_certificate': 'str', + 'require_sign_on_paper': 'str', + 'require_upload_signature': 'str', + 'role_name': 'str', + 'routing_order': 'str', + 'routing_order_metadata': 'PropertyMetadata', + 'sent_date_time': 'str', + 'signature_info': 'RecipientSignatureInformation', + 'signed_date_time': 'str', + 'sign_in_each_location': 'str', + 'sign_in_each_location_metadata': 'PropertyMetadata', + 'signing_group_id': 'str', + 'signing_group_id_metadata': 'PropertyMetadata', + 'signing_group_name': 'str', + 'signing_group_users': 'list[UserInfo]', + 'sms_authentication': 'RecipientSMSAuthentication', + 'social_authentications': 'list[SocialAuthentication]', + 'status': 'str', + 'status_code': 'str', + 'suppress_emails': 'str', + 'tabs': 'Tabs', + 'template_locked': 'str', + 'template_required': 'str', + 'total_tab_count': 'str', + 'user_id': 'str' + } + + attribute_map = { + 'access_code': 'accessCode', + 'access_code_metadata': 'accessCodeMetadata', + 'add_access_code_to_email': 'addAccessCodeToEmail', + 'additional_notifications': 'additionalNotifications', + 'additional_notifications_metadata': 'additionalNotificationsMetadata', + 'agent_can_edit_email': 'agentCanEditEmail', + 'agent_can_edit_name': 'agentCanEditName', + 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', + 'auto_navigation': 'autoNavigation', + 'bulk_recipients_uri': 'bulkRecipientsUri', + 'can_sign_offline': 'canSignOffline', + 'client_user_id': 'clientUserId', + 'completed_count': 'completedCount', + 'creation_reason': 'creationReason', + 'custom_fields': 'customFields', + 'declined_date_time': 'declinedDateTime', + 'declined_reason': 'declinedReason', + 'default_recipient': 'defaultRecipient', + 'delivered_date_time': 'deliveredDateTime', + 'delivery_method': 'deliveryMethod', + 'delivery_method_metadata': 'deliveryMethodMetadata', + 'designator_id': 'designatorId', + 'designator_id_guid': 'designatorIdGuid', + 'document_visibility': 'documentVisibility', + 'email': 'email', + 'email_metadata': 'emailMetadata', + 'email_notification': 'emailNotification', + 'embedded_recipient_start_url': 'embeddedRecipientStartURL', + 'error_details': 'errorDetails', + 'excluded_documents': 'excludedDocuments', + 'fax_number': 'faxNumber', + 'fax_number_metadata': 'faxNumberMetadata', + 'first_name': 'firstName', + 'first_name_metadata': 'firstNameMetadata', + 'full_name': 'fullName', + 'full_name_metadata': 'fullNameMetadata', + 'id_check_configuration_name': 'idCheckConfigurationName', + 'id_check_configuration_name_metadata': 'idCheckConfigurationNameMetadata', + 'id_check_information_input': 'idCheckInformationInput', + 'identity_verification': 'identityVerification', + 'inherit_email_notification_configuration': 'inheritEmailNotificationConfiguration', + 'is_bulk_recipient': 'isBulkRecipient', + 'is_bulk_recipient_metadata': 'isBulkRecipientMetadata', + 'last_name': 'lastName', + 'last_name_metadata': 'lastNameMetadata', + 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', + 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', + 'name': 'name', + 'name_metadata': 'nameMetadata', + 'notary_id': 'notaryId', + 'notary_signers': 'notarySigners', + 'notary_type': 'notaryType', + 'note': 'note', + 'note_metadata': 'noteMetadata', + 'offline_attributes': 'offlineAttributes', + 'phone_authentication': 'phoneAuthentication', + 'proof_file': 'proofFile', + 'recipient_attachments': 'recipientAttachments', + 'recipient_authentication_status': 'recipientAuthenticationStatus', + 'recipient_feature_metadata': 'recipientFeatureMetadata', + 'recipient_id': 'recipientId', + 'recipient_id_guid': 'recipientIdGuid', + 'recipient_signature_providers': 'recipientSignatureProviders', + 'recipient_supplies_tabs': 'recipientSuppliesTabs', + 'recipient_type': 'recipientType', + 'recipient_type_metadata': 'recipientTypeMetadata', + 'require_id_lookup': 'requireIdLookup', + 'require_id_lookup_metadata': 'requireIdLookupMetadata', + 'require_signer_certificate': 'requireSignerCertificate', + 'require_sign_on_paper': 'requireSignOnPaper', + 'require_upload_signature': 'requireUploadSignature', + 'role_name': 'roleName', + 'routing_order': 'routingOrder', + 'routing_order_metadata': 'routingOrderMetadata', + 'sent_date_time': 'sentDateTime', + 'signature_info': 'signatureInfo', + 'signed_date_time': 'signedDateTime', + 'sign_in_each_location': 'signInEachLocation', + 'sign_in_each_location_metadata': 'signInEachLocationMetadata', + 'signing_group_id': 'signingGroupId', + 'signing_group_id_metadata': 'signingGroupIdMetadata', + 'signing_group_name': 'signingGroupName', + 'signing_group_users': 'signingGroupUsers', + 'sms_authentication': 'smsAuthentication', + 'social_authentications': 'socialAuthentications', + 'status': 'status', + 'status_code': 'statusCode', + 'suppress_emails': 'suppressEmails', + 'tabs': 'tabs', + 'template_locked': 'templateLocked', + 'template_required': 'templateRequired', + 'total_tab_count': 'totalTabCount', + 'user_id': 'userId' + } + + def __init__(self, access_code=None, access_code_metadata=None, add_access_code_to_email=None, additional_notifications=None, additional_notifications_metadata=None, agent_can_edit_email=None, agent_can_edit_name=None, allow_system_override_for_locked_recipient=None, auto_navigation=None, bulk_recipients_uri=None, can_sign_offline=None, client_user_id=None, completed_count=None, creation_reason=None, custom_fields=None, declined_date_time=None, declined_reason=None, default_recipient=None, delivered_date_time=None, delivery_method=None, delivery_method_metadata=None, designator_id=None, designator_id_guid=None, document_visibility=None, email=None, email_metadata=None, email_notification=None, embedded_recipient_start_url=None, error_details=None, excluded_documents=None, fax_number=None, fax_number_metadata=None, first_name=None, first_name_metadata=None, full_name=None, full_name_metadata=None, id_check_configuration_name=None, id_check_configuration_name_metadata=None, id_check_information_input=None, identity_verification=None, inherit_email_notification_configuration=None, is_bulk_recipient=None, is_bulk_recipient_metadata=None, last_name=None, last_name_metadata=None, locked_recipient_phone_auth_editable=None, locked_recipient_sms_editable=None, name=None, name_metadata=None, notary_id=None, notary_signers=None, notary_type=None, note=None, note_metadata=None, offline_attributes=None, phone_authentication=None, proof_file=None, recipient_attachments=None, recipient_authentication_status=None, recipient_feature_metadata=None, recipient_id=None, recipient_id_guid=None, recipient_signature_providers=None, recipient_supplies_tabs=None, recipient_type=None, recipient_type_metadata=None, require_id_lookup=None, require_id_lookup_metadata=None, require_signer_certificate=None, require_sign_on_paper=None, require_upload_signature=None, role_name=None, routing_order=None, routing_order_metadata=None, sent_date_time=None, signature_info=None, signed_date_time=None, sign_in_each_location=None, sign_in_each_location_metadata=None, signing_group_id=None, signing_group_id_metadata=None, signing_group_name=None, signing_group_users=None, sms_authentication=None, social_authentications=None, status=None, status_code=None, suppress_emails=None, tabs=None, template_locked=None, template_required=None, total_tab_count=None, user_id=None): # noqa: E501 + """NotaryRecipient - a model defined in Swagger""" # noqa: E501 + + self._access_code = None + self._access_code_metadata = None + self._add_access_code_to_email = None + self._additional_notifications = None + self._additional_notifications_metadata = None + self._agent_can_edit_email = None + self._agent_can_edit_name = None + self._allow_system_override_for_locked_recipient = None + self._auto_navigation = None + self._bulk_recipients_uri = None + self._can_sign_offline = None + self._client_user_id = None + self._completed_count = None + self._creation_reason = None + self._custom_fields = None + self._declined_date_time = None + self._declined_reason = None + self._default_recipient = None + self._delivered_date_time = None + self._delivery_method = None + self._delivery_method_metadata = None + self._designator_id = None + self._designator_id_guid = None + self._document_visibility = None + self._email = None + self._email_metadata = None + self._email_notification = None + self._embedded_recipient_start_url = None + self._error_details = None + self._excluded_documents = None + self._fax_number = None + self._fax_number_metadata = None + self._first_name = None + self._first_name_metadata = None + self._full_name = None + self._full_name_metadata = None + self._id_check_configuration_name = None + self._id_check_configuration_name_metadata = None + self._id_check_information_input = None + self._identity_verification = None + self._inherit_email_notification_configuration = None + self._is_bulk_recipient = None + self._is_bulk_recipient_metadata = None + self._last_name = None + self._last_name_metadata = None + self._locked_recipient_phone_auth_editable = None + self._locked_recipient_sms_editable = None + self._name = None + self._name_metadata = None + self._notary_id = None + self._notary_signers = None + self._notary_type = None + self._note = None + self._note_metadata = None + self._offline_attributes = None + self._phone_authentication = None + self._proof_file = None + self._recipient_attachments = None + self._recipient_authentication_status = None + self._recipient_feature_metadata = None + self._recipient_id = None + self._recipient_id_guid = None + self._recipient_signature_providers = None + self._recipient_supplies_tabs = None + self._recipient_type = None + self._recipient_type_metadata = None + self._require_id_lookup = None + self._require_id_lookup_metadata = None + self._require_signer_certificate = None + self._require_sign_on_paper = None + self._require_upload_signature = None + self._role_name = None + self._routing_order = None + self._routing_order_metadata = None + self._sent_date_time = None + self._signature_info = None + self._signed_date_time = None + self._sign_in_each_location = None + self._sign_in_each_location_metadata = None + self._signing_group_id = None + self._signing_group_id_metadata = None + self._signing_group_name = None + self._signing_group_users = None + self._sms_authentication = None + self._social_authentications = None + self._status = None + self._status_code = None + self._suppress_emails = None + self._tabs = None + self._template_locked = None + self._template_required = None + self._total_tab_count = None + self._user_id = None + self.discriminator = None + + if access_code is not None: + self.access_code = access_code + if access_code_metadata is not None: + self.access_code_metadata = access_code_metadata + if add_access_code_to_email is not None: + self.add_access_code_to_email = add_access_code_to_email + if additional_notifications is not None: + self.additional_notifications = additional_notifications + if additional_notifications_metadata is not None: + self.additional_notifications_metadata = additional_notifications_metadata + if agent_can_edit_email is not None: + self.agent_can_edit_email = agent_can_edit_email + if agent_can_edit_name is not None: + self.agent_can_edit_name = agent_can_edit_name + if allow_system_override_for_locked_recipient is not None: + self.allow_system_override_for_locked_recipient = allow_system_override_for_locked_recipient + if auto_navigation is not None: + self.auto_navigation = auto_navigation + if bulk_recipients_uri is not None: + self.bulk_recipients_uri = bulk_recipients_uri + if can_sign_offline is not None: + self.can_sign_offline = can_sign_offline + if client_user_id is not None: + self.client_user_id = client_user_id + if completed_count is not None: + self.completed_count = completed_count + if creation_reason is not None: + self.creation_reason = creation_reason + if custom_fields is not None: + self.custom_fields = custom_fields + if declined_date_time is not None: + self.declined_date_time = declined_date_time + if declined_reason is not None: + self.declined_reason = declined_reason + if default_recipient is not None: + self.default_recipient = default_recipient + if delivered_date_time is not None: + self.delivered_date_time = delivered_date_time + if delivery_method is not None: + self.delivery_method = delivery_method + if delivery_method_metadata is not None: + self.delivery_method_metadata = delivery_method_metadata + if designator_id is not None: + self.designator_id = designator_id + if designator_id_guid is not None: + self.designator_id_guid = designator_id_guid + if document_visibility is not None: + self.document_visibility = document_visibility + if email is not None: + self.email = email + if email_metadata is not None: + self.email_metadata = email_metadata + if email_notification is not None: + self.email_notification = email_notification + if embedded_recipient_start_url is not None: + self.embedded_recipient_start_url = embedded_recipient_start_url + if error_details is not None: + self.error_details = error_details + if excluded_documents is not None: + self.excluded_documents = excluded_documents + if fax_number is not None: + self.fax_number = fax_number + if fax_number_metadata is not None: + self.fax_number_metadata = fax_number_metadata + if first_name is not None: + self.first_name = first_name + if first_name_metadata is not None: + self.first_name_metadata = first_name_metadata + if full_name is not None: + self.full_name = full_name + if full_name_metadata is not None: + self.full_name_metadata = full_name_metadata + if id_check_configuration_name is not None: + self.id_check_configuration_name = id_check_configuration_name + if id_check_configuration_name_metadata is not None: + self.id_check_configuration_name_metadata = id_check_configuration_name_metadata + if id_check_information_input is not None: + self.id_check_information_input = id_check_information_input + if identity_verification is not None: + self.identity_verification = identity_verification + if inherit_email_notification_configuration is not None: + self.inherit_email_notification_configuration = inherit_email_notification_configuration + if is_bulk_recipient is not None: + self.is_bulk_recipient = is_bulk_recipient + if is_bulk_recipient_metadata is not None: + self.is_bulk_recipient_metadata = is_bulk_recipient_metadata + if last_name is not None: + self.last_name = last_name + if last_name_metadata is not None: + self.last_name_metadata = last_name_metadata + if locked_recipient_phone_auth_editable is not None: + self.locked_recipient_phone_auth_editable = locked_recipient_phone_auth_editable + if locked_recipient_sms_editable is not None: + self.locked_recipient_sms_editable = locked_recipient_sms_editable + if name is not None: + self.name = name + if name_metadata is not None: + self.name_metadata = name_metadata + if notary_id is not None: + self.notary_id = notary_id + if notary_signers is not None: + self.notary_signers = notary_signers + if notary_type is not None: + self.notary_type = notary_type + if note is not None: + self.note = note + if note_metadata is not None: + self.note_metadata = note_metadata + if offline_attributes is not None: + self.offline_attributes = offline_attributes + if phone_authentication is not None: + self.phone_authentication = phone_authentication + if proof_file is not None: + self.proof_file = proof_file + if recipient_attachments is not None: + self.recipient_attachments = recipient_attachments + if recipient_authentication_status is not None: + self.recipient_authentication_status = recipient_authentication_status + if recipient_feature_metadata is not None: + self.recipient_feature_metadata = recipient_feature_metadata + if recipient_id is not None: + self.recipient_id = recipient_id + if recipient_id_guid is not None: + self.recipient_id_guid = recipient_id_guid + if recipient_signature_providers is not None: + self.recipient_signature_providers = recipient_signature_providers + if recipient_supplies_tabs is not None: + self.recipient_supplies_tabs = recipient_supplies_tabs + if recipient_type is not None: + self.recipient_type = recipient_type + if recipient_type_metadata is not None: + self.recipient_type_metadata = recipient_type_metadata + if require_id_lookup is not None: + self.require_id_lookup = require_id_lookup + if require_id_lookup_metadata is not None: + self.require_id_lookup_metadata = require_id_lookup_metadata + if require_signer_certificate is not None: + self.require_signer_certificate = require_signer_certificate + if require_sign_on_paper is not None: + self.require_sign_on_paper = require_sign_on_paper + if require_upload_signature is not None: + self.require_upload_signature = require_upload_signature + if role_name is not None: + self.role_name = role_name + if routing_order is not None: + self.routing_order = routing_order + if routing_order_metadata is not None: + self.routing_order_metadata = routing_order_metadata + if sent_date_time is not None: + self.sent_date_time = sent_date_time + if signature_info is not None: + self.signature_info = signature_info + if signed_date_time is not None: + self.signed_date_time = signed_date_time + if sign_in_each_location is not None: + self.sign_in_each_location = sign_in_each_location + if sign_in_each_location_metadata is not None: + self.sign_in_each_location_metadata = sign_in_each_location_metadata + if signing_group_id is not None: + self.signing_group_id = signing_group_id + if signing_group_id_metadata is not None: + self.signing_group_id_metadata = signing_group_id_metadata + if signing_group_name is not None: + self.signing_group_name = signing_group_name + if signing_group_users is not None: + self.signing_group_users = signing_group_users + if sms_authentication is not None: + self.sms_authentication = sms_authentication + if social_authentications is not None: + self.social_authentications = social_authentications + if status is not None: + self.status = status + if status_code is not None: + self.status_code = status_code + if suppress_emails is not None: + self.suppress_emails = suppress_emails + if tabs is not None: + self.tabs = tabs + if template_locked is not None: + self.template_locked = template_locked + if template_required is not None: + self.template_required = template_required + if total_tab_count is not None: + self.total_tab_count = total_tab_count + if user_id is not None: + self.user_id = user_id + + @property + def access_code(self): + """Gets the access_code of this NotaryRecipient. # noqa: E501 + + If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 + + :return: The access_code of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._access_code + + @access_code.setter + def access_code(self, access_code): + """Sets the access_code of this NotaryRecipient. + + If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 + + :param access_code: The access_code of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._access_code = access_code + + @property + def access_code_metadata(self): + """Gets the access_code_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The access_code_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._access_code_metadata + + @access_code_metadata.setter + def access_code_metadata(self, access_code_metadata): + """Sets the access_code_metadata of this NotaryRecipient. + + + :param access_code_metadata: The access_code_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._access_code_metadata = access_code_metadata + + @property + def add_access_code_to_email(self): + """Gets the add_access_code_to_email of this NotaryRecipient. # noqa: E501 + + This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. # noqa: E501 + + :return: The add_access_code_to_email of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._add_access_code_to_email + + @add_access_code_to_email.setter + def add_access_code_to_email(self, add_access_code_to_email): + """Sets the add_access_code_to_email of this NotaryRecipient. + + This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. # noqa: E501 + + :param add_access_code_to_email: The add_access_code_to_email of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._add_access_code_to_email = add_access_code_to_email + + @property + def additional_notifications(self): + """Gets the additional_notifications of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The additional_notifications of this NotaryRecipient. # noqa: E501 + :rtype: list[RecipientAdditionalNotification] + """ + return self._additional_notifications + + @additional_notifications.setter + def additional_notifications(self, additional_notifications): + """Sets the additional_notifications of this NotaryRecipient. + + # noqa: E501 + + :param additional_notifications: The additional_notifications of this NotaryRecipient. # noqa: E501 + :type: list[RecipientAdditionalNotification] + """ + + self._additional_notifications = additional_notifications + + @property + def additional_notifications_metadata(self): + """Gets the additional_notifications_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The additional_notifications_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._additional_notifications_metadata + + @additional_notifications_metadata.setter + def additional_notifications_metadata(self, additional_notifications_metadata): + """Sets the additional_notifications_metadata of this NotaryRecipient. + + + :param additional_notifications_metadata: The additional_notifications_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._additional_notifications_metadata = additional_notifications_metadata + + @property + def agent_can_edit_email(self): + """Gets the agent_can_edit_email of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The agent_can_edit_email of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._agent_can_edit_email + + @agent_can_edit_email.setter + def agent_can_edit_email(self, agent_can_edit_email): + """Sets the agent_can_edit_email of this NotaryRecipient. + + # noqa: E501 + + :param agent_can_edit_email: The agent_can_edit_email of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._agent_can_edit_email = agent_can_edit_email + + @property + def agent_can_edit_name(self): + """Gets the agent_can_edit_name of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The agent_can_edit_name of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._agent_can_edit_name + + @agent_can_edit_name.setter + def agent_can_edit_name(self, agent_can_edit_name): + """Sets the agent_can_edit_name of this NotaryRecipient. + + # noqa: E501 + + :param agent_can_edit_name: The agent_can_edit_name of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._agent_can_edit_name = agent_can_edit_name + + @property + def allow_system_override_for_locked_recipient(self): + """Gets the allow_system_override_for_locked_recipient of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The allow_system_override_for_locked_recipient of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._allow_system_override_for_locked_recipient + + @allow_system_override_for_locked_recipient.setter + def allow_system_override_for_locked_recipient(self, allow_system_override_for_locked_recipient): + """Sets the allow_system_override_for_locked_recipient of this NotaryRecipient. + + # noqa: E501 + + :param allow_system_override_for_locked_recipient: The allow_system_override_for_locked_recipient of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._allow_system_override_for_locked_recipient = allow_system_override_for_locked_recipient + + @property + def auto_navigation(self): + """Gets the auto_navigation of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The auto_navigation of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._auto_navigation + + @auto_navigation.setter + def auto_navigation(self, auto_navigation): + """Sets the auto_navigation of this NotaryRecipient. + + # noqa: E501 + + :param auto_navigation: The auto_navigation of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._auto_navigation = auto_navigation + + @property + def bulk_recipients_uri(self): + """Gets the bulk_recipients_uri of this NotaryRecipient. # noqa: E501 + + Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501 + + :return: The bulk_recipients_uri of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._bulk_recipients_uri + + @bulk_recipients_uri.setter + def bulk_recipients_uri(self, bulk_recipients_uri): + """Sets the bulk_recipients_uri of this NotaryRecipient. + + Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501 + + :param bulk_recipients_uri: The bulk_recipients_uri of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._bulk_recipients_uri = bulk_recipients_uri + + @property + def can_sign_offline(self): + """Gets the can_sign_offline of this NotaryRecipient. # noqa: E501 + + When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501 + + :return: The can_sign_offline of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._can_sign_offline + + @can_sign_offline.setter + def can_sign_offline(self, can_sign_offline): + """Sets the can_sign_offline of this NotaryRecipient. + + When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501 + + :param can_sign_offline: The can_sign_offline of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._can_sign_offline = can_sign_offline + + @property + def client_user_id(self): + """Gets the client_user_id of this NotaryRecipient. # noqa: E501 + + Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. # noqa: E501 + + :return: The client_user_id of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._client_user_id + + @client_user_id.setter + def client_user_id(self, client_user_id): + """Sets the client_user_id of this NotaryRecipient. + + Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. # noqa: E501 + + :param client_user_id: The client_user_id of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._client_user_id = client_user_id + + @property + def completed_count(self): + """Gets the completed_count of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The completed_count of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._completed_count + + @completed_count.setter + def completed_count(self, completed_count): + """Sets the completed_count of this NotaryRecipient. + + # noqa: E501 + + :param completed_count: The completed_count of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._completed_count = completed_count + + @property + def creation_reason(self): + """Gets the creation_reason of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The creation_reason of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._creation_reason + + @creation_reason.setter + def creation_reason(self, creation_reason): + """Sets the creation_reason of this NotaryRecipient. + + # noqa: E501 + + :param creation_reason: The creation_reason of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._creation_reason = creation_reason + + @property + def custom_fields(self): + """Gets the custom_fields of this NotaryRecipient. # noqa: E501 + + An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. # noqa: E501 + + :return: The custom_fields of this NotaryRecipient. # noqa: E501 + :rtype: list[str] + """ + return self._custom_fields + + @custom_fields.setter + def custom_fields(self, custom_fields): + """Sets the custom_fields of this NotaryRecipient. + + An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. # noqa: E501 + + :param custom_fields: The custom_fields of this NotaryRecipient. # noqa: E501 + :type: list[str] + """ + + self._custom_fields = custom_fields + + @property + def declined_date_time(self): + """Gets the declined_date_time of this NotaryRecipient. # noqa: E501 + + The date and time the recipient declined the document. # noqa: E501 + + :return: The declined_date_time of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._declined_date_time + + @declined_date_time.setter + def declined_date_time(self, declined_date_time): + """Sets the declined_date_time of this NotaryRecipient. + + The date and time the recipient declined the document. # noqa: E501 + + :param declined_date_time: The declined_date_time of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._declined_date_time = declined_date_time + + @property + def declined_reason(self): + """Gets the declined_reason of this NotaryRecipient. # noqa: E501 + + The reason the recipient declined the document. # noqa: E501 + + :return: The declined_reason of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._declined_reason + + @declined_reason.setter + def declined_reason(self, declined_reason): + """Sets the declined_reason of this NotaryRecipient. + + The reason the recipient declined the document. # noqa: E501 + + :param declined_reason: The declined_reason of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._declined_reason = declined_reason + + @property + def default_recipient(self): + """Gets the default_recipient of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The default_recipient of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._default_recipient + + @default_recipient.setter + def default_recipient(self, default_recipient): + """Sets the default_recipient of this NotaryRecipient. + + # noqa: E501 + + :param default_recipient: The default_recipient of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._default_recipient = default_recipient + + @property + def delivered_date_time(self): + """Gets the delivered_date_time of this NotaryRecipient. # noqa: E501 + + Reserved: For DocuSign use only. # noqa: E501 + + :return: The delivered_date_time of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._delivered_date_time + + @delivered_date_time.setter + def delivered_date_time(self, delivered_date_time): + """Sets the delivered_date_time of this NotaryRecipient. + + Reserved: For DocuSign use only. # noqa: E501 + + :param delivered_date_time: The delivered_date_time of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._delivered_date_time = delivered_date_time + + @property + def delivery_method(self): + """Gets the delivery_method of this NotaryRecipient. # noqa: E501 + + Reserved: For DocuSign use only. # noqa: E501 + + :return: The delivery_method of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._delivery_method + + @delivery_method.setter + def delivery_method(self, delivery_method): + """Sets the delivery_method of this NotaryRecipient. + + Reserved: For DocuSign use only. # noqa: E501 + + :param delivery_method: The delivery_method of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._delivery_method = delivery_method + + @property + def delivery_method_metadata(self): + """Gets the delivery_method_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The delivery_method_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._delivery_method_metadata + + @delivery_method_metadata.setter + def delivery_method_metadata(self, delivery_method_metadata): + """Sets the delivery_method_metadata of this NotaryRecipient. + + + :param delivery_method_metadata: The delivery_method_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._delivery_method_metadata = delivery_method_metadata + + @property + def designator_id(self): + """Gets the designator_id of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The designator_id of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._designator_id + + @designator_id.setter + def designator_id(self, designator_id): + """Sets the designator_id of this NotaryRecipient. + + # noqa: E501 + + :param designator_id: The designator_id of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._designator_id = designator_id + + @property + def designator_id_guid(self): + """Gets the designator_id_guid of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The designator_id_guid of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._designator_id_guid + + @designator_id_guid.setter + def designator_id_guid(self, designator_id_guid): + """Sets the designator_id_guid of this NotaryRecipient. + + # noqa: E501 + + :param designator_id_guid: The designator_id_guid of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._designator_id_guid = designator_id_guid + + @property + def document_visibility(self): + """Gets the document_visibility of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The document_visibility of this NotaryRecipient. # noqa: E501 + :rtype: list[DocumentVisibility] + """ + return self._document_visibility + + @document_visibility.setter + def document_visibility(self, document_visibility): + """Sets the document_visibility of this NotaryRecipient. + + # noqa: E501 + + :param document_visibility: The document_visibility of this NotaryRecipient. # noqa: E501 + :type: list[DocumentVisibility] + """ + + self._document_visibility = document_visibility + + @property + def email(self): + """Gets the email of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The email of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this NotaryRecipient. + + # noqa: E501 + + :param email: The email of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._email = email + + @property + def email_metadata(self): + """Gets the email_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The email_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._email_metadata + + @email_metadata.setter + def email_metadata(self, email_metadata): + """Sets the email_metadata of this NotaryRecipient. + + + :param email_metadata: The email_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._email_metadata = email_metadata + + @property + def email_notification(self): + """Gets the email_notification of this NotaryRecipient. # noqa: E501 + + + :return: The email_notification of this NotaryRecipient. # noqa: E501 + :rtype: RecipientEmailNotification + """ + return self._email_notification + + @email_notification.setter + def email_notification(self, email_notification): + """Sets the email_notification of this NotaryRecipient. + + + :param email_notification: The email_notification of this NotaryRecipient. # noqa: E501 + :type: RecipientEmailNotification + """ + + self._email_notification = email_notification + + @property + def embedded_recipient_start_url(self): + """Gets the embedded_recipient_start_url of this NotaryRecipient. # noqa: E501 + + Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` # noqa: E501 + + :return: The embedded_recipient_start_url of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._embedded_recipient_start_url + + @embedded_recipient_start_url.setter + def embedded_recipient_start_url(self, embedded_recipient_start_url): + """Sets the embedded_recipient_start_url of this NotaryRecipient. + + Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` # noqa: E501 + + :param embedded_recipient_start_url: The embedded_recipient_start_url of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._embedded_recipient_start_url = embedded_recipient_start_url + + @property + def error_details(self): + """Gets the error_details of this NotaryRecipient. # noqa: E501 + + + :return: The error_details of this NotaryRecipient. # noqa: E501 + :rtype: ErrorDetails + """ + return self._error_details + + @error_details.setter + def error_details(self, error_details): + """Sets the error_details of this NotaryRecipient. + + + :param error_details: The error_details of this NotaryRecipient. # noqa: E501 + :type: ErrorDetails + """ + + self._error_details = error_details + + @property + def excluded_documents(self): + """Gets the excluded_documents of this NotaryRecipient. # noqa: E501 + + Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. # noqa: E501 + + :return: The excluded_documents of this NotaryRecipient. # noqa: E501 + :rtype: list[str] + """ + return self._excluded_documents + + @excluded_documents.setter + def excluded_documents(self, excluded_documents): + """Sets the excluded_documents of this NotaryRecipient. + + Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. # noqa: E501 + + :param excluded_documents: The excluded_documents of this NotaryRecipient. # noqa: E501 + :type: list[str] + """ + + self._excluded_documents = excluded_documents + + @property + def fax_number(self): + """Gets the fax_number of this NotaryRecipient. # noqa: E501 + + Reserved: # noqa: E501 + + :return: The fax_number of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._fax_number + + @fax_number.setter + def fax_number(self, fax_number): + """Sets the fax_number of this NotaryRecipient. + + Reserved: # noqa: E501 + + :param fax_number: The fax_number of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._fax_number = fax_number + + @property + def fax_number_metadata(self): + """Gets the fax_number_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The fax_number_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._fax_number_metadata + + @fax_number_metadata.setter + def fax_number_metadata(self, fax_number_metadata): + """Sets the fax_number_metadata of this NotaryRecipient. + + + :param fax_number_metadata: The fax_number_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._fax_number_metadata = fax_number_metadata + + @property + def first_name(self): + """Gets the first_name of this NotaryRecipient. # noqa: E501 + + The user's first name. Maximum Length: 50 characters. # noqa: E501 + + :return: The first_name of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this NotaryRecipient. + + The user's first name. Maximum Length: 50 characters. # noqa: E501 + + :param first_name: The first_name of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._first_name = first_name + + @property + def first_name_metadata(self): + """Gets the first_name_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The first_name_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._first_name_metadata + + @first_name_metadata.setter + def first_name_metadata(self, first_name_metadata): + """Sets the first_name_metadata of this NotaryRecipient. + + + :param first_name_metadata: The first_name_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._first_name_metadata = first_name_metadata + + @property + def full_name(self): + """Gets the full_name of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The full_name of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._full_name + + @full_name.setter + def full_name(self, full_name): + """Sets the full_name of this NotaryRecipient. + + # noqa: E501 + + :param full_name: The full_name of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._full_name = full_name + + @property + def full_name_metadata(self): + """Gets the full_name_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The full_name_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._full_name_metadata + + @full_name_metadata.setter + def full_name_metadata(self, full_name_metadata): + """Sets the full_name_metadata of this NotaryRecipient. + + + :param full_name_metadata: The full_name_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._full_name_metadata = full_name_metadata + + @property + def id_check_configuration_name(self): + """Gets the id_check_configuration_name of this NotaryRecipient. # noqa: E501 + + Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501 + + :return: The id_check_configuration_name of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._id_check_configuration_name + + @id_check_configuration_name.setter + def id_check_configuration_name(self, id_check_configuration_name): + """Sets the id_check_configuration_name of this NotaryRecipient. + + Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501 + + :param id_check_configuration_name: The id_check_configuration_name of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._id_check_configuration_name = id_check_configuration_name + + @property + def id_check_configuration_name_metadata(self): + """Gets the id_check_configuration_name_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The id_check_configuration_name_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._id_check_configuration_name_metadata + + @id_check_configuration_name_metadata.setter + def id_check_configuration_name_metadata(self, id_check_configuration_name_metadata): + """Sets the id_check_configuration_name_metadata of this NotaryRecipient. + + + :param id_check_configuration_name_metadata: The id_check_configuration_name_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._id_check_configuration_name_metadata = id_check_configuration_name_metadata + + @property + def id_check_information_input(self): + """Gets the id_check_information_input of this NotaryRecipient. # noqa: E501 + + + :return: The id_check_information_input of this NotaryRecipient. # noqa: E501 + :rtype: IdCheckInformationInput + """ + return self._id_check_information_input + + @id_check_information_input.setter + def id_check_information_input(self, id_check_information_input): + """Sets the id_check_information_input of this NotaryRecipient. + + + :param id_check_information_input: The id_check_information_input of this NotaryRecipient. # noqa: E501 + :type: IdCheckInformationInput + """ + + self._id_check_information_input = id_check_information_input + + @property + def identity_verification(self): + """Gets the identity_verification of this NotaryRecipient. # noqa: E501 + + + :return: The identity_verification of this NotaryRecipient. # noqa: E501 + :rtype: RecipientIdentityVerification + """ + return self._identity_verification + + @identity_verification.setter + def identity_verification(self, identity_verification): + """Sets the identity_verification of this NotaryRecipient. + + + :param identity_verification: The identity_verification of this NotaryRecipient. # noqa: E501 + :type: RecipientIdentityVerification + """ + + self._identity_verification = identity_verification + + @property + def inherit_email_notification_configuration(self): + """Gets the inherit_email_notification_configuration of this NotaryRecipient. # noqa: E501 + + When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. # noqa: E501 + + :return: The inherit_email_notification_configuration of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._inherit_email_notification_configuration + + @inherit_email_notification_configuration.setter + def inherit_email_notification_configuration(self, inherit_email_notification_configuration): + """Sets the inherit_email_notification_configuration of this NotaryRecipient. + + When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. # noqa: E501 + + :param inherit_email_notification_configuration: The inherit_email_notification_configuration of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._inherit_email_notification_configuration = inherit_email_notification_configuration + + @property + def is_bulk_recipient(self): + """Gets the is_bulk_recipient of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The is_bulk_recipient of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._is_bulk_recipient + + @is_bulk_recipient.setter + def is_bulk_recipient(self, is_bulk_recipient): + """Sets the is_bulk_recipient of this NotaryRecipient. + + # noqa: E501 + + :param is_bulk_recipient: The is_bulk_recipient of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._is_bulk_recipient = is_bulk_recipient + + @property + def is_bulk_recipient_metadata(self): + """Gets the is_bulk_recipient_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The is_bulk_recipient_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._is_bulk_recipient_metadata + + @is_bulk_recipient_metadata.setter + def is_bulk_recipient_metadata(self, is_bulk_recipient_metadata): + """Sets the is_bulk_recipient_metadata of this NotaryRecipient. + + + :param is_bulk_recipient_metadata: The is_bulk_recipient_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._is_bulk_recipient_metadata = is_bulk_recipient_metadata + + @property + def last_name(self): + """Gets the last_name of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The last_name of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this NotaryRecipient. + + # noqa: E501 + + :param last_name: The last_name of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def last_name_metadata(self): + """Gets the last_name_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The last_name_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._last_name_metadata + + @last_name_metadata.setter + def last_name_metadata(self, last_name_metadata): + """Sets the last_name_metadata of this NotaryRecipient. + + + :param last_name_metadata: The last_name_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._last_name_metadata = last_name_metadata + + @property + def locked_recipient_phone_auth_editable(self): + """Gets the locked_recipient_phone_auth_editable of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The locked_recipient_phone_auth_editable of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._locked_recipient_phone_auth_editable + + @locked_recipient_phone_auth_editable.setter + def locked_recipient_phone_auth_editable(self, locked_recipient_phone_auth_editable): + """Sets the locked_recipient_phone_auth_editable of this NotaryRecipient. + + # noqa: E501 + + :param locked_recipient_phone_auth_editable: The locked_recipient_phone_auth_editable of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._locked_recipient_phone_auth_editable = locked_recipient_phone_auth_editable + + @property + def locked_recipient_sms_editable(self): + """Gets the locked_recipient_sms_editable of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The locked_recipient_sms_editable of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._locked_recipient_sms_editable + + @locked_recipient_sms_editable.setter + def locked_recipient_sms_editable(self, locked_recipient_sms_editable): + """Sets the locked_recipient_sms_editable of this NotaryRecipient. + + # noqa: E501 + + :param locked_recipient_sms_editable: The locked_recipient_sms_editable of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._locked_recipient_sms_editable = locked_recipient_sms_editable + + @property + def name(self): + """Gets the name of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The name of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this NotaryRecipient. + + # noqa: E501 + + :param name: The name of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def name_metadata(self): + """Gets the name_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The name_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._name_metadata + + @name_metadata.setter + def name_metadata(self, name_metadata): + """Sets the name_metadata of this NotaryRecipient. + + + :param name_metadata: The name_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._name_metadata = name_metadata + + @property + def notary_id(self): + """Gets the notary_id of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The notary_id of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._notary_id + + @notary_id.setter + def notary_id(self, notary_id): + """Sets the notary_id of this NotaryRecipient. + + # noqa: E501 + + :param notary_id: The notary_id of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._notary_id = notary_id + + @property + def notary_signers(self): + """Gets the notary_signers of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The notary_signers of this NotaryRecipient. # noqa: E501 + :rtype: list[str] + """ + return self._notary_signers + + @notary_signers.setter + def notary_signers(self, notary_signers): + """Sets the notary_signers of this NotaryRecipient. + + # noqa: E501 + + :param notary_signers: The notary_signers of this NotaryRecipient. # noqa: E501 + :type: list[str] + """ + + self._notary_signers = notary_signers + + @property + def notary_type(self): + """Gets the notary_type of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The notary_type of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._notary_type + + @notary_type.setter + def notary_type(self, notary_type): + """Sets the notary_type of this NotaryRecipient. + + # noqa: E501 + + :param notary_type: The notary_type of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._notary_type = notary_type + + @property + def note(self): + """Gets the note of this NotaryRecipient. # noqa: E501 + + Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. # noqa: E501 + + :return: The note of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._note + + @note.setter + def note(self, note): + """Sets the note of this NotaryRecipient. + + Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. # noqa: E501 + + :param note: The note of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._note = note + + @property + def note_metadata(self): + """Gets the note_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The note_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._note_metadata + + @note_metadata.setter + def note_metadata(self, note_metadata): + """Sets the note_metadata of this NotaryRecipient. + + + :param note_metadata: The note_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._note_metadata = note_metadata + + @property + def offline_attributes(self): + """Gets the offline_attributes of this NotaryRecipient. # noqa: E501 + + + :return: The offline_attributes of this NotaryRecipient. # noqa: E501 + :rtype: OfflineAttributes + """ + return self._offline_attributes + + @offline_attributes.setter + def offline_attributes(self, offline_attributes): + """Sets the offline_attributes of this NotaryRecipient. + + + :param offline_attributes: The offline_attributes of this NotaryRecipient. # noqa: E501 + :type: OfflineAttributes + """ + + self._offline_attributes = offline_attributes + + @property + def phone_authentication(self): + """Gets the phone_authentication of this NotaryRecipient. # noqa: E501 + + + :return: The phone_authentication of this NotaryRecipient. # noqa: E501 + :rtype: RecipientPhoneAuthentication + """ + return self._phone_authentication + + @phone_authentication.setter + def phone_authentication(self, phone_authentication): + """Sets the phone_authentication of this NotaryRecipient. + + + :param phone_authentication: The phone_authentication of this NotaryRecipient. # noqa: E501 + :type: RecipientPhoneAuthentication + """ + + self._phone_authentication = phone_authentication + + @property + def proof_file(self): + """Gets the proof_file of this NotaryRecipient. # noqa: E501 + + + :return: The proof_file of this NotaryRecipient. # noqa: E501 + :rtype: RecipientProofFile + """ + return self._proof_file + + @proof_file.setter + def proof_file(self, proof_file): + """Sets the proof_file of this NotaryRecipient. + + + :param proof_file: The proof_file of this NotaryRecipient. # noqa: E501 + :type: RecipientProofFile + """ + + self._proof_file = proof_file + + @property + def recipient_attachments(self): + """Gets the recipient_attachments of this NotaryRecipient. # noqa: E501 + + Reserved: # noqa: E501 + + :return: The recipient_attachments of this NotaryRecipient. # noqa: E501 + :rtype: list[RecipientAttachment] + """ + return self._recipient_attachments + + @recipient_attachments.setter + def recipient_attachments(self, recipient_attachments): + """Sets the recipient_attachments of this NotaryRecipient. + + Reserved: # noqa: E501 + + :param recipient_attachments: The recipient_attachments of this NotaryRecipient. # noqa: E501 + :type: list[RecipientAttachment] + """ + + self._recipient_attachments = recipient_attachments + + @property + def recipient_authentication_status(self): + """Gets the recipient_authentication_status of this NotaryRecipient. # noqa: E501 + + + :return: The recipient_authentication_status of this NotaryRecipient. # noqa: E501 + :rtype: AuthenticationStatus + """ + return self._recipient_authentication_status + + @recipient_authentication_status.setter + def recipient_authentication_status(self, recipient_authentication_status): + """Sets the recipient_authentication_status of this NotaryRecipient. + + + :param recipient_authentication_status: The recipient_authentication_status of this NotaryRecipient. # noqa: E501 + :type: AuthenticationStatus + """ + + self._recipient_authentication_status = recipient_authentication_status + + @property + def recipient_feature_metadata(self): + """Gets the recipient_feature_metadata of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The recipient_feature_metadata of this NotaryRecipient. # noqa: E501 + :rtype: list[FeatureAvailableMetadata] + """ + return self._recipient_feature_metadata + + @recipient_feature_metadata.setter + def recipient_feature_metadata(self, recipient_feature_metadata): + """Sets the recipient_feature_metadata of this NotaryRecipient. + + # noqa: E501 + + :param recipient_feature_metadata: The recipient_feature_metadata of this NotaryRecipient. # noqa: E501 + :type: list[FeatureAvailableMetadata] + """ + + self._recipient_feature_metadata = recipient_feature_metadata + + @property + def recipient_id(self): + """Gets the recipient_id of this NotaryRecipient. # 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 NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._recipient_id + + @recipient_id.setter + def recipient_id(self, recipient_id): + """Sets the recipient_id of this NotaryRecipient. + + 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 NotaryRecipient. # noqa: E501 + :type: str + """ + + self._recipient_id = recipient_id + + @property + def recipient_id_guid(self): + """Gets the recipient_id_guid of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The recipient_id_guid of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._recipient_id_guid + + @recipient_id_guid.setter + def recipient_id_guid(self, recipient_id_guid): + """Sets the recipient_id_guid of this NotaryRecipient. + + # noqa: E501 + + :param recipient_id_guid: The recipient_id_guid of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._recipient_id_guid = recipient_id_guid + + @property + def recipient_signature_providers(self): + """Gets the recipient_signature_providers of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The recipient_signature_providers of this NotaryRecipient. # noqa: E501 + :rtype: list[RecipientSignatureProvider] + """ + return self._recipient_signature_providers + + @recipient_signature_providers.setter + def recipient_signature_providers(self, recipient_signature_providers): + """Sets the recipient_signature_providers of this NotaryRecipient. + + # noqa: E501 + + :param recipient_signature_providers: The recipient_signature_providers of this NotaryRecipient. # noqa: E501 + :type: list[RecipientSignatureProvider] + """ + + self._recipient_signature_providers = recipient_signature_providers + + @property + def recipient_supplies_tabs(self): + """Gets the recipient_supplies_tabs of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The recipient_supplies_tabs of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._recipient_supplies_tabs + + @recipient_supplies_tabs.setter + def recipient_supplies_tabs(self, recipient_supplies_tabs): + """Sets the recipient_supplies_tabs of this NotaryRecipient. + + # noqa: E501 + + :param recipient_supplies_tabs: The recipient_supplies_tabs of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._recipient_supplies_tabs = recipient_supplies_tabs + + @property + def recipient_type(self): + """Gets the recipient_type of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The recipient_type of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._recipient_type + + @recipient_type.setter + def recipient_type(self, recipient_type): + """Sets the recipient_type of this NotaryRecipient. + + # noqa: E501 + + :param recipient_type: The recipient_type of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._recipient_type = recipient_type + + @property + def recipient_type_metadata(self): + """Gets the recipient_type_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The recipient_type_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._recipient_type_metadata + + @recipient_type_metadata.setter + def recipient_type_metadata(self, recipient_type_metadata): + """Sets the recipient_type_metadata of this NotaryRecipient. + + + :param recipient_type_metadata: The recipient_type_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._recipient_type_metadata = recipient_type_metadata + + @property + def require_id_lookup(self): + """Gets the require_id_lookup of this NotaryRecipient. # noqa: E501 + + When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. # noqa: E501 + + :return: The require_id_lookup of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._require_id_lookup + + @require_id_lookup.setter + def require_id_lookup(self, require_id_lookup): + """Sets the require_id_lookup of this NotaryRecipient. + + When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. # noqa: E501 + + :param require_id_lookup: The require_id_lookup of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._require_id_lookup = require_id_lookup + + @property + def require_id_lookup_metadata(self): + """Gets the require_id_lookup_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The require_id_lookup_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._require_id_lookup_metadata + + @require_id_lookup_metadata.setter + def require_id_lookup_metadata(self, require_id_lookup_metadata): + """Sets the require_id_lookup_metadata of this NotaryRecipient. + + + :param require_id_lookup_metadata: The require_id_lookup_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._require_id_lookup_metadata = require_id_lookup_metadata + + @property + def require_signer_certificate(self): + """Gets the require_signer_certificate of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The require_signer_certificate of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._require_signer_certificate + + @require_signer_certificate.setter + def require_signer_certificate(self, require_signer_certificate): + """Sets the require_signer_certificate of this NotaryRecipient. + + # noqa: E501 + + :param require_signer_certificate: The require_signer_certificate of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._require_signer_certificate = require_signer_certificate + + @property + def require_sign_on_paper(self): + """Gets the require_sign_on_paper of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The require_sign_on_paper of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._require_sign_on_paper + + @require_sign_on_paper.setter + def require_sign_on_paper(self, require_sign_on_paper): + """Sets the require_sign_on_paper of this NotaryRecipient. + + # noqa: E501 + + :param require_sign_on_paper: The require_sign_on_paper of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._require_sign_on_paper = require_sign_on_paper + + @property + def require_upload_signature(self): + """Gets the require_upload_signature of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The require_upload_signature of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._require_upload_signature + + @require_upload_signature.setter + def require_upload_signature(self, require_upload_signature): + """Sets the require_upload_signature of this NotaryRecipient. + + # noqa: E501 + + :param require_upload_signature: The require_upload_signature of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._require_upload_signature = require_upload_signature + + @property + def role_name(self): + """Gets the role_name of this NotaryRecipient. # 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 NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._role_name + + @role_name.setter + def role_name(self, role_name): + """Sets the role_name of this NotaryRecipient. + + 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 NotaryRecipient. # noqa: E501 + :type: str + """ + + self._role_name = role_name + + @property + def routing_order(self): + """Gets the routing_order of this NotaryRecipient. # noqa: E501 + + Specifies the routing order of the recipient in the envelope. # noqa: E501 + + :return: The routing_order of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._routing_order + + @routing_order.setter + def routing_order(self, routing_order): + """Sets the routing_order of this NotaryRecipient. + + Specifies the routing order of the recipient in the envelope. # noqa: E501 + + :param routing_order: The routing_order of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._routing_order = routing_order + + @property + def routing_order_metadata(self): + """Gets the routing_order_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The routing_order_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._routing_order_metadata + + @routing_order_metadata.setter + def routing_order_metadata(self, routing_order_metadata): + """Sets the routing_order_metadata of this NotaryRecipient. + + + :param routing_order_metadata: The routing_order_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._routing_order_metadata = routing_order_metadata + + @property + def sent_date_time(self): + """Gets the sent_date_time of this NotaryRecipient. # noqa: E501 + + The date and time the envelope was sent. # noqa: E501 + + :return: The sent_date_time of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._sent_date_time + + @sent_date_time.setter + def sent_date_time(self, sent_date_time): + """Sets the sent_date_time of this NotaryRecipient. + + The date and time the envelope was sent. # noqa: E501 + + :param sent_date_time: The sent_date_time of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._sent_date_time = sent_date_time + + @property + def signature_info(self): + """Gets the signature_info of this NotaryRecipient. # noqa: E501 + + + :return: The signature_info of this NotaryRecipient. # noqa: E501 + :rtype: RecipientSignatureInformation + """ + return self._signature_info + + @signature_info.setter + def signature_info(self, signature_info): + """Sets the signature_info of this NotaryRecipient. + + + :param signature_info: The signature_info of this NotaryRecipient. # noqa: E501 + :type: RecipientSignatureInformation + """ + + self._signature_info = signature_info + + @property + def signed_date_time(self): + """Gets the signed_date_time of this NotaryRecipient. # noqa: E501 + + Reserved: For DocuSign use only. # noqa: E501 + + :return: The signed_date_time of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._signed_date_time + + @signed_date_time.setter + def signed_date_time(self, signed_date_time): + """Sets the signed_date_time of this NotaryRecipient. + + Reserved: For DocuSign use only. # noqa: E501 + + :param signed_date_time: The signed_date_time of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._signed_date_time = signed_date_time + + @property + def sign_in_each_location(self): + """Gets the sign_in_each_location of this NotaryRecipient. # noqa: E501 + + When set to **true**, specifies that the signer must sign in all locations. # noqa: E501 + + :return: The sign_in_each_location of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._sign_in_each_location + + @sign_in_each_location.setter + def sign_in_each_location(self, sign_in_each_location): + """Sets the sign_in_each_location of this NotaryRecipient. + + When set to **true**, specifies that the signer must sign in all locations. # noqa: E501 + + :param sign_in_each_location: The sign_in_each_location of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._sign_in_each_location = sign_in_each_location + + @property + def sign_in_each_location_metadata(self): + """Gets the sign_in_each_location_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The sign_in_each_location_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._sign_in_each_location_metadata + + @sign_in_each_location_metadata.setter + def sign_in_each_location_metadata(self, sign_in_each_location_metadata): + """Sets the sign_in_each_location_metadata of this NotaryRecipient. + + + :param sign_in_each_location_metadata: The sign_in_each_location_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._sign_in_each_location_metadata = sign_in_each_location_metadata + + @property + def signing_group_id(self): + """Gets the signing_group_id of this NotaryRecipient. # 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 NotaryRecipient. # 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 NotaryRecipient. + + 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 NotaryRecipient. # noqa: E501 + :type: str + """ + + self._signing_group_id = signing_group_id + + @property + def signing_group_id_metadata(self): + """Gets the signing_group_id_metadata of this NotaryRecipient. # noqa: E501 + + + :return: The signing_group_id_metadata of this NotaryRecipient. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._signing_group_id_metadata + + @signing_group_id_metadata.setter + def signing_group_id_metadata(self, signing_group_id_metadata): + """Sets the signing_group_id_metadata of this NotaryRecipient. + + + :param signing_group_id_metadata: The signing_group_id_metadata of this NotaryRecipient. # noqa: E501 + :type: PropertyMetadata + """ + + self._signing_group_id_metadata = signing_group_id_metadata + + @property + def signing_group_name(self): + """Gets the signing_group_name of this NotaryRecipient. # noqa: E501 + + The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 + + :return: The signing_group_name of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._signing_group_name + + @signing_group_name.setter + def signing_group_name(self, signing_group_name): + """Sets the signing_group_name of this NotaryRecipient. + + The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 + + :param signing_group_name: The signing_group_name of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._signing_group_name = signing_group_name + + @property + def signing_group_users(self): + """Gets the signing_group_users of this NotaryRecipient. # noqa: E501 + + A complex type that contains information about users in the signing group. # noqa: E501 + + :return: The signing_group_users of this NotaryRecipient. # noqa: E501 + :rtype: list[UserInfo] + """ + return self._signing_group_users + + @signing_group_users.setter + def signing_group_users(self, signing_group_users): + """Sets the signing_group_users of this NotaryRecipient. + + A complex type that contains information about users in the signing group. # noqa: E501 + + :param signing_group_users: The signing_group_users of this NotaryRecipient. # noqa: E501 + :type: list[UserInfo] + """ + + self._signing_group_users = signing_group_users + + @property + def sms_authentication(self): + """Gets the sms_authentication of this NotaryRecipient. # noqa: E501 + + + :return: The sms_authentication of this NotaryRecipient. # noqa: E501 + :rtype: RecipientSMSAuthentication + """ + return self._sms_authentication + + @sms_authentication.setter + def sms_authentication(self, sms_authentication): + """Sets the sms_authentication of this NotaryRecipient. + + + :param sms_authentication: The sms_authentication of this NotaryRecipient. # noqa: E501 + :type: RecipientSMSAuthentication + """ + + self._sms_authentication = sms_authentication + + @property + def social_authentications(self): + """Gets the social_authentications of this NotaryRecipient. # noqa: E501 + + Lists the social ID type that can be used for recipient authentication. # noqa: E501 + + :return: The social_authentications of this NotaryRecipient. # noqa: E501 + :rtype: list[SocialAuthentication] + """ + return self._social_authentications + + @social_authentications.setter + def social_authentications(self, social_authentications): + """Sets the social_authentications of this NotaryRecipient. + + Lists the social ID type that can be used for recipient authentication. # noqa: E501 + + :param social_authentications: The social_authentications of this NotaryRecipient. # noqa: E501 + :type: list[SocialAuthentication] + """ + + self._social_authentications = social_authentications + + @property + def status(self): + """Gets the status of this NotaryRecipient. # 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 NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this NotaryRecipient. + + 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 NotaryRecipient. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def status_code(self): + """Gets the status_code of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The status_code of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._status_code + + @status_code.setter + def status_code(self, status_code): + """Sets the status_code of this NotaryRecipient. + + # noqa: E501 + + :param status_code: The status_code of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._status_code = status_code + + @property + def suppress_emails(self): + """Gets the suppress_emails of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The suppress_emails of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._suppress_emails + + @suppress_emails.setter + def suppress_emails(self, suppress_emails): + """Sets the suppress_emails of this NotaryRecipient. + + # noqa: E501 + + :param suppress_emails: The suppress_emails of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._suppress_emails = suppress_emails + + @property + def tabs(self): + """Gets the tabs of this NotaryRecipient. # noqa: E501 + + + :return: The tabs of this NotaryRecipient. # noqa: E501 + :rtype: Tabs + """ + return self._tabs + + @tabs.setter + def tabs(self, tabs): + """Sets the tabs of this NotaryRecipient. + + + :param tabs: The tabs of this NotaryRecipient. # noqa: E501 + :type: Tabs + """ + + self._tabs = tabs + + @property + def template_locked(self): + """Gets the template_locked of this NotaryRecipient. # noqa: E501 + + When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 + + :return: The template_locked of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._template_locked + + @template_locked.setter + def template_locked(self, template_locked): + """Sets the template_locked of this NotaryRecipient. + + When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 + + :param template_locked: The template_locked of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._template_locked = template_locked + + @property + def template_required(self): + """Gets the template_required of this NotaryRecipient. # noqa: E501 + + When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 + + :return: The template_required of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._template_required + + @template_required.setter + def template_required(self, template_required): + """Sets the template_required of this NotaryRecipient. + + When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 + + :param template_required: The template_required of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._template_required = template_required + + @property + def total_tab_count(self): + """Gets the total_tab_count of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The total_tab_count of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._total_tab_count + + @total_tab_count.setter + def total_tab_count(self, total_tab_count): + """Sets the total_tab_count of this NotaryRecipient. + + # noqa: E501 + + :param total_tab_count: The total_tab_count of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._total_tab_count = total_tab_count + + @property + def user_id(self): + """Gets the user_id of this NotaryRecipient. # noqa: E501 + + # noqa: E501 + + :return: The user_id of this NotaryRecipient. # noqa: E501 + :rtype: str + """ + return self._user_id + + @user_id.setter + def user_id(self, user_id): + """Sets the user_id of this NotaryRecipient. + + # noqa: E501 + + :param user_id: The user_id of this NotaryRecipient. # noqa: E501 + :type: str + """ + + self._user_id = user_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(NotaryRecipient, 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, NotaryRecipient): + 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/notary_seal.py b/docusign_esign/models/notary_seal.py new file mode 100644 index 00000000..7c9f62c0 --- /dev/null +++ b/docusign_esign/models/notary_seal.py @@ -0,0 +1,2381 @@ +# 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 NotarySeal(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 = { + 'anchor_allow_white_space_in_characters': 'str', + 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', + 'anchor_case_sensitive': 'str', + 'anchor_case_sensitive_metadata': 'PropertyMetadata', + 'anchor_horizontal_alignment': 'str', + 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', + 'anchor_ignore_if_not_present': 'str', + 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', + 'anchor_match_whole_word': 'str', + 'anchor_match_whole_word_metadata': 'PropertyMetadata', + 'anchor_string': 'str', + 'anchor_string_metadata': 'PropertyMetadata', + 'anchor_tab_processor_version': 'str', + 'anchor_tab_processor_version_metadata': 'PropertyMetadata', + 'anchor_units': 'str', + 'anchor_units_metadata': 'PropertyMetadata', + 'anchor_x_offset': 'str', + 'anchor_x_offset_metadata': 'PropertyMetadata', + 'anchor_y_offset': 'str', + 'anchor_y_offset_metadata': 'PropertyMetadata', + 'bold': 'str', + 'bold_metadata': 'PropertyMetadata', + 'conditional_parent_label': 'str', + 'conditional_parent_label_metadata': 'PropertyMetadata', + 'conditional_parent_value': 'str', + 'conditional_parent_value_metadata': 'PropertyMetadata', + 'custom_tab_id': 'str', + 'custom_tab_id_metadata': 'PropertyMetadata', + 'document_id': 'str', + 'document_id_metadata': 'PropertyMetadata', + 'error_details': 'ErrorDetails', + 'font': 'str', + 'font_color': 'str', + 'font_color_metadata': 'PropertyMetadata', + 'font_metadata': 'PropertyMetadata', + 'font_size': 'str', + 'font_size_metadata': 'PropertyMetadata', + 'form_order': 'str', + 'form_order_metadata': 'PropertyMetadata', + 'form_page_label': 'str', + 'form_page_label_metadata': 'PropertyMetadata', + 'form_page_number': 'str', + 'form_page_number_metadata': 'PropertyMetadata', + 'height': 'str', + 'height_metadata': 'PropertyMetadata', + 'italic': 'str', + 'italic_metadata': 'PropertyMetadata', + 'locale_policy': 'LocalePolicyTab', + 'merge_field': 'MergeField', + 'merge_field_xml': 'str', + 'name': 'str', + 'name_metadata': 'PropertyMetadata', + 'page_number': 'str', + 'page_number_metadata': 'PropertyMetadata', + 'recipient_id': 'str', + 'recipient_id_guid': 'str', + 'recipient_id_guid_metadata': 'PropertyMetadata', + 'recipient_id_metadata': 'PropertyMetadata', + 'smart_contract_information': 'SmartContractInformation', + 'status': 'str', + 'status_metadata': 'PropertyMetadata', + 'tab_group_labels': 'list[str]', + 'tab_group_labels_metadata': 'PropertyMetadata', + 'tab_id': 'str', + 'tab_id_metadata': 'PropertyMetadata', + 'tab_label': 'str', + 'tab_label_metadata': 'PropertyMetadata', + 'tab_order': 'str', + 'tab_order_metadata': 'PropertyMetadata', + 'tab_type': 'str', + 'tab_type_metadata': 'PropertyMetadata', + 'template_locked': 'str', + 'template_locked_metadata': 'PropertyMetadata', + 'template_required': 'str', + 'template_required_metadata': 'PropertyMetadata', + 'tooltip': 'str', + 'tool_tip_metadata': 'PropertyMetadata', + 'underline': 'str', + 'underline_metadata': 'PropertyMetadata', + 'width': 'str', + 'width_metadata': 'PropertyMetadata', + 'x_position': 'str', + 'x_position_metadata': 'PropertyMetadata', + 'y_position': 'str', + 'y_position_metadata': 'PropertyMetadata' + } + + attribute_map = { + 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', + 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', + 'anchor_case_sensitive': 'anchorCaseSensitive', + 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', + 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', + 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', + 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', + 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', + 'anchor_match_whole_word': 'anchorMatchWholeWord', + 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', + 'anchor_string': 'anchorString', + 'anchor_string_metadata': 'anchorStringMetadata', + 'anchor_tab_processor_version': 'anchorTabProcessorVersion', + 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', + 'anchor_units': 'anchorUnits', + 'anchor_units_metadata': 'anchorUnitsMetadata', + 'anchor_x_offset': 'anchorXOffset', + 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', + 'anchor_y_offset': 'anchorYOffset', + 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', + 'bold': 'bold', + 'bold_metadata': 'boldMetadata', + 'conditional_parent_label': 'conditionalParentLabel', + 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', + 'conditional_parent_value': 'conditionalParentValue', + 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', + 'custom_tab_id': 'customTabId', + 'custom_tab_id_metadata': 'customTabIdMetadata', + 'document_id': 'documentId', + 'document_id_metadata': 'documentIdMetadata', + 'error_details': 'errorDetails', + 'font': 'font', + 'font_color': 'fontColor', + 'font_color_metadata': 'fontColorMetadata', + 'font_metadata': 'fontMetadata', + 'font_size': 'fontSize', + 'font_size_metadata': 'fontSizeMetadata', + 'form_order': 'formOrder', + 'form_order_metadata': 'formOrderMetadata', + 'form_page_label': 'formPageLabel', + 'form_page_label_metadata': 'formPageLabelMetadata', + 'form_page_number': 'formPageNumber', + 'form_page_number_metadata': 'formPageNumberMetadata', + 'height': 'height', + 'height_metadata': 'heightMetadata', + 'italic': 'italic', + 'italic_metadata': 'italicMetadata', + 'locale_policy': 'localePolicy', + 'merge_field': 'mergeField', + 'merge_field_xml': 'mergeFieldXml', + 'name': 'name', + 'name_metadata': 'nameMetadata', + 'page_number': 'pageNumber', + 'page_number_metadata': 'pageNumberMetadata', + 'recipient_id': 'recipientId', + 'recipient_id_guid': 'recipientIdGuid', + 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', + 'recipient_id_metadata': 'recipientIdMetadata', + 'smart_contract_information': 'smartContractInformation', + 'status': 'status', + 'status_metadata': 'statusMetadata', + 'tab_group_labels': 'tabGroupLabels', + 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', + 'tab_id': 'tabId', + 'tab_id_metadata': 'tabIdMetadata', + 'tab_label': 'tabLabel', + 'tab_label_metadata': 'tabLabelMetadata', + 'tab_order': 'tabOrder', + 'tab_order_metadata': 'tabOrderMetadata', + 'tab_type': 'tabType', + 'tab_type_metadata': 'tabTypeMetadata', + 'template_locked': 'templateLocked', + 'template_locked_metadata': 'templateLockedMetadata', + 'template_required': 'templateRequired', + 'template_required_metadata': 'templateRequiredMetadata', + 'tooltip': 'tooltip', + 'tool_tip_metadata': 'toolTipMetadata', + 'underline': 'underline', + 'underline_metadata': 'underlineMetadata', + 'width': 'width', + 'width_metadata': 'widthMetadata', + 'x_position': 'xPosition', + 'x_position_metadata': 'xPositionMetadata', + 'y_position': 'yPosition', + 'y_position_metadata': 'yPositionMetadata' + } + + def __init__(self, anchor_allow_white_space_in_characters=None, anchor_allow_white_space_in_characters_metadata=None, anchor_case_sensitive=None, anchor_case_sensitive_metadata=None, anchor_horizontal_alignment=None, anchor_horizontal_alignment_metadata=None, anchor_ignore_if_not_present=None, anchor_ignore_if_not_present_metadata=None, anchor_match_whole_word=None, anchor_match_whole_word_metadata=None, anchor_string=None, anchor_string_metadata=None, anchor_tab_processor_version=None, anchor_tab_processor_version_metadata=None, anchor_units=None, anchor_units_metadata=None, anchor_x_offset=None, anchor_x_offset_metadata=None, anchor_y_offset=None, anchor_y_offset_metadata=None, bold=None, bold_metadata=None, conditional_parent_label=None, conditional_parent_label_metadata=None, conditional_parent_value=None, conditional_parent_value_metadata=None, custom_tab_id=None, custom_tab_id_metadata=None, document_id=None, document_id_metadata=None, error_details=None, font=None, font_color=None, font_color_metadata=None, font_metadata=None, font_size=None, font_size_metadata=None, form_order=None, form_order_metadata=None, form_page_label=None, form_page_label_metadata=None, form_page_number=None, form_page_number_metadata=None, height=None, height_metadata=None, italic=None, italic_metadata=None, locale_policy=None, merge_field=None, merge_field_xml=None, name=None, name_metadata=None, page_number=None, page_number_metadata=None, recipient_id=None, recipient_id_guid=None, recipient_id_guid_metadata=None, recipient_id_metadata=None, smart_contract_information=None, status=None, status_metadata=None, tab_group_labels=None, tab_group_labels_metadata=None, tab_id=None, tab_id_metadata=None, tab_label=None, tab_label_metadata=None, tab_order=None, tab_order_metadata=None, tab_type=None, tab_type_metadata=None, template_locked=None, template_locked_metadata=None, template_required=None, template_required_metadata=None, tooltip=None, tool_tip_metadata=None, underline=None, underline_metadata=None, width=None, width_metadata=None, x_position=None, x_position_metadata=None, y_position=None, y_position_metadata=None): # noqa: E501 + """NotarySeal - a model defined in Swagger""" # noqa: E501 + + self._anchor_allow_white_space_in_characters = None + self._anchor_allow_white_space_in_characters_metadata = None + self._anchor_case_sensitive = None + self._anchor_case_sensitive_metadata = None + self._anchor_horizontal_alignment = None + self._anchor_horizontal_alignment_metadata = None + self._anchor_ignore_if_not_present = None + self._anchor_ignore_if_not_present_metadata = None + self._anchor_match_whole_word = None + self._anchor_match_whole_word_metadata = None + self._anchor_string = None + self._anchor_string_metadata = None + self._anchor_tab_processor_version = None + self._anchor_tab_processor_version_metadata = None + self._anchor_units = None + self._anchor_units_metadata = None + self._anchor_x_offset = None + self._anchor_x_offset_metadata = None + self._anchor_y_offset = None + self._anchor_y_offset_metadata = None + self._bold = None + self._bold_metadata = None + self._conditional_parent_label = None + self._conditional_parent_label_metadata = None + self._conditional_parent_value = None + self._conditional_parent_value_metadata = None + self._custom_tab_id = None + self._custom_tab_id_metadata = None + self._document_id = None + self._document_id_metadata = None + self._error_details = None + self._font = None + self._font_color = None + self._font_color_metadata = None + self._font_metadata = None + self._font_size = None + self._font_size_metadata = None + self._form_order = None + self._form_order_metadata = None + self._form_page_label = None + self._form_page_label_metadata = None + self._form_page_number = None + self._form_page_number_metadata = None + self._height = None + self._height_metadata = None + self._italic = None + self._italic_metadata = None + self._locale_policy = None + self._merge_field = None + self._merge_field_xml = None + self._name = None + self._name_metadata = None + self._page_number = None + self._page_number_metadata = None + self._recipient_id = None + self._recipient_id_guid = None + self._recipient_id_guid_metadata = None + self._recipient_id_metadata = None + self._smart_contract_information = None + self._status = None + self._status_metadata = None + self._tab_group_labels = None + self._tab_group_labels_metadata = None + self._tab_id = None + self._tab_id_metadata = None + self._tab_label = None + self._tab_label_metadata = None + self._tab_order = None + self._tab_order_metadata = None + self._tab_type = None + self._tab_type_metadata = None + self._template_locked = None + self._template_locked_metadata = None + self._template_required = None + self._template_required_metadata = None + self._tooltip = None + self._tool_tip_metadata = None + self._underline = None + self._underline_metadata = None + self._width = None + self._width_metadata = None + self._x_position = None + self._x_position_metadata = None + self._y_position = None + self._y_position_metadata = None + self.discriminator = None + + if anchor_allow_white_space_in_characters is not None: + self.anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters + if anchor_allow_white_space_in_characters_metadata is not None: + self.anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata + if anchor_case_sensitive is not None: + self.anchor_case_sensitive = anchor_case_sensitive + if anchor_case_sensitive_metadata is not None: + self.anchor_case_sensitive_metadata = anchor_case_sensitive_metadata + if anchor_horizontal_alignment is not None: + self.anchor_horizontal_alignment = anchor_horizontal_alignment + if anchor_horizontal_alignment_metadata is not None: + self.anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata + if anchor_ignore_if_not_present is not None: + self.anchor_ignore_if_not_present = anchor_ignore_if_not_present + if anchor_ignore_if_not_present_metadata is not None: + self.anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata + if anchor_match_whole_word is not None: + self.anchor_match_whole_word = anchor_match_whole_word + if anchor_match_whole_word_metadata is not None: + self.anchor_match_whole_word_metadata = anchor_match_whole_word_metadata + if anchor_string is not None: + self.anchor_string = anchor_string + if anchor_string_metadata is not None: + self.anchor_string_metadata = anchor_string_metadata + if anchor_tab_processor_version is not None: + self.anchor_tab_processor_version = anchor_tab_processor_version + if anchor_tab_processor_version_metadata is not None: + self.anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata + if anchor_units is not None: + self.anchor_units = anchor_units + if anchor_units_metadata is not None: + self.anchor_units_metadata = anchor_units_metadata + if anchor_x_offset is not None: + self.anchor_x_offset = anchor_x_offset + if anchor_x_offset_metadata is not None: + self.anchor_x_offset_metadata = anchor_x_offset_metadata + if anchor_y_offset is not None: + self.anchor_y_offset = anchor_y_offset + if anchor_y_offset_metadata is not None: + self.anchor_y_offset_metadata = anchor_y_offset_metadata + if bold is not None: + self.bold = bold + if bold_metadata is not None: + self.bold_metadata = bold_metadata + if conditional_parent_label is not None: + self.conditional_parent_label = conditional_parent_label + if conditional_parent_label_metadata is not None: + self.conditional_parent_label_metadata = conditional_parent_label_metadata + if conditional_parent_value is not None: + self.conditional_parent_value = conditional_parent_value + if conditional_parent_value_metadata is not None: + self.conditional_parent_value_metadata = conditional_parent_value_metadata + if custom_tab_id is not None: + self.custom_tab_id = custom_tab_id + if custom_tab_id_metadata is not None: + self.custom_tab_id_metadata = custom_tab_id_metadata + if document_id is not None: + self.document_id = document_id + if document_id_metadata is not None: + self.document_id_metadata = document_id_metadata + if error_details is not None: + self.error_details = error_details + if font is not None: + self.font = font + if font_color is not None: + self.font_color = font_color + if font_color_metadata is not None: + self.font_color_metadata = font_color_metadata + if font_metadata is not None: + self.font_metadata = font_metadata + if font_size is not None: + self.font_size = font_size + if font_size_metadata is not None: + self.font_size_metadata = font_size_metadata + if form_order is not None: + self.form_order = form_order + if form_order_metadata is not None: + self.form_order_metadata = form_order_metadata + if form_page_label is not None: + self.form_page_label = form_page_label + if form_page_label_metadata is not None: + self.form_page_label_metadata = form_page_label_metadata + if form_page_number is not None: + self.form_page_number = form_page_number + if form_page_number_metadata is not None: + self.form_page_number_metadata = form_page_number_metadata + if height is not None: + self.height = height + if height_metadata is not None: + self.height_metadata = height_metadata + if italic is not None: + self.italic = italic + if italic_metadata is not None: + self.italic_metadata = italic_metadata + if locale_policy is not None: + self.locale_policy = locale_policy + if merge_field is not None: + self.merge_field = merge_field + if merge_field_xml is not None: + self.merge_field_xml = merge_field_xml + if name is not None: + self.name = name + if name_metadata is not None: + self.name_metadata = name_metadata + if page_number is not None: + self.page_number = page_number + if page_number_metadata is not None: + self.page_number_metadata = page_number_metadata + if recipient_id is not None: + self.recipient_id = recipient_id + if recipient_id_guid is not None: + self.recipient_id_guid = recipient_id_guid + if recipient_id_guid_metadata is not None: + self.recipient_id_guid_metadata = recipient_id_guid_metadata + if recipient_id_metadata is not None: + self.recipient_id_metadata = recipient_id_metadata + if smart_contract_information is not None: + self.smart_contract_information = smart_contract_information + if status is not None: + self.status = status + if status_metadata is not None: + self.status_metadata = status_metadata + if tab_group_labels is not None: + self.tab_group_labels = tab_group_labels + if tab_group_labels_metadata is not None: + self.tab_group_labels_metadata = tab_group_labels_metadata + if tab_id is not None: + self.tab_id = tab_id + if tab_id_metadata is not None: + self.tab_id_metadata = tab_id_metadata + if tab_label is not None: + self.tab_label = tab_label + if tab_label_metadata is not None: + self.tab_label_metadata = tab_label_metadata + if tab_order is not None: + self.tab_order = tab_order + if tab_order_metadata is not None: + self.tab_order_metadata = tab_order_metadata + if tab_type is not None: + self.tab_type = tab_type + if tab_type_metadata is not None: + self.tab_type_metadata = tab_type_metadata + if template_locked is not None: + self.template_locked = template_locked + if template_locked_metadata is not None: + self.template_locked_metadata = template_locked_metadata + if template_required is not None: + self.template_required = template_required + if template_required_metadata is not None: + self.template_required_metadata = template_required_metadata + if tooltip is not None: + self.tooltip = tooltip + if tool_tip_metadata is not None: + self.tool_tip_metadata = tool_tip_metadata + if underline is not None: + self.underline = underline + if underline_metadata is not None: + self.underline_metadata = underline_metadata + if width is not None: + self.width = width + if width_metadata is not None: + self.width_metadata = width_metadata + if x_position is not None: + self.x_position = x_position + if x_position_metadata is not None: + self.x_position_metadata = x_position_metadata + if y_position is not None: + self.y_position = y_position + if y_position_metadata is not None: + self.y_position_metadata = y_position_metadata + + @property + def anchor_allow_white_space_in_characters(self): + """Gets the anchor_allow_white_space_in_characters of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The anchor_allow_white_space_in_characters of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._anchor_allow_white_space_in_characters + + @anchor_allow_white_space_in_characters.setter + def anchor_allow_white_space_in_characters(self, anchor_allow_white_space_in_characters): + """Sets the anchor_allow_white_space_in_characters of this NotarySeal. + + # noqa: E501 + + :param anchor_allow_white_space_in_characters: The anchor_allow_white_space_in_characters of this NotarySeal. # noqa: E501 + :type: str + """ + + self._anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters + + @property + def anchor_allow_white_space_in_characters_metadata(self): + """Gets the anchor_allow_white_space_in_characters_metadata of this NotarySeal. # noqa: E501 + + + :return: The anchor_allow_white_space_in_characters_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_allow_white_space_in_characters_metadata + + @anchor_allow_white_space_in_characters_metadata.setter + def anchor_allow_white_space_in_characters_metadata(self, anchor_allow_white_space_in_characters_metadata): + """Sets the anchor_allow_white_space_in_characters_metadata of this NotarySeal. + + + :param anchor_allow_white_space_in_characters_metadata: The anchor_allow_white_space_in_characters_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata + + @property + def anchor_case_sensitive(self): + """Gets the anchor_case_sensitive of this NotarySeal. # noqa: E501 + + When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 + + :return: The anchor_case_sensitive of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._anchor_case_sensitive + + @anchor_case_sensitive.setter + def anchor_case_sensitive(self, anchor_case_sensitive): + """Sets the anchor_case_sensitive of this NotarySeal. + + When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 + + :param anchor_case_sensitive: The anchor_case_sensitive of this NotarySeal. # noqa: E501 + :type: str + """ + + self._anchor_case_sensitive = anchor_case_sensitive + + @property + def anchor_case_sensitive_metadata(self): + """Gets the anchor_case_sensitive_metadata of this NotarySeal. # noqa: E501 + + + :return: The anchor_case_sensitive_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_case_sensitive_metadata + + @anchor_case_sensitive_metadata.setter + def anchor_case_sensitive_metadata(self, anchor_case_sensitive_metadata): + """Sets the anchor_case_sensitive_metadata of this NotarySeal. + + + :param anchor_case_sensitive_metadata: The anchor_case_sensitive_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_case_sensitive_metadata = anchor_case_sensitive_metadata + + @property + def anchor_horizontal_alignment(self): + """Gets the anchor_horizontal_alignment of this NotarySeal. # noqa: E501 + + Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 + + :return: The anchor_horizontal_alignment of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._anchor_horizontal_alignment + + @anchor_horizontal_alignment.setter + def anchor_horizontal_alignment(self, anchor_horizontal_alignment): + """Sets the anchor_horizontal_alignment of this NotarySeal. + + Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 + + :param anchor_horizontal_alignment: The anchor_horizontal_alignment of this NotarySeal. # noqa: E501 + :type: str + """ + + self._anchor_horizontal_alignment = anchor_horizontal_alignment + + @property + def anchor_horizontal_alignment_metadata(self): + """Gets the anchor_horizontal_alignment_metadata of this NotarySeal. # noqa: E501 + + + :return: The anchor_horizontal_alignment_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_horizontal_alignment_metadata + + @anchor_horizontal_alignment_metadata.setter + def anchor_horizontal_alignment_metadata(self, anchor_horizontal_alignment_metadata): + """Sets the anchor_horizontal_alignment_metadata of this NotarySeal. + + + :param anchor_horizontal_alignment_metadata: The anchor_horizontal_alignment_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata + + @property + def anchor_ignore_if_not_present(self): + """Gets the anchor_ignore_if_not_present of this NotarySeal. # noqa: E501 + + When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 + + :return: The anchor_ignore_if_not_present of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._anchor_ignore_if_not_present + + @anchor_ignore_if_not_present.setter + def anchor_ignore_if_not_present(self, anchor_ignore_if_not_present): + """Sets the anchor_ignore_if_not_present of this NotarySeal. + + When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 + + :param anchor_ignore_if_not_present: The anchor_ignore_if_not_present of this NotarySeal. # noqa: E501 + :type: str + """ + + self._anchor_ignore_if_not_present = anchor_ignore_if_not_present + + @property + def anchor_ignore_if_not_present_metadata(self): + """Gets the anchor_ignore_if_not_present_metadata of this NotarySeal. # noqa: E501 + + + :return: The anchor_ignore_if_not_present_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_ignore_if_not_present_metadata + + @anchor_ignore_if_not_present_metadata.setter + def anchor_ignore_if_not_present_metadata(self, anchor_ignore_if_not_present_metadata): + """Sets the anchor_ignore_if_not_present_metadata of this NotarySeal. + + + :param anchor_ignore_if_not_present_metadata: The anchor_ignore_if_not_present_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata + + @property + def anchor_match_whole_word(self): + """Gets the anchor_match_whole_word of this NotarySeal. # noqa: E501 + + When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. # noqa: E501 + + :return: The anchor_match_whole_word of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._anchor_match_whole_word + + @anchor_match_whole_word.setter + def anchor_match_whole_word(self, anchor_match_whole_word): + """Sets the anchor_match_whole_word of this NotarySeal. + + When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. # noqa: E501 + + :param anchor_match_whole_word: The anchor_match_whole_word of this NotarySeal. # noqa: E501 + :type: str + """ + + self._anchor_match_whole_word = anchor_match_whole_word + + @property + def anchor_match_whole_word_metadata(self): + """Gets the anchor_match_whole_word_metadata of this NotarySeal. # noqa: E501 + + + :return: The anchor_match_whole_word_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_match_whole_word_metadata + + @anchor_match_whole_word_metadata.setter + def anchor_match_whole_word_metadata(self, anchor_match_whole_word_metadata): + """Sets the anchor_match_whole_word_metadata of this NotarySeal. + + + :param anchor_match_whole_word_metadata: The anchor_match_whole_word_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_match_whole_word_metadata = anchor_match_whole_word_metadata + + @property + def anchor_string(self): + """Gets the anchor_string of this NotarySeal. # noqa: E501 + + Anchor text information for a radio button. # noqa: E501 + + :return: The anchor_string of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._anchor_string + + @anchor_string.setter + def anchor_string(self, anchor_string): + """Sets the anchor_string of this NotarySeal. + + Anchor text information for a radio button. # noqa: E501 + + :param anchor_string: The anchor_string of this NotarySeal. # noqa: E501 + :type: str + """ + + self._anchor_string = anchor_string + + @property + def anchor_string_metadata(self): + """Gets the anchor_string_metadata of this NotarySeal. # noqa: E501 + + + :return: The anchor_string_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_string_metadata + + @anchor_string_metadata.setter + def anchor_string_metadata(self, anchor_string_metadata): + """Sets the anchor_string_metadata of this NotarySeal. + + + :param anchor_string_metadata: The anchor_string_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_string_metadata = anchor_string_metadata + + @property + def anchor_tab_processor_version(self): + """Gets the anchor_tab_processor_version of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The anchor_tab_processor_version of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._anchor_tab_processor_version + + @anchor_tab_processor_version.setter + def anchor_tab_processor_version(self, anchor_tab_processor_version): + """Sets the anchor_tab_processor_version of this NotarySeal. + + # noqa: E501 + + :param anchor_tab_processor_version: The anchor_tab_processor_version of this NotarySeal. # noqa: E501 + :type: str + """ + + self._anchor_tab_processor_version = anchor_tab_processor_version + + @property + def anchor_tab_processor_version_metadata(self): + """Gets the anchor_tab_processor_version_metadata of this NotarySeal. # noqa: E501 + + + :return: The anchor_tab_processor_version_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_tab_processor_version_metadata + + @anchor_tab_processor_version_metadata.setter + def anchor_tab_processor_version_metadata(self, anchor_tab_processor_version_metadata): + """Sets the anchor_tab_processor_version_metadata of this NotarySeal. + + + :param anchor_tab_processor_version_metadata: The anchor_tab_processor_version_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata + + @property + def anchor_units(self): + """Gets the anchor_units of this NotarySeal. # noqa: E501 + + Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 + + :return: The anchor_units of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._anchor_units + + @anchor_units.setter + def anchor_units(self, anchor_units): + """Sets the anchor_units of this NotarySeal. + + Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 + + :param anchor_units: The anchor_units of this NotarySeal. # noqa: E501 + :type: str + """ + + self._anchor_units = anchor_units + + @property + def anchor_units_metadata(self): + """Gets the anchor_units_metadata of this NotarySeal. # noqa: E501 + + + :return: The anchor_units_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_units_metadata + + @anchor_units_metadata.setter + def anchor_units_metadata(self, anchor_units_metadata): + """Sets the anchor_units_metadata of this NotarySeal. + + + :param anchor_units_metadata: The anchor_units_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_units_metadata = anchor_units_metadata + + @property + def anchor_x_offset(self): + """Gets the anchor_x_offset of this NotarySeal. # noqa: E501 + + Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 + + :return: The anchor_x_offset of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._anchor_x_offset + + @anchor_x_offset.setter + def anchor_x_offset(self, anchor_x_offset): + """Sets the anchor_x_offset of this NotarySeal. + + Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 + + :param anchor_x_offset: The anchor_x_offset of this NotarySeal. # noqa: E501 + :type: str + """ + + self._anchor_x_offset = anchor_x_offset + + @property + def anchor_x_offset_metadata(self): + """Gets the anchor_x_offset_metadata of this NotarySeal. # noqa: E501 + + + :return: The anchor_x_offset_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_x_offset_metadata + + @anchor_x_offset_metadata.setter + def anchor_x_offset_metadata(self, anchor_x_offset_metadata): + """Sets the anchor_x_offset_metadata of this NotarySeal. + + + :param anchor_x_offset_metadata: The anchor_x_offset_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_x_offset_metadata = anchor_x_offset_metadata + + @property + def anchor_y_offset(self): + """Gets the anchor_y_offset of this NotarySeal. # noqa: E501 + + Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 + + :return: The anchor_y_offset of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._anchor_y_offset + + @anchor_y_offset.setter + def anchor_y_offset(self, anchor_y_offset): + """Sets the anchor_y_offset of this NotarySeal. + + Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 + + :param anchor_y_offset: The anchor_y_offset of this NotarySeal. # noqa: E501 + :type: str + """ + + self._anchor_y_offset = anchor_y_offset + + @property + def anchor_y_offset_metadata(self): + """Gets the anchor_y_offset_metadata of this NotarySeal. # noqa: E501 + + + :return: The anchor_y_offset_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._anchor_y_offset_metadata + + @anchor_y_offset_metadata.setter + def anchor_y_offset_metadata(self, anchor_y_offset_metadata): + """Sets the anchor_y_offset_metadata of this NotarySeal. + + + :param anchor_y_offset_metadata: The anchor_y_offset_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._anchor_y_offset_metadata = anchor_y_offset_metadata + + @property + def bold(self): + """Gets the bold of this NotarySeal. # noqa: E501 + + When set to **true**, the information in the tab is bold. # noqa: E501 + + :return: The bold of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._bold + + @bold.setter + def bold(self, bold): + """Sets the bold of this NotarySeal. + + When set to **true**, the information in the tab is bold. # noqa: E501 + + :param bold: The bold of this NotarySeal. # noqa: E501 + :type: str + """ + + self._bold = bold + + @property + def bold_metadata(self): + """Gets the bold_metadata of this NotarySeal. # noqa: E501 + + + :return: The bold_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._bold_metadata + + @bold_metadata.setter + def bold_metadata(self, bold_metadata): + """Sets the bold_metadata of this NotarySeal. + + + :param bold_metadata: The bold_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._bold_metadata = bold_metadata + + @property + def conditional_parent_label(self): + """Gets the conditional_parent_label of this NotarySeal. # noqa: E501 + + For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 + + :return: The conditional_parent_label of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._conditional_parent_label + + @conditional_parent_label.setter + def conditional_parent_label(self, conditional_parent_label): + """Sets the conditional_parent_label of this NotarySeal. + + For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 + + :param conditional_parent_label: The conditional_parent_label of this NotarySeal. # noqa: E501 + :type: str + """ + + self._conditional_parent_label = conditional_parent_label + + @property + def conditional_parent_label_metadata(self): + """Gets the conditional_parent_label_metadata of this NotarySeal. # noqa: E501 + + + :return: The conditional_parent_label_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._conditional_parent_label_metadata + + @conditional_parent_label_metadata.setter + def conditional_parent_label_metadata(self, conditional_parent_label_metadata): + """Sets the conditional_parent_label_metadata of this NotarySeal. + + + :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._conditional_parent_label_metadata = conditional_parent_label_metadata + + @property + def conditional_parent_value(self): + """Gets the conditional_parent_value of this NotarySeal. # noqa: E501 + + For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 + + :return: The conditional_parent_value of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._conditional_parent_value + + @conditional_parent_value.setter + def conditional_parent_value(self, conditional_parent_value): + """Sets the conditional_parent_value of this NotarySeal. + + For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 + + :param conditional_parent_value: The conditional_parent_value of this NotarySeal. # noqa: E501 + :type: str + """ + + self._conditional_parent_value = conditional_parent_value + + @property + def conditional_parent_value_metadata(self): + """Gets the conditional_parent_value_metadata of this NotarySeal. # noqa: E501 + + + :return: The conditional_parent_value_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._conditional_parent_value_metadata + + @conditional_parent_value_metadata.setter + def conditional_parent_value_metadata(self, conditional_parent_value_metadata): + """Sets the conditional_parent_value_metadata of this NotarySeal. + + + :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._conditional_parent_value_metadata = conditional_parent_value_metadata + + @property + def custom_tab_id(self): + """Gets the custom_tab_id of this NotarySeal. # noqa: E501 + + The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. # noqa: E501 + + :return: The custom_tab_id of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._custom_tab_id + + @custom_tab_id.setter + def custom_tab_id(self, custom_tab_id): + """Sets the custom_tab_id of this NotarySeal. + + The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. # noqa: E501 + + :param custom_tab_id: The custom_tab_id of this NotarySeal. # noqa: E501 + :type: str + """ + + self._custom_tab_id = custom_tab_id + + @property + def custom_tab_id_metadata(self): + """Gets the custom_tab_id_metadata of this NotarySeal. # noqa: E501 + + + :return: The custom_tab_id_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._custom_tab_id_metadata + + @custom_tab_id_metadata.setter + def custom_tab_id_metadata(self, custom_tab_id_metadata): + """Sets the custom_tab_id_metadata of this NotarySeal. + + + :param custom_tab_id_metadata: The custom_tab_id_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._custom_tab_id_metadata = custom_tab_id_metadata + + @property + def document_id(self): + """Gets the document_id of this NotarySeal. # noqa: E501 + + Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 + + :return: The document_id of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._document_id + + @document_id.setter + def document_id(self, document_id): + """Sets the document_id of this NotarySeal. + + Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 + + :param document_id: The document_id of this NotarySeal. # noqa: E501 + :type: str + """ + + self._document_id = document_id + + @property + def document_id_metadata(self): + """Gets the document_id_metadata of this NotarySeal. # noqa: E501 + + + :return: The document_id_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._document_id_metadata + + @document_id_metadata.setter + def document_id_metadata(self, document_id_metadata): + """Sets the document_id_metadata of this NotarySeal. + + + :param document_id_metadata: The document_id_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._document_id_metadata = document_id_metadata + + @property + def error_details(self): + """Gets the error_details of this NotarySeal. # noqa: E501 + + + :return: The error_details of this NotarySeal. # noqa: E501 + :rtype: ErrorDetails + """ + return self._error_details + + @error_details.setter + def error_details(self, error_details): + """Sets the error_details of this NotarySeal. + + + :param error_details: The error_details of this NotarySeal. # noqa: E501 + :type: ErrorDetails + """ + + self._error_details = error_details + + @property + def font(self): + """Gets the font of this NotarySeal. # noqa: E501 + + The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. # noqa: E501 + + :return: The font of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._font + + @font.setter + def font(self, font): + """Sets the font of this NotarySeal. + + The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. # noqa: E501 + + :param font: The font of this NotarySeal. # noqa: E501 + :type: str + """ + + self._font = font + + @property + def font_color(self): + """Gets the font_color of this NotarySeal. # noqa: E501 + + The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. # noqa: E501 + + :return: The font_color of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._font_color + + @font_color.setter + def font_color(self, font_color): + """Sets the font_color of this NotarySeal. + + The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. # noqa: E501 + + :param font_color: The font_color of this NotarySeal. # noqa: E501 + :type: str + """ + + self._font_color = font_color + + @property + def font_color_metadata(self): + """Gets the font_color_metadata of this NotarySeal. # noqa: E501 + + + :return: The font_color_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._font_color_metadata + + @font_color_metadata.setter + def font_color_metadata(self, font_color_metadata): + """Sets the font_color_metadata of this NotarySeal. + + + :param font_color_metadata: The font_color_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._font_color_metadata = font_color_metadata + + @property + def font_metadata(self): + """Gets the font_metadata of this NotarySeal. # noqa: E501 + + + :return: The font_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._font_metadata + + @font_metadata.setter + def font_metadata(self, font_metadata): + """Sets the font_metadata of this NotarySeal. + + + :param font_metadata: The font_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._font_metadata = font_metadata + + @property + def font_size(self): + """Gets the font_size of this NotarySeal. # noqa: E501 + + The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. # noqa: E501 + + :return: The font_size of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._font_size + + @font_size.setter + def font_size(self, font_size): + """Sets the font_size of this NotarySeal. + + The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. # noqa: E501 + + :param font_size: The font_size of this NotarySeal. # noqa: E501 + :type: str + """ + + self._font_size = font_size + + @property + def font_size_metadata(self): + """Gets the font_size_metadata of this NotarySeal. # noqa: E501 + + + :return: The font_size_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._font_size_metadata + + @font_size_metadata.setter + def font_size_metadata(self, font_size_metadata): + """Sets the font_size_metadata of this NotarySeal. + + + :param font_size_metadata: The font_size_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._font_size_metadata = font_size_metadata + + @property + def form_order(self): + """Gets the form_order of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The form_order of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._form_order + + @form_order.setter + def form_order(self, form_order): + """Sets the form_order of this NotarySeal. + + # noqa: E501 + + :param form_order: The form_order of this NotarySeal. # noqa: E501 + :type: str + """ + + self._form_order = form_order + + @property + def form_order_metadata(self): + """Gets the form_order_metadata of this NotarySeal. # noqa: E501 + + + :return: The form_order_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._form_order_metadata + + @form_order_metadata.setter + def form_order_metadata(self, form_order_metadata): + """Sets the form_order_metadata of this NotarySeal. + + + :param form_order_metadata: The form_order_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._form_order_metadata = form_order_metadata + + @property + def form_page_label(self): + """Gets the form_page_label of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The form_page_label of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._form_page_label + + @form_page_label.setter + def form_page_label(self, form_page_label): + """Sets the form_page_label of this NotarySeal. + + # noqa: E501 + + :param form_page_label: The form_page_label of this NotarySeal. # noqa: E501 + :type: str + """ + + self._form_page_label = form_page_label + + @property + def form_page_label_metadata(self): + """Gets the form_page_label_metadata of this NotarySeal. # noqa: E501 + + + :return: The form_page_label_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._form_page_label_metadata + + @form_page_label_metadata.setter + def form_page_label_metadata(self, form_page_label_metadata): + """Sets the form_page_label_metadata of this NotarySeal. + + + :param form_page_label_metadata: The form_page_label_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._form_page_label_metadata = form_page_label_metadata + + @property + def form_page_number(self): + """Gets the form_page_number of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The form_page_number of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._form_page_number + + @form_page_number.setter + def form_page_number(self, form_page_number): + """Sets the form_page_number of this NotarySeal. + + # noqa: E501 + + :param form_page_number: The form_page_number of this NotarySeal. # noqa: E501 + :type: str + """ + + self._form_page_number = form_page_number + + @property + def form_page_number_metadata(self): + """Gets the form_page_number_metadata of this NotarySeal. # noqa: E501 + + + :return: The form_page_number_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._form_page_number_metadata + + @form_page_number_metadata.setter + def form_page_number_metadata(self, form_page_number_metadata): + """Sets the form_page_number_metadata of this NotarySeal. + + + :param form_page_number_metadata: The form_page_number_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._form_page_number_metadata = form_page_number_metadata + + @property + def height(self): + """Gets the height of this NotarySeal. # noqa: E501 + + Height of the tab in pixels. # noqa: E501 + + :return: The height of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._height + + @height.setter + def height(self, height): + """Sets the height of this NotarySeal. + + Height of the tab in pixels. # noqa: E501 + + :param height: The height of this NotarySeal. # noqa: E501 + :type: str + """ + + self._height = height + + @property + def height_metadata(self): + """Gets the height_metadata of this NotarySeal. # noqa: E501 + + + :return: The height_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._height_metadata + + @height_metadata.setter + def height_metadata(self, height_metadata): + """Sets the height_metadata of this NotarySeal. + + + :param height_metadata: The height_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._height_metadata = height_metadata + + @property + def italic(self): + """Gets the italic of this NotarySeal. # noqa: E501 + + When set to **true**, the information in the tab is italic. # noqa: E501 + + :return: The italic of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._italic + + @italic.setter + def italic(self, italic): + """Sets the italic of this NotarySeal. + + When set to **true**, the information in the tab is italic. # noqa: E501 + + :param italic: The italic of this NotarySeal. # noqa: E501 + :type: str + """ + + self._italic = italic + + @property + def italic_metadata(self): + """Gets the italic_metadata of this NotarySeal. # noqa: E501 + + + :return: The italic_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._italic_metadata + + @italic_metadata.setter + def italic_metadata(self, italic_metadata): + """Sets the italic_metadata of this NotarySeal. + + + :param italic_metadata: The italic_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._italic_metadata = italic_metadata + + @property + def locale_policy(self): + """Gets the locale_policy of this NotarySeal. # noqa: E501 + + + :return: The locale_policy of this NotarySeal. # noqa: E501 + :rtype: LocalePolicyTab + """ + return self._locale_policy + + @locale_policy.setter + def locale_policy(self, locale_policy): + """Sets the locale_policy of this NotarySeal. + + + :param locale_policy: The locale_policy of this NotarySeal. # noqa: E501 + :type: LocalePolicyTab + """ + + self._locale_policy = locale_policy + + @property + def merge_field(self): + """Gets the merge_field of this NotarySeal. # noqa: E501 + + + :return: The merge_field of this NotarySeal. # noqa: E501 + :rtype: MergeField + """ + return self._merge_field + + @merge_field.setter + def merge_field(self, merge_field): + """Sets the merge_field of this NotarySeal. + + + :param merge_field: The merge_field of this NotarySeal. # noqa: E501 + :type: MergeField + """ + + self._merge_field = merge_field + + @property + def merge_field_xml(self): + """Gets the merge_field_xml of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The merge_field_xml of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._merge_field_xml + + @merge_field_xml.setter + def merge_field_xml(self, merge_field_xml): + """Sets the merge_field_xml of this NotarySeal. + + # noqa: E501 + + :param merge_field_xml: The merge_field_xml of this NotarySeal. # noqa: E501 + :type: str + """ + + self._merge_field_xml = merge_field_xml + + @property + def name(self): + """Gets the name of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The name of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this NotarySeal. + + # noqa: E501 + + :param name: The name of this NotarySeal. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def name_metadata(self): + """Gets the name_metadata of this NotarySeal. # noqa: E501 + + + :return: The name_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._name_metadata + + @name_metadata.setter + def name_metadata(self, name_metadata): + """Sets the name_metadata of this NotarySeal. + + + :param name_metadata: The name_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._name_metadata = name_metadata + + @property + def page_number(self): + """Gets the page_number of this NotarySeal. # noqa: E501 + + Specifies the page number on which the tab is located. # noqa: E501 + + :return: The page_number of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._page_number + + @page_number.setter + def page_number(self, page_number): + """Sets the page_number of this NotarySeal. + + Specifies the page number on which the tab is located. # noqa: E501 + + :param page_number: The page_number of this NotarySeal. # noqa: E501 + :type: str + """ + + self._page_number = page_number + + @property + def page_number_metadata(self): + """Gets the page_number_metadata of this NotarySeal. # noqa: E501 + + + :return: The page_number_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._page_number_metadata + + @page_number_metadata.setter + def page_number_metadata(self, page_number_metadata): + """Sets the page_number_metadata of this NotarySeal. + + + :param page_number_metadata: The page_number_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._page_number_metadata = page_number_metadata + + @property + def recipient_id(self): + """Gets the recipient_id of this NotarySeal. # 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 NotarySeal. # noqa: E501 + :rtype: str + """ + return self._recipient_id + + @recipient_id.setter + def recipient_id(self, recipient_id): + """Sets the recipient_id of this NotarySeal. + + 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 NotarySeal. # noqa: E501 + :type: str + """ + + self._recipient_id = recipient_id + + @property + def recipient_id_guid(self): + """Gets the recipient_id_guid of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The recipient_id_guid of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._recipient_id_guid + + @recipient_id_guid.setter + def recipient_id_guid(self, recipient_id_guid): + """Sets the recipient_id_guid of this NotarySeal. + + # noqa: E501 + + :param recipient_id_guid: The recipient_id_guid of this NotarySeal. # noqa: E501 + :type: str + """ + + self._recipient_id_guid = recipient_id_guid + + @property + def recipient_id_guid_metadata(self): + """Gets the recipient_id_guid_metadata of this NotarySeal. # noqa: E501 + + + :return: The recipient_id_guid_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._recipient_id_guid_metadata + + @recipient_id_guid_metadata.setter + def recipient_id_guid_metadata(self, recipient_id_guid_metadata): + """Sets the recipient_id_guid_metadata of this NotarySeal. + + + :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._recipient_id_guid_metadata = recipient_id_guid_metadata + + @property + def recipient_id_metadata(self): + """Gets the recipient_id_metadata of this NotarySeal. # noqa: E501 + + + :return: The recipient_id_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._recipient_id_metadata + + @recipient_id_metadata.setter + def recipient_id_metadata(self, recipient_id_metadata): + """Sets the recipient_id_metadata of this NotarySeal. + + + :param recipient_id_metadata: The recipient_id_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._recipient_id_metadata = recipient_id_metadata + + @property + def smart_contract_information(self): + """Gets the smart_contract_information of this NotarySeal. # noqa: E501 + + + :return: The smart_contract_information of this NotarySeal. # noqa: E501 + :rtype: SmartContractInformation + """ + return self._smart_contract_information + + @smart_contract_information.setter + def smart_contract_information(self, smart_contract_information): + """Sets the smart_contract_information of this NotarySeal. + + + :param smart_contract_information: The smart_contract_information of this NotarySeal. # noqa: E501 + :type: SmartContractInformation + """ + + self._smart_contract_information = smart_contract_information + + @property + def status(self): + """Gets the status of this NotarySeal. # 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 NotarySeal. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this NotarySeal. + + 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 NotarySeal. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def status_metadata(self): + """Gets the status_metadata of this NotarySeal. # noqa: E501 + + + :return: The status_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._status_metadata + + @status_metadata.setter + def status_metadata(self, status_metadata): + """Sets the status_metadata of this NotarySeal. + + + :param status_metadata: The status_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._status_metadata = status_metadata + + @property + def tab_group_labels(self): + """Gets the tab_group_labels of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The tab_group_labels of this NotarySeal. # noqa: E501 + :rtype: list[str] + """ + return self._tab_group_labels + + @tab_group_labels.setter + def tab_group_labels(self, tab_group_labels): + """Sets the tab_group_labels of this NotarySeal. + + # noqa: E501 + + :param tab_group_labels: The tab_group_labels of this NotarySeal. # noqa: E501 + :type: list[str] + """ + + self._tab_group_labels = tab_group_labels + + @property + def tab_group_labels_metadata(self): + """Gets the tab_group_labels_metadata of this NotarySeal. # noqa: E501 + + + :return: The tab_group_labels_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tab_group_labels_metadata + + @tab_group_labels_metadata.setter + def tab_group_labels_metadata(self, tab_group_labels_metadata): + """Sets the tab_group_labels_metadata of this NotarySeal. + + + :param tab_group_labels_metadata: The tab_group_labels_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._tab_group_labels_metadata = tab_group_labels_metadata + + @property + def tab_id(self): + """Gets the tab_id of this NotarySeal. # 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 NotarySeal. # noqa: E501 + :rtype: str + """ + return self._tab_id + + @tab_id.setter + def tab_id(self, tab_id): + """Sets the tab_id of this NotarySeal. + + 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 NotarySeal. # noqa: E501 + :type: str + """ + + self._tab_id = tab_id + + @property + def tab_id_metadata(self): + """Gets the tab_id_metadata of this NotarySeal. # noqa: E501 + + + :return: The tab_id_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tab_id_metadata + + @tab_id_metadata.setter + def tab_id_metadata(self, tab_id_metadata): + """Sets the tab_id_metadata of this NotarySeal. + + + :param tab_id_metadata: The tab_id_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._tab_id_metadata = tab_id_metadata + + @property + def tab_label(self): + """Gets the tab_label of this NotarySeal. # noqa: E501 + + The label string associated with the tab. # noqa: E501 + + :return: The tab_label of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._tab_label + + @tab_label.setter + def tab_label(self, tab_label): + """Sets the tab_label of this NotarySeal. + + The label string associated with the tab. # noqa: E501 + + :param tab_label: The tab_label of this NotarySeal. # noqa: E501 + :type: str + """ + + self._tab_label = tab_label + + @property + def tab_label_metadata(self): + """Gets the tab_label_metadata of this NotarySeal. # noqa: E501 + + + :return: The tab_label_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tab_label_metadata + + @tab_label_metadata.setter + def tab_label_metadata(self, tab_label_metadata): + """Sets the tab_label_metadata of this NotarySeal. + + + :param tab_label_metadata: The tab_label_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._tab_label_metadata = tab_label_metadata + + @property + def tab_order(self): + """Gets the tab_order of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The tab_order of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._tab_order + + @tab_order.setter + def tab_order(self, tab_order): + """Sets the tab_order of this NotarySeal. + + # noqa: E501 + + :param tab_order: The tab_order of this NotarySeal. # noqa: E501 + :type: str + """ + + self._tab_order = tab_order + + @property + def tab_order_metadata(self): + """Gets the tab_order_metadata of this NotarySeal. # noqa: E501 + + + :return: The tab_order_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tab_order_metadata + + @tab_order_metadata.setter + def tab_order_metadata(self, tab_order_metadata): + """Sets the tab_order_metadata of this NotarySeal. + + + :param tab_order_metadata: The tab_order_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._tab_order_metadata = tab_order_metadata + + @property + def tab_type(self): + """Gets the tab_type of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The tab_type of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._tab_type + + @tab_type.setter + def tab_type(self, tab_type): + """Sets the tab_type of this NotarySeal. + + # noqa: E501 + + :param tab_type: The tab_type of this NotarySeal. # noqa: E501 + :type: str + """ + + self._tab_type = tab_type + + @property + def tab_type_metadata(self): + """Gets the tab_type_metadata of this NotarySeal. # noqa: E501 + + + :return: The tab_type_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tab_type_metadata + + @tab_type_metadata.setter + def tab_type_metadata(self, tab_type_metadata): + """Sets the tab_type_metadata of this NotarySeal. + + + :param tab_type_metadata: The tab_type_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._tab_type_metadata = tab_type_metadata + + @property + def template_locked(self): + """Gets the template_locked of this NotarySeal. # noqa: E501 + + When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 + + :return: The template_locked of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._template_locked + + @template_locked.setter + def template_locked(self, template_locked): + """Sets the template_locked of this NotarySeal. + + When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 + + :param template_locked: The template_locked of this NotarySeal. # noqa: E501 + :type: str + """ + + self._template_locked = template_locked + + @property + def template_locked_metadata(self): + """Gets the template_locked_metadata of this NotarySeal. # noqa: E501 + + + :return: The template_locked_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._template_locked_metadata + + @template_locked_metadata.setter + def template_locked_metadata(self, template_locked_metadata): + """Sets the template_locked_metadata of this NotarySeal. + + + :param template_locked_metadata: The template_locked_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._template_locked_metadata = template_locked_metadata + + @property + def template_required(self): + """Gets the template_required of this NotarySeal. # noqa: E501 + + When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 + + :return: The template_required of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._template_required + + @template_required.setter + def template_required(self, template_required): + """Sets the template_required of this NotarySeal. + + When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 + + :param template_required: The template_required of this NotarySeal. # noqa: E501 + :type: str + """ + + self._template_required = template_required + + @property + def template_required_metadata(self): + """Gets the template_required_metadata of this NotarySeal. # noqa: E501 + + + :return: The template_required_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._template_required_metadata + + @template_required_metadata.setter + def template_required_metadata(self, template_required_metadata): + """Sets the template_required_metadata of this NotarySeal. + + + :param template_required_metadata: The template_required_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._template_required_metadata = template_required_metadata + + @property + def tooltip(self): + """Gets the tooltip of this NotarySeal. # noqa: E501 + + # noqa: E501 + + :return: The tooltip of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._tooltip + + @tooltip.setter + def tooltip(self, tooltip): + """Sets the tooltip of this NotarySeal. + + # noqa: E501 + + :param tooltip: The tooltip of this NotarySeal. # noqa: E501 + :type: str + """ + + self._tooltip = tooltip + + @property + def tool_tip_metadata(self): + """Gets the tool_tip_metadata of this NotarySeal. # noqa: E501 + + + :return: The tool_tip_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._tool_tip_metadata + + @tool_tip_metadata.setter + def tool_tip_metadata(self, tool_tip_metadata): + """Sets the tool_tip_metadata of this NotarySeal. + + + :param tool_tip_metadata: The tool_tip_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._tool_tip_metadata = tool_tip_metadata + + @property + def underline(self): + """Gets the underline of this NotarySeal. # noqa: E501 + + When set to **true**, the information in the tab is underlined. # noqa: E501 + + :return: The underline of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._underline + + @underline.setter + def underline(self, underline): + """Sets the underline of this NotarySeal. + + When set to **true**, the information in the tab is underlined. # noqa: E501 + + :param underline: The underline of this NotarySeal. # noqa: E501 + :type: str + """ + + self._underline = underline + + @property + def underline_metadata(self): + """Gets the underline_metadata of this NotarySeal. # noqa: E501 + + + :return: The underline_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._underline_metadata + + @underline_metadata.setter + def underline_metadata(self, underline_metadata): + """Sets the underline_metadata of this NotarySeal. + + + :param underline_metadata: The underline_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._underline_metadata = underline_metadata + + @property + def width(self): + """Gets the width of this NotarySeal. # noqa: E501 + + Width of the tab in pixels. # noqa: E501 + + :return: The width of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._width + + @width.setter + def width(self, width): + """Sets the width of this NotarySeal. + + Width of the tab in pixels. # noqa: E501 + + :param width: The width of this NotarySeal. # noqa: E501 + :type: str + """ + + self._width = width + + @property + def width_metadata(self): + """Gets the width_metadata of this NotarySeal. # noqa: E501 + + + :return: The width_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._width_metadata + + @width_metadata.setter + def width_metadata(self, width_metadata): + """Sets the width_metadata of this NotarySeal. + + + :param width_metadata: The width_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._width_metadata = width_metadata + + @property + def x_position(self): + """Gets the x_position of this NotarySeal. # noqa: E501 + + This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 + + :return: The x_position of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._x_position + + @x_position.setter + def x_position(self, x_position): + """Sets the x_position of this NotarySeal. + + This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 + + :param x_position: The x_position of this NotarySeal. # noqa: E501 + :type: str + """ + + self._x_position = x_position + + @property + def x_position_metadata(self): + """Gets the x_position_metadata of this NotarySeal. # noqa: E501 + + + :return: The x_position_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._x_position_metadata + + @x_position_metadata.setter + def x_position_metadata(self, x_position_metadata): + """Sets the x_position_metadata of this NotarySeal. + + + :param x_position_metadata: The x_position_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._x_position_metadata = x_position_metadata + + @property + def y_position(self): + """Gets the y_position of this NotarySeal. # noqa: E501 + + This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 + + :return: The y_position of this NotarySeal. # noqa: E501 + :rtype: str + """ + return self._y_position + + @y_position.setter + def y_position(self, y_position): + """Sets the y_position of this NotarySeal. + + This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 + + :param y_position: The y_position of this NotarySeal. # noqa: E501 + :type: str + """ + + self._y_position = y_position + + @property + def y_position_metadata(self): + """Gets the y_position_metadata of this NotarySeal. # noqa: E501 + + + :return: The y_position_metadata of this NotarySeal. # noqa: E501 + :rtype: PropertyMetadata + """ + return self._y_position_metadata + + @y_position_metadata.setter + def y_position_metadata(self, y_position_metadata): + """Sets the y_position_metadata of this NotarySeal. + + + :param y_position_metadata: The y_position_metadata of this NotarySeal. # noqa: E501 + :type: PropertyMetadata + """ + + self._y_position_metadata = y_position_metadata + + 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(NotarySeal, 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, NotarySeal): + 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/recipients.py b/docusign_esign/models/recipients.py index 6a6a5846..3a1677f4 100644 --- a/docusign_esign/models/recipients.py +++ b/docusign_esign/models/recipients.py @@ -39,6 +39,7 @@ class Recipients(object): 'error_details': 'ErrorDetails', 'in_person_signers': 'list[InPersonSigner]', 'intermediaries': 'list[Intermediary]', + 'notaries': 'list[NotaryRecipient]', 'recipient_count': 'str', 'seals': 'list[SealSign]', 'signers': 'list[Signer]', @@ -54,13 +55,14 @@ class Recipients(object): 'error_details': 'errorDetails', 'in_person_signers': 'inPersonSigners', 'intermediaries': 'intermediaries', + 'notaries': 'notaries', 'recipient_count': 'recipientCount', 'seals': 'seals', 'signers': 'signers', 'witnesses': 'witnesses' } - def __init__(self, agents=None, carbon_copies=None, certified_deliveries=None, current_routing_order=None, editors=None, error_details=None, in_person_signers=None, intermediaries=None, recipient_count=None, seals=None, signers=None, witnesses=None): # noqa: E501 + def __init__(self, agents=None, carbon_copies=None, certified_deliveries=None, current_routing_order=None, editors=None, error_details=None, in_person_signers=None, intermediaries=None, notaries=None, recipient_count=None, seals=None, signers=None, witnesses=None): # noqa: E501 """Recipients - a model defined in Swagger""" # noqa: E501 self._agents = None @@ -71,6 +73,7 @@ def __init__(self, agents=None, carbon_copies=None, certified_deliveries=None, c self._error_details = None self._in_person_signers = None self._intermediaries = None + self._notaries = None self._recipient_count = None self._seals = None self._signers = None @@ -93,6 +96,8 @@ def __init__(self, agents=None, carbon_copies=None, certified_deliveries=None, c self.in_person_signers = in_person_signers if intermediaries is not None: self.intermediaries = intermediaries + if notaries is not None: + self.notaries = notaries if recipient_count is not None: self.recipient_count = recipient_count if seals is not None: @@ -284,6 +289,29 @@ def intermediaries(self, intermediaries): self._intermediaries = intermediaries + @property + def notaries(self): + """Gets the notaries of this Recipients. # noqa: E501 + + # noqa: E501 + + :return: The notaries of this Recipients. # noqa: E501 + :rtype: list[NotaryRecipient] + """ + return self._notaries + + @notaries.setter + def notaries(self, notaries): + """Sets the notaries of this Recipients. + + # noqa: E501 + + :param notaries: The notaries of this Recipients. # noqa: E501 + :type: list[NotaryRecipient] + """ + + self._notaries = notaries + @property def recipient_count(self): """Gets the recipient_count of this Recipients. # noqa: E501 diff --git a/docusign_esign/models/signature_group.py b/docusign_esign/models/signature_group.py new file mode 100644 index 00000000..3370d088 --- /dev/null +++ b/docusign_esign/models/signature_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 SignatureGroup(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_id': 'str', + 'group_name': 'str', + 'rights': 'str' + } + + attribute_map = { + 'group_id': 'groupId', + 'group_name': 'groupName', + 'rights': 'rights' + } + + def __init__(self, group_id=None, group_name=None, rights=None): # noqa: E501 + """SignatureGroup - a model defined in Swagger""" # noqa: E501 + + self._group_id = None + self._group_name = None + self._rights = None + self.discriminator = None + + if group_id is not None: + self.group_id = group_id + if group_name is not None: + self.group_name = group_name + if rights is not None: + self.rights = rights + + @property + def group_id(self): + """Gets the group_id of this SignatureGroup. # noqa: E501 + + # noqa: E501 + + :return: The group_id of this SignatureGroup. # noqa: E501 + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """Sets the group_id of this SignatureGroup. + + # noqa: E501 + + :param group_id: The group_id of this SignatureGroup. # noqa: E501 + :type: str + """ + + self._group_id = group_id + + @property + def group_name(self): + """Gets the group_name of this SignatureGroup. # noqa: E501 + + The name of the group. # noqa: E501 + + :return: The group_name of this SignatureGroup. # noqa: E501 + :rtype: str + """ + return self._group_name + + @group_name.setter + def group_name(self, group_name): + """Sets the group_name of this SignatureGroup. + + The name of the group. # noqa: E501 + + :param group_name: The group_name of this SignatureGroup. # noqa: E501 + :type: str + """ + + self._group_name = group_name + + @property + def rights(self): + """Gets the rights of this SignatureGroup. # noqa: E501 + + # noqa: E501 + + :return: The rights of this SignatureGroup. # noqa: E501 + :rtype: str + """ + return self._rights + + @rights.setter + def rights(self, rights): + """Sets the rights of this SignatureGroup. + + # noqa: E501 + + :param rights: The rights of this SignatureGroup. # noqa: E501 + :type: str + """ + + self._rights = rights + + 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(SignatureGroup, 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, SignatureGroup): + 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/signature_group_def.py b/docusign_esign/models/signature_group_def.py new file mode 100644 index 00000000..749a2acc --- /dev/null +++ b/docusign_esign/models/signature_group_def.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 SignatureGroupDef(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_id': 'str', + 'rights': 'str' + } + + attribute_map = { + 'group_id': 'groupId', + 'rights': 'rights' + } + + def __init__(self, group_id=None, rights=None): # noqa: E501 + """SignatureGroupDef - a model defined in Swagger""" # noqa: E501 + + self._group_id = None + self._rights = None + self.discriminator = None + + if group_id is not None: + self.group_id = group_id + if rights is not None: + self.rights = rights + + @property + def group_id(self): + """Gets the group_id of this SignatureGroupDef. # noqa: E501 + + # noqa: E501 + + :return: The group_id of this SignatureGroupDef. # noqa: E501 + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """Sets the group_id of this SignatureGroupDef. + + # noqa: E501 + + :param group_id: The group_id of this SignatureGroupDef. # noqa: E501 + :type: str + """ + + self._group_id = group_id + + @property + def rights(self): + """Gets the rights of this SignatureGroupDef. # noqa: E501 + + # noqa: E501 + + :return: The rights of this SignatureGroupDef. # noqa: E501 + :rtype: str + """ + return self._rights + + @rights.setter + def rights(self, rights): + """Sets the rights of this SignatureGroupDef. + + # noqa: E501 + + :param rights: The rights of this SignatureGroupDef. # noqa: E501 + :type: str + """ + + self._rights = rights + + 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(SignatureGroupDef, 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, SignatureGroupDef): + 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/signature_user.py b/docusign_esign/models/signature_user.py new file mode 100644 index 00000000..a37ed6db --- /dev/null +++ b/docusign_esign/models/signature_user.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 SignatureUser(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 = { + 'is_default': 'str', + 'rights': 'str', + 'user_id': 'str', + 'user_name': 'str' + } + + attribute_map = { + 'is_default': 'isDefault', + 'rights': 'rights', + 'user_id': 'userId', + 'user_name': 'userName' + } + + def __init__(self, is_default=None, rights=None, user_id=None, user_name=None): # noqa: E501 + """SignatureUser - a model defined in Swagger""" # noqa: E501 + + self._is_default = None + self._rights = None + self._user_id = None + self._user_name = None + self.discriminator = None + + if is_default is not None: + self.is_default = is_default + if rights is not None: + self.rights = rights + if user_id is not None: + self.user_id = user_id + if user_name is not None: + self.user_name = user_name + + @property + def is_default(self): + """Gets the is_default of this SignatureUser. # noqa: E501 + + # noqa: E501 + + :return: The is_default of this SignatureUser. # noqa: E501 + :rtype: str + """ + return self._is_default + + @is_default.setter + def is_default(self, is_default): + """Sets the is_default of this SignatureUser. + + # noqa: E501 + + :param is_default: The is_default of this SignatureUser. # noqa: E501 + :type: str + """ + + self._is_default = is_default + + @property + def rights(self): + """Gets the rights of this SignatureUser. # noqa: E501 + + # noqa: E501 + + :return: The rights of this SignatureUser. # noqa: E501 + :rtype: str + """ + return self._rights + + @rights.setter + def rights(self, rights): + """Sets the rights of this SignatureUser. + + # noqa: E501 + + :param rights: The rights of this SignatureUser. # noqa: E501 + :type: str + """ + + self._rights = rights + + @property + def user_id(self): + """Gets the user_id of this SignatureUser. # noqa: E501 + + # noqa: E501 + + :return: The user_id of this SignatureUser. # noqa: E501 + :rtype: str + """ + return self._user_id + + @user_id.setter + def user_id(self, user_id): + """Sets the user_id of this SignatureUser. + + # noqa: E501 + + :param user_id: The user_id of this SignatureUser. # noqa: E501 + :type: str + """ + + self._user_id = user_id + + @property + def user_name(self): + """Gets the user_name of this SignatureUser. # noqa: E501 + + # noqa: E501 + + :return: The user_name of this SignatureUser. # noqa: E501 + :rtype: str + """ + return self._user_name + + @user_name.setter + def user_name(self, user_name): + """Sets the user_name of this SignatureUser. + + # noqa: E501 + + :param user_name: The user_name of this SignatureUser. # noqa: E501 + :type: str + """ + + self._user_name = user_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(SignatureUser, 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, SignatureUser): + 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/signature_user_def.py b/docusign_esign/models/signature_user_def.py new file mode 100644 index 00000000..aec5fcd6 --- /dev/null +++ b/docusign_esign/models/signature_user_def.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 SignatureUserDef(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 = { + 'is_default': 'str', + 'rights': 'str', + 'user_id': 'str' + } + + attribute_map = { + 'is_default': 'isDefault', + 'rights': 'rights', + 'user_id': 'userId' + } + + def __init__(self, is_default=None, rights=None, user_id=None): # noqa: E501 + """SignatureUserDef - a model defined in Swagger""" # noqa: E501 + + self._is_default = None + self._rights = None + self._user_id = None + self.discriminator = None + + if is_default is not None: + self.is_default = is_default + if rights is not None: + self.rights = rights + if user_id is not None: + self.user_id = user_id + + @property + def is_default(self): + """Gets the is_default of this SignatureUserDef. # noqa: E501 + + # noqa: E501 + + :return: The is_default of this SignatureUserDef. # noqa: E501 + :rtype: str + """ + return self._is_default + + @is_default.setter + def is_default(self, is_default): + """Sets the is_default of this SignatureUserDef. + + # noqa: E501 + + :param is_default: The is_default of this SignatureUserDef. # noqa: E501 + :type: str + """ + + self._is_default = is_default + + @property + def rights(self): + """Gets the rights of this SignatureUserDef. # noqa: E501 + + # noqa: E501 + + :return: The rights of this SignatureUserDef. # noqa: E501 + :rtype: str + """ + return self._rights + + @rights.setter + def rights(self, rights): + """Sets the rights of this SignatureUserDef. + + # noqa: E501 + + :param rights: The rights of this SignatureUserDef. # noqa: E501 + :type: str + """ + + self._rights = rights + + @property + def user_id(self): + """Gets the user_id of this SignatureUserDef. # noqa: E501 + + # noqa: E501 + + :return: The user_id of this SignatureUserDef. # noqa: E501 + :rtype: str + """ + return self._user_id + + @user_id.setter + def user_id(self, user_id): + """Sets the user_id of this SignatureUserDef. + + # noqa: E501 + + :param user_id: The user_id of this SignatureUserDef. # noqa: E501 + :type: str + """ + + self._user_id = user_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(SignatureUserDef, 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, SignatureUserDef): + 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/signer.py b/docusign_esign/models/signer.py index 992ccac2..a1c524b6 100644 --- a/docusign_esign/models/signer.py +++ b/docusign_esign/models/signer.py @@ -80,6 +80,7 @@ class Signer(object): 'locked_recipient_sms_editable': 'str', 'name': 'str', 'name_metadata': 'PropertyMetadata', + 'notary_id': 'str', 'note': 'str', 'note_metadata': 'PropertyMetadata', 'offline_attributes': 'OfflineAttributes', @@ -173,6 +174,7 @@ class Signer(object): 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 'name': 'name', 'name_metadata': 'nameMetadata', + 'notary_id': 'notaryId', 'note': 'note', 'note_metadata': 'noteMetadata', 'offline_attributes': 'offlineAttributes', @@ -216,7 +218,7 @@ class Signer(object): 'user_id': 'userId' } - def __init__(self, access_code=None, access_code_metadata=None, add_access_code_to_email=None, additional_notifications=None, additional_notifications_metadata=None, agent_can_edit_email=None, agent_can_edit_name=None, allow_system_override_for_locked_recipient=None, auto_navigation=None, bulk_recipients_uri=None, can_sign_offline=None, client_user_id=None, completed_count=None, creation_reason=None, custom_fields=None, declined_date_time=None, declined_reason=None, default_recipient=None, delivered_date_time=None, delivery_method=None, delivery_method_metadata=None, designator_id=None, designator_id_guid=None, document_visibility=None, email=None, email_metadata=None, email_notification=None, embedded_recipient_start_url=None, error_details=None, excluded_documents=None, fax_number=None, fax_number_metadata=None, first_name=None, first_name_metadata=None, full_name=None, full_name_metadata=None, id_check_configuration_name=None, id_check_configuration_name_metadata=None, id_check_information_input=None, identity_verification=None, inherit_email_notification_configuration=None, is_bulk_recipient=None, is_bulk_recipient_metadata=None, last_name=None, last_name_metadata=None, locked_recipient_phone_auth_editable=None, locked_recipient_sms_editable=None, name=None, name_metadata=None, note=None, note_metadata=None, offline_attributes=None, phone_authentication=None, proof_file=None, recipient_attachments=None, recipient_authentication_status=None, recipient_feature_metadata=None, recipient_id=None, recipient_id_guid=None, recipient_signature_providers=None, recipient_supplies_tabs=None, recipient_type=None, recipient_type_metadata=None, require_id_lookup=None, require_id_lookup_metadata=None, require_signer_certificate=None, require_sign_on_paper=None, require_upload_signature=None, role_name=None, routing_order=None, routing_order_metadata=None, sent_date_time=None, signature_info=None, signed_date_time=None, sign_in_each_location=None, sign_in_each_location_metadata=None, signing_group_id=None, signing_group_id_metadata=None, signing_group_name=None, signing_group_users=None, sms_authentication=None, social_authentications=None, status=None, status_code=None, suppress_emails=None, tabs=None, template_locked=None, template_required=None, total_tab_count=None, user_id=None): # noqa: E501 + def __init__(self, access_code=None, access_code_metadata=None, add_access_code_to_email=None, additional_notifications=None, additional_notifications_metadata=None, agent_can_edit_email=None, agent_can_edit_name=None, allow_system_override_for_locked_recipient=None, auto_navigation=None, bulk_recipients_uri=None, can_sign_offline=None, client_user_id=None, completed_count=None, creation_reason=None, custom_fields=None, declined_date_time=None, declined_reason=None, default_recipient=None, delivered_date_time=None, delivery_method=None, delivery_method_metadata=None, designator_id=None, designator_id_guid=None, document_visibility=None, email=None, email_metadata=None, email_notification=None, embedded_recipient_start_url=None, error_details=None, excluded_documents=None, fax_number=None, fax_number_metadata=None, first_name=None, first_name_metadata=None, full_name=None, full_name_metadata=None, id_check_configuration_name=None, id_check_configuration_name_metadata=None, id_check_information_input=None, identity_verification=None, inherit_email_notification_configuration=None, is_bulk_recipient=None, is_bulk_recipient_metadata=None, last_name=None, last_name_metadata=None, locked_recipient_phone_auth_editable=None, locked_recipient_sms_editable=None, name=None, name_metadata=None, notary_id=None, note=None, note_metadata=None, offline_attributes=None, phone_authentication=None, proof_file=None, recipient_attachments=None, recipient_authentication_status=None, recipient_feature_metadata=None, recipient_id=None, recipient_id_guid=None, recipient_signature_providers=None, recipient_supplies_tabs=None, recipient_type=None, recipient_type_metadata=None, require_id_lookup=None, require_id_lookup_metadata=None, require_signer_certificate=None, require_sign_on_paper=None, require_upload_signature=None, role_name=None, routing_order=None, routing_order_metadata=None, sent_date_time=None, signature_info=None, signed_date_time=None, sign_in_each_location=None, sign_in_each_location_metadata=None, signing_group_id=None, signing_group_id_metadata=None, signing_group_name=None, signing_group_users=None, sms_authentication=None, social_authentications=None, status=None, status_code=None, suppress_emails=None, tabs=None, template_locked=None, template_required=None, total_tab_count=None, user_id=None): # noqa: E501 """Signer - a model defined in Swagger""" # noqa: E501 self._access_code = None @@ -268,6 +270,7 @@ def __init__(self, access_code=None, access_code_metadata=None, add_access_code_ self._locked_recipient_sms_editable = None self._name = None self._name_metadata = None + self._notary_id = None self._note = None self._note_metadata = None self._offline_attributes = None @@ -409,6 +412,8 @@ def __init__(self, access_code=None, access_code_metadata=None, add_access_code_ self.name = name if name_metadata is not None: self.name_metadata = name_metadata + if notary_id is not None: + self.notary_id = notary_id if note is not None: self.note = note if note_metadata is not None: @@ -1589,6 +1594,29 @@ def name_metadata(self, name_metadata): self._name_metadata = name_metadata + @property + def notary_id(self): + """Gets the notary_id of this Signer. # noqa: E501 + + # noqa: E501 + + :return: The notary_id of this Signer. # noqa: E501 + :rtype: str + """ + return self._notary_id + + @notary_id.setter + def notary_id(self, notary_id): + """Sets the notary_id of this Signer. + + # noqa: E501 + + :param notary_id: The notary_id of this Signer. # noqa: E501 + :type: str + """ + + self._notary_id = notary_id + @property def note(self): """Gets the note of this Signer. # noqa: E501 diff --git a/docusign_esign/models/tabs.py b/docusign_esign/models/tabs.py index 22a7d994..963a6900 100644 --- a/docusign_esign/models/tabs.py +++ b/docusign_esign/models/tabs.py @@ -49,6 +49,8 @@ class Tabs(object): 'last_name_tabs': 'list[LastName]', 'list_tabs': 'list[List]', 'notarize_tabs': 'list[Notarize]', + 'notary_certificate_tabs': 'list[NotaryCertificate]', + 'notary_seal_tabs': 'list[NotarySeal]', 'note_tabs': 'list[Note]', 'number_tabs': 'list[Number]', 'poly_line_overlay_tabs': 'list[PolyLineOverlay]', @@ -83,6 +85,8 @@ class Tabs(object): 'last_name_tabs': 'lastNameTabs', 'list_tabs': 'listTabs', 'notarize_tabs': 'notarizeTabs', + 'notary_certificate_tabs': 'notaryCertificateTabs', + 'notary_seal_tabs': 'notarySealTabs', 'note_tabs': 'noteTabs', 'number_tabs': 'numberTabs', 'poly_line_overlay_tabs': 'polyLineOverlayTabs', @@ -98,7 +102,7 @@ class Tabs(object): 'zip_tabs': 'zipTabs' } - def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=None, company_tabs=None, date_signed_tabs=None, date_tabs=None, decline_tabs=None, draw_tabs=None, email_address_tabs=None, email_tabs=None, envelope_id_tabs=None, first_name_tabs=None, formula_tabs=None, full_name_tabs=None, initial_here_tabs=None, last_name_tabs=None, list_tabs=None, notarize_tabs=None, note_tabs=None, number_tabs=None, poly_line_overlay_tabs=None, radio_group_tabs=None, signer_attachment_tabs=None, sign_here_tabs=None, smart_section_tabs=None, ssn_tabs=None, tab_groups=None, text_tabs=None, title_tabs=None, view_tabs=None, zip_tabs=None): # noqa: E501 + def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=None, company_tabs=None, date_signed_tabs=None, date_tabs=None, decline_tabs=None, draw_tabs=None, email_address_tabs=None, email_tabs=None, envelope_id_tabs=None, first_name_tabs=None, formula_tabs=None, full_name_tabs=None, initial_here_tabs=None, last_name_tabs=None, list_tabs=None, notarize_tabs=None, notary_certificate_tabs=None, notary_seal_tabs=None, note_tabs=None, number_tabs=None, poly_line_overlay_tabs=None, radio_group_tabs=None, signer_attachment_tabs=None, sign_here_tabs=None, smart_section_tabs=None, ssn_tabs=None, tab_groups=None, text_tabs=None, title_tabs=None, view_tabs=None, zip_tabs=None): # noqa: E501 """Tabs - a model defined in Swagger""" # noqa: E501 self._approve_tabs = None @@ -119,6 +123,8 @@ def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=No self._last_name_tabs = None self._list_tabs = None self._notarize_tabs = None + self._notary_certificate_tabs = None + self._notary_seal_tabs = None self._note_tabs = None self._number_tabs = None self._poly_line_overlay_tabs = None @@ -170,6 +176,10 @@ def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=No self.list_tabs = list_tabs if notarize_tabs is not None: self.notarize_tabs = notarize_tabs + if notary_certificate_tabs is not None: + self.notary_certificate_tabs = notary_certificate_tabs + if notary_seal_tabs is not None: + self.notary_seal_tabs = notary_seal_tabs if note_tabs is not None: self.note_tabs = note_tabs if number_tabs is not None: @@ -611,6 +621,52 @@ def notarize_tabs(self, notarize_tabs): self._notarize_tabs = notarize_tabs + @property + def notary_certificate_tabs(self): + """Gets the notary_certificate_tabs of this Tabs. # noqa: E501 + + # noqa: E501 + + :return: The notary_certificate_tabs of this Tabs. # noqa: E501 + :rtype: list[NotaryCertificate] + """ + return self._notary_certificate_tabs + + @notary_certificate_tabs.setter + def notary_certificate_tabs(self, notary_certificate_tabs): + """Sets the notary_certificate_tabs of this Tabs. + + # noqa: E501 + + :param notary_certificate_tabs: The notary_certificate_tabs of this Tabs. # noqa: E501 + :type: list[NotaryCertificate] + """ + + self._notary_certificate_tabs = notary_certificate_tabs + + @property + def notary_seal_tabs(self): + """Gets the notary_seal_tabs of this Tabs. # noqa: E501 + + # noqa: E501 + + :return: The notary_seal_tabs of this Tabs. # noqa: E501 + :rtype: list[NotarySeal] + """ + return self._notary_seal_tabs + + @notary_seal_tabs.setter + def notary_seal_tabs(self, notary_seal_tabs): + """Sets the notary_seal_tabs of this Tabs. + + # noqa: E501 + + :param notary_seal_tabs: The notary_seal_tabs of this Tabs. # noqa: E501 + :type: list[NotarySeal] + """ + + self._notary_seal_tabs = notary_seal_tabs + @property def note_tabs(self): """Gets the note_tabs of this Tabs. # noqa: E501 diff --git a/docusign_esign/models/template_recipients.py b/docusign_esign/models/template_recipients.py index f1bdf7d0..f9efa936 100644 --- a/docusign_esign/models/template_recipients.py +++ b/docusign_esign/models/template_recipients.py @@ -39,6 +39,7 @@ class TemplateRecipients(object): 'error_details': 'ErrorDetails', 'in_person_signers': 'list[InPersonSigner]', 'intermediaries': 'list[Intermediary]', + 'notaries': 'list[NotaryRecipient]', 'recipient_count': 'str', 'seals': 'list[SealSign]', 'signers': 'list[Signer]', @@ -54,13 +55,14 @@ class TemplateRecipients(object): 'error_details': 'errorDetails', 'in_person_signers': 'inPersonSigners', 'intermediaries': 'intermediaries', + 'notaries': 'notaries', 'recipient_count': 'recipientCount', 'seals': 'seals', 'signers': 'signers', 'witnesses': 'witnesses' } - def __init__(self, agents=None, carbon_copies=None, certified_deliveries=None, current_routing_order=None, editors=None, error_details=None, in_person_signers=None, intermediaries=None, recipient_count=None, seals=None, signers=None, witnesses=None): # noqa: E501 + def __init__(self, agents=None, carbon_copies=None, certified_deliveries=None, current_routing_order=None, editors=None, error_details=None, in_person_signers=None, intermediaries=None, notaries=None, recipient_count=None, seals=None, signers=None, witnesses=None): # noqa: E501 """TemplateRecipients - a model defined in Swagger""" # noqa: E501 self._agents = None @@ -71,6 +73,7 @@ def __init__(self, agents=None, carbon_copies=None, certified_deliveries=None, c self._error_details = None self._in_person_signers = None self._intermediaries = None + self._notaries = None self._recipient_count = None self._seals = None self._signers = None @@ -93,6 +96,8 @@ def __init__(self, agents=None, carbon_copies=None, certified_deliveries=None, c self.in_person_signers = in_person_signers if intermediaries is not None: self.intermediaries = intermediaries + if notaries is not None: + self.notaries = notaries if recipient_count is not None: self.recipient_count = recipient_count if seals is not None: @@ -284,6 +289,29 @@ def intermediaries(self, intermediaries): self._intermediaries = intermediaries + @property + def notaries(self): + """Gets the notaries of this TemplateRecipients. # noqa: E501 + + # noqa: E501 + + :return: The notaries of this TemplateRecipients. # noqa: E501 + :rtype: list[NotaryRecipient] + """ + return self._notaries + + @notaries.setter + def notaries(self, notaries): + """Sets the notaries of this TemplateRecipients. + + # noqa: E501 + + :param notaries: The notaries of this TemplateRecipients. # noqa: E501 + :type: list[NotaryRecipient] + """ + + self._notaries = notaries + @property def recipient_count(self): """Gets the recipient_count of this TemplateRecipients. # noqa: E501 diff --git a/docusign_esign/models/template_tabs.py b/docusign_esign/models/template_tabs.py index e7457c51..074d9f46 100644 --- a/docusign_esign/models/template_tabs.py +++ b/docusign_esign/models/template_tabs.py @@ -49,6 +49,8 @@ class TemplateTabs(object): 'last_name_tabs': 'list[LastName]', 'list_tabs': 'list[List]', 'notarize_tabs': 'list[Notarize]', + 'notary_certificate_tabs': 'list[NotaryCertificate]', + 'notary_seal_tabs': 'list[NotarySeal]', 'note_tabs': 'list[Note]', 'number_tabs': 'list[Number]', 'poly_line_overlay_tabs': 'list[PolyLineOverlay]', @@ -83,6 +85,8 @@ class TemplateTabs(object): 'last_name_tabs': 'lastNameTabs', 'list_tabs': 'listTabs', 'notarize_tabs': 'notarizeTabs', + 'notary_certificate_tabs': 'notaryCertificateTabs', + 'notary_seal_tabs': 'notarySealTabs', 'note_tabs': 'noteTabs', 'number_tabs': 'numberTabs', 'poly_line_overlay_tabs': 'polyLineOverlayTabs', @@ -98,7 +102,7 @@ class TemplateTabs(object): 'zip_tabs': 'zipTabs' } - def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=None, company_tabs=None, date_signed_tabs=None, date_tabs=None, decline_tabs=None, draw_tabs=None, email_address_tabs=None, email_tabs=None, envelope_id_tabs=None, first_name_tabs=None, formula_tabs=None, full_name_tabs=None, initial_here_tabs=None, last_name_tabs=None, list_tabs=None, notarize_tabs=None, note_tabs=None, number_tabs=None, poly_line_overlay_tabs=None, radio_group_tabs=None, signer_attachment_tabs=None, sign_here_tabs=None, smart_section_tabs=None, ssn_tabs=None, tab_groups=None, text_tabs=None, title_tabs=None, view_tabs=None, zip_tabs=None): # noqa: E501 + def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=None, company_tabs=None, date_signed_tabs=None, date_tabs=None, decline_tabs=None, draw_tabs=None, email_address_tabs=None, email_tabs=None, envelope_id_tabs=None, first_name_tabs=None, formula_tabs=None, full_name_tabs=None, initial_here_tabs=None, last_name_tabs=None, list_tabs=None, notarize_tabs=None, notary_certificate_tabs=None, notary_seal_tabs=None, note_tabs=None, number_tabs=None, poly_line_overlay_tabs=None, radio_group_tabs=None, signer_attachment_tabs=None, sign_here_tabs=None, smart_section_tabs=None, ssn_tabs=None, tab_groups=None, text_tabs=None, title_tabs=None, view_tabs=None, zip_tabs=None): # noqa: E501 """TemplateTabs - a model defined in Swagger""" # noqa: E501 self._approve_tabs = None @@ -119,6 +123,8 @@ def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=No self._last_name_tabs = None self._list_tabs = None self._notarize_tabs = None + self._notary_certificate_tabs = None + self._notary_seal_tabs = None self._note_tabs = None self._number_tabs = None self._poly_line_overlay_tabs = None @@ -170,6 +176,10 @@ def __init__(self, approve_tabs=None, checkbox_tabs=None, comment_thread_tabs=No self.list_tabs = list_tabs if notarize_tabs is not None: self.notarize_tabs = notarize_tabs + if notary_certificate_tabs is not None: + self.notary_certificate_tabs = notary_certificate_tabs + if notary_seal_tabs is not None: + self.notary_seal_tabs = notary_seal_tabs if note_tabs is not None: self.note_tabs = note_tabs if number_tabs is not None: @@ -611,6 +621,52 @@ def notarize_tabs(self, notarize_tabs): self._notarize_tabs = notarize_tabs + @property + def notary_certificate_tabs(self): + """Gets the notary_certificate_tabs of this TemplateTabs. # noqa: E501 + + # noqa: E501 + + :return: The notary_certificate_tabs of this TemplateTabs. # noqa: E501 + :rtype: list[NotaryCertificate] + """ + return self._notary_certificate_tabs + + @notary_certificate_tabs.setter + def notary_certificate_tabs(self, notary_certificate_tabs): + """Sets the notary_certificate_tabs of this TemplateTabs. + + # noqa: E501 + + :param notary_certificate_tabs: The notary_certificate_tabs of this TemplateTabs. # noqa: E501 + :type: list[NotaryCertificate] + """ + + self._notary_certificate_tabs = notary_certificate_tabs + + @property + def notary_seal_tabs(self): + """Gets the notary_seal_tabs of this TemplateTabs. # noqa: E501 + + # noqa: E501 + + :return: The notary_seal_tabs of this TemplateTabs. # noqa: E501 + :rtype: list[NotarySeal] + """ + return self._notary_seal_tabs + + @notary_seal_tabs.setter + def notary_seal_tabs(self, notary_seal_tabs): + """Sets the notary_seal_tabs of this TemplateTabs. + + # noqa: E501 + + :param notary_seal_tabs: The notary_seal_tabs of this TemplateTabs. # noqa: E501 + :type: list[NotarySeal] + """ + + self._notary_seal_tabs = notary_seal_tabs + @property def note_tabs(self): """Gets the note_tabs of this TemplateTabs. # noqa: E501 diff --git a/docusign_esign/models/user_account_management_granular_information.py b/docusign_esign/models/user_account_management_granular_information.py index 33cf3bf2..becd7565 100644 --- a/docusign_esign/models/user_account_management_granular_information.py +++ b/docusign_esign/models/user_account_management_granular_information.py @@ -37,6 +37,8 @@ class UserAccountManagementGranularInformation(object): 'can_manage_account_settings_metadata': 'SettingsMetadata', 'can_manage_admins': 'str', 'can_manage_admins_metadata': 'SettingsMetadata', + 'can_manage_envelope_transfer': 'str', + 'can_manage_envelope_transfer_metadata': 'SettingsMetadata', 'can_manage_reporting': 'str', 'can_manage_reporting_metadata': 'SettingsMetadata', 'can_manage_sharing': 'str', @@ -55,6 +57,8 @@ class UserAccountManagementGranularInformation(object): 'can_manage_account_settings_metadata': 'canManageAccountSettingsMetadata', 'can_manage_admins': 'canManageAdmins', 'can_manage_admins_metadata': 'canManageAdminsMetadata', + 'can_manage_envelope_transfer': 'canManageEnvelopeTransfer', + 'can_manage_envelope_transfer_metadata': 'canManageEnvelopeTransferMetadata', 'can_manage_reporting': 'canManageReporting', 'can_manage_reporting_metadata': 'canManageReportingMetadata', 'can_manage_sharing': 'canManageSharing', @@ -66,7 +70,7 @@ class UserAccountManagementGranularInformation(object): 'can_view_users': 'canViewUsers' } - def __init__(self, can_manage_account_security_settings=None, can_manage_account_security_settings_metadata=None, can_manage_account_settings=None, can_manage_account_settings_metadata=None, can_manage_admins=None, can_manage_admins_metadata=None, can_manage_reporting=None, can_manage_reporting_metadata=None, can_manage_sharing=None, can_manage_sharing_metadata=None, can_manage_signing_groups=None, can_manage_signing_groups_metadata=None, can_manage_users=None, can_manage_users_metadata=None, can_view_users=None): # noqa: E501 + def __init__(self, can_manage_account_security_settings=None, can_manage_account_security_settings_metadata=None, can_manage_account_settings=None, can_manage_account_settings_metadata=None, can_manage_admins=None, can_manage_admins_metadata=None, can_manage_envelope_transfer=None, can_manage_envelope_transfer_metadata=None, can_manage_reporting=None, can_manage_reporting_metadata=None, can_manage_sharing=None, can_manage_sharing_metadata=None, can_manage_signing_groups=None, can_manage_signing_groups_metadata=None, can_manage_users=None, can_manage_users_metadata=None, can_view_users=None): # noqa: E501 """UserAccountManagementGranularInformation - a model defined in Swagger""" # noqa: E501 self._can_manage_account_security_settings = None @@ -75,6 +79,8 @@ def __init__(self, can_manage_account_security_settings=None, can_manage_account self._can_manage_account_settings_metadata = None self._can_manage_admins = None self._can_manage_admins_metadata = None + self._can_manage_envelope_transfer = None + self._can_manage_envelope_transfer_metadata = None self._can_manage_reporting = None self._can_manage_reporting_metadata = None self._can_manage_sharing = None @@ -98,6 +104,10 @@ def __init__(self, can_manage_account_security_settings=None, can_manage_account self.can_manage_admins = can_manage_admins if can_manage_admins_metadata is not None: self.can_manage_admins_metadata = can_manage_admins_metadata + if can_manage_envelope_transfer is not None: + self.can_manage_envelope_transfer = can_manage_envelope_transfer + if can_manage_envelope_transfer_metadata is not None: + self.can_manage_envelope_transfer_metadata = can_manage_envelope_transfer_metadata if can_manage_reporting is not None: self.can_manage_reporting = can_manage_reporting if can_manage_reporting_metadata is not None: @@ -249,6 +259,50 @@ def can_manage_admins_metadata(self, can_manage_admins_metadata): self._can_manage_admins_metadata = can_manage_admins_metadata + @property + def can_manage_envelope_transfer(self): + """Gets the can_manage_envelope_transfer of this UserAccountManagementGranularInformation. # noqa: E501 + + # noqa: E501 + + :return: The can_manage_envelope_transfer of this UserAccountManagementGranularInformation. # noqa: E501 + :rtype: str + """ + return self._can_manage_envelope_transfer + + @can_manage_envelope_transfer.setter + def can_manage_envelope_transfer(self, can_manage_envelope_transfer): + """Sets the can_manage_envelope_transfer of this UserAccountManagementGranularInformation. + + # noqa: E501 + + :param can_manage_envelope_transfer: The can_manage_envelope_transfer of this UserAccountManagementGranularInformation. # noqa: E501 + :type: str + """ + + self._can_manage_envelope_transfer = can_manage_envelope_transfer + + @property + def can_manage_envelope_transfer_metadata(self): + """Gets the can_manage_envelope_transfer_metadata of this UserAccountManagementGranularInformation. # noqa: E501 + + + :return: The can_manage_envelope_transfer_metadata of this UserAccountManagementGranularInformation. # noqa: E501 + :rtype: SettingsMetadata + """ + return self._can_manage_envelope_transfer_metadata + + @can_manage_envelope_transfer_metadata.setter + def can_manage_envelope_transfer_metadata(self, can_manage_envelope_transfer_metadata): + """Sets the can_manage_envelope_transfer_metadata of this UserAccountManagementGranularInformation. + + + :param can_manage_envelope_transfer_metadata: The can_manage_envelope_transfer_metadata of this UserAccountManagementGranularInformation. # noqa: E501 + :type: SettingsMetadata + """ + + self._can_manage_envelope_transfer_metadata = can_manage_envelope_transfer_metadata + @property def can_manage_reporting(self): """Gets the can_manage_reporting of this UserAccountManagementGranularInformation. # noqa: E501 diff --git a/docusign_esign/models/witness.py b/docusign_esign/models/witness.py index b104db52..5bef59f5 100644 --- a/docusign_esign/models/witness.py +++ b/docusign_esign/models/witness.py @@ -80,6 +80,7 @@ class Witness(object): 'locked_recipient_sms_editable': 'str', 'name': 'str', 'name_metadata': 'PropertyMetadata', + 'notary_id': 'str', 'note': 'str', 'note_metadata': 'PropertyMetadata', 'offline_attributes': 'OfflineAttributes', @@ -175,6 +176,7 @@ class Witness(object): 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 'name': 'name', 'name_metadata': 'nameMetadata', + 'notary_id': 'notaryId', 'note': 'note', 'note_metadata': 'noteMetadata', 'offline_attributes': 'offlineAttributes', @@ -220,7 +222,7 @@ class Witness(object): 'witness_for_guid': 'witnessForGuid' } - def __init__(self, access_code=None, access_code_metadata=None, add_access_code_to_email=None, additional_notifications=None, additional_notifications_metadata=None, agent_can_edit_email=None, agent_can_edit_name=None, allow_system_override_for_locked_recipient=None, auto_navigation=None, bulk_recipients_uri=None, can_sign_offline=None, client_user_id=None, completed_count=None, creation_reason=None, custom_fields=None, declined_date_time=None, declined_reason=None, default_recipient=None, delivered_date_time=None, delivery_method=None, delivery_method_metadata=None, designator_id=None, designator_id_guid=None, document_visibility=None, email=None, email_metadata=None, email_notification=None, embedded_recipient_start_url=None, error_details=None, excluded_documents=None, fax_number=None, fax_number_metadata=None, first_name=None, first_name_metadata=None, full_name=None, full_name_metadata=None, id_check_configuration_name=None, id_check_configuration_name_metadata=None, id_check_information_input=None, identity_verification=None, inherit_email_notification_configuration=None, is_bulk_recipient=None, is_bulk_recipient_metadata=None, last_name=None, last_name_metadata=None, locked_recipient_phone_auth_editable=None, locked_recipient_sms_editable=None, name=None, name_metadata=None, note=None, note_metadata=None, offline_attributes=None, phone_authentication=None, proof_file=None, recipient_attachments=None, recipient_authentication_status=None, recipient_feature_metadata=None, recipient_id=None, recipient_id_guid=None, recipient_signature_providers=None, recipient_supplies_tabs=None, recipient_type=None, recipient_type_metadata=None, require_id_lookup=None, require_id_lookup_metadata=None, require_signer_certificate=None, require_sign_on_paper=None, require_upload_signature=None, role_name=None, routing_order=None, routing_order_metadata=None, sent_date_time=None, signature_info=None, signed_date_time=None, sign_in_each_location=None, sign_in_each_location_metadata=None, signing_group_id=None, signing_group_id_metadata=None, signing_group_name=None, signing_group_users=None, sms_authentication=None, social_authentications=None, status=None, status_code=None, suppress_emails=None, tabs=None, template_locked=None, template_required=None, total_tab_count=None, user_id=None, witness_for=None, witness_for_guid=None): # noqa: E501 + def __init__(self, access_code=None, access_code_metadata=None, add_access_code_to_email=None, additional_notifications=None, additional_notifications_metadata=None, agent_can_edit_email=None, agent_can_edit_name=None, allow_system_override_for_locked_recipient=None, auto_navigation=None, bulk_recipients_uri=None, can_sign_offline=None, client_user_id=None, completed_count=None, creation_reason=None, custom_fields=None, declined_date_time=None, declined_reason=None, default_recipient=None, delivered_date_time=None, delivery_method=None, delivery_method_metadata=None, designator_id=None, designator_id_guid=None, document_visibility=None, email=None, email_metadata=None, email_notification=None, embedded_recipient_start_url=None, error_details=None, excluded_documents=None, fax_number=None, fax_number_metadata=None, first_name=None, first_name_metadata=None, full_name=None, full_name_metadata=None, id_check_configuration_name=None, id_check_configuration_name_metadata=None, id_check_information_input=None, identity_verification=None, inherit_email_notification_configuration=None, is_bulk_recipient=None, is_bulk_recipient_metadata=None, last_name=None, last_name_metadata=None, locked_recipient_phone_auth_editable=None, locked_recipient_sms_editable=None, name=None, name_metadata=None, notary_id=None, note=None, note_metadata=None, offline_attributes=None, phone_authentication=None, proof_file=None, recipient_attachments=None, recipient_authentication_status=None, recipient_feature_metadata=None, recipient_id=None, recipient_id_guid=None, recipient_signature_providers=None, recipient_supplies_tabs=None, recipient_type=None, recipient_type_metadata=None, require_id_lookup=None, require_id_lookup_metadata=None, require_signer_certificate=None, require_sign_on_paper=None, require_upload_signature=None, role_name=None, routing_order=None, routing_order_metadata=None, sent_date_time=None, signature_info=None, signed_date_time=None, sign_in_each_location=None, sign_in_each_location_metadata=None, signing_group_id=None, signing_group_id_metadata=None, signing_group_name=None, signing_group_users=None, sms_authentication=None, social_authentications=None, status=None, status_code=None, suppress_emails=None, tabs=None, template_locked=None, template_required=None, total_tab_count=None, user_id=None, witness_for=None, witness_for_guid=None): # noqa: E501 """Witness - a model defined in Swagger""" # noqa: E501 self._access_code = None @@ -272,6 +274,7 @@ def __init__(self, access_code=None, access_code_metadata=None, add_access_code_ self._locked_recipient_sms_editable = None self._name = None self._name_metadata = None + self._notary_id = None self._note = None self._note_metadata = None self._offline_attributes = None @@ -415,6 +418,8 @@ def __init__(self, access_code=None, access_code_metadata=None, add_access_code_ self.name = name if name_metadata is not None: self.name_metadata = name_metadata + if notary_id is not None: + self.notary_id = notary_id if note is not None: self.note = note if note_metadata is not None: @@ -1599,6 +1604,29 @@ def name_metadata(self, name_metadata): self._name_metadata = name_metadata + @property + def notary_id(self): + """Gets the notary_id of this Witness. # noqa: E501 + + # noqa: E501 + + :return: The notary_id of this Witness. # noqa: E501 + :rtype: str + """ + return self._notary_id + + @notary_id.setter + def notary_id(self, notary_id): + """Sets the notary_id of this Witness. + + # noqa: E501 + + :param notary_id: The notary_id of this Witness. # noqa: E501 + :type: str + """ + + self._notary_id = notary_id + @property def note(self): """Gets the note of this Witness. # noqa: E501 diff --git a/setup.py b/setup.py index 9b794dd7..32c983b3 100644 --- a/setup.py +++ b/setup.py @@ -10,11 +10,10 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from setuptools import setup, find_packages, Command, os # noqa: H301 NAME = "docusign-esign" -VERSION = "3.5.0" +VERSION = "3.6.0rc1" # To install the library, run the following # # python setup.py install