Class: FireflyIIIClient::BillsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BillsApi

Returns a new instance of BillsApi.



19
20
21
# File 'lib/firefly_iii_client/api/bills_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/firefly_iii_client/api/bills_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

Delete a bill. Delete a bill. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments.

Parameters:

  • id (Integer)

    The ID of the bill.

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

    the optional parameters

Returns:

  • (nil)


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

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

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

Delete a bill. Delete a bill. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments.

Parameters:

  • id (Integer)

    The ID of the bill.

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

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

#get_bill(id, opts = {}) ⇒ BillSingle

Get a single bill. Get a single bill.

Parameters:

  • id (Integer)

    The ID of the bill.

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

    the optional parameters

Options Hash (opts):

  • :start (Date)

    A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.

  • :_end (Date)

    A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.

Returns:



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

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

#get_bill_with_http_info(id, opts = {}) ⇒ Array<(BillSingle, Integer, Hash)>

Get a single bill. Get a single bill.

Parameters:

  • id (Integer)

    The ID of the bill.

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

    the optional parameters

Options Hash (opts):

  • :start (Date)

    A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.

  • :_end (Date)

    A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.

Returns:

  • (Array<(BillSingle, Integer, Hash)>)

    BillSingle data, response status code and response headers



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
148
149
150
# File 'lib/firefly_iii_client/api/bills_api.rb', line 102

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

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

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

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

#list_attachment_by_bill(id, opts = {}) ⇒ AttachmentArray

List all attachments uploaded to the bill. This endpoint will list all attachments linked to the bill.

Parameters:

  • id (Integer)

    The ID of the bill.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    Page number. The default pagination is 50.

Returns:



158
159
160
161
# File 'lib/firefly_iii_client/api/bills_api.rb', line 158

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

#list_attachment_by_bill_with_http_info(id, opts = {}) ⇒ Array<(AttachmentArray, Integer, Hash)>

List all attachments uploaded to the bill. This endpoint will list all attachments linked to the bill.

Parameters:

  • id (Integer)

    The ID of the bill.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    Page number. The default pagination is 50.

Returns:

  • (Array<(AttachmentArray, Integer, Hash)>)

    AttachmentArray data, response status code and response headers



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
215
216
# File 'lib/firefly_iii_client/api/bills_api.rb', line 169

def list_attachment_by_bill_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.list_attachment_by_bill ...'
  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 BillsApi.list_attachment_by_bill"
  end
  # resource path
  local_var_path = '/api/v1/bills/{id}/attachments'.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] || 'AttachmentArray'

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

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

#list_bill(opts = {}) ⇒ BillArray

List all bills. This endpoint will list all the user’s bills.

Parameters:

  • 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. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.

  • :_end (Date)

    A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.

Returns:



225
226
227
228
# File 'lib/firefly_iii_client/api/bills_api.rb', line 225

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

#list_bill_with_http_info(opts = {}) ⇒ Array<(BillArray, Integer, Hash)>

List all bills. This endpoint will list all the user&#39;s bills.

Parameters:

  • 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. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.

  • :_end (Date)

    A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.

Returns:

  • (Array<(BillArray, Integer, Hash)>)

    BillArray data, response status code and response headers



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
280
281
282
# File 'lib/firefly_iii_client/api/bills_api.rb', line 237

def list_bill_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.list_bill ...'
  end
  # resource path
  local_var_path = '/api/v1/bills'

  # 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?

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

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

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

#list_rule_by_bill(id, opts = {}) ⇒ RuleArray

List all rules associated with the bill. This endpoint will list all rules that have an action to set the bill to this bill.

Parameters:

  • id (Integer)

    The ID of the bill.

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

    the optional parameters

Returns:



289
290
291
292
# File 'lib/firefly_iii_client/api/bills_api.rb', line 289

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

#list_rule_by_bill_with_http_info(id, opts = {}) ⇒ Array<(RuleArray, Integer, Hash)>

List all rules associated with the bill. This endpoint will list all rules that have an action to set the bill to this bill.

Parameters:

  • id (Integer)

    The ID of the bill.

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

    the optional parameters

Returns:

  • (Array<(RuleArray, Integer, Hash)>)

    RuleArray data, response status code and response headers



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
345
# File 'lib/firefly_iii_client/api/bills_api.rb', line 299

def list_rule_by_bill_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.list_rule_by_bill ...'
  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 BillsApi.list_rule_by_bill"
  end
  # resource path
  local_var_path = '/api/v1/bills/{id}/rules'.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] || 'RuleArray'

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

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

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

List all transactions associated with the bill. This endpoint will list all transactions linked to this bill.

Parameters:

  • id (Integer)

    The ID of the bill.

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

    the optional parameters

Options Hash (opts):

  • :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:



355
356
357
358
# File 'lib/firefly_iii_client/api/bills_api.rb', line 355

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

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

List all transactions associated with the bill. This endpoint will list all transactions linked to this bill.

Parameters:

  • id (Integer)

    The ID of the bill.

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

    the optional parameters

Options Hash (opts):

  • :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



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
407
408
409
410
411
412
413
414
415
416
417
# File 'lib/firefly_iii_client/api/bills_api.rb', line 368

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

  # query parameters
  query_params = opts[:query_params] || {}
  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 => :"BillsApi.list_transaction_by_bill",
    :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: BillsApi#list_transaction_by_bill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#store_bill(bill, opts = {}) ⇒ BillSingle

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

Parameters:

  • bill (Bill)

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

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

    the optional parameters

Returns:



424
425
426
427
# File 'lib/firefly_iii_client/api/bills_api.rb', line 424

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

#store_bill_with_http_info(bill, opts = {}) ⇒ Array<(BillSingle, Integer, Hash)>

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

Parameters:

  • bill (Bill)

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

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

    the optional parameters

Returns:

  • (Array<(BillSingle, Integer, Hash)>)

    BillSingle data, response status code and response headers



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
471
472
473
474
475
476
477
478
479
480
481
482
# File 'lib/firefly_iii_client/api/bills_api.rb', line 434

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

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

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

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

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

#update_bill(id, bill, opts = {}) ⇒ BillSingle

Update existing bill. Update existing bill.

Parameters:

  • id (Integer)

    The ID of the bill.

  • bill (Bill)

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

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

    the optional parameters

Returns:



490
491
492
493
# File 'lib/firefly_iii_client/api/bills_api.rb', line 490

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

#update_bill_with_http_info(id, bill, opts = {}) ⇒ Array<(BillSingle, Integer, Hash)>

Update existing bill. Update existing bill.

Parameters:

  • id (Integer)

    The ID of the bill.

  • bill (Bill)

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

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

    the optional parameters

Returns:

  • (Array<(BillSingle, Integer, Hash)>)

    BillSingle data, response status code and response headers



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'lib/firefly_iii_client/api/bills_api.rb', line 501

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

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

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

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