class Wallee::HumanUserService

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 24
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

count(opts = {}) click to toggle source

Count Counts the number of items in the database as restricted by the given filter. @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Integer]

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 33
def count(opts = {})
  data, _status_code, _headers = count_with_http_info(opts)
  return data
end
count_with_http_info(opts = {}) click to toggle source

Count Counts the number of items in the database as restricted by the given filter. @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Array<(Integer, Fixnum, Hash)>] Integer data, response status code and response headers

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 43
def count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.count ..."
  end
  # resource path
  local_var_path = "/human-user/count".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'filter'])
  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 => 'Integer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create(entity, opts = {}) click to toggle source

Create Creates the entity with the given properties. @param entity The human user object with the properties which should be created. @param [Hash] opts the optional parameters @return [HumanUser]

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 88
def create(entity, opts = {})
  data, _status_code, _headers = create_with_http_info(entity, opts)
  return data
end
create_with_http_info(entity, opts = {}) click to toggle source

Create Creates the entity with the given properties. @param entity The human user object with the properties which should be created. @param [Hash] opts the optional parameters @return [Array<(HumanUser, Fixnum, Hash)>] HumanUser data, response status code and response headers

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 98
def create_with_http_info(entity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.create ..."
  end
  # verify the required parameter 'entity' is set
  fail ArgumentError, "Missing the required parameter 'entity' when calling HumanUserService.create" if entity.nil?
  # resource path
  local_var_path = "/human-user/create".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(entity)
  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 => 'HumanUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete(id, opts = {}) click to toggle source

Delete Deletes the entity with the given id. @param id @param [Hash] opts the optional parameters @return [nil]

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 145
def delete(id, opts = {})
  delete_with_http_info(id, opts)
  return nil
end
delete_with_http_info(id, opts = {}) click to toggle source

Delete Deletes the entity with the given id. @param id @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 155
def delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.delete ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling HumanUserService.delete" if id.nil?
  # resource path
  local_var_path = "/human-user/delete".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(id)
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
export(request, opts = {}) click to toggle source

Export Exports the human users into a CSV file. The file will contain the properties defined in the request. @param request The request controls the entries which are exported. @param [Hash] opts the optional parameters @return [String]

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 201
def export(request, opts = {})
  data, _status_code, _headers = export_with_http_info(request, opts)
  return data
end
export_with_http_info(request, opts = {}) click to toggle source

Export Exports the human users into a CSV file. The file will contain the properties defined in the request. @param request The request controls the entries which are exported. @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 211
def export_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.export ..."
  end
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling HumanUserService.export" if request.nil?
  # resource path
  local_var_path = "/human-user/export".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8', 'text/csv']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read(id, opts = {}) click to toggle source

Read Reads the entity with the given 'id' and returns it. @param id The id of the human user which should be returned. @param [Hash] opts the optional parameters @return [HumanUser]

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 258
def read(id, opts = {})
  data, _status_code, _headers = read_with_http_info(id, opts)
  return data
end
read_with_http_info(id, opts = {}) click to toggle source

Read Reads the entity with the given &#39;id&#39; and returns it. @param id The id of the human user which should be returned. @param [Hash] opts the optional parameters @return [Array<(HumanUser, Fixnum, Hash)>] HumanUser data, response status code and response headers

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 268
def read_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.read ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling HumanUserService.read" if id.nil?
  # resource path
  local_var_path = "/human-user/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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 => 'HumanUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
search_with_http_info(query, opts = {}) click to toggle source

Search Searches for the entities as specified by the given query. @param query The query restricts the human users which are returned by the search. @param [Hash] opts the optional parameters @return [Array<(Array<HumanUser>, Fixnum, Hash)>] Array<HumanUser> data, response status code and response headers

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 326
def search_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.search ..."
  end
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling HumanUserService.search" if query.nil?
  # resource path
  local_var_path = "/human-user/search".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  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 => 'Array<HumanUser>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update(entity, opts = {}) click to toggle source

Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity. @param entity The object with all the properties which should be updated. The id and the version are required properties. @param [Hash] opts the optional parameters @return [HumanUser]

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 373
def update(entity, opts = {})
  data, _status_code, _headers = update_with_http_info(entity, opts)
  return data
end
update_with_http_info(entity, opts = {}) click to toggle source

Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The &#39;id&#39; and &#39;version&#39; are required to identify the entity. @param entity The object with all the properties which should be updated. The id and the version are required properties. @param [Hash] opts the optional parameters @return [Array<(HumanUser, Fixnum, Hash)>] HumanUser data, response status code and response headers

# File lib/wallee-ruby-sdk/api/human_user_service_api.rb, line 383
def update_with_http_info(entity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.update ..."
  end
  # verify the required parameter 'entity' is set
  fail ArgumentError, "Missing the required parameter 'entity' when calling HumanUserService.update" if entity.nil?
  # resource path
  local_var_path = "/human-user/update".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(entity)
  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 => 'HumanUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end