Class: FireflyIIIClient::SummaryApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SummaryApi

Returns a new instance of SummaryApi.



19
20
21
 
# File 'lib/firefly_iii_client/api/summary_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/summary_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_basic_summary(start, _end, opts = {}) ⇒ Array<BasicSummaryEntry>

Returns basic sums of the users data. Returns basic sums of the users data, like the net worth, spent and earned amounts. It is multi-currency, and is in Firefly III to populate the dashboard.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Options Hash (opts):

  • :currency_code (String) —

    A currency code like EUR or USD, to filter the result.

Returns:



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

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

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

Returns basic sums of the users data. Returns basic sums of the users data, like the net worth, spent and earned amounts. It is multi-currency, and is in Firefly III to populate the dashboard.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Options Hash (opts):

  • :currency_code (String) —

    A currency code like EUR or USD, to filter the result.

Returns:

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

    Array<BasicSummaryEntry> 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
 
# File 'lib/firefly_iii_client/api/summary_api.rb', line 41

def get_basic_summary_with_http_info(start, _end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SummaryApi.get_basic_summary ...'
  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 SummaryApi.get_basic_summary"
  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 SummaryApi.get_basic_summary"
  end
  # resource path
  local_var_path = '/api/v1/summary/basic'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'currency_code'] = opts[:'currency_code'] if !opts[:'currency_code'].nil?

  # 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<BasicSummaryEntry>'

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

  new_options = opts.merge(
    :operation => :"SummaryApi.get_basic_summary",
    :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: SummaryApi#get_basic_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end