Class: FireflyIIIClient::ConfigurationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigurationApi

Returns a new instance of ConfigurationApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_configuration(opts = {}) ⇒ SystemConfiguration

Get Firefly III system configuration. Get system configuration

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/firefly_iii_client/api/configuration_api.rb', line 26

def get_configuration(opts = {})
  data, _status_code, _headers = get_configuration_with_http_info(opts)
  data
end

#get_configuration_with_http_info(opts = {}) ⇒ Array<(SystemConfiguration, Integer, Hash)>

Get Firefly III system configuration. Get system configuration

Parameters:

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

    the optional parameters

Returns:

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

    SystemConfiguration data, response status code and response headers



35
36
37
38
39
40
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
 
# File 'lib/firefly_iii_client/api/configuration_api.rb', line 35

def get_configuration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_configuration ...'
  end
  # resource path
  local_var_path = '/api/v1/configuration'

  # query parameters
  query_params = opts[:query_params] || {}

  # 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] || 'SystemConfiguration'

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

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

#set_configuration(name, value, opts = {}) ⇒ SystemConfiguration

Update configuration Set a single config value.

Parameters:

  • name (String) —

    The configuration value name.

  • value (String) —

    Can be a number or a boolean. This depends on the actual configuration value.

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

    the optional parameters

Returns:



85
86
87
88
 
# File 'lib/firefly_iii_client/api/configuration_api.rb', line 85

def set_configuration(name, value, opts = {})
  data, _status_code, _headers = set_configuration_with_http_info(name, value, opts)
  data
end

#set_configuration_with_http_info(name, value, opts = {}) ⇒ Array<(SystemConfiguration, Integer, Hash)>

Update configuration Set a single config value.

Parameters:

  • name (String) —

    The configuration value name.

  • value (String) —

    Can be a number or a boolean. This depends on the actual configuration value.

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

    the optional parameters

Returns:

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

    SystemConfiguration data, response status code and response headers



96
97
98
99
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/firefly_iii_client/api/configuration_api.rb', line 96

def set_configuration_with_http_info(name, value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.set_configuration ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling ConfigurationApi.set_configuration"
  end
  # verify enum value
  allowable_values = ["is_demo_site", "last_update_check", "single_user_mode"]
  if @api_client.config.client_side_validation && !allowable_values.include?(name)
    fail ArgumentError, "invalid value for \"name\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling ConfigurationApi.set_configuration"
  end
  # resource path
  local_var_path = '/api/v1/configuration/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded', 'application/json'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'SystemConfiguration'

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

  new_options = opts.merge(
    :operation => :"ConfigurationApi.set_configuration",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#set_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end