Class: FireflyIIIClient::AccountsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountsApi

Returns a new instance of AccountsApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Permanently delete account. Will permanently delete an account. Any associated transactions and piggy banks are ALSO deleted. Cannot be recovered from.

Parameters:

  • id (Integer) —

    The ID of the account.

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

    the optional parameters

Returns:

  • (nil) 


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

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

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

Permanently delete account. Will permanently delete an account. Any associated transactions and piggy banks are ALSO deleted. Cannot be recovered from.

Parameters:

  • id (Integer) —

    The ID of the account.

  • 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/accounts_api.rb', line 37

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.delete_account ...'
  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 AccountsApi.delete_account"
  end
  # resource path
  local_var_path = '/api/v1/accounts/{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 => :"AccountsApi.delete_account",
    :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: AccountsApi#delete_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account(id, opts = {}) ⇒ AccountSingle

Get single account. Returns a single account by its ID.

Parameters:

  • id (Integer) —

    The ID of the account.

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

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account&#39;s balance on that day.

Returns:



89
90
91
92
 
# File 'lib/firefly_iii_client/api/accounts_api.rb', line 89

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

#get_account_with_http_info(id, opts = {}) ⇒ Array<(AccountSingle, Integer, Hash)>

Get single account. Returns a single account by its ID.

Parameters:

  • id (Integer) —

    The ID of the account.

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

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account&#39;s balance on that day.

Returns:

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

    AccountSingle 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
144
145
146
147
 
# File 'lib/firefly_iii_client/api/accounts_api.rb', line 100

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

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

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

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

#list_account(opts = {}) ⇒ AccountArray

List all accounts. This endpoint returns a list of all the accounts owned by the authenticated user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is per 50 items.

  • :date (Date) —

    A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account&#39;s balance on that day.

  • :type (AccountTypeFilter) —

    Optional filter on the account type(s) returned

Returns:



156
157
158
159
 
# File 'lib/firefly_iii_client/api/accounts_api.rb', line 156

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

#list_account_with_http_info(opts = {}) ⇒ Array<(AccountArray, Integer, Hash)>

List all accounts. This endpoint returns a list of all the accounts owned by the authenticated user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is per 50 items.

  • :date (Date) —

    A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account&#39;s balance on that day.

  • :type (AccountTypeFilter) —

    Optional filter on the account type(s) returned

Returns:

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

    AccountArray data, response status code and response headers



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

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.list_account ...'
  end
  # resource path
  local_var_path = '/api/v1/accounts'

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

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

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

#list_piggy_bank_by_account(id, opts = {}) ⇒ PiggyBankArray

List all piggy banks related to the account. This endpoint returns a list of all the piggy banks connected to the account.

Parameters:

  • id (Integer) —

    The ID of the account.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is per 50 items.

Returns:



221
222
223
224
 
# File 'lib/firefly_iii_client/api/accounts_api.rb', line 221

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

#list_piggy_bank_by_account_with_http_info(id, opts = {}) ⇒ Array<(PiggyBankArray, Integer, Hash)>

List all piggy banks related to the account. This endpoint returns a list of all the piggy banks connected to the account.

Parameters:

  • id (Integer) —

    The ID of the account.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is per 50 items.

Returns:

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

    PiggyBankArray data, response status code and response headers



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
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/firefly_iii_client/api/accounts_api.rb', line 232

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

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

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

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

#list_transaction_by_account(id, opts = {}) ⇒ TransactionArray

List all transactions related to the account. This endpoint returns a list of all the transactions connected to the account.

Parameters:

  • id (Integer) —

    The ID of the account.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is per 50 items.

  • :limit (Integer) —

    Limits the number of results on one page.

  • :start (Date) —

    A date formatted YYYY-MM-DD.

  • :_end (Date) —

    A date formatted YYYY-MM-DD.

  • :type (TransactionTypeFilter) —

    Optional filter on the transaction type(s) returned.

Returns:



291
292
293
294
 
# File 'lib/firefly_iii_client/api/accounts_api.rb', line 291

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

#list_transaction_by_account_with_http_info(id, opts = {}) ⇒ Array<(TransactionArray, Integer, Hash)>

List all transactions related to the account. This endpoint returns a list of all the transactions connected to the account.

Parameters:

  • id (Integer) —

    The ID of the account.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is per 50 items.

  • :limit (Integer) —

    Limits the number of results on one page.

  • :start (Date) —

    A date formatted YYYY-MM-DD.

  • :_end (Date) —

    A date formatted YYYY-MM-DD.

  • :type (TransactionTypeFilter) —

    Optional filter on the transaction type(s) returned.

Returns:

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

    TransactionArray data, response status code and response headers



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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/firefly_iii_client/api/accounts_api.rb', line 306

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].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] || 'TransactionArray'

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

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

#store_account(account, opts = {}) ⇒ AccountSingle

Create new account. Creates a new account. The data required can be submitted as a JSON body or as a list of parameters (in key=value pairs, like a webform).

Parameters:

  • account (Account) —

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

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

    the optional parameters

Returns:



364
365
366
367
 
# File 'lib/firefly_iii_client/api/accounts_api.rb', line 364

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

#store_account_with_http_info(account, opts = {}) ⇒ Array<(AccountSingle, Integer, Hash)>

Create new account. Creates a new account. The data required can be submitted as a JSON body or as a list of parameters (in key&#x3D;value pairs, like a webform).

Parameters:

  • account (Account) —

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

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

    the optional parameters

Returns:

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

    AccountSingle data, response status code and response headers



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/firefly_iii_client/api/accounts_api.rb', line 374

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

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

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

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

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

#update_account(id, account, opts = {}) ⇒ AccountSingle

Update existing account. Used to update a single account. All fields that are not submitted will be cleared (set to NULL). The model will tell you which fields are mandatory.

Parameters:

  • id (Integer) —

    The ID of the account.

  • account (Account) —

    JSON array or formdata with updated account information. See the model for the exact specifications.

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

    the optional parameters

Returns:



430
431
432
433
 
# File 'lib/firefly_iii_client/api/accounts_api.rb', line 430

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

#update_account_with_http_info(id, account, opts = {}) ⇒ Array<(AccountSingle, Integer, Hash)>

Update existing account. Used to update a single account. All fields that are not submitted will be cleared (set to NULL). The model will tell you which fields are mandatory.

Parameters:

  • id (Integer) —

    The ID of the account.

  • account (Account) —

    JSON array or formdata with updated account information. See the model for the exact specifications.

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

    the optional parameters

Returns:

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

    AccountSingle data, response status code and response headers



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/firefly_iii_client/api/accounts_api.rb', line 441

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

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

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

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