Class: FireflyIIIClient::PreferencesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PreferencesApi

Returns a new instance of PreferencesApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_preference(name, opts = {}) ⇒ PreferenceSingle

Return a single preference. Return a single preference.

Parameters:

  • name (String) —

    The name of the preference.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/firefly_iii_client/api/preferences_api.rb', line 27

def get_preference(name, opts = {})
  data, _status_code, _headers = get_preference_with_http_info(name, opts)
  data
end

#get_preference_with_http_info(name, opts = {}) ⇒ Array<(PreferenceSingle, Integer, Hash)>

Return a single preference. Return a single preference.

Parameters:

  • name (String) —

    The name of the preference.

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

    the optional parameters

Returns:

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

    PreferenceSingle data, response status code and response headers



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
78
79
80
81
82
83
 
# File 'lib/firefly_iii_client/api/preferences_api.rb', line 37

def get_preference_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PreferencesApi.get_preference ...'
  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 PreferencesApi.get_preference"
  end
  # resource path
  local_var_path = '/api/v1/preferences/{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'])

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

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

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

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

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

#list_preference(opts = {}) ⇒ PreferenceArray

List all users preferences. List all preferences of the user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

Returns:



90
91
92
93
 
# File 'lib/firefly_iii_client/api/preferences_api.rb', line 90

def list_preference(opts = {})
  data, _status_code, _headers = list_preference_with_http_info(opts)
  data
end

#list_preference_with_http_info(opts = {}) ⇒ Array<(PreferenceArray, Integer, Hash)>

List all users preferences. List all preferences of the user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

Returns:

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

    PreferenceArray 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
141
142
143
 
# File 'lib/firefly_iii_client/api/preferences_api.rb', line 100

def list_preference_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PreferencesApi.list_preference ...'
  end
  # resource path
  local_var_path = '/api/v1/preferences'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'PreferenceArray'

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

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

#update_preference(name, preference, opts = {}) ⇒ PreferenceSingle

Update preference Update a user’s preference.

Parameters:

  • name (String) —

    The name of the preference. Will always overwrite. Will be created if it does not exist.

  • preference (Preference) —

    JSON array or key&#x3D;value pairs with the necessary preference information. See the model for the exact specifications.

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

    the optional parameters

Returns:



151
152
153
154
 
# File 'lib/firefly_iii_client/api/preferences_api.rb', line 151

def update_preference(name, preference, opts = {})
  data, _status_code, _headers = update_preference_with_http_info(name, preference, opts)
  data
end

#update_preference_with_http_info(name, preference, opts = {}) ⇒ Array<(PreferenceSingle, Integer, Hash)>

Update preference Update a user&#39;s preference.

Parameters:

  • name (String) —

    The name of the preference. Will always overwrite. Will be created if it does not exist.

  • preference (Preference) —

    JSON array or key&#x3D;value pairs with the necessary preference information. See the model for the exact specifications.

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

    the optional parameters

Returns:

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

    PreferenceSingle data, response status code and response headers



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
 
# File 'lib/firefly_iii_client/api/preferences_api.rb', line 162

def update_preference_with_http_info(name, preference, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PreferencesApi.update_preference ...'
  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 PreferencesApi.update_preference"
  end
  # verify the required parameter 'preference' is set
  if @api_client.config.client_side_validation && preference.nil?
    fail ArgumentError, "Missing the required parameter 'preference' when calling PreferencesApi.update_preference"
  end
  # resource path
  local_var_path = '/api/v1/preferences/{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/json', 'application/x-www-form-urlencoded'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(preference)

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

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

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