Class: FireflyIIIClient::ChartsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/firefly_iii_client/api/charts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ChartsApi

Returns a new instance of ChartsApi.



19
20
21
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_chart_ab_overview(id, start, _end, opts = {}) ⇒ Array<ChartDataSet>

Dashboard chart with an overview of the available budget. This endpoint returns the data required to generate a pie chart for the available budget.

Parameters:

  • id (Integer) —

    The ID of the available budget.

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 29

def get_chart_ab_overview(id, start, _end, opts = {})
  data, _status_code, _headers = get_chart_ab_overview_with_http_info(id, start, _end, opts)
  data
end

#get_chart_ab_overview_with_http_info(id, start, _end, opts = {}) ⇒ Array<(Array<ChartDataSet>, Integer, Hash)>

Dashboard chart with an overview of the available budget. This endpoint returns the data required to generate a pie chart for the available budget.

Parameters:

  • id (Integer) —

    The ID of the available budget.

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:

  • (Array<(Array<ChartDataSet>, Integer, Hash)>) —

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



41
42
43
44
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 41

def get_chart_ab_overview_with_http_info(id, start, _end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChartsApi.get_chart_ab_overview ...'
  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 ChartsApi.get_chart_ab_overview"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling ChartsApi.get_chart_ab_overview"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling ChartsApi.get_chart_ab_overview"
  end
  # resource path
  local_var_path = '/api/v1/chart/ab/overview/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = start
  query_params[:'end'] = _end

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ChartDataSet>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']

  new_options = opts.merge(
    :operation => :"ChartsApi.get_chart_ab_overview",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChartsApi#get_chart_ab_overview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chart_account_expense(start, _end, opts = {}) ⇒ Array<ChartDataSet>

Dashboard chart with expense account balance information. This endpoint returns the data required to generate a chart that shows the user how much they’ve spent on their expense accounts.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:



105
106
107
108
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 105

def (start, _end, opts = {})
  data, _status_code, _headers = (start, _end, opts)
  data
end

#get_chart_account_expense_with_http_info(start, _end, opts = {}) ⇒ Array<(Array<ChartDataSet>, Integer, Hash)>

Dashboard chart with expense account balance information. This endpoint returns the data required to generate a chart that shows the user how much they&#39;ve spent on their expense accounts.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:

  • (Array<(Array<ChartDataSet>, Integer, Hash)>) —

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



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 116

def (start, _end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChartsApi.get_chart_account_expense ...'
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling ChartsApi.get_chart_account_expense"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling ChartsApi.get_chart_account_expense"
  end
  # resource path
  local_var_path = '/api/v1/chart/account/expense'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = start
  query_params[:'end'] = _end

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ChartDataSet>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']

  new_options = opts.merge(
    :operation => :"ChartsApi.get_chart_account_expense",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChartsApi#get_chart_account_expense\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chart_account_overview(start, _end, opts = {}) ⇒ Array<ChartDataSet>

Dashboard chart with asset account balance information. This endpoint returns the data required to generate a chart with basic asset account balance information.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:



176
177
178
179
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 176

def (start, _end, opts = {})
  data, _status_code, _headers = (start, _end, opts)
  data
end

#get_chart_account_overview_with_http_info(start, _end, opts = {}) ⇒ Array<(Array<ChartDataSet>, Integer, Hash)>

Dashboard chart with asset account balance information. This endpoint returns the data required to generate a chart with basic asset account balance information.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:

  • (Array<(Array<ChartDataSet>, Integer, Hash)>) —

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 187

def (start, _end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChartsApi.get_chart_account_overview ...'
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling ChartsApi.get_chart_account_overview"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling ChartsApi.get_chart_account_overview"
  end
  # resource path
  local_var_path = '/api/v1/chart/account/overview'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = start
  query_params[:'end'] = _end

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ChartDataSet>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']

  new_options = opts.merge(
    :operation => :"ChartsApi.get_chart_account_overview",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChartsApi#get_chart_account_overview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chart_account_revenue(start, _end, opts = {}) ⇒ Array<ChartDataSet>

Dashboard chart with revenue account balance information. This endpoint returns the data required to generate a chart that shows the user how much they’ve earned from their revenue accounts.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:



247
248
249
250
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 247

def (start, _end, opts = {})
  data, _status_code, _headers = (start, _end, opts)
  data
end

#get_chart_account_revenue_with_http_info(start, _end, opts = {}) ⇒ Array<(Array<ChartDataSet>, Integer, Hash)>

Dashboard chart with revenue account balance information. This endpoint returns the data required to generate a chart that shows the user how much they&#39;ve earned from their revenue accounts.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:

  • (Array<(Array<ChartDataSet>, Integer, Hash)>) —

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 258

def (start, _end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChartsApi.get_chart_account_revenue ...'
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling ChartsApi.get_chart_account_revenue"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling ChartsApi.get_chart_account_revenue"
  end
  # resource path
  local_var_path = '/api/v1/chart/account/revenue'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = start
  query_params[:'end'] = _end

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ChartDataSet>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']

  new_options = opts.merge(
    :operation => :"ChartsApi.get_chart_account_revenue",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChartsApi#get_chart_account_revenue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chart_category_overview(start, _end, opts = {}) ⇒ Array<ChartDataSet>

Dashboard chart with an overview of the users categories. This endpoint returns the data required to generate a bar chart for the expenses and incomes on the users categories.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:



318
319
320
321
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 318

def get_chart_category_overview(start, _end, opts = {})
  data, _status_code, _headers = get_chart_category_overview_with_http_info(start, _end, opts)
  data
end

#get_chart_category_overview_with_http_info(start, _end, opts = {}) ⇒ Array<(Array<ChartDataSet>, Integer, Hash)>

Dashboard chart with an overview of the users categories. This endpoint returns the data required to generate a bar chart for the expenses and incomes on the users categories.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:

  • (Array<(Array<ChartDataSet>, Integer, Hash)>) —

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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/firefly_iii_client/api/charts_api.rb', line 329

def get_chart_category_overview_with_http_info(start, _end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChartsApi.get_chart_category_overview ...'
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling ChartsApi.get_chart_category_overview"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling ChartsApi.get_chart_category_overview"
  end
  # resource path
  local_var_path = '/api/v1/chart/category/overview'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = start
  query_params[:'end'] = _end

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ChartDataSet>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']

  new_options = opts.merge(
    :operation => :"ChartsApi.get_chart_category_overview",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChartsApi#get_chart_category_overview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end