class DocuSign_eSign::AccountsApi
Attributes
Public Class Methods
# File lib/docusign_esign/api/accounts_api.rb, line 278 def initialize(api_client = AccountsApi.default) @api_client = api_client end
Public Instance Methods
Creates new accounts. Creates new DocuSign service accounts. This is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a [Accounts:create](accounts_create) call with the information included within a `newAccountRequests` element. A maximum of 100 new accounts can be created at one time. Note
that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a `newAccountDefinition` property inside the `newAccountRequests` element. Response The response returns the new account ID, password and the default user information for each newly created account. A 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an `errorDetails` node is added in the response to each specific request that failed. @param new_account_definition (optional parameter) @param DocuSign_eSign::CreateOptions
Options for modifying the behavior of the function. @return [NewAccountSummary]
# File lib/docusign_esign/api/accounts_api.rb, line 287 def create(new_account_definition, options = DocuSign_eSign::CreateOptions.default) data, _status_code, _headers = create_with_http_info( new_account_definition, options) return data end
Adds/updates one or more account signatures. This request may include images in multi-part format.
@param account_id The external account number (int) or account ID Guid. @param account_signatures_information (optional parameter) @param DocuSign_eSign::CreateAccountSignaturesOptions
Options for modifying the behavior of the function. @return [AccountSignaturesInformation]
# File lib/docusign_esign/api/accounts_api.rb, line 338 def create_account_signatures(account_id, account_signatures_information, options = DocuSign_eSign::CreateAccountSignaturesOptions.default) data, _status_code, _headers = create_account_signatures_with_http_info(account_id, account_signatures_information, options) return data end
Adds/updates one or more account signatures. This request may include images in multi-part format.
@param account_id The external account number (int) or account ID Guid. @param account_signatures_information (optional parameter) @param DocuSign_eSign::CreateAccountSignaturesOptions
Options for modifying the behavior of the function. @return [Array<(AccountSignaturesInformation
, Fixnum, Hash)>] AccountSignaturesInformation
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 349 def create_account_signatures_with_http_info(account_id, account_signatures_information, options = DocuSign_eSign::CreateAccountSignaturesOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.create_account_signatures ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_account_signatures" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signatures".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'decode_only'] = options.decode_only if !options.decode_only.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(account_signatures_information) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountSignaturesInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#create_account_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Creates one or more brand profile files for the account. Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`. @param account_id The external account number (int) or account ID GUID. @param brand (optional parameter) @return [BrandsResponse]
# File lib/docusign_esign/api/accounts_api.rb, line 391 def create_brand(account_id, brand) data, _status_code, _headers = create_brand_with_http_info(account_id, brand) return data end
Creates one or more brand profile files for the account. Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`. @param account_id The external account number (int) or account ID GUID. @param brand (optional parameter) @return [Array<(BrandsResponse
, Fixnum, Hash)>] BrandsResponse
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 401 def create_brand_with_http_info(account_id, brand) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.create_brand ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_brand" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(brand) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'BrandsResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#create_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Creates an acount custom field.
@param account_id The external account number (int) or account ID Guid. @param custom_field (optional parameter) @param DocuSign_eSign::CreateCustomFieldOptions
Options for modifying the behavior of the function. @return [CustomFields]
# File lib/docusign_esign/api/accounts_api.rb, line 443 def create_custom_field(account_id, custom_field, options = DocuSign_eSign::CreateCustomFieldOptions.default) data, _status_code, _headers = create_custom_field_with_http_info(account_id, custom_field, options) return data end
Creates an acount custom field.
@param account_id The external account number (int) or account ID Guid. @param custom_field (optional parameter) @param DocuSign_eSign::CreateCustomFieldOptions
Options for modifying the behavior of the function. @return [Array<(CustomFields
, Fixnum, Hash)>] CustomFields
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 454 def create_custom_field_with_http_info(account_id, custom_field, options = DocuSign_eSign::CreateCustomFieldOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.create_custom_field ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_custom_field" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'apply_to_templates'] = options.apply_to_templates if !options.apply_to_templates.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(custom_field) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CustomFields') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#create_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Creates a new permission profile in the specified account.
@param account_id The external account number (int) or account ID Guid. @param permission_profile (optional parameter) @param DocuSign_eSign::CreatePermissionProfileOptions
Options for modifying the behavior of the function. @return [PermissionProfile]
# File lib/docusign_esign/api/accounts_api.rb, line 497 def create_permission_profile(account_id, permission_profile, options = DocuSign_eSign::CreatePermissionProfileOptions.default) data, _status_code, _headers = create_permission_profile_with_http_info(account_id, permission_profile, options) return data end
Creates a new permission profile in the specified account.
@param account_id The external account number (int) or account ID Guid. @param permission_profile (optional parameter) @param DocuSign_eSign::CreatePermissionProfileOptions
Options for modifying the behavior of the function. @return [Array<(PermissionProfile
, Fixnum, Hash)>] PermissionProfile
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 508 def create_permission_profile_with_http_info(account_id, permission_profile, options = DocuSign_eSign::CreatePermissionProfileOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.create_permission_profile ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_permission_profile" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/permission_profiles".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'include'] = options.include if !options.include.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(permission_profile) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PermissionProfile') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#create_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Creates a customized report
@param account_id The external account number (int) or account ID Guid. @param report_in_product_run_request (optional parameter) @return [ReportInProductSaveResponse]
# File lib/docusign_esign/api/accounts_api.rb, line 550 def create_report_in_product_create(account_id, report_in_product_run_request) data, _status_code, _headers = create_report_in_product_create_with_http_info(account_id, report_in_product_run_request) return data end
Creates a customized report
@param account_id The external account number (int) or account ID Guid. @param report_in_product_run_request (optional parameter) @return [Array<(ReportInProductSaveResponse
, Fixnum, Hash)>] ReportInProductSaveResponse
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 560 def create_report_in_product_create_with_http_info(account_id, report_in_product_run_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.create_report_in_product_create ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_report_in_product_create" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/reports".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(report_in_product_run_request) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportInProductSaveResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#create_report_in_product_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Creates new accounts. Creates new DocuSign service accounts. This is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a [Accounts:create](accounts_create) call with the information included within a `newAccountRequests` element. A maximum of 100 new accounts can be created at one time. Note
that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a `newAccountDefinition` property inside the `newAccountRequests` element. Response The response returns the new account ID, password and the default user information for each newly created account. A 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an `errorDetails` node is added in the response to each specific request that failed. @param new_account_definition (optional parameter) @param DocuSign_eSign::CreateOptions
Options for modifying the behavior of the function. @return [Array<(NewAccountSummary
, Fixnum, Hash)>] NewAccountSummary
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 297 def create_with_http_info(new_account_definition, options = DocuSign_eSign::CreateOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.create ..." end # resource path local_var_path = "/v2.1/accounts".sub('{format}','json') # query parameters query_params = {} query_params[:'preview_billing_plan'] = options.preview_billing_plan if !options.preview_billing_plan.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(new_account_definition) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'NewAccountSummary') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Deletes the specified account. This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign. @param account_id The external account number (int) or account ID Guid. @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 600 def delete(account_id) delete_with_http_info(account_id) return nil end
Close the specified signature by Id.
@param account_id The external account number (int) or account ID Guid. @param signature_id The ID of the signature being accessed. @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 649 def delete_account_signature(account_id, signature_id) delete_account_signature_with_http_info(account_id, signature_id) return nil end
Deletes a signature, initials, or stamps image.
@param account_id The external account number (int) or account ID Guid. @param image_type One of signature_image or initials_image. @param signature_id The ID of the signature being accessed. @return [AccountSignature]
# File lib/docusign_esign/api/accounts_api.rb, line 702 def delete_account_signature_image(account_id, image_type, signature_id) data, _status_code, _headers = delete_account_signature_image_with_http_info(account_id, image_type, signature_id) return data end
Deletes a signature, initials, or stamps image.
@param account_id The external account number (int) or account ID Guid. @param image_type One of signature_image or initials_image. @param signature_id The ID of the signature being accessed. @return [Array<(AccountSignature
, Fixnum, Hash)>] AccountSignature
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 713 def delete_account_signature_image_with_http_info(account_id, image_type, signature_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.delete_account_signature_image ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_account_signature_image" if account_id.nil? # verify the required parameter 'image_type' is set fail ArgumentError, "Missing the required parameter 'image_type' when calling AccountsApi.delete_account_signature_image" if image_type.nil? # verify the required parameter 'signature_id' is set fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.delete_account_signature_image" if signature_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountSignature') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_account_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Close the specified signature by Id.
@param account_id The external account number (int) or account ID Guid. @param signature_id The ID of the signature being accessed. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 659 def delete_account_signature_with_http_info(account_id, signature_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.delete_account_signature ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_account_signature" if account_id.nil? # verify the required parameter 'signature_id' is set fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.delete_account_signature" if signature_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_account_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Removes a brand.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 758 def delete_brand(account_id, brand_id) delete_brand_with_http_info(account_id, brand_id) return nil end
Delete one branding logo.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @param logo_type One of Primary, Secondary or Email. @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 811 def delete_brand_logo_by_type(account_id, brand_id, logo_type) delete_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type) return nil end
Delete one branding logo.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @param logo_type One of Primary, Secondary or Email. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 822 def delete_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.delete_brand_logo_by_type ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_brand_logo_by_type" if account_id.nil? # verify the required parameter 'brand_id' is set fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.delete_brand_logo_by_type" if brand_id.nil? # verify the required parameter 'logo_type' is set fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.delete_brand_logo_by_type" if logo_type.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_brand_logo_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Removes a brand.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 768 def delete_brand_with_http_info(account_id, brand_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.delete_brand ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_brand" if account_id.nil? # verify the required parameter 'brand_id' is set fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.delete_brand" if brand_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param account_id The external account number (int) or account ID Guid. @param brands_request (optional parameter) @return [BrandsResponse]
# File lib/docusign_esign/api/accounts_api.rb, line 866 def delete_brands(account_id, brands_request) data, _status_code, _headers = delete_brands_with_http_info(account_id, brands_request) return data end
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. @param account_id The external account number (int) or account ID Guid. @param brands_request (optional parameter) @return [Array<(BrandsResponse
, Fixnum, Hash)>] BrandsResponse
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 876 def delete_brands_with_http_info(account_id, brands_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.delete_brands ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_brands" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(brands_request) auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'BrandsResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param account_id The external account number (int) or account ID Guid. @param recipient_part @param captive_recipient_information (optional parameter) @return [CaptiveRecipientInformation]
# File lib/docusign_esign/api/accounts_api.rb, line 918 def delete_captive_recipient(account_id, recipient_part, captive_recipient_information) data, _status_code, _headers = delete_captive_recipient_with_http_info(account_id, recipient_part, captive_recipient_information) return data end
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. @param account_id The external account number (int) or account ID Guid. @param recipient_part @param captive_recipient_information (optional parameter) @return [Array<(CaptiveRecipientInformation
, Fixnum, Hash)>] CaptiveRecipientInformation
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 929 def delete_captive_recipient_with_http_info(account_id, recipient_part, captive_recipient_information) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.delete_captive_recipient ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_captive_recipient" if account_id.nil? # verify the required parameter 'recipient_part' is set fail ArgumentError, "Missing the required parameter 'recipient_part' when calling AccountsApi.delete_captive_recipient" if recipient_part.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientPart' + '}', recipient_part.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(captive_recipient_information) auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CaptiveRecipientInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_captive_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete an existing account custom field.
@param account_id The external account number (int) or account ID Guid. @param custom_field_id @param DocuSign_eSign::DeleteCustomFieldOptions
Options for modifying the behavior of the function. @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 973 def delete_custom_field(account_id, custom_field_id, options = DocuSign_eSign::DeleteCustomFieldOptions.default) delete_custom_field_with_http_info(account_id, custom_field_id, options) return nil end
Delete an existing account custom field.
@param account_id The external account number (int) or account ID Guid. @param custom_field_id @param DocuSign_eSign::DeleteCustomFieldOptions
Options for modifying the behavior of the function. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 984 def delete_custom_field_with_http_info(account_id, custom_field_id, options = DocuSign_eSign::DeleteCustomFieldOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.delete_custom_field ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_custom_field" if account_id.nil? # verify the required parameter 'custom_field_id' is set fail ArgumentError, "Missing the required parameter 'custom_field_id' when calling AccountsApi.delete_custom_field" if custom_field_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/custom_fields/{customFieldId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'customFieldId' + '}', custom_field_id.to_s) # query parameters query_params = {} query_params[:'apply_to_templates'] = options.apply_to_templates if !options.apply_to_templates.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Deletes configuration information for the eNote eOriginal integration.
@param account_id The external account number (int) or account ID Guid. @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 1026 def delete_e_note_configuration(account_id) delete_e_note_configuration_with_http_info(account_id) return nil end
Deletes configuration information for the eNote eOriginal integration.
@param account_id The external account number (int) or account ID Guid. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1035 def delete_e_note_configuration_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.delete_e_note_configuration ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_e_note_configuration" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_e_note_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Deletes a permissions profile within the specified account.
@param account_id The external account number (int) or account ID Guid. @param permission_profile_id @param DocuSign_eSign::DeletePermissionProfileOptions
Options for modifying the behavior of the function. @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 1076 def delete_permission_profile(account_id, permission_profile_id, options = DocuSign_eSign::DeletePermissionProfileOptions.default) delete_permission_profile_with_http_info(account_id, permission_profile_id, options) return nil end
Deletes a permissions profile within the specified account.
@param account_id The external account number (int) or account ID Guid. @param permission_profile_id @param DocuSign_eSign::DeletePermissionProfileOptions
Options for modifying the behavior of the function. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1087 def delete_permission_profile_with_http_info(account_id, permission_profile_id, options = DocuSign_eSign::DeletePermissionProfileOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.delete_permission_profile ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_permission_profile" if account_id.nil? # verify the required parameter 'permission_profile_id' is set fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.delete_permission_profile" if permission_profile_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s) # query parameters query_params = {} query_params[:'move_users_to'] = options.move_users_to if !options.move_users_to.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Removes a customized report
@param account_id The external account number (int) or account ID Guid. @param id @return [ReportInProductSaveResponse]
# File lib/docusign_esign/api/accounts_api.rb, line 1130 def delete_report_in_product(account_id, id) data, _status_code, _headers = delete_report_in_product_with_http_info(account_id, id) return data end
Removes a customized report
@param account_id The external account number (int) or account ID Guid. @param id @return [Array<(ReportInProductSaveResponse
, Fixnum, Hash)>] ReportInProductSaveResponse
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1140 def delete_report_in_product_with_http_info(account_id, id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.delete_report_in_product ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_report_in_product" if account_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.delete_report_in_product" if id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/reports/{id}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportInProductSaveResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_report_in_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Deletes the specified account. This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign. @param account_id The external account number (int) or account ID Guid. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 609 def delete_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.delete ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get the list of identity verification options for an account
@param account_id The external account number (int) or account ID Guid. @return [AccountIdentityVerificationResponse]
# File lib/docusign_esign/api/accounts_api.rb, line 1182 def get_account_identity_verification(account_id) data, _status_code, _headers = get_account_identity_verification_with_http_info(account_id) return data end
Get the list of identity verification options for an account
@param account_id The external account number (int) or account ID Guid. @return [Array<(AccountIdentityVerificationResponse
, Fixnum, Hash)>] AccountIdentityVerificationResponse
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1191 def get_account_identity_verification_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_account_identity_verification ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_identity_verification" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/identity_verification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountIdentityVerificationResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_account_identity_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::GetAccountInformationOptions
Options for modifying the behavior of the function. @return [AccountInformation]
# File lib/docusign_esign/api/accounts_api.rb, line 1232 def get_account_information(account_id, options = DocuSign_eSign::GetAccountInformationOptions.default) data, _status_code, _headers = get_account_information_with_http_info(account_id, options) return data end
Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::GetAccountInformationOptions
Options for modifying the behavior of the function. @return [Array<(AccountInformation
, Fixnum, Hash)>] AccountInformation
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1242 def get_account_information_with_http_info(account_id, options = DocuSign_eSign::GetAccountInformationOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_account_information ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_information" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'include_account_settings'] = options.include_account_settings if !options.include_account_settings.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_account_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns information about a single signature by specifed signatureId.
@param account_id The external account number (int) or account ID Guid. @param signature_id The ID of the signature being accessed. @return [AccountSignature]
# File lib/docusign_esign/api/accounts_api.rb, line 1284 def get_account_signature(account_id, signature_id) data, _status_code, _headers = get_account_signature_with_http_info(account_id, signature_id) return data end
Returns a signature, initials, or stamps image.
@param account_id The external account number (int) or account ID Guid. @param image_type One of signature_image or initials_image. @param signature_id The ID of the signature being accessed. @param DocuSign_eSign::GetAccountSignatureImageOptions
Options for modifying the behavior of the function. @return [File]
# File lib/docusign_esign/api/accounts_api.rb, line 1339 def get_account_signature_image(account_id, image_type, signature_id, options = DocuSign_eSign::GetAccountSignatureImageOptions.default) data, _status_code, _headers = get_account_signature_image_with_http_info(account_id, image_type, signature_id, options) return data end
Returns a signature, initials, or stamps image.
@param account_id The external account number (int) or account ID Guid. @param image_type One of signature_image or initials_image. @param signature_id The ID of the signature being accessed. @param DocuSign_eSign::GetAccountSignatureImageOptions
Options for modifying the behavior of the function. @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1351 def get_account_signature_image_with_http_info(account_id, image_type, signature_id, options = DocuSign_eSign::GetAccountSignatureImageOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_account_signature_image ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_signature_image" if account_id.nil? # verify the required parameter 'image_type' is set fail ArgumentError, "Missing the required parameter 'image_type' when calling AccountsApi.get_account_signature_image" if image_type.nil? # verify the required parameter 'signature_id' is set fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.get_account_signature_image" if signature_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s) # query parameters query_params = {} query_params[:'include_chrome'] = options.include_chrome if !options.include_chrome.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['image/gif']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'File') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_account_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns information about a single signature by specifed signatureId.
@param account_id The external account number (int) or account ID Guid. @param signature_id The ID of the signature being accessed. @return [Array<(AccountSignature
, Fixnum, Hash)>] AccountSignature
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1294 def get_account_signature_with_http_info(account_id, signature_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_account_signature ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_signature" if account_id.nil? # verify the required parameter 'signature_id' is set fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.get_account_signature" if signature_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountSignature') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_account_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns the managed signature definitions for the account
@param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::GetAccountSignaturesOptions
Options for modifying the behavior of the function. @return [AccountSignaturesInformation]
# File lib/docusign_esign/api/accounts_api.rb, line 1397 def get_account_signatures(account_id, options = DocuSign_eSign::GetAccountSignaturesOptions.default) data, _status_code, _headers = get_account_signatures_with_http_info(account_id, options) return data end
Returns the managed signature definitions for the account
@param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::GetAccountSignaturesOptions
Options for modifying the behavior of the function. @return [Array<(AccountSignaturesInformation
, Fixnum, Hash)>] AccountSignaturesInformation
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1407 def get_account_signatures_with_http_info(account_id, options = DocuSign_eSign::GetAccountSignaturesOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_account_signatures ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_signatures" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signatures".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'stamp_format'] = options.stamp_format if !options.stamp_format.nil? query_params[:'stamp_name'] = options.stamp_name if !options.stamp_name.nil? query_params[:'stamp_type'] = options.stamp_type if !options.stamp_type.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountSignaturesInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_account_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns tab settings list for specified account
@param account_id The external account number (int) or account ID Guid. @return [TabAccountSettings]
# File lib/docusign_esign/api/accounts_api.rb, line 1450 def get_account_tab_settings(account_id) data, _status_code, _headers = get_account_tab_settings_with_http_info(account_id) return data end
Returns tab settings list for specified account
@param account_id The external account number (int) or account ID Guid. @return [Array<(TabAccountSettings
, Fixnum, Hash)>] TabAccountSettings
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1459 def get_account_tab_settings_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_account_tab_settings ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_tab_settings" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'TabAccountSettings') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_account_tab_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all payment gateway account for the provided accountId
@param account_id The external account number (int) or account ID Guid. @return [PaymentGatewayAccountsInfo]
# File lib/docusign_esign/api/accounts_api.rb, line 1499 def get_all_payment_gateway_accounts(account_id) data, _status_code, _headers = get_all_payment_gateway_accounts_with_http_info(account_id) return data end
Get all payment gateway account for the provided accountId
@param account_id The external account number (int) or account ID Guid. @return [Array<(PaymentGatewayAccountsInfo
, Fixnum, Hash)>] PaymentGatewayAccountsInfo
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1508 def get_all_payment_gateway_accounts_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_all_payment_gateway_accounts ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_all_payment_gateway_accounts" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/payment_gateway_accounts".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PaymentGatewayAccountsInfo') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_all_payment_gateway_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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 @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::GetBillingChargesOptions
Options for modifying the behavior of the function. @return [BillingChargeResponse]
# File lib/docusign_esign/api/accounts_api.rb, line 1549 def get_billing_charges(account_id, options = DocuSign_eSign::GetBillingChargesOptions.default) data, _status_code, _headers = get_billing_charges_with_http_info(account_id, options) return data end
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 @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::GetBillingChargesOptions
Options for modifying the behavior of the function. @return [Array<(BillingChargeResponse
, Fixnum, Hash)>] BillingChargeResponse
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1559 def get_billing_charges_with_http_info(account_id, options = DocuSign_eSign::GetBillingChargesOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_billing_charges ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_billing_charges" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/billing_charges".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'include_charges'] = options.include_charges if !options.include_charges.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'BillingChargeResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_billing_charges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get information for a specific brand.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @param DocuSign_eSign::GetBrandOptions
Options for modifying the behavior of the function. @return [Brand]
# File lib/docusign_esign/api/accounts_api.rb, line 1602 def get_brand(account_id, brand_id, options = DocuSign_eSign::GetBrandOptions.default) data, _status_code, _headers = get_brand_with_http_info(account_id, brand_id, options) return data end
Export a specific brand.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 1658 def get_brand_export_file(account_id, brand_id) get_brand_export_file_with_http_info(account_id, brand_id) return nil end
Export a specific brand.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1668 def get_brand_export_file_with_http_info(account_id, brand_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_brand_export_file ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_export_file" if account_id.nil? # verify the required parameter 'brand_id' is set fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_export_file" if brand_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/file".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_brand_export_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Obtains the specified image for a brand.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @param logo_type One of Primary, Secondary or Email. @return [File]
# File lib/docusign_esign/api/accounts_api.rb, line 1711 def get_brand_logo_by_type(account_id, brand_id, logo_type) data, _status_code, _headers = get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type) return data end
Obtains the specified image for a brand.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @param logo_type One of Primary, Secondary or Email. @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1722 def get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_brand_logo_by_type ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_logo_by_type" if account_id.nil? # verify the required parameter 'brand_id' is set fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_logo_by_type" if brand_id.nil? # verify the required parameter 'logo_type' is set fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.get_brand_logo_by_type" if logo_type.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['image/png']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'File') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_brand_logo_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns the specified account's list of branding resources (metadata).
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @return [BrandResourcesList]
# File lib/docusign_esign/api/accounts_api.rb, line 1767 def get_brand_resources(account_id, brand_id) data, _status_code, _headers = get_brand_resources_with_http_info(account_id, brand_id) return data end
Returns the specified branding resource file.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @param resource_content_type @param DocuSign_eSign::GetBrandResourcesByContentTypeOptions
Options for modifying the behavior of the function. @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 1822 def get_brand_resources_by_content_type(account_id, brand_id, resource_content_type, options = DocuSign_eSign::GetBrandResourcesByContentTypeOptions.default) get_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type, options) return nil end
Returns the specified branding resource file.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @param resource_content_type @param DocuSign_eSign::GetBrandResourcesByContentTypeOptions
Options for modifying the behavior of the function. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1834 def get_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type, options = DocuSign_eSign::GetBrandResourcesByContentTypeOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_brand_resources_by_content_type ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_resources_by_content_type" if account_id.nil? # verify the required parameter 'brand_id' is set fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_resources_by_content_type" if brand_id.nil? # verify the required parameter 'resource_content_type' is set fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.get_brand_resources_by_content_type" if resource_content_type.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s) # query parameters query_params = {} query_params[:'langcode'] = options.langcode if !options.langcode.nil? query_params[:'return_master'] = options.return_master if !options.return_master.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_brand_resources_by_content_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns the specified account's list of branding resources (metadata).
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @return [Array<(BrandResourcesList
, Fixnum, Hash)>] BrandResourcesList
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1777 def get_brand_resources_with_http_info(account_id, brand_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_brand_resources ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_resources" if account_id.nil? # verify the required parameter 'brand_id' is set fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_resources" if brand_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/resources".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'BrandResourcesList') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_brand_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get information for a specific brand.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @param DocuSign_eSign::GetBrandOptions
Options for modifying the behavior of the function. @return [Array<(Brand
, Fixnum, Hash)>] Brand
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1613 def get_brand_with_http_info(account_id, brand_id, options = DocuSign_eSign::GetBrandOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_brand ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand" if account_id.nil? # verify the required parameter 'brand_id' is set fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand" if brand_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s) # query parameters query_params = {} query_params[:'include_external_references'] = options.include_external_references if !options.include_external_references.nil? query_params[:'include_logos'] = options.include_logos if !options.include_logos.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Brand') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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.
@param account_id The external account number (int) or account ID Guid. @param 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. @return [ConsumerDisclosure]
# File lib/docusign_esign/api/accounts_api.rb, line 1880 def get_consumer_disclosure(account_id, lang_code) data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code) return data end
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. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::GetConsumerDisclosureDefaultOptions
Options for modifying the behavior of the function. @return [ConsumerDisclosure]
# File lib/docusign_esign/api/accounts_api.rb, line 1933 def get_consumer_disclosure_default(account_id, options = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default) data, _status_code, _headers = get_consumer_disclosure_default_with_http_info(account_id, options) return data end
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. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::GetConsumerDisclosureDefaultOptions
Options for modifying the behavior of the function. @return [Array<(ConsumerDisclosure
, Fixnum, Hash)>] ConsumerDisclosure
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1943 def get_consumer_disclosure_default_with_http_info(account_id, options = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_consumer_disclosure_default ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_consumer_disclosure_default" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/consumer_disclosure".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'langCode'] = options.lang_code if !options.lang_code.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConsumerDisclosure') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_consumer_disclosure_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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.
@param account_id The external account number (int) or account ID Guid. @param 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. @return [Array<(ConsumerDisclosure
, Fixnum, Hash)>] ConsumerDisclosure
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1890 def get_consumer_disclosure_with_http_info(account_id, lang_code) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_consumer_disclosure ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_consumer_disclosure" if account_id.nil? # verify the required parameter 'lang_code' is set fail ArgumentError, "Missing the required parameter 'lang_code' when calling AccountsApi.get_consumer_disclosure" if lang_code.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'langCode' + '}', lang_code.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConsumerDisclosure') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_consumer_disclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns the configuration information for the eNote eOriginal integration.
@param account_id The external account number (int) or account ID Guid. @return [ENoteConfiguration]
# File lib/docusign_esign/api/accounts_api.rb, line 1984 def get_e_note_configuration(account_id) data, _status_code, _headers = get_e_note_configuration_with_http_info(account_id) return data end
Returns the configuration information for the eNote eOriginal integration.
@param account_id The external account number (int) or account ID Guid. @return [Array<(ENoteConfiguration
, Fixnum, Hash)>] ENoteConfiguration
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 1993 def get_e_note_configuration_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_e_note_configuration ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_e_note_configuration" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ENoteConfiguration') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_e_note_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Select envelope purge configuration.
@param account_id The external account number (int) or account ID Guid. @return [EnvelopePurgeConfiguration]
# File lib/docusign_esign/api/accounts_api.rb, line 2033 def get_envelope_purge_configuration(account_id) data, _status_code, _headers = get_envelope_purge_configuration_with_http_info(account_id) return data end
Select envelope purge configuration.
@param account_id The external account number (int) or account ID Guid. @return [Array<(EnvelopePurgeConfiguration
, Fixnum, Hash)>] EnvelopePurgeConfiguration
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2042 def get_envelope_purge_configuration_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_envelope_purge_configuration ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_envelope_purge_configuration" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings/envelope_purge_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'EnvelopePurgeConfiguration') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_envelope_purge_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves the list of favorited templates for this caller
@param account_id The external account number (int) or account ID Guid. @return [FavoriteTemplatesInfo]
# File lib/docusign_esign/api/accounts_api.rb, line 2082 def get_favorite_templates(account_id) data, _status_code, _headers = get_favorite_templates_with_http_info(account_id) return data end
Retrieves the list of favorited templates for this caller
@param account_id The external account number (int) or account ID Guid. @return [Array<(FavoriteTemplatesInfo
, Fixnum, Hash)>] FavoriteTemplatesInfo
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2091 def get_favorite_templates_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_favorite_templates ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_favorite_templates" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/favorite_templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'FavoriteTemplatesInfo') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_favorite_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns default user level settings for a specified account
@param account_id The external account number (int) or account ID Guid. @return [NotificationDefaults]
# File lib/docusign_esign/api/accounts_api.rb, line 2131 def get_notification_defaults(account_id) data, _status_code, _headers = get_notification_defaults_with_http_info(account_id) return data end
Returns default user level settings for a specified account
@param account_id The external account number (int) or account ID Guid. @return [Array<(NotificationDefaults
, Fixnum, Hash)>] NotificationDefaults
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2140 def get_notification_defaults_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_notification_defaults ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_notification_defaults" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings/notification_defaults".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'NotificationDefaults') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_notification_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get the password rules
@param account_id The external account number (int) or account ID Guid. @return [AccountPasswordRules]
# File lib/docusign_esign/api/accounts_api.rb, line 2180 def get_password_rules(account_id) data, _status_code, _headers = get_password_rules_with_http_info(account_id) return data end
Get membership account password rules
@return [UserPasswordRules]
# File lib/docusign_esign/api/accounts_api.rb, line 2228 def get_password_rules_0() data, _status_code, _headers = get_password_rules_0_with_http_info() return data end
Get membership account password rules
@return [Array<(UserPasswordRules
, Fixnum, Hash)>] UserPasswordRules
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2236 def get_password_rules_0_with_http_info() if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_password_rules_0 ..." end # resource path local_var_path = "/v2.1/current_user/password_rules".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserPasswordRules') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_password_rules_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get the password rules
@param account_id The external account number (int) or account ID Guid. @return [Array<(AccountPasswordRules
, Fixnum, Hash)>] AccountPasswordRules
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2189 def get_password_rules_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_password_rules ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_password_rules" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings/password_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountPasswordRules') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_password_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns a permissions profile in the specified account.
@param account_id The external account number (int) or account ID Guid. @param permission_profile_id @param DocuSign_eSign::GetPermissionProfileOptions
Options for modifying the behavior of the function. @return [PermissionProfile]
# File lib/docusign_esign/api/accounts_api.rb, line 2276 def get_permission_profile(account_id, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default) data, _status_code, _headers = get_permission_profile_with_http_info(account_id, permission_profile_id, options) return data end
Returns a permissions profile in the specified account.
@param account_id The external account number (int) or account ID Guid. @param permission_profile_id @param DocuSign_eSign::GetPermissionProfileOptions
Options for modifying the behavior of the function. @return [Array<(PermissionProfile
, Fixnum, Hash)>] PermissionProfile
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2287 def get_permission_profile_with_http_info(account_id, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_permission_profile ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_permission_profile" if account_id.nil? # verify the required parameter 'permission_profile_id' is set fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.get_permission_profile" if permission_profile_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s) # query parameters query_params = {} query_params[:'include'] = options.include if !options.include.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PermissionProfile') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account. @return [ProvisioningInformation]
# File lib/docusign_esign/api/accounts_api.rb, line 2329 def get_provisioning() data, _status_code, _headers = get_provisioning_with_http_info() return data end
Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account. @return [Array<(ProvisioningInformation
, Fixnum, Hash)>] ProvisioningInformation
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2337 def get_provisioning_with_http_info() if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_provisioning ..." end # resource path local_var_path = "/v2.1/accounts/provisioning".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ProvisioningInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_provisioning\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets the specified report
@param account_id The external account number (int) or account ID Guid. @param id @return [ReportInProductGet]
# File lib/docusign_esign/api/accounts_api.rb, line 2376 def get_report_in_product(account_id, id) data, _status_code, _headers = get_report_in_product_with_http_info(account_id, id) return data end
Gets the descriptors for all of an account's active reports (for listings)
@param account_id The external account number (int) or account ID Guid. @return [ReportInProductList]
# File lib/docusign_esign/api/accounts_api.rb, line 2428 def get_report_in_product_list(account_id) data, _status_code, _headers = get_report_in_product_list_with_http_info(account_id) return data end
Gets the descriptors for all of an account's active reports (for listings)
@param account_id The external account number (int) or account ID Guid. @return [Array<(ReportInProductList
, Fixnum, Hash)>] ReportInProductList
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2437 def get_report_in_product_list_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_report_in_product_list ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_report_in_product_list" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/reports".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportInProductList') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_report_in_product_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets the specified report
@param account_id The external account number (int) or account ID Guid. @param id @return [Array<(ReportInProductGet
, Fixnum, Hash)>] ReportInProductGet
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2386 def get_report_in_product_with_http_info(account_id, id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_report_in_product ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_report_in_product" if account_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.get_report_in_product" if id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/reports/{id}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportInProductGet') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_report_in_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets list of supported languages for recipient language setting.
@param account_id The external account number (int) or account ID Guid. @return [SupportedLanguages]
# File lib/docusign_esign/api/accounts_api.rb, line 2477 def get_supported_languages(account_id) data, _status_code, _headers = get_supported_languages_with_http_info(account_id) return data end
Gets list of supported languages for recipient language setting.
@param account_id The external account number (int) or account ID Guid. @return [Array<(SupportedLanguages
, Fixnum, Hash)>] SupportedLanguages
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2486 def get_supported_languages_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_supported_languages ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_supported_languages" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/supported_languages".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SupportedLanguages') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_supported_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get watermark information.
@param account_id The external account number (int) or account ID Guid. @return [Watermark]
# File lib/docusign_esign/api/accounts_api.rb, line 2526 def get_watermark(account_id) data, _status_code, _headers = get_watermark_with_http_info(account_id) return data end
Get watermark preview.
@param account_id The external account number (int) or account ID Guid. @param watermark (optional parameter) @return [Watermark]
# File lib/docusign_esign/api/accounts_api.rb, line 2576 def get_watermark_preview(account_id, watermark) data, _status_code, _headers = get_watermark_preview_with_http_info(account_id, watermark) return data end
Get watermark preview.
@param account_id The external account number (int) or account ID Guid. @param watermark (optional parameter) @return [Array<(Watermark
, Fixnum, Hash)>] Watermark
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2586 def get_watermark_preview_with_http_info(account_id, watermark) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_watermark_preview ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_watermark_preview" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/watermark/preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(watermark) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Watermark') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_watermark_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get watermark information.
@param account_id The external account number (int) or account ID Guid. @return [Array<(Watermark
, Fixnum, Hash)>] Watermark
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2535 def get_watermark_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.get_watermark ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_watermark" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/watermark".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Watermark') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_watermark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::ListBrandsOptions
Options for modifying the behavior of the function. @return [BrandsResponse]
# File lib/docusign_esign/api/accounts_api.rb, line 2627 def list_brands(account_id, options = DocuSign_eSign::ListBrandsOptions.default) data, _status_code, _headers = list_brands_with_http_info(account_id, options) return data end
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. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::ListBrandsOptions
Options for modifying the behavior of the function. @return [Array<(BrandsResponse
, Fixnum, Hash)>] BrandsResponse
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2637 def list_brands_with_http_info(account_id, options = DocuSign_eSign::ListBrandsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.list_brands ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_brands" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'exclude_distributor_brand'] = options.exclude_distributor_brand if !options.exclude_distributor_brand.nil? query_params[:'include_logos'] = options.include_logos if !options.include_logos.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'BrandsResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#list_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param account_id The external account number (int) or account ID Guid. @return [CustomFields]
# File lib/docusign_esign/api/accounts_api.rb, line 2679 def list_custom_fields(account_id) data, _status_code, _headers = list_custom_fields_with_http_info(account_id) return data end
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. @param account_id The external account number (int) or account ID Guid. @return [Array<(CustomFields
, Fixnum, Hash)>] CustomFields
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2688 def list_custom_fields_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.list_custom_fields ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_custom_fields" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CustomFields') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#list_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::ListPermissionsOptions
Options for modifying the behavior of the function. @return [PermissionProfileInformation]
# File lib/docusign_esign/api/accounts_api.rb, line 2729 def list_permissions(account_id, options = DocuSign_eSign::ListPermissionsOptions.default) data, _status_code, _headers = list_permissions_with_http_info(account_id, options) return data end
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. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::ListPermissionsOptions
Options for modifying the behavior of the function. @return [Array<(PermissionProfileInformation
, Fixnum, Hash)>] PermissionProfileInformation
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2739 def list_permissions_with_http_info(account_id, options = DocuSign_eSign::ListPermissionsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.list_permissions ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_permissions" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/permission_profiles".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'include'] = options.include if !options.include.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PermissionProfileInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#list_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::ListRecipientNamesByEmailOptions
Options for modifying the behavior of the function. @return [RecipientNamesResponse]
# File lib/docusign_esign/api/accounts_api.rb, line 2781 def list_recipient_names_by_email(account_id, options = DocuSign_eSign::ListRecipientNamesByEmailOptions.default) data, _status_code, _headers = list_recipient_names_by_email_with_http_info(account_id, options) return data end
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. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::ListRecipientNamesByEmailOptions
Options for modifying the behavior of the function. @return [Array<(RecipientNamesResponse
, Fixnum, Hash)>] RecipientNamesResponse
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2791 def list_recipient_names_by_email_with_http_info(account_id, options = DocuSign_eSign::ListRecipientNamesByEmailOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.list_recipient_names_by_email ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_recipient_names_by_email" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/recipient_names".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'email'] = options.email if !options.email.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RecipientNamesResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#list_recipient_names_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets account settings information. Retrieves the account settings information for the specified account. @param account_id The external account number (int) or account ID Guid. @return [AccountSettingsInformation]
# File lib/docusign_esign/api/accounts_api.rb, line 2832 def list_settings(account_id) data, _status_code, _headers = list_settings_with_http_info(account_id) return data end
Gets account settings information. Retrieves the account settings information for the specified account. @param account_id The external account number (int) or account ID Guid. @return [Array<(AccountSettingsInformation
, Fixnum, Hash)>] AccountSettingsInformation
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2841 def list_settings_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.list_settings ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_settings" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountSettingsInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#list_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns Account available signature providers for specified account.
@param account_id The external account number (int) or account ID Guid. @return [AccountSignatureProviders]
# File lib/docusign_esign/api/accounts_api.rb, line 2940 def list_signature_providers(account_id) data, _status_code, _headers = list_signature_providers_with_http_info(account_id) return data end
Returns Account available signature providers for specified account.
@param account_id The external account number (int) or account ID Guid. @return [Array<(AccountSignatureProviders
, Fixnum, Hash)>] AccountSignatureProviders
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2949 def list_signature_providers_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.list_signature_providers ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_signature_providers" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signatureProviders".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountSignatureProviders') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#list_signature_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param account_id The external account number (int) or account ID Guid. @return [FileTypeList]
# File lib/docusign_esign/api/accounts_api.rb, line 2989 def list_unsupported_file_types(account_id) data, _status_code, _headers = list_unsupported_file_types_with_http_info(account_id) return data end
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. @param account_id The external account number (int) or account ID Guid. @return [Array<(FileTypeList
, Fixnum, Hash)>] FileTypeList
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 2998 def list_unsupported_file_types_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.list_unsupported_file_types ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_unsupported_file_types" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/unsupported_file_types".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'FileTypeList') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#list_unsupported_file_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Unfavorite a template
@param account_id The external account number (int) or account ID Guid. @param favorite_templates_info (optional parameter) @return [FavoriteTemplatesInfo]
# File lib/docusign_esign/api/accounts_api.rb, line 3039 def un_favorite_template(account_id, favorite_templates_info) data, _status_code, _headers = un_favorite_template_with_http_info(account_id, favorite_templates_info) return data end
Unfavorite a template
@param account_id The external account number (int) or account ID Guid. @param favorite_templates_info (optional parameter) @return [Array<(FavoriteTemplatesInfo
, Fixnum, Hash)>] FavoriteTemplatesInfo
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3049 def un_favorite_template_with_http_info(account_id, favorite_templates_info) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.un_favorite_template ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.un_favorite_template" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/favorite_templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(favorite_templates_info) auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'FavoriteTemplatesInfo') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#un_favorite_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates a account signature.
@param account_id The external account number (int) or account ID Guid. @param account_signatures_information (optional parameter) @return [AccountSignaturesInformation]
# File lib/docusign_esign/api/accounts_api.rb, line 3090 def update_account_signature(account_id, account_signatures_information) data, _status_code, _headers = update_account_signature_with_http_info(account_id, account_signatures_information) return data end
Updates a account signature.
@param account_id The external account number (int) or account ID Guid. @param signature_id The ID of the signature being accessed. @param account_signature_definition (optional parameter) @param DocuSign_eSign::UpdateAccountSignatureByIdOptions
Options for modifying the behavior of the function. @return [AccountSignature]
# File lib/docusign_esign/api/accounts_api.rb, line 3143 def update_account_signature_by_id(account_id, signature_id, account_signature_definition, options = DocuSign_eSign::UpdateAccountSignatureByIdOptions.default) data, _status_code, _headers = update_account_signature_by_id_with_http_info(account_id, signature_id, account_signature_definition, options) return data end
Updates a account signature.
@param account_id The external account number (int) or account ID Guid. @param signature_id The ID of the signature being accessed. @param account_signature_definition (optional parameter) @param DocuSign_eSign::UpdateAccountSignatureByIdOptions
Options for modifying the behavior of the function. @return [Array<(AccountSignature
, Fixnum, Hash)>] AccountSignature
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3155 def update_account_signature_by_id_with_http_info(account_id, signature_id, account_signature_definition, options = DocuSign_eSign::UpdateAccountSignatureByIdOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_account_signature_by_id ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account_signature_by_id" if account_id.nil? # verify the required parameter 'signature_id' is set fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.update_account_signature_by_id" if signature_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s) # query parameters query_params = {} query_params[:'close_existing_signature'] = options.close_existing_signature if !options.close_existing_signature.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(account_signature_definition) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountSignature') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_account_signature_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Sets a signature, initials, or stamps image.
@param account_id The external account number (int) or account ID Guid. @param image_type One of signature_image or initials_image. @param signature_id The ID of the signature being accessed. @param DocuSign_eSign::UpdateAccountSignatureImageOptions
Options for modifying the behavior of the function. @return [AccountSignature]
# File lib/docusign_esign/api/accounts_api.rb, line 3201 def update_account_signature_image(account_id, image_type, signature_id, options = DocuSign_eSign::UpdateAccountSignatureImageOptions.default) data, _status_code, _headers = update_account_signature_image_with_http_info(account_id, image_type, signature_id, options) return data end
Sets a signature, initials, or stamps image.
@param account_id The external account number (int) or account ID Guid. @param image_type One of signature_image or initials_image. @param signature_id The ID of the signature being accessed. @param DocuSign_eSign::UpdateAccountSignatureImageOptions
Options for modifying the behavior of the function. @return [Array<(AccountSignature
, Fixnum, Hash)>] AccountSignature
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3213 def update_account_signature_image_with_http_info(account_id, image_type, signature_id, options = DocuSign_eSign::UpdateAccountSignatureImageOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_account_signature_image ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account_signature_image" if account_id.nil? # verify the required parameter 'image_type' is set fail ArgumentError, "Missing the required parameter 'image_type' when calling AccountsApi.update_account_signature_image" if image_type.nil? # verify the required parameter 'signature_id' is set fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.update_account_signature_image" if signature_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s) # query parameters query_params = {} query_params[:'transparent_png'] = options.transparent_png if !options.transparent_png.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['image/gif']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountSignature') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_account_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates a account signature.
@param account_id The external account number (int) or account ID Guid. @param account_signatures_information (optional parameter) @return [Array<(AccountSignaturesInformation
, Fixnum, Hash)>] AccountSignaturesInformation
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3100 def update_account_signature_with_http_info(account_id, account_signatures_information) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_account_signature ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account_signature" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signatures".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(account_signatures_information) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountSignaturesInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_account_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Modifies tab settings for specified account
@param account_id The external account number (int) or account ID Guid. @param tab_account_settings (optional parameter) @return [TabAccountSettings]
# File lib/docusign_esign/api/accounts_api.rb, line 3261 def update_account_tab_settings(account_id, tab_account_settings) data, _status_code, _headers = update_account_tab_settings_with_http_info(account_id, tab_account_settings) return data end
Modifies tab settings for specified account
@param account_id The external account number (int) or account ID Guid. @param tab_account_settings (optional parameter) @return [Array<(TabAccountSettings
, Fixnum, Hash)>] TabAccountSettings
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3271 def update_account_tab_settings_with_http_info(account_id, tab_account_settings) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_account_tab_settings ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account_tab_settings" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(tab_account_settings) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'TabAccountSettings') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_account_tab_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates an existing brand.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @param brand (optional parameter) @return [Brand]
# File lib/docusign_esign/api/accounts_api.rb, line 3313 def update_brand(account_id, brand_id, brand) data, _status_code, _headers = update_brand_with_http_info(account_id, brand_id, brand) return data end
Put one branding logo.
@param account_id The external account number (int) or account ID GUID. @param brand_id The id of the brand. @param logo_type The type of logo. Valid values are: - `primary` - `secondary` - `email` @param logo_file_bytes Brand
logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 3369 def update_brand_logo_by_type(account_id, brand_id, logo_type, logo_file_bytes) update_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, logo_file_bytes) return nil end
Put one branding logo.
@param account_id The external account number (int) or account ID GUID. @param brand_id The id of the brand. @param logo_type The type of logo. Valid values are: - `primary` - `secondary` - `email` @param logo_file_bytes Brand
logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3381 def update_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, logo_file_bytes) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_brand_logo_by_type ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_brand_logo_by_type" if account_id.nil? # verify the required parameter 'brand_id' is set fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_logo_by_type" if brand_id.nil? # verify the required parameter 'logo_type' is set fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.update_brand_logo_by_type" if logo_type.nil? # verify the required parameter 'logo_file_bytes' is set fail ArgumentError, "Missing the required parameter 'logo_file_bytes' when calling AccountsApi.update_brand_logo_by_type" if logo_file_bytes.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['image/png']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(logo_file_bytes) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_brand_logo_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Uploads a branding resource file.
@param account_id The external account number (int) or account ID GUID. @param brand_id The id of the brand. @param resource_content_type The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive` @return [BrandResources]
# File lib/docusign_esign/api/accounts_api.rb, line 3430 def update_brand_resources_by_content_type(account_id, brand_id, resource_content_type) data, _status_code, _headers = update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type) return data end
Uploads a branding resource file.
@param account_id The external account number (int) or account ID GUID. @param brand_id The id of the brand. @param resource_content_type The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive` @return [Array<(BrandResources
, Fixnum, Hash)>] BrandResources
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3441 def update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_brand_resources_by_content_type ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_brand_resources_by_content_type" if account_id.nil? # verify the required parameter 'brand_id' is set fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_resources_by_content_type" if brand_id.nil? # verify the required parameter 'resource_content_type' is set fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.update_brand_resources_by_content_type" if resource_content_type.nil? # verify the required parameter 'file_xml' is set fail ArgumentError, "Missing the required parameter 'file_xml' when calling AccountsApi.update_brand_resources_by_content_type" if file_xml.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data']) # form parameters form_params = {} form_params["file.xml"] = file_xml # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'BrandResources') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_brand_resources_by_content_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates an existing brand.
@param account_id The external account number (int) or account ID Guid. @param brand_id The unique identifier of a brand. @param brand (optional parameter) @return [Array<(Brand
, Fixnum, Hash)>] Brand
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3324 def update_brand_with_http_info(account_id, brand_id, brand) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_brand ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_brand" if account_id.nil? # verify the required parameter 'brand_id' is set fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand" if brand_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(brand) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Brand') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update Consumer Disclosure.
@param account_id The external account number (int) or account ID Guid. @param 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. @param consumer_disclosure (optional parameter) @param DocuSign_eSign::UpdateConsumerDisclosureOptions
Options for modifying the behavior of the function. @return [ConsumerDisclosure]
# File lib/docusign_esign/api/accounts_api.rb, line 3493 def update_consumer_disclosure(account_id, lang_code, consumer_disclosure, options = DocuSign_eSign::UpdateConsumerDisclosureOptions.default) data, _status_code, _headers = update_consumer_disclosure_with_http_info(account_id, lang_code, consumer_disclosure, options) return data end
Update Consumer Disclosure.
@param account_id The external account number (int) or account ID Guid. @param 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. @param consumer_disclosure (optional parameter) @param DocuSign_eSign::UpdateConsumerDisclosureOptions
Options for modifying the behavior of the function. @return [Array<(ConsumerDisclosure
, Fixnum, Hash)>] ConsumerDisclosure
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3505 def update_consumer_disclosure_with_http_info(account_id, lang_code, consumer_disclosure, options = DocuSign_eSign::UpdateConsumerDisclosureOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_consumer_disclosure ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_consumer_disclosure" if account_id.nil? # verify the required parameter 'lang_code' is set fail ArgumentError, "Missing the required parameter 'lang_code' when calling AccountsApi.update_consumer_disclosure" if lang_code.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'langCode' + '}', lang_code.to_s) # query parameters query_params = {} query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(consumer_disclosure) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConsumerDisclosure') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_consumer_disclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates an existing account custom field.
@param account_id The external account number (int) or account ID Guid. @param custom_field_id @param custom_field (optional parameter) @param DocuSign_eSign::UpdateCustomFieldOptions
Options for modifying the behavior of the function. @return [CustomFields]
# File lib/docusign_esign/api/accounts_api.rb, line 3551 def update_custom_field(account_id, custom_field_id, custom_field, options = DocuSign_eSign::UpdateCustomFieldOptions.default) data, _status_code, _headers = update_custom_field_with_http_info(account_id, custom_field_id, custom_field, options) return data end
Updates an existing account custom field.
@param account_id The external account number (int) or account ID Guid. @param custom_field_id @param custom_field (optional parameter) @param DocuSign_eSign::UpdateCustomFieldOptions
Options for modifying the behavior of the function. @return [Array<(CustomFields
, Fixnum, Hash)>] CustomFields
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3563 def update_custom_field_with_http_info(account_id, custom_field_id, custom_field, options = DocuSign_eSign::UpdateCustomFieldOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_custom_field ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_custom_field" if account_id.nil? # verify the required parameter 'custom_field_id' is set fail ArgumentError, "Missing the required parameter 'custom_field_id' when calling AccountsApi.update_custom_field" if custom_field_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/custom_fields/{customFieldId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'customFieldId' + '}', custom_field_id.to_s) # query parameters query_params = {} query_params[:'apply_to_templates'] = options.apply_to_templates if !options.apply_to_templates.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(custom_field) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CustomFields') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates configuration information for the eNote eOriginal integration.
@param account_id The external account number (int) or account ID Guid. @param e_note_configuration (optional parameter) @return [ENoteConfiguration]
# File lib/docusign_esign/api/accounts_api.rb, line 3607 def update_e_note_configuration(account_id, e_note_configuration) data, _status_code, _headers = update_e_note_configuration_with_http_info(account_id, e_note_configuration) return data end
Updates configuration information for the eNote eOriginal integration.
@param account_id The external account number (int) or account ID Guid. @param e_note_configuration (optional parameter) @return [Array<(ENoteConfiguration
, Fixnum, Hash)>] ENoteConfiguration
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3617 def update_e_note_configuration_with_http_info(account_id, e_note_configuration) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_e_note_configuration ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_e_note_configuration" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(e_note_configuration) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ENoteConfiguration') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_e_note_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates envelope purge configuration.
@param account_id The external account number (int) or account ID Guid. @param envelope_purge_configuration (optional parameter) @return [EnvelopePurgeConfiguration]
# File lib/docusign_esign/api/accounts_api.rb, line 3658 def update_envelope_purge_configuration(account_id, envelope_purge_configuration) data, _status_code, _headers = update_envelope_purge_configuration_with_http_info(account_id, envelope_purge_configuration) return data end
Updates envelope purge configuration.
@param account_id The external account number (int) or account ID Guid. @param envelope_purge_configuration (optional parameter) @return [Array<(EnvelopePurgeConfiguration
, Fixnum, Hash)>] EnvelopePurgeConfiguration
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3668 def update_envelope_purge_configuration_with_http_info(account_id, envelope_purge_configuration) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_envelope_purge_configuration ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_envelope_purge_configuration" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings/envelope_purge_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(envelope_purge_configuration) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'EnvelopePurgeConfiguration') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_envelope_purge_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Favorites a template
@param account_id The external account number (int) or account ID Guid. @param favorite_templates_info (optional parameter) @return [FavoriteTemplatesInfo]
# File lib/docusign_esign/api/accounts_api.rb, line 3709 def update_favorite_template(account_id, favorite_templates_info) data, _status_code, _headers = update_favorite_template_with_http_info(account_id, favorite_templates_info) return data end
Favorites a template
@param account_id The external account number (int) or account ID Guid. @param favorite_templates_info (optional parameter) @return [Array<(FavoriteTemplatesInfo
, Fixnum, Hash)>] FavoriteTemplatesInfo
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3719 def update_favorite_template_with_http_info(account_id, favorite_templates_info) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_favorite_template ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_favorite_template" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/favorite_templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(favorite_templates_info) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'FavoriteTemplatesInfo') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_favorite_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates default user level settings for a specified account
@param account_id The external account number (int) or account ID Guid. @param notification_defaults (optional parameter) @return [NotificationDefaults]
# File lib/docusign_esign/api/accounts_api.rb, line 3760 def update_notification_defaults(account_id, notification_defaults) data, _status_code, _headers = update_notification_defaults_with_http_info(account_id, notification_defaults) return data end
Updates default user level settings for a specified account
@param account_id The external account number (int) or account ID Guid. @param notification_defaults (optional parameter) @return [Array<(NotificationDefaults
, Fixnum, Hash)>] NotificationDefaults
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3770 def update_notification_defaults_with_http_info(account_id, notification_defaults) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_notification_defaults ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_notification_defaults" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings/notification_defaults".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(notification_defaults) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'NotificationDefaults') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_notification_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update the password rules
@param account_id The external account number (int) or account ID Guid. @param account_password_rules (optional parameter) @return [AccountPasswordRules]
# File lib/docusign_esign/api/accounts_api.rb, line 3811 def update_password_rules(account_id, account_password_rules) data, _status_code, _headers = update_password_rules_with_http_info(account_id, account_password_rules) return data end
Update the password rules
@param account_id The external account number (int) or account ID Guid. @param account_password_rules (optional parameter) @return [Array<(AccountPasswordRules
, Fixnum, Hash)>] AccountPasswordRules
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3821 def update_password_rules_with_http_info(account_id, account_password_rules) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_password_rules ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_password_rules" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings/password_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(account_password_rules) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AccountPasswordRules') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_password_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates a permission profile within the specified account.
@param account_id The external account number (int) or account ID Guid. @param permission_profile_id @param permission_profile (optional parameter) @param DocuSign_eSign::UpdatePermissionProfileOptions
Options for modifying the behavior of the function. @return [PermissionProfile]
# File lib/docusign_esign/api/accounts_api.rb, line 3864 def update_permission_profile(account_id, permission_profile_id, permission_profile, options = DocuSign_eSign::UpdatePermissionProfileOptions.default) data, _status_code, _headers = update_permission_profile_with_http_info(account_id, permission_profile_id, permission_profile, options) return data end
Updates a permission profile within the specified account.
@param account_id The external account number (int) or account ID Guid. @param permission_profile_id @param permission_profile (optional parameter) @param DocuSign_eSign::UpdatePermissionProfileOptions
Options for modifying the behavior of the function. @return [Array<(PermissionProfile
, Fixnum, Hash)>] PermissionProfile
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3876 def update_permission_profile_with_http_info(account_id, permission_profile_id, permission_profile, options = DocuSign_eSign::UpdatePermissionProfileOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_permission_profile ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_permission_profile" if account_id.nil? # verify the required parameter 'permission_profile_id' is set fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.update_permission_profile" if permission_profile_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s) # query parameters query_params = {} query_params[:'include'] = options.include if !options.include.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(permission_profile) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PermissionProfile') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns the result set from running the specified report
@param account_id The external account number (int) or account ID Guid. @param report_in_product_run_request (optional parameter) @return [ReportInProductRunResponse]
# File lib/docusign_esign/api/accounts_api.rb, line 3920 def update_report_in_product_run_results(account_id, report_in_product_run_request) data, _status_code, _headers = update_report_in_product_run_results_with_http_info(account_id, report_in_product_run_request) return data end
Returns the result set from running the specified report
@param account_id The external account number (int) or account ID Guid. @param report_in_product_run_request (optional parameter) @return [Array<(ReportInProductRunResponse
, Fixnum, Hash)>] ReportInProductRunResponse
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3930 def update_report_in_product_run_results_with_http_info(account_id, report_in_product_run_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_report_in_product_run_results ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_report_in_product_run_results" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/reports/report_results".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(report_in_product_run_request) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportInProductRunResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_report_in_product_run_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Saves a customized report
@param account_id The external account number (int) or account ID Guid. @param id @param report_in_product_run_request (optional parameter) @return [ReportInProductSaveResponse]
# File lib/docusign_esign/api/accounts_api.rb, line 3972 def update_report_in_product_save(account_id, id, report_in_product_run_request) data, _status_code, _headers = update_report_in_product_save_with_http_info(account_id, id, report_in_product_run_request) return data end
Saves a customized report
@param account_id The external account number (int) or account ID Guid. @param id @param report_in_product_run_request (optional parameter) @return [Array<(ReportInProductSaveResponse
, Fixnum, Hash)>] ReportInProductSaveResponse
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 3983 def update_report_in_product_save_with_http_info(account_id, id, report_in_product_run_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_report_in_product_save ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_report_in_product_save" if account_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.update_report_in_product_save" if id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/reports/{id}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(report_in_product_run_request) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportInProductSaveResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_report_in_product_save\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns the specified report as a CSV string
@param account_id The external account number (int) or account ID Guid. @param report_in_product_csv_run_request (optional parameter) @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 4026 def update_report_results_csv(account_id, report_in_product_csv_run_request) update_report_results_csv_with_http_info(account_id, report_in_product_csv_run_request) return nil end
Returns the specified report as a CSV string
@param account_id The external account number (int) or account ID Guid. @param report_in_product_csv_run_request (optional parameter) @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 4036 def update_report_results_csv_with_http_info(account_id, report_in_product_csv_run_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_report_results_csv ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_report_results_csv" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/reports/report_results_csv".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(report_in_product_csv_run_request) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_report_results_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates the account settings for an account. Updates the account settings for the specified account. @param account_id The external account number (int) or account ID Guid. @param account_settings_information (optional parameter) @return [nil]
# File lib/docusign_esign/api/accounts_api.rb, line 4076 def update_settings(account_id, account_settings_information) update_settings_with_http_info(account_id, account_settings_information) return nil end
Updates the account settings for an account. Updates the account settings for the specified account. @param account_id The external account number (int) or account ID Guid. @param account_settings_information (optional parameter) @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 4086 def update_settings_with_http_info(account_id, account_settings_information) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_settings ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_settings" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(account_settings_information) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update watermark information.
@param account_id The external account number (int) or account ID Guid. @param watermark (optional parameter) @return [Watermark]
# File lib/docusign_esign/api/accounts_api.rb, line 4182 def update_watermark(account_id, watermark) data, _status_code, _headers = update_watermark_with_http_info(account_id, watermark) return data end
Update watermark information.
@param account_id The external account number (int) or account ID Guid. @param watermark (optional parameter) @return [Array<(Watermark
, Fixnum, Hash)>] Watermark
data, response status code and response headers
# File lib/docusign_esign/api/accounts_api.rb, line 4192 def update_watermark_with_http_info(account_id, watermark) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AccountsApi.update_watermark ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_watermark" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/watermark".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(watermark) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Watermark') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_watermark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end