class QwilAPI::IncomeApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

income_list(opts = {}) click to toggle source

The list of Income items for all Users The list of Income items for all Users.<br/>This can be filtered by date using the start_date and end_date query parameters. @param [Hash] opts the optional parameters @return [Array<IncomeSerializer>]

# File lib/qwil_api/api/income_api.rb, line 36
def income_list(opts = {})
  data, _status_code, _headers = income_list_with_http_info(opts)
  return data
end
income_list_with_http_info(opts = {}) click to toggle source

The list of Income items for all Users The list of Income items for all Users.&lt;br/&gt;This can be filtered by date using the start_date and end_date query parameters. @param [Hash] opts the optional parameters @return [Array<(Array<IncomeSerializer>, Fixnum, Hash)>] Array<IncomeSerializer> data, response status code and response headers

# File lib/qwil_api/api/income_api.rb, line 45
def income_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.income_list ..."
  end
  # resource path
  local_var_path = "/income/".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  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 => 'Array<IncomeSerializer>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IncomeApi#income_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
income_retrieve(pk, opts = {}) click to toggle source

The list of Income items for all Users The list of Income items for all Users.<br/>This can be filtered by date using the start_date and end_date query parameters. @param pk @param [Hash] opts the optional parameters @return [IncomeSerializer]

# File lib/qwil_api/api/income_api.rb, line 90
def income_retrieve(pk, opts = {})
  data, _status_code, _headers = income_retrieve_with_http_info(pk, opts)
  return data
end
income_retrieve_with_http_info(pk, opts = {}) click to toggle source

The list of Income items for all Users The list of Income items for all Users.&lt;br/&gt;This can be filtered by date using the start_date and end_date query parameters. @param pk @param [Hash] opts the optional parameters @return [Array<(IncomeSerializer, Fixnum, Hash)>] IncomeSerializer data, response status code and response headers

# File lib/qwil_api/api/income_api.rb, line 100
def income_retrieve_with_http_info(pk, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.income_retrieve ..."
  end
  # verify the required parameter 'pk' is set
  fail ArgumentError, "Missing the required parameter 'pk' when calling IncomeApi.income_retrieve" if pk.nil?
  # resource path
  local_var_path = "/income/{pk}/".sub('{format}','json').sub('{' + 'pk' + '}', pk.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  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 => 'IncomeSerializer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IncomeApi#income_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end