Class: FattureInCloud_Ruby_Sdk::IssuedDocumentsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IssuedDocumentsApi

Returns a new instance of IssuedDocumentsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_issued_document(company_id, opts = {}) ⇒ CreateIssuedDocumentResponse

Create Issued 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/issued_documents_api.rb', line 28

def create_issued_document(company_id, opts = {})
  data, _status_code, _headers = create_issued_document_with_http_info(company_id, opts)
  data
end

#create_issued_document_with_http_info(company_id, opts = {}) ⇒ Array<(CreateIssuedDocumentResponse, Integer, Hash)>

Create Issued 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/issued_documents_api.rb', line 39

def create_issued_document_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedDocumentsApi.create_issued_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 IssuedDocumentsApi.create_issued_document"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_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'])
  # 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_issued_document_request'])

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

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

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

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

Delete Issued 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/issued_documents_api.rb', line 98

def delete_issued_document(company_id, document_id, opts = {})
  delete_issued_document_with_http_info(company_id, document_id, opts)
  nil
end

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

Delete Issued 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/issued_documents_api.rb', line 165

def delete_issued_document_attachment(company_id, document_id, opts = {})
  delete_issued_document_attachment_with_http_info(company_id, document_id, opts)
  nil
end

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

Delete Issued 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/issued_documents_api.rb', line 176

def delete_issued_document_attachment_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedDocumentsApi.delete_issued_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 IssuedDocumentsApi.delete_issued_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 IssuedDocumentsApi.delete_issued_document_attachment"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_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 => :"IssuedDocumentsApi.delete_issued_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: IssuedDocumentsApi#delete_issued_document_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Issued 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/issued_documents_api.rb', line 109

def delete_issued_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedDocumentsApi.delete_issued_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 IssuedDocumentsApi.delete_issued_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 IssuedDocumentsApi.delete_issued_document"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_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 => :"IssuedDocumentsApi.delete_issued_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: IssuedDocumentsApi#delete_issued_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_data(company_id, document_id, opts = {}) ⇒ GetEmailDataResponse

Get Email Data Gets the pre-compiled email details.

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:



232
233
234
235
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 232

def get_email_data(company_id, document_id, opts = {})
  data, _status_code, _headers = get_email_data_with_http_info(company_id, document_id, opts)
  data
end

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

Get Email Data Gets the pre-compiled email details.

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

    GetEmailDataResponse data, response status code and response headers



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 243

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

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

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

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

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

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

#get_existing_issued_document_totals(company_id, document_id, opts = {}) ⇒ GetExistingIssuedDocumentTotalsResponse

Get Existing Issued Document Totals Returns the totals for a 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:



302
303
304
305
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 302

def get_existing_issued_document_totals(company_id, document_id, opts = {})
  data, _status_code, _headers = get_existing_issued_document_totals_with_http_info(company_id, document_id, opts)
  data
end

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

Get Existing Issued Document Totals Returns the totals for a 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:



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

def get_existing_issued_document_totals_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedDocumentsApi.get_existing_issued_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 IssuedDocumentsApi.get_existing_issued_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 IssuedDocumentsApi.get_existing_issued_document_totals"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_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'])
  # 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_issued_document_totals_request'])

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

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

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

#get_issued_document(company_id, document_id, opts = {}) ⇒ GetIssuedDocumentResponse

Get Issued 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:



379
380
381
382
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 379

def get_issued_document(company_id, document_id, opts = {})
  data, _status_code, _headers = get_issued_document_with_http_info(company_id, document_id, opts)
  data
end

#get_issued_document_pre_create_info(company_id, type, opts = {}) ⇒ GetIssuedDocumentPreCreateInfoResponse

Get Issued 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 issued document.

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

    the optional parameters

Returns:



456
457
458
459
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 456

def get_issued_document_pre_create_info(company_id, type, opts = {})
  data, _status_code, _headers = get_issued_document_pre_create_info_with_http_info(company_id, type, opts)
  data
end

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

Get Issued 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 issued document.

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

    the optional parameters

Returns:



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

def get_issued_document_pre_create_info_with_http_info(company_id, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedDocumentsApi.get_issued_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 IssuedDocumentsApi.get_issued_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 IssuedDocumentsApi.get_issued_document_pre_create_info"
  end
  # verify enum value
  allowable_values = ["invoice", "quote", "proforma", "receipt", "delivery_note", "credit_note", "order", "work_report", "supplier_order", "self_own_invoice", "self_supplier_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}/issued_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'])

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

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

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

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

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

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

Get Issued 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<(GetIssuedDocumentResponse, Integer, Hash)>) —

    GetIssuedDocumentResponse data, response status code and response headers



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

def get_issued_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedDocumentsApi.get_issued_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 IssuedDocumentsApi.get_issued_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 IssuedDocumentsApi.get_issued_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}/issued_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'])

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

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

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

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

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

#get_new_issued_document_totals(company_id, opts = {}) ⇒ GetNewIssuedDocumentTotalsResponse

Get New Issued 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:



531
532
533
534
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 531

def get_new_issued_document_totals(company_id, opts = {})
  data, _status_code, _headers = get_new_issued_document_totals_with_http_info(company_id, opts)
  data
end

#get_new_issued_document_totals_with_http_info(company_id, opts = {}) ⇒ Array<(GetNewIssuedDocumentTotalsResponse, Integer, Hash)>

Get New Issued 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:



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
592
593
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 542

def get_new_issued_document_totals_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedDocumentsApi.get_new_issued_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 IssuedDocumentsApi.get_new_issued_document_totals"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_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'])
  # 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_issued_document_totals_request'])

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

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

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

#list_issued_documents(company_id, type, opts = {}) ⇒ ListIssuedDocumentsResponse

List Issued Documents Lists the issued documents.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • type (String) —

    The type of the issued 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:



607
608
609
610
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 607

def list_issued_documents(company_id, type, opts = {})
  data, _status_code, _headers = list_issued_documents_with_http_info(company_id, type, opts)
  data
end

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

List Issued Documents Lists the issued documents.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • type (String) —

    The type of the issued 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:

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

    ListIssuedDocumentsResponse data, response status code and response headers



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
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 624

def list_issued_documents_with_http_info(company_id, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedDocumentsApi.list_issued_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 IssuedDocumentsApi.list_issued_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 IssuedDocumentsApi.list_issued_documents"
  end
  # verify enum value
  allowable_values = ["invoice", "quote", "proforma", "receipt", "delivery_note", "credit_note", "order", "work_report", "supplier_order", "self_own_invoice", "self_supplier_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
  # resource path
  local_var_path = '/c/{company_id}/issued_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'])

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

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

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

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

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

#modify_issued_document(company_id, document_id, opts = {}) ⇒ ModifyIssuedDocumentResponse

Modify Issued 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:



699
700
701
702
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 699

def modify_issued_document(company_id, document_id, opts = {})
  data, _status_code, _headers = modify_issued_document_with_http_info(company_id, document_id, opts)
  data
end

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

Modify Issued 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:



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
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 711

def modify_issued_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedDocumentsApi.modify_issued_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 IssuedDocumentsApi.modify_issued_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 IssuedDocumentsApi.modify_issued_document"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_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'])
  # 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_issued_document_request'])

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

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

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

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

Schedule Email Schedules the sending of a document by email.

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:

  • (nil) 


775
776
777
778
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 775

def schedule_email(company_id, document_id, opts = {})
  schedule_email_with_http_info(company_id, document_id, opts)
  nil
end

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

Schedule Email Schedules the sending of a document by email.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 787

def schedule_email_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedDocumentsApi.schedule_email ...'
  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 IssuedDocumentsApi.schedule_email"
  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 IssuedDocumentsApi.schedule_email"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_documents/{document_id}/email'.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 '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[:'schedule_email_request'])

  # return_type
  return_type = opts[:debug_return_type]

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

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

#upload_issued_document_attachment(company_id, opts = {}) ⇒ UploadIssuedDocumentAttachmentResponse

Upload Issued Document Attachment Uploads an attachment destined to an issued 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) —

    Name of the file.

  • :attachment (File) —

    Valid format: .png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx

Returns:



849
850
851
852
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 849

def upload_issued_document_attachment(company_id, opts = {})
  data, _status_code, _headers = upload_issued_document_attachment_with_http_info(company_id, opts)
  data
end

#upload_issued_document_attachment_with_http_info(company_id, opts = {}) ⇒ Array<(UploadIssuedDocumentAttachmentResponse, Integer, Hash)>

Upload Issued Document Attachment Uploads an attachment destined to an issued 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) —

    Name of the file.

  • :attachment (File) —

    Valid format: .png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx

Returns:



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
914
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_documents_api.rb', line 861

def upload_issued_document_attachment_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedDocumentsApi.upload_issued_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 IssuedDocumentsApi.upload_issued_document_attachment"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_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'])
  # 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] || 'UploadIssuedDocumentAttachmentResponse'

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

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