Class: FattureInCloud_Ruby_Sdk::ReceiptsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fattureincloud_ruby_sdk/api/receipts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReceiptsApi

Returns a new instance of ReceiptsApi.



19
20
21
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_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/fattureincloud_ruby_sdk/api/receipts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_receipt(company_id, opts = {}) ⇒ CreateReceiptResponse

Create Receipt Creates a new receipt.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

Returns:



28
29
30
31
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 28

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

#create_receipt_with_http_info(company_id, opts = {}) ⇒ Array<(CreateReceiptResponse, Integer, Hash)>

Create Receipt Creates a new receipt.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CreateReceiptResponse data, response status code and response headers



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
82
83
84
85
86
87
88
89
90
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 39

def create_receipt_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceiptsApi.create_receipt ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling ReceiptsApi.create_receipt"
  end
  # resource path
  local_var_path = '/c/{company_id}/receipts'.sub('{' + 'company_id' + '}', CGI.escape(company_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_receipt_request'])

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

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

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

#delete_receipt(company_id, document_id, opts = {}) ⇒ nil

Delete Receipt Deletes the specified receipt.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Returns:

  • (nil) 


98
99
100
101
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 98

def delete_receipt(company_id, document_id, opts = {})
  delete_receipt_with_http_info(company_id, document_id, opts)
  nil
end

#delete_receipt_with_http_info(company_id, document_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Receipt Deletes the specified receipt.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
151
152
153
154
155
156
157
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 109

def delete_receipt_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceiptsApi.delete_receipt ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling ReceiptsApi.delete_receipt"
  end
  # verify the required parameter 'document_id' is set
  if @api_client.config.client_side_validation && document_id.nil?
    fail ArgumentError, "Missing the required parameter 'document_id' when calling ReceiptsApi.delete_receipt"
  end
  # resource path
  local_var_path = '/c/{company_id}/receipts/{document_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'document_id' + '}', CGI.escape(document_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] || ['OAuth2AuthenticationCodeFlow']

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

#get_receipt(company_id, document_id, opts = {}) ⇒ GetReceiptResponse

Get Receipt Gets the specified receipt.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    List of comma-separated fields.

  • :fieldset (String) —

    Name of the fieldset.

Returns:



167
168
169
170
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 167

def get_receipt(company_id, document_id, opts = {})
  data, _status_code, _headers = get_receipt_with_http_info(company_id, document_id, opts)
  data
end

#get_receipt_pre_create_info(company_id, opts = {}) ⇒ GetReceiptPreCreateInfoResponse

Get Receipt Pre-Create Info Retrieves the information useful while creating a new receipt.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Returns:



243
244
245
246
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 243

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

#get_receipt_pre_create_info_with_http_info(company_id, opts = {}) ⇒ Array<(GetReceiptPreCreateInfoResponse, Integer, Hash)>

Get Receipt Pre-Create Info Retrieves the information useful while creating a new receipt.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Returns:



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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 253

def get_receipt_pre_create_info_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceiptsApi.get_receipt_pre_create_info ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling ReceiptsApi.get_receipt_pre_create_info"
  end
  # resource path
  local_var_path = '/c/{company_id}/receipts/info'.sub('{' + 'company_id' + '}', CGI.escape(company_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']) unless header_params['Accept']

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

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

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

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

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

#get_receipt_with_http_info(company_id, document_id, opts = {}) ⇒ Array<(GetReceiptResponse, Integer, Hash)>

Get Receipt Gets the specified receipt.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    List of comma-separated fields.

  • :fieldset (String) —

    Name of the fieldset.

Returns:

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

    GetReceiptResponse data, response status code and response headers



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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 180

def get_receipt_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceiptsApi.get_receipt ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling ReceiptsApi.get_receipt"
  end
  # verify the required parameter 'document_id' is set
  if @api_client.config.client_side_validation && document_id.nil?
    fail ArgumentError, "Missing the required parameter 'document_id' when calling ReceiptsApi.get_receipt"
  end
  allowable_values = ["basic", "detailed"]
  if @api_client.config.client_side_validation && opts[:'fieldset'] && !allowable_values.include?(opts[:'fieldset'])
    fail ArgumentError, "invalid value for \"fieldset\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/c/{company_id}/receipts/{document_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'document_id' + '}', CGI.escape(document_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'fieldset'] = opts[:'fieldset'] if !opts[:'fieldset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

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

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

#get_receipts_monthly_totals(company_id, type, year, opts = {}) ⇒ GetReceiptsMonthlyTotalsResponse

Get Receipts Monthly Totals Returns the monthly totals by year and receipt type.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • type (String) —

    Receipt Type

  • year (String) —

    Year for which you want monthly totals

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

    the optional parameters

Returns:



308
309
310
311
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 308

def get_receipts_monthly_totals(company_id, type, year, opts = {})
  data, _status_code, _headers = get_receipts_monthly_totals_with_http_info(company_id, type, year, opts)
  data
end

#get_receipts_monthly_totals_with_http_info(company_id, type, year, opts = {}) ⇒ Array<(GetReceiptsMonthlyTotalsResponse, Integer, Hash)>

Get Receipts Monthly Totals Returns the monthly totals by year and receipt type.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • type (String) —

    Receipt Type

  • year (String) —

    Year for which you want monthly totals

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

    the optional parameters

Returns:



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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 320

def get_receipts_monthly_totals_with_http_info(company_id, type, year, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceiptsApi.get_receipts_monthly_totals ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling ReceiptsApi.get_receipts_monthly_totals"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling ReceiptsApi.get_receipts_monthly_totals"
  end
  # verify enum value
  allowable_values = ["sales_receipt", "till_receipt"]
  if @api_client.config.client_side_validation && !allowable_values.include?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'year' is set
  if @api_client.config.client_side_validation && year.nil?
    fail ArgumentError, "Missing the required parameter 'year' when calling ReceiptsApi.get_receipts_monthly_totals"
  end
  # resource path
  local_var_path = '/c/{company_id}/receipts/monthly_totals'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

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

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

#list_receipts(company_id, opts = {}) ⇒ ListReceiptsResponse

List Receipts Lists the receipts.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    List of comma-separated fields.

  • :fieldset (String) —

    Name of the fieldset.

  • :page (Integer) —

    The page to retrieve. (default to 1)

  • :per_page (Integer) —

    The size of the page. (default to 5)

  • :sort (String) —

    List of comma-separated fields for result sorting (minus for desc sorting).

  • :q (String) —

    Query for filtering the results.

Returns:



394
395
396
397
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 394

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

#list_receipts_with_http_info(company_id, opts = {}) ⇒ Array<(ListReceiptsResponse, Integer, Hash)>

List Receipts Lists the receipts.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    List of comma-separated fields.

  • :fieldset (String) —

    Name of the fieldset.

  • :page (Integer) —

    The page to retrieve. (default to 1)

  • :per_page (Integer) —

    The size of the page. (default to 5)

  • :sort (String) —

    List of comma-separated fields for result sorting (minus for desc sorting).

  • :q (String) —

    Query for filtering the results.

Returns:

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

    ListReceiptsResponse data, response status code and response headers



410
411
412
413
414
415
416
417
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
471
472
473
474
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 410

def list_receipts_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceiptsApi.list_receipts ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling ReceiptsApi.list_receipts"
  end
  allowable_values = ["basic", "detailed"]
  if @api_client.config.client_side_validation && opts[:'fieldset'] && !allowable_values.include?(opts[:'fieldset'])
    fail ArgumentError, "invalid value for \"fieldset\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling ReceiptsApi.list_receipts, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling ReceiptsApi.list_receipts, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/c/{company_id}/receipts'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'fieldset'] = opts[:'fieldset'] if !opts[:'fieldset'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

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

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

#modify_receipt(company_id, document_id, opts = {}) ⇒ ModifyReceiptResponse

Modify Receipt Modifies the specified receipt.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Options Hash (opts):

Returns:



483
484
485
486
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 483

def modify_receipt(company_id, document_id, opts = {})
  data, _status_code, _headers = modify_receipt_with_http_info(company_id, document_id, opts)
  data
end

#modify_receipt_with_http_info(company_id, document_id, opts = {}) ⇒ Array<(ModifyReceiptResponse, Integer, Hash)>

Modify Receipt Modifies the specified receipt.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ModifyReceiptResponse data, response status code and response headers



495
496
497
498
499
500
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
 
# File 'lib/fattureincloud_ruby_sdk/api/receipts_api.rb', line 495

def modify_receipt_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceiptsApi.modify_receipt ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling ReceiptsApi.modify_receipt"
  end
  # verify the required parameter 'document_id' is set
  if @api_client.config.client_side_validation && document_id.nil?
    fail ArgumentError, "Missing the required parameter 'document_id' when calling ReceiptsApi.modify_receipt"
  end
  # resource path
  local_var_path = '/c/{company_id}/receipts/{document_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'document_id' + '}', CGI.escape(document_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'modify_receipt_request'])

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

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

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