Class: FireflyIIIClient::PiggyBanksApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PiggyBanksApi

Returns a new instance of PiggyBanksApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Delete a piggy bank. Delete a piggy bank.

Parameters:

  • id (Integer) —

    The ID of the piggy bank.

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

    the optional parameters

Returns:

  • (nil) 


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

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

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

Delete a piggy bank. Delete a piggy bank.

Parameters:

  • id (Integer) —

    The ID of the piggy bank.

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

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

#get_piggy_bank(id, opts = {}) ⇒ PiggyBankSingle

Get a single piggy bank. Get a single piggy bank.

Parameters:

  • id (Integer) —

    The ID of the piggy bank.

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

    the optional parameters

Returns:



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

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

#get_piggy_bank_with_http_info(id, opts = {}) ⇒ Array<(PiggyBankSingle, Integer, Hash)>

Get a single piggy bank. Get a single piggy bank.

Parameters:

  • id (Integer) —

    The ID of the piggy bank.

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

    the optional parameters

Returns:

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

    PiggyBankSingle 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/piggy_banks_api.rb', line 98

def get_piggy_bank_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PiggyBanksApi.get_piggy_bank ...'
  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 PiggyBanksApi.get_piggy_bank"
  end
  # resource path
  local_var_path = '/api/v1/piggy_banks/{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] || 'PiggyBankSingle'

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

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

#list_event_by_piggy_bank(id, opts = {}) ⇒ PiggyBankEventArray

List all events linked to a piggy bank. List all events linked to a piggy bank (adding and removing money).

Parameters:

  • id (Integer) —

    The ID of the piggy bank

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

Returns:



152
153
154
155
 
# File 'lib/firefly_iii_client/api/piggy_banks_api.rb', line 152

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

#list_event_by_piggy_bank_with_http_info(id, opts = {}) ⇒ Array<(PiggyBankEventArray, Integer, Hash)>

List all events linked to a piggy bank. List all events linked to a piggy bank (adding and removing money).

Parameters:

  • id (Integer) —

    The ID of the piggy bank

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

Returns:

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

    PiggyBankEventArray data, response status code and response headers



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

def list_event_by_piggy_bank_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PiggyBanksApi.list_event_by_piggy_bank ...'
  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 PiggyBanksApi.list_event_by_piggy_bank"
  end
  # resource path
  local_var_path = '/api/v1/piggy_banks/{id}/events'.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] || 'PiggyBankEventArray'

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

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

#list_piggy_bank(opts = {}) ⇒ PiggyBankArray

List all piggy banks. List all piggy banks.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

Returns:



217
218
219
220
 
# File 'lib/firefly_iii_client/api/piggy_banks_api.rb', line 217

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

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

List all piggy banks. List all piggy banks.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

Returns:

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

    PiggyBankArray data, response status code and response headers



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
270
 
# File 'lib/firefly_iii_client/api/piggy_banks_api.rb', line 227

def list_piggy_bank_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PiggyBanksApi.list_piggy_bank ...'
  end
  # resource path
  local_var_path = '/api/v1/piggy_banks'

  # 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 => :"PiggyBanksApi.list_piggy_bank",
    :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: PiggyBanksApi#list_piggy_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#store_piggy_bank(piggy_bank, opts = {}) ⇒ PiggyBankSingle

Store a new piggy bank Creates a new piggy bank. The data required can be submitted as a JSON body or as a list of parameters.

Parameters:

  • piggy_bank (PiggyBank) —

    JSON array or key&#x3D;value pairs with the necessary piggy bank 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/piggy_banks_api.rb', line 277

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

#store_piggy_bank_with_http_info(piggy_bank, opts = {}) ⇒ Array<(PiggyBankSingle, Integer, Hash)>

Store a new piggy bank Creates a new piggy bank. The data required can be submitted as a JSON body or as a list of parameters.

Parameters:

  • piggy_bank (PiggyBank) —

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

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

    the optional parameters

Returns:

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

    PiggyBankSingle data, response status code and response headers



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

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

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

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

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

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

#update_piggy_bank(id, piggy_bank, opts = {}) ⇒ PiggyBankSingle

Update existing piggy bank. Update existing piggy bank.

Parameters:

  • id (Integer) —

    The ID of the piggy bank

  • piggy_bank (PiggyBank) —

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

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

    the optional parameters

Returns:



343
344
345
346
 
# File 'lib/firefly_iii_client/api/piggy_banks_api.rb', line 343

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

#update_piggy_bank_with_http_info(id, piggy_bank, opts = {}) ⇒ Array<(PiggyBankSingle, Integer, Hash)>

Update existing piggy bank. Update existing piggy bank.

Parameters:

  • id (Integer) —

    The ID of the piggy bank

  • piggy_bank (PiggyBank) —

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

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

    the optional parameters

Returns:

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

    PiggyBankSingle data, response status code and response headers



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
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
 
# File 'lib/firefly_iii_client/api/piggy_banks_api.rb', line 354

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

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

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

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