Class: QwilAPI::IncomeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/qwil_api/api/income_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IncomeApi

Returns a new instance of IncomeApi.



28
29
30
 
# File 'lib/qwil_api/api/income_api.rb', line 28

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



26
27
28
 
# File 'lib/qwil_api/api/income_api.rb', line 26

def api_client
  @api_client
end

Instance Method Details

#income_list(opts = {}) ⇒ Array<IncomeSerializer>

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.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



36
37
38
39
 
# 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 = {}) ⇒ Array<(Array<IncomeSerializer>, Fixnum, Hash)>

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.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<IncomeSerializer>, Fixnum, Hash)>) —

    Array<IncomeSerializer> data, response status code and response headers



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# 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 = {}) ⇒ IncomeSerializer

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.

Parameters:

  • pk
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



90
91
92
93
 
# 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 = {}) ⇒ Array<(IncomeSerializer, Fixnum, Hash)>

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.

Parameters:

  • pk
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(IncomeSerializer, Fixnum, Hash)>) —

    IncomeSerializer data, response status code and response headers



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# 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