Class: FireflyIIIClient::RecurrencesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RecurrencesApi

Returns a new instance of RecurrencesApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Delete a recurring transaction. Delete a recurring transaction. Transactions created will not be deleted.

Parameters:

  • id (Integer) —

    The ID of the recurring transaction.

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

    the optional parameters

Returns:

  • (nil) 


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

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

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

Delete a recurring transaction. Delete a recurring transaction. Transactions created will not be deleted.

Parameters:

  • id (Integer) —

    The ID of the recurring transaction.

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

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

#get_recurrence(id, opts = {}) ⇒ RecurrenceSingle

Get a single recurring transaction. Get a single recurring transaction.

Parameters:

  • id (Integer) —

    The ID of the recurring transaction.

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

    the optional parameters

Returns:



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

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

#get_recurrence_with_http_info(id, opts = {}) ⇒ Array<(RecurrenceSingle, Integer, Hash)>

Get a single recurring transaction. Get a single recurring transaction.

Parameters:

  • id (Integer) —

    The ID of the recurring transaction.

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

    the optional parameters

Returns:

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

    RecurrenceSingle 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/recurrences_api.rb', line 98

def get_recurrence_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecurrencesApi.get_recurrence ...'
  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 RecurrencesApi.get_recurrence"
  end
  # resource path
  local_var_path = '/api/v1/recurrences/{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] || 'RecurrenceSingle'

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

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

#list_recurrence(opts = {}) ⇒ RecurrenceArray

List all recurring transactions. List all recurring transactions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

Returns:



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

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

#list_recurrence_with_http_info(opts = {}) ⇒ Array<(RecurrenceArray, Integer, Hash)>

List all recurring transactions. List all recurring transactions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

Returns:

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

    RecurrenceArray 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/recurrences_api.rb', line 161

def list_recurrence_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecurrencesApi.list_recurrence ...'
  end
  # resource path
  local_var_path = '/api/v1/recurrences'

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

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

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

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

List all transactions created by a recurring transaction. List all transactions created by a recurring transaction, optionally limited to the date ranges specified.

Parameters:

  • id (Integer) —

    The ID of the recurring transaction.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

  • :start (Date) —

    A date formatted YYYY-MM-DD. Both the start and end date must be present.

  • :_end (Date) —

    A date formatted YYYY-MM-DD. Both the start and end date must be present.

  • :type (TransactionTypeFilter) —

    Optional filter on the transaction type(s) returned

Returns:



215
216
217
218
 
# File 'lib/firefly_iii_client/api/recurrences_api.rb', line 215

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

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

List all transactions created by a recurring transaction. List all transactions created by a recurring transaction, optionally limited to the date ranges specified.

Parameters:

  • id (Integer) —

    The ID of the recurring transaction.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

  • :start (Date) —

    A date formatted YYYY-MM-DD. Both the start and end date must be present.

  • :_end (Date) —

    A date formatted YYYY-MM-DD. Both the start and end date must be present.

  • :type (TransactionTypeFilter) —

    Optional filter on the transaction type(s) returned

Returns:

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

    TransactionArray data, response status code and response headers



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

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

#store_recurrence(recurrence, opts = {}) ⇒ RecurrenceSingle

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

Parameters:

  • recurrence (Recurrence) —

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

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

    the optional parameters

Returns:



286
287
288
289
 
# File 'lib/firefly_iii_client/api/recurrences_api.rb', line 286

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

#store_recurrence_with_http_info(recurrence, opts = {}) ⇒ Array<(RecurrenceSingle, Integer, Hash)>

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

Parameters:

  • recurrence (Recurrence) —

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

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

    the optional parameters

Returns:

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

    RecurrenceSingle data, response status code and response headers



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
341
342
343
344
 
# File 'lib/firefly_iii_client/api/recurrences_api.rb', line 296

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

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

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

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

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

#trigger_recurrence(opts = {}) ⇒ nil

Trigger the creation of recurring transactions (like a cron job). Triggers the recurring transactions, like a cron job would. If the schedule does not call for a new transaction to be created, nothing will happen.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


350
351
352
353
 
# File 'lib/firefly_iii_client/api/recurrences_api.rb', line 350

def trigger_recurrence(opts = {})
  trigger_recurrence_with_http_info(opts)
  nil
end

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

Trigger the creation of recurring transactions (like a cron job). Triggers the recurring transactions, like a cron job would. If the schedule does not call for a new transaction to be created, nothing will happen.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def trigger_recurrence_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecurrencesApi.trigger_recurrence ...'
  end
  # resource path
  local_var_path = '/api/v1/recurrences/trigger'

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

#update_recurrence(id, recurrence, opts = {}) ⇒ RecurrenceSingle

Update existing recurring transaction. Update existing recurring transaction.

Parameters:

  • id (Integer) —

    The ID of the recurring transaction.

  • recurrence (Recurrence) —

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

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

    the optional parameters

Returns:



407
408
409
410
 
# File 'lib/firefly_iii_client/api/recurrences_api.rb', line 407

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

#update_recurrence_with_http_info(id, recurrence, opts = {}) ⇒ Array<(RecurrenceSingle, Integer, Hash)>

Update existing recurring transaction. Update existing recurring transaction.

Parameters:

  • id (Integer) —

    The ID of the recurring transaction.

  • recurrence (Recurrence) —

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

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

    the optional parameters

Returns:

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

    RecurrenceSingle data, response status code and response headers



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
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
 
# File 'lib/firefly_iii_client/api/recurrences_api.rb', line 418

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

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

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

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