Class: FireflyIIIClient::UsersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersApi

Returns a new instance of UsersApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_user(id, opts = {}) ⇒ nil

Delete a user. Delete a user. You cannot delete the current user.

Parameters:

  • id (Integer) —

    The user ID.

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_user(id, opts = {})
  delete_user_with_http_info(id, opts)
  nil
end

#delete_user_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a user. Delete a user. You cannot delete the current user.

Parameters:

  • id (Integer) —

    The user ID.

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/firefly_iii_client/api/users_api.rb', line 37

def delete_user_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.delete_user ...'
  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 UsersApi.delete_user"
  end
  # resource path
  local_var_path = '/api/v1/users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#get_user(id, opts = {}) ⇒ UserSingle

Get a single user. Gets all info of a single user.

Parameters:

  • id (Integer) —

    The user ID.

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/firefly_iii_client/api/users_api.rb', line 88

def get_user(id, opts = {})
  data, _status_code, _headers = get_user_with_http_info(id, opts)
  data
end

#get_user_with_http_info(id, opts = {}) ⇒ Array<(UserSingle, Integer, Hash)>

Get a single user. Gets all info of a single user.

Parameters:

  • id (Integer) —

    The user ID.

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

    the optional parameters

Returns:

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

    UserSingle data, response status code and response headers



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

def get_user_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.get_user ...'
  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 UsersApi.get_user"
  end
  # resource path
  local_var_path = '/api/v1/users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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] || 'UserSingle'

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

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

#list_user(opts = {}) ⇒ UserArray

List all users. List all the users in this instance of Firefly III.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page number, if necessary. The default pagination is 50, so 50 users per page.

Returns:



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

def list_user(opts = {})
  data, _status_code, _headers = list_user_with_http_info(opts)
  data
end

#list_user_with_http_info(opts = {}) ⇒ Array<(UserArray, Integer, Hash)>

List all users. List all the users in this instance of Firefly III.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page number, if necessary. The default pagination is 50, so 50 users per page.

Returns:

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

    UserArray data, response status code and response headers



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

def list_user_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.list_user ...'
  end
  # resource path
  local_var_path = '/api/v1/users'

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

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

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

#store_user(user, opts = {}) ⇒ UserSingle

Store a new user Creates a new user. The data required can be submitted as a JSON body or as a list of parameters. The user will be given a random password, which they can reset using the "forgot password" function.

Parameters:

  • user (User) —

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

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

    the optional parameters

Returns:



211
212
213
214
 
# File 'lib/firefly_iii_client/api/users_api.rb', line 211

def store_user(user, opts = {})
  data, _status_code, _headers = store_user_with_http_info(user, opts)
  data
end

#store_user_with_http_info(user, opts = {}) ⇒ Array<(UserSingle, Integer, Hash)>

Store a new user Creates a new user. The data required can be submitted as a JSON body or as a list of parameters. The user will be given a random password, which they can reset using the &quot;forgot password&quot; function.

Parameters:

  • user (User) —

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

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

    the optional parameters

Returns:

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

    UserSingle data, response status code and response headers



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/firefly_iii_client/api/users_api.rb', line 221

def store_user_with_http_info(user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.store_user ...'
  end
  # verify the required parameter 'user' is set
  if @api_client.config.client_side_validation && user.nil?
    fail ArgumentError, "Missing the required parameter 'user' when calling UsersApi.store_user"
  end
  # resource path
  local_var_path = '/api/v1/users'

  # 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(user)

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

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

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

#update_user(id, user, opts = {}) ⇒ UserSingle

Update an existing user’s information. Update existing user.

Parameters:

  • id (Integer) —

    The user ID.

  • user (User) —

    JSON array with updated user information. See the model for the exact specifications.

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

    the optional parameters

Returns:



277
278
279
280
 
# File 'lib/firefly_iii_client/api/users_api.rb', line 277

def update_user(id, user, opts = {})
  data, _status_code, _headers = update_user_with_http_info(id, user, opts)
  data
end

#update_user_with_http_info(id, user, opts = {}) ⇒ Array<(UserSingle, Integer, Hash)>

Update an existing user&#39;s information. Update existing user.

Parameters:

  • id (Integer) —

    The user ID.

  • user (User) —

    JSON array with updated user information. See the model for the exact specifications.

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

    the optional parameters

Returns:

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

    UserSingle data, response status code and response headers



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/firefly_iii_client/api/users_api.rb', line 288

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

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

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

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