Class: FireflyIIIClient::CurrencyExchangeRatesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CurrencyExchangeRatesApi 



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

def api_client
  @api_client
end

Instance Method Details

#get_exchange_rate(opts = {}) ⇒ ExchangeRate

Get an exchange rate. Get an exchange rate. If Firefly III doesn’t know the rate it will set the rate to 1.0.

Options Hash (opts):

  • :from (String) —

    The source currency code. If omitted, defaults to EUR.

  • :to (String) —

    The destination currency code. If omitted, defaults to USD.

  • :date (Date) —

    The date you want to know the exchange rate on.

  • :amount (Float) —

    The amount in the source currency. If added, Firefly III will calculate the amount in the destination currency.



30
31
32
33
 
# File 'lib/firefly_iii_client/api/currency_exchange_rates_api.rb', line 30

def get_exchange_rate(opts = {})
  data, _status_code, _headers = get_exchange_rate_with_http_info(opts)
  data
end

#get_exchange_rate_with_http_info(opts = {}) ⇒ Array<(ExchangeRate, Integer, Hash)>

Get an exchange rate. Get an exchange rate. If Firefly III doesn&#39;t know the rate it will set the rate to 1.0.

Options Hash (opts):

  • :from (String) —

    The source currency code. If omitted, defaults to EUR.

  • :to (String) —

    The destination currency code. If omitted, defaults to USD.

  • :date (Date) —

    The date you want to know the exchange rate on.

  • :amount (Float) —

    The amount in the source currency. If added, Firefly III will calculate the amount in the destination currency.



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
 
# File 'lib/firefly_iii_client/api/currency_exchange_rates_api.rb', line 43

def get_exchange_rate_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CurrencyExchangeRatesApi.get_exchange_rate ...'
  end
  # resource path
  local_var_path = '/api/v1/cer'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
  query_params[:'amount'] = opts[:'amount'] if !opts[:'amount'].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] || 'ExchangeRate'

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

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