class YousignClient::CheckDocumentsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/yousign_client/api/check_documents_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

check_document_bank_accounts_id_get(id, opts = {}) click to toggle source

Get informations about a bank document (RIB) @param id @param [Hash] opts the optional parameters @return [CheckDocumentBankAccountsOutput]

# File lib/yousign_client/api/check_documents_api.rb, line 26
def check_document_bank_accounts_id_get(id, opts = {})
  data, _status_code, _headers = check_document_bank_accounts_id_get_with_http_info(id, opts)
  data
end
check_document_bank_accounts_id_get_with_http_info(id, opts = {}) click to toggle source

Get informations about a bank document (RIB) @param id @param [Hash] opts the optional parameters @return [Array<(CheckDocumentBankAccountsOutput, Fixnum, Hash)>] CheckDocumentBankAccountsOutput data, response status code and response headers

# File lib/yousign_client/api/check_documents_api.rb, line 35
def check_document_bank_accounts_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckDocumentsApi.check_document_bank_accounts_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CheckDocumentsApi.check_document_bank_accounts_id_get"
  end
  # resource path
  local_var_path = '/check-document/bank_accounts/{id}'.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'CheckDocumentBankAccountsOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckDocumentsApi#check_document_bank_accounts_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
check_document_bank_accounts_post(body, opts = {}) click to toggle source

Verify a bank document (RIB) @param body @param [Hash] opts the optional parameters @return [CheckDocumentBankAccountsOutput]

# File lib/yousign_client/api/check_documents_api.rb, line 78
def check_document_bank_accounts_post(body, opts = {})
  data, _status_code, _headers = check_document_bank_accounts_post_with_http_info(body, opts)
  data
end
check_document_bank_accounts_post_with_http_info(body, opts = {}) click to toggle source

Verify a bank document (RIB) @param body @param [Hash] opts the optional parameters @return [Array<(CheckDocumentBankAccountsOutput, Fixnum, Hash)>] CheckDocumentBankAccountsOutput data, response status code and response headers

# File lib/yousign_client/api/check_documents_api.rb, line 87
def check_document_bank_accounts_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckDocumentsApi.check_document_bank_accounts_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CheckDocumentsApi.check_document_bank_accounts_post"
  end
  # resource path
  local_var_path = '/check-document/bank_accounts'

  # 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(body)
  auth_names = ['api_key']
  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 => 'CheckDocumentBankAccountsOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckDocumentsApi#check_document_bank_accounts_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
check_document_identities_id_get(id, opts = {}) click to toggle source

Get informations about an identity document (passport, id cards) @param id @param [Hash] opts the optional parameters @return [CheckDocumentIdentitiesOutput]

# File lib/yousign_client/api/check_documents_api.rb, line 128
def check_document_identities_id_get(id, opts = {})
  data, _status_code, _headers = check_document_identities_id_get_with_http_info(id, opts)
  data
end
check_document_identities_id_get_with_http_info(id, opts = {}) click to toggle source

Get informations about an identity document (passport, id cards) @param id @param [Hash] opts the optional parameters @return [Array<(CheckDocumentIdentitiesOutput, Fixnum, Hash)>] CheckDocumentIdentitiesOutput data, response status code and response headers

# File lib/yousign_client/api/check_documents_api.rb, line 137
def check_document_identities_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckDocumentsApi.check_document_identities_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CheckDocumentsApi.check_document_identities_id_get"
  end
  # resource path
  local_var_path = '/check-document/identities/{id}'.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'CheckDocumentIdentitiesOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckDocumentsApi#check_document_identities_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
check_document_identities_post(body, opts = {}) click to toggle source

Verify an identity document (passport, id cards) @param body @param [Hash] opts the optional parameters @return [CheckDocumentIdentitiesOutput]

# File lib/yousign_client/api/check_documents_api.rb, line 180
def check_document_identities_post(body, opts = {})
  data, _status_code, _headers = check_document_identities_post_with_http_info(body, opts)
  data
end
check_document_identities_post_with_http_info(body, opts = {}) click to toggle source

Verify an identity document (passport, id cards) @param body @param [Hash] opts the optional parameters @return [Array<(CheckDocumentIdentitiesOutput, Fixnum, Hash)>] CheckDocumentIdentitiesOutput data, response status code and response headers

# File lib/yousign_client/api/check_documents_api.rb, line 189
def check_document_identities_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckDocumentsApi.check_document_identities_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CheckDocumentsApi.check_document_identities_post"
  end
  # resource path
  local_var_path = '/check-document/identities'

  # 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(body)
  auth_names = ['api_key']
  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 => 'CheckDocumentIdentitiesOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckDocumentsApi#check_document_identities_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end