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_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) 


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

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) 


165
166
167
168
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 165

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



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

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] || {}

  # 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



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

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] || {}

  # 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_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:



233
234
235
236
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 233

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:



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

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:



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

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:



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
367
368
369
370
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 319

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



380
381
382
383
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 380

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:



457
458
459
460
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 457

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:



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
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 468

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



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
443
444
445
446
447
448
449
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 393

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"]
  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_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:



538
539
540
541
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 538

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:



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
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 555

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"]
  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:



638
639
640
641
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 638

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:



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 650

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

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



714
715
716
717
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 714

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:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'lib/fattureincloud_ruby_sdk/api/received_documents_api.rb', line 726

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