Class: FattureInCloud_Ruby_Sdk::ArchiveApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ArchiveApi

Returns a new instance of ArchiveApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_archive_document(company_id, opts = {}) ⇒ CreateArchiveDocumentResponse

Create Archive Document Creates a new archive 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/archive_api.rb', line 28

def create_archive_document(company_id, opts = {})
  data, _status_code, _headers = create_archive_document_with_http_info(company_id, opts)
  data
end

#create_archive_document_with_http_info(company_id, opts = {}) ⇒ Array<(CreateArchiveDocumentResponse, Integer, Hash)>

Create Archive Document Creates a new archive 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/archive_api.rb', line 39

def create_archive_document_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchiveApi.create_archive_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 ArchiveApi.create_archive_document"
  end
  # resource path
  local_var_path = '/c/{company_id}/archive'.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_archive_document_request'])

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

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

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

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

Delete Archive Document Deletes the specified archive 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/archive_api.rb', line 98

def delete_archive_document(company_id, document_id, opts = {})
  delete_archive_document_with_http_info(company_id, document_id, opts)
  nil
end

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

Delete Archive Document Deletes the specified archive 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/archive_api.rb', line 109

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

#get_archive_document(company_id, document_id, opts = {}) ⇒ GetArchiveDocumentResponse

Get Archive Document Gets the specified archive 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:



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

def get_archive_document(company_id, document_id, opts = {})
  data, _status_code, _headers = get_archive_document_with_http_info(company_id, document_id, opts)
  data
end

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

Get Archive Document Gets the specified archive 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<(GetArchiveDocumentResponse, Integer, Hash)>) —

    GetArchiveDocumentResponse data, response status code and response headers



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/fattureincloud_ruby_sdk/api/archive_api.rb', line 180

def get_archive_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchiveApi.get_archive_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 ArchiveApi.get_archive_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 ArchiveApi.get_archive_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}/archive/{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] || 'GetArchiveDocumentResponse'

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

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

#list_archive_documents(company_id, opts = {}) ⇒ ListArchiveDocumentsResponse

List Archive Documents Lists the archive documents.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    List of comma-separated fields.

  • :fieldset (String) —

    Name of the fieldset.

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



249
250
251
252
 
# File 'lib/fattureincloud_ruby_sdk/api/archive_api.rb', line 249

def list_archive_documents(company_id, opts = {})
  data, _status_code, _headers = list_archive_documents_with_http_info(company_id, opts)
  data
end

#list_archive_documents_with_http_info(company_id, opts = {}) ⇒ Array<(ListArchiveDocumentsResponse, Integer, Hash)>

List Archive Documents Lists the archive documents.

Parameters:

  • company_id (Integer) —

    The ID of the company.

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    List of comma-separated fields.

  • :fieldset (String) —

    Name of the fieldset.

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



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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/fattureincloud_ruby_sdk/api/archive_api.rb', line 265

def list_archive_documents_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchiveApi.list_archive_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 ArchiveApi.list_archive_documents"
  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 ArchiveApi.list_archive_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 ArchiveApi.list_archive_documents, must be greater than or equal to 1.'
  end

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

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

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

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

#modify_archive_document(company_id, document_id, opts = {}) ⇒ ModifyArchiveDocumentResponse

Modify Archive Document Modifies the specified archive 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:



338
339
340
341
 
# File 'lib/fattureincloud_ruby_sdk/api/archive_api.rb', line 338

def modify_archive_document(company_id, document_id, opts = {})
  data, _status_code, _headers = modify_archive_document_with_http_info(company_id, document_id, opts)
  data
end

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

Modify Archive Document Modifies the specified archive 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:



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/fattureincloud_ruby_sdk/api/archive_api.rb', line 350

def modify_archive_document_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchiveApi.modify_archive_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 ArchiveApi.modify_archive_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 ArchiveApi.modify_archive_document"
  end
  # resource path
  local_var_path = '/c/{company_id}/archive/{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_archive_document_request'])

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

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

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

#upload_archive_document_attachment(company_id, opts = {}) ⇒ UploadArchiveAttachmentResponse

Upload Archive Document Attachment Uploads an attachment destined to an archive 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:



414
415
416
417
 
# File 'lib/fattureincloud_ruby_sdk/api/archive_api.rb', line 414

def upload_archive_document_attachment(company_id, opts = {})
  data, _status_code, _headers = upload_archive_document_attachment_with_http_info(company_id, opts)
  data
end

#upload_archive_document_attachment_with_http_info(company_id, opts = {}) ⇒ Array<(UploadArchiveAttachmentResponse, Integer, Hash)>

Upload Archive Document Attachment Uploads an attachment destined to an archive 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:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/fattureincloud_ruby_sdk/api/archive_api.rb', line 426

def upload_archive_document_attachment_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchiveApi.upload_archive_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 ArchiveApi.upload_archive_document_attachment"
  end
  # resource path
  local_var_path = '/c/{company_id}/archive/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] || 'UploadArchiveAttachmentResponse'

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

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