Class: FattureInCloud_Ruby_Sdk::ReceivedDocumentsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReceivedDocumentsApi

Returns a new instance of ReceivedDocumentsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_received_document(company_id, opts = {}) ⇒ CreateReceivedDocumentResponse

Create Received Document Creates a new document.

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/received_documents_api.rb', line 28

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

#create_received_document_with_http_info(company_id, opts = {}) ⇒ Array<(CreateReceivedDocumentResponse, Integer, Hash)>

Create Received Document Creates a new document.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

Returns:



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/received_documents_api.rb', line 39

def create_received_document_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.create_received_document ...'
  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 ReceivedDocumentsApi.create_received_document"
  end
  # resource path
  local_var_path = '/c/{company_id}/received_documents'.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_received_document_request'])

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

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

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

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

Delete Bin Received Document Delete Bin Received Document

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

def delete_bin_received_document(company_id, document_id, opts = {})
  delete_bin_received_document_with_http_info(company_id, document_id, opts)
  nil
end

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

Delete Bin Received Document Delete Bin Received Document

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
158
159
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 109

def delete_bin_received_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.delete_bin_received_document ...'
  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 ReceivedDocumentsApi.delete_bin_received_document"
  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 ReceivedDocumentsApi.delete_bin_received_document"
  end
  # resource path
  local_var_path = '/c/{company_id}/bin/received_documents/{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']

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

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

Delete Received Document Deletes the specified document.

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) 


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

def delete_received_document(company_id, document_id, opts = {})
  delete_received_document_with_http_info(company_id, document_id, opts)
  nil
end

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

Delete Received Document Attachment Removes the attachment of the specified document.

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) 


236
237
238
239
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 236

def delete_received_document_attachment(company_id, document_id, opts = {})
  delete_received_document_attachment_with_http_info(company_id, document_id, opts)
  nil
end

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

Delete Received Document Attachment Removes the attachment of the specified document.

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



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

def delete_received_document_attachment_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.delete_received_document_attachment ...'
  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 ReceivedDocumentsApi.delete_received_document_attachment"
  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 ReceivedDocumentsApi.delete_received_document_attachment"
  end
  # resource path
  local_var_path = '/c/{company_id}/received_documents/{document_id}/attachment'.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']

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

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

Delete Received Document Deletes the specified document.

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



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
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 178

def delete_received_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.delete_received_document ...'
  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 ReceivedDocumentsApi.delete_received_document"
  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 ReceivedDocumentsApi.delete_received_document"
  end
  # resource path
  local_var_path = '/c/{company_id}/received_documents/{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']

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

#get_bin_received_document(company_id, document_id, opts = {}) ⇒ GetBinReceivedDocumentResponse

Get Bin Received Documents List Get bin issued documents detail

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:



305
306
307
308
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 305

def get_bin_received_document(company_id, document_id, opts = {})
  data, _status_code, _headers = get_bin_received_document_with_http_info(company_id, document_id, opts)
  data
end

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

Get Bin Received Documents List Get bin issued documents detail

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:



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 316

def get_bin_received_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.get_bin_received_document ...'
  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 ReceivedDocumentsApi.get_bin_received_document"
  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 ReceivedDocumentsApi.get_bin_received_document"
  end
  # resource path
  local_var_path = '/c/{company_id}/bin/received_documents/{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']

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

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

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

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

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

#get_existing_received_document_totals(company_id, document_id, opts = {}) ⇒ GetExistingReceivedDocumentTotalsResponse

Get Existing Received Document Totals Returns the totals for the specified document.

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:



375
376
377
378
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 375

def get_existing_received_document_totals(company_id, document_id, opts = {})
  data, _status_code, _headers = get_existing_received_document_totals_with_http_info(company_id, document_id, opts)
  data
end

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

Get Existing Received Document Totals Returns the totals for the specified document.

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:



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 387

def get_existing_received_document_totals_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.get_existing_received_document_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 ReceivedDocumentsApi.get_existing_received_document_totals"
  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 ReceivedDocumentsApi.get_existing_received_document_totals"
  end
  # resource path
  local_var_path = '/c/{company_id}/received_documents/{document_id}/totals'.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[:'get_existing_received_document_totals_request'])

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

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

  new_options = opts.merge(
    :operation => :"ReceivedDocumentsApi.get_existing_received_document_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReceivedDocumentsApi#get_existing_received_document_totals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_new_received_document_totals(company_id, opts = {}) ⇒ GetNewReceivedDocumentTotalsResponse

Get New Received Document Totals Returns the totals for a new document.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

Returns:



450
451
452
453
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 450

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

#get_new_received_document_totals_with_http_info(company_id, opts = {}) ⇒ Array<(GetNewReceivedDocumentTotalsResponse, Integer, Hash)>

Get New Received Document Totals Returns the totals for a new document.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

Returns:



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 461

def get_new_received_document_totals_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.get_new_received_document_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 ReceivedDocumentsApi.get_new_received_document_totals"
  end
  # resource path
  local_var_path = '/c/{company_id}/received_documents/totals'.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[:'get_new_received_document_totals_request'])

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

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

  new_options = opts.merge(
    :operation => :"ReceivedDocumentsApi.get_new_received_document_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReceivedDocumentsApi#get_new_received_document_totals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pending_received_document(company_id, document_id, opts = {}) ⇒ GetPendingReceivedDocumentResponse

Get Pending Received Document Gets the specified pending received document.

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:



522
523
524
525
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 522

def get_pending_received_document(company_id, document_id, opts = {})
  data, _status_code, _headers = get_pending_received_document_with_http_info(company_id, document_id, opts)
  data
end

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

Get Pending Received Document Gets the specified pending received document.

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:



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 535

def get_pending_received_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.get_pending_received_document ...'
  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 ReceivedDocumentsApi.get_pending_received_document"
  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 ReceivedDocumentsApi.get_pending_received_document"
  end
  allowable_values = ["basic", "detailed", "fic_view"]
  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}/received_documents/pending/{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] || 'GetPendingReceivedDocumentResponse'

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

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

#get_received_document(company_id, document_id, opts = {}) ⇒ GetReceivedDocumentResponse

Get Received Document Gets the specified document.

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:



601
602
603
604
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 601

def get_received_document(company_id, document_id, opts = {})
  data, _status_code, _headers = get_received_document_with_http_info(company_id, document_id, opts)
  data
end

#get_received_document_pre_create_info(company_id, type, opts = {}) ⇒ GetReceivedDocumentPreCreateInfoResponse

Get Received Document Pre-Create Info Retrieves the information useful while creating a new document.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • type (String) —

    The type of the received document.

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

    the optional parameters

Returns:



678
679
680
681
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 678

def get_received_document_pre_create_info(company_id, type, opts = {})
  data, _status_code, _headers = get_received_document_pre_create_info_with_http_info(company_id, type, opts)
  data
end

#get_received_document_pre_create_info_with_http_info(company_id, type, opts = {}) ⇒ Array<(GetReceivedDocumentPreCreateInfoResponse, Integer, Hash)>

Get Received Document Pre-Create Info Retrieves the information useful while creating a new document.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • type (String) —

    The type of the received document.

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

    the optional parameters

Returns:



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 689

def get_received_document_pre_create_info_with_http_info(company_id, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.get_received_document_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 ReceivedDocumentsApi.get_received_document_pre_create_info"
  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 ReceivedDocumentsApi.get_received_document_pre_create_info"
  end
  # verify enum value
  allowable_values = ["expense", "passive_credit_note", "passive_delivery_note", "self_invoice"]
  if @api_client.config.client_side_validation && !allowable_values.include?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/c/{company_id}/received_documents/info'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))

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

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

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

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

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

Get Received Document Gets the specified document.

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<(GetReceivedDocumentResponse, Integer, Hash)>) —

    GetReceivedDocumentResponse data, response status code and response headers



614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 614

def get_received_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.get_received_document ...'
  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 ReceivedDocumentsApi.get_received_document"
  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 ReceivedDocumentsApi.get_received_document"
  end
  allowable_values = ["basic", "detailed", "fic_view"]
  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}/received_documents/{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] || 'GetReceivedDocumentResponse'

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

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

#list_bin_received_documents(company_id, opts = {}) ⇒ ListBinReceivedDocuments

Get Bin Received Documents List Get bin Received documents list

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Returns:



752
753
754
755
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 752

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

#list_bin_received_documents_with_http_info(company_id, opts = {}) ⇒ Array<(ListBinReceivedDocuments, Integer, Hash)>

Get Bin Received Documents List Get bin Received documents list

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Returns:

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

    ListBinReceivedDocuments data, response status code and response headers



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 762

def list_bin_received_documents_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.list_bin_received_documents ...'
  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 ReceivedDocumentsApi.list_bin_received_documents"
  end
  # resource path
  local_var_path = '/c/{company_id}/bin/received_documents'.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] || 'ListBinReceivedDocuments'

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

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

#list_pending_received_documents(company_id, type, opts = {}) ⇒ ListPendingReceivedDocumentsResponse

List Pending Received Documents Lists the pending received documents.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • type (String) —

    The type of the pending received document.

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    List of comma-separated fields.

  • :fieldset (String) —

    Name of the fieldset.

  • :sort (String) —

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

  • :page (Integer) —

    The page to retrieve. (default to 1)

  • :per_page (Integer) —

    The size of the page. (default to 5)

  • :q (String) —

    Query for filtering the results.

Returns:



822
823
824
825
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 822

def list_pending_received_documents(company_id, type, opts = {})
  data, _status_code, _headers = list_pending_received_documents_with_http_info(company_id, type, opts)
  data
end

#list_pending_received_documents_with_http_info(company_id, type, opts = {}) ⇒ Array<(ListPendingReceivedDocumentsResponse, Integer, Hash)>

List Pending Received Documents Lists the pending received documents.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • type (String) —

    The type of the pending received document.

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    List of comma-separated fields.

  • :fieldset (String) —

    Name of the fieldset.

  • :sort (String) —

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

  • :page (Integer) —

    The page to retrieve. (default to 1)

  • :per_page (Integer) —

    The size of the page. (default to 5)

  • :q (String) —

    Query for filtering the results.

Returns:



839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 839

def list_pending_received_documents_with_http_info(company_id, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.list_pending_received_documents ...'
  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 ReceivedDocumentsApi.list_pending_received_documents"
  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 ReceivedDocumentsApi.list_pending_received_documents"
  end
  # verify enum value
  allowable_values = ["agyo", "mail", "browser"]
  if @api_client.config.client_side_validation && !allowable_values.include?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  allowable_values = ["basic", "detailed", "fic_view"]
  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 ReceivedDocumentsApi.list_pending_received_documents, 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 ReceivedDocumentsApi.list_pending_received_documents, must be greater than or equal to 1.'
  end

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'type'] = type
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'fieldset'] = opts[:'fieldset'] if !opts[:'fieldset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'ListPendingReceivedDocumentsResponse'

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

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

#list_received_documents(company_id, type, opts = {}) ⇒ ListReceivedDocumentsResponse

List Received Documents Lists the received documents.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • type (String) —

    The type of the received document.

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    List of comma-separated fields.

  • :fieldset (String) —

    Name of the fieldset.

  • :sort (String) —

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

  • :page (Integer) —

    The page to retrieve. (default to 1)

  • :per_page (Integer) —

    The size of the page. (default to 5)

  • :q (String) —

    Query for filtering the results.

Returns:



927
928
929
930
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 927

def list_received_documents(company_id, type, opts = {})
  data, _status_code, _headers = list_received_documents_with_http_info(company_id, type, opts)
  data
end

#list_received_documents_with_http_info(company_id, type, opts = {}) ⇒ Array<(ListReceivedDocumentsResponse, Integer, Hash)>

List Received Documents Lists the received documents.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • type (String) —

    The type of the received document.

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    List of comma-separated fields.

  • :fieldset (String) —

    Name of the fieldset.

  • :sort (String) —

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

  • :page (Integer) —

    The page to retrieve. (default to 1)

  • :per_page (Integer) —

    The size of the page. (default to 5)

  • :q (String) —

    Query for filtering the results.

Returns:



944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 944

def list_received_documents_with_http_info(company_id, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.list_received_documents ...'
  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 ReceivedDocumentsApi.list_received_documents"
  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 ReceivedDocumentsApi.list_received_documents"
  end
  # verify enum value
  allowable_values = ["expense", "passive_credit_note", "passive_delivery_note", "self_invoice"]
  if @api_client.config.client_side_validation && !allowable_values.include?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  allowable_values = ["basic", "detailed", "fic_view"]
  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 ReceivedDocumentsApi.list_received_documents, 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 ReceivedDocumentsApi.list_received_documents, must be greater than or equal to 1.'
  end

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'type'] = type
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'fieldset'] = opts[:'fieldset'] if !opts[:'fieldset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'ListReceivedDocumentsResponse'

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

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

#modify_received_document(company_id, document_id, opts = {}) ⇒ ModifyReceivedDocumentResponse

Modify Received Document Modifies the specified document.

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:



1027
1028
1029
1030
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 1027

def modify_received_document(company_id, document_id, opts = {})
  data, _status_code, _headers = modify_received_document_with_http_info(company_id, document_id, opts)
  data
end

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

Modify Received Document Modifies the specified document.

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:



1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 1039

def modify_received_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.modify_received_document ...'
  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 ReceivedDocumentsApi.modify_received_document"
  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 ReceivedDocumentsApi.modify_received_document"
  end
  # resource path
  local_var_path = '/c/{company_id}/received_documents/{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_received_document_request'])

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

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

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

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

Recover Received Document From The Bin Recover Received Document From The Bin

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) 


1102
1103
1104
1105
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 1102

def recover_bin_received_document(company_id, document_id, opts = {})
  recover_bin_received_document_with_http_info(company_id, document_id, opts)
  nil
end

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

Recover Received Document From The Bin Recover Received Document From The Bin

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



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 1113

def recover_bin_received_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.recover_bin_received_document ...'
  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 ReceivedDocumentsApi.recover_bin_received_document"
  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 ReceivedDocumentsApi.recover_bin_received_document"
  end
  # resource path
  local_var_path = '/c/{company_id}/bin/received_documents/{document_id}/recover'.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']

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

#upload_received_document_attachment(company_id, opts = {}) ⇒ UploadReceivedDocumentAttachmentResponse

Upload Received Document Attachment Uploads an attachment destined to a received document. The actual association between the document and the attachment must be implemented separately, using the returned token.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

  • :filename (String) —

    Attachment file name

  • :attachment (File) —

    Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx]

Returns:



1172
1173
1174
1175
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 1172

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

#upload_received_document_attachment_with_http_info(company_id, opts = {}) ⇒ Array<(UploadReceivedDocumentAttachmentResponse, Integer, Hash)>

Upload Received Document Attachment Uploads an attachment destined to a received document. The actual association between the document and the attachment must be implemented separately, using the returned token.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

  • :filename (String) —

    Attachment file name

  • :attachment (File) —

    Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx]

Returns:



1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 1184

def upload_received_document_attachment_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceivedDocumentsApi.upload_received_document_attachment ...'
  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 ReceivedDocumentsApi.upload_received_document_attachment"
  end
  # resource path
  local_var_path = '/c/{company_id}/received_documents/attachment'.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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['filename'] = opts[:'filename'] if !opts[:'filename'].nil?
  form_params['attachment'] = opts[:'attachment'] if !opts[:'attachment'].nil?

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

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

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

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