cloudmersive-convert-api-client 2.1.3 → 2.1.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +21 -4
  3. data/docs/EditDocumentApi.md +165 -0
  4. data/docs/EditHtmlApi.md +60 -0
  5. data/docs/GetMacrosResponse.md +9 -0
  6. data/docs/HtmlGetLinksResponse.md +9 -0
  7. data/docs/HtmlHyperlink.md +9 -0
  8. data/docs/HtmlSsrfThreatCheckResult.md +10 -0
  9. data/docs/HtmlThreatLink.md +9 -0
  10. data/docs/MergeDocumentApi.md +134 -0
  11. data/docs/ValidateDocumentApi.md +220 -0
  12. data/docs/XxeThreatDetectionResult.md +9 -0
  13. data/docs/ZipArchiveApi.md +62 -0
  14. data/lib/cloudmersive-convert-api-client.rb +6 -0
  15. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +165 -0
  16. data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +55 -0
  17. data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +148 -0
  18. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +220 -0
  19. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +63 -0
  20. data/lib/cloudmersive-convert-api-client/models/get_macros_response.rb +196 -0
  21. data/lib/cloudmersive-convert-api-client/models/html_get_links_response.rb +198 -0
  22. data/lib/cloudmersive-convert-api-client/models/html_hyperlink.rb +196 -0
  23. data/lib/cloudmersive-convert-api-client/models/html_ssrf_threat_check_result.rb +208 -0
  24. data/lib/cloudmersive-convert-api-client/models/html_threat_link.rb +196 -0
  25. data/lib/cloudmersive-convert-api-client/models/xxe_threat_detection_result.rb +196 -0
  26. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  27. data/spec/api/edit_document_api_spec.rb +36 -0
  28. data/spec/api/edit_html_api_spec.rb +14 -0
  29. data/spec/api/merge_document_api_spec.rb +34 -0
  30. data/spec/api/validate_document_api_spec.rb +48 -0
  31. data/spec/api/zip_archive_api_spec.rb +14 -0
  32. data/spec/models/get_macros_response_spec.rb +47 -0
  33. data/spec/models/html_get_links_response_spec.rb +47 -0
  34. data/spec/models/html_hyperlink_spec.rb +47 -0
  35. data/spec/models/html_ssrf_threat_check_result_spec.rb +53 -0
  36. data/spec/models/html_threat_link_spec.rb +47 -0
  37. data/spec/models/xxe_threat_detection_result_spec.rb +47 -0
  38. metadata +20 -2
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::HtmlThreatLink
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **link_url** | **String** | URL of the link | [optional]
7
+ **threat_level** | **String** | Threat assessment level; possible values are None, Low, Medium and High | [optional]
8
+
9
+
@@ -6,6 +6,8 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**merge_document_docx**](MergeDocumentApi.md#merge_document_docx) | **POST** /convert/merge/docx | Merge Two Word DOCX Together
8
8
  [**merge_document_docx_multi**](MergeDocumentApi.md#merge_document_docx_multi) | **POST** /convert/merge/docx/multi | Merge Multple Word DOCX Together
9
+ [**merge_document_html**](MergeDocumentApi.md#merge_document_html) | **POST** /convert/merge/html | Merge Two HTML (HTM) Files Together
10
+ [**merge_document_html_multi**](MergeDocumentApi.md#merge_document_html_multi) | **POST** /convert/merge/html/multi | Merge Multple HTML (HTM) Files Together
9
11
  [**merge_document_pdf**](MergeDocumentApi.md#merge_document_pdf) | **POST** /convert/merge/pdf | Merge Two PDF Files Together
10
12
  [**merge_document_pdf_multi**](MergeDocumentApi.md#merge_document_pdf_multi) | **POST** /convert/merge/pdf/multi | Merge Multple PDF Files Together
11
13
  [**merge_document_png**](MergeDocumentApi.md#merge_document_png) | **POST** /convert/merge/png/vertical | Merge Two PNG Files Together
@@ -150,6 +152,138 @@ Name | Type | Description | Notes
150
152
 
151
153
 
152
154
 
155
+ # **merge_document_html**
156
+ > Object merge_document_html(input_file1, input_file2)
157
+
158
+ Merge Two HTML (HTM) Files Together
159
+
160
+ Combine two HTML (.HTM) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.
161
+
162
+ ### Example
163
+ ```ruby
164
+ # load the gem
165
+ require 'cloudmersive-convert-api-client'
166
+ # setup authorization
167
+ CloudmersiveConvertApiClient.configure do |config|
168
+ # Configure API key authorization: Apikey
169
+ config.api_key['Apikey'] = 'YOUR API KEY'
170
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
171
+ #config.api_key_prefix['Apikey'] = 'Bearer'
172
+ end
173
+
174
+ api_instance = CloudmersiveConvertApiClient::MergeDocumentApi.new
175
+
176
+ input_file1 = File.new('/path/to/file.txt') # File | First input file to perform the operation on.
177
+
178
+ input_file2 = File.new('/path/to/file.txt') # File | Second input file to perform the operation on (more than 2 can be supplied).
179
+
180
+
181
+ begin
182
+ #Merge Two HTML (HTM) Files Together
183
+ result = api_instance.merge_document_html(input_file1, input_file2)
184
+ p result
185
+ rescue CloudmersiveConvertApiClient::ApiError => e
186
+ puts "Exception when calling MergeDocumentApi->merge_document_html: #{e}"
187
+ end
188
+ ```
189
+
190
+ ### Parameters
191
+
192
+ Name | Type | Description | Notes
193
+ ------------- | ------------- | ------------- | -------------
194
+ **input_file1** | **File**| First input file to perform the operation on. |
195
+ **input_file2** | **File**| Second input file to perform the operation on (more than 2 can be supplied). |
196
+
197
+ ### Return type
198
+
199
+ **Object**
200
+
201
+ ### Authorization
202
+
203
+ [Apikey](../README.md#Apikey)
204
+
205
+ ### HTTP request headers
206
+
207
+ - **Content-Type**: multipart/form-data
208
+ - **Accept**: application/octet-stream
209
+
210
+
211
+
212
+ # **merge_document_html_multi**
213
+ > String merge_document_html_multi(input_file1, input_file2, opts)
214
+
215
+ Merge Multple HTML (HTM) Files Together
216
+
217
+ Combine multiple HTML (.HTM) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.
218
+
219
+ ### Example
220
+ ```ruby
221
+ # load the gem
222
+ require 'cloudmersive-convert-api-client'
223
+ # setup authorization
224
+ CloudmersiveConvertApiClient.configure do |config|
225
+ # Configure API key authorization: Apikey
226
+ config.api_key['Apikey'] = 'YOUR API KEY'
227
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
228
+ #config.api_key_prefix['Apikey'] = 'Bearer'
229
+ end
230
+
231
+ api_instance = CloudmersiveConvertApiClient::MergeDocumentApi.new
232
+
233
+ input_file1 = File.new('/path/to/file.txt') # File | First input file to perform the operation on.
234
+
235
+ input_file2 = File.new('/path/to/file.txt') # File | Second input file to perform the operation on.
236
+
237
+ opts = {
238
+ input_file3: File.new('/path/to/file.txt'), # File | Third input file to perform the operation on.
239
+ input_file4: File.new('/path/to/file.txt'), # File | Fourth input file to perform the operation on.
240
+ input_file5: File.new('/path/to/file.txt'), # File | Fifth input file to perform the operation on.
241
+ input_file6: File.new('/path/to/file.txt'), # File | Sixth input file to perform the operation on.
242
+ input_file7: File.new('/path/to/file.txt'), # File | Seventh input file to perform the operation on.
243
+ input_file8: File.new('/path/to/file.txt'), # File | Eighth input file to perform the operation on.
244
+ input_file9: File.new('/path/to/file.txt'), # File | Ninth input file to perform the operation on.
245
+ input_file10: File.new('/path/to/file.txt') # File | Tenth input file to perform the operation on.
246
+ }
247
+
248
+ begin
249
+ #Merge Multple HTML (HTM) Files Together
250
+ result = api_instance.merge_document_html_multi(input_file1, input_file2, opts)
251
+ p result
252
+ rescue CloudmersiveConvertApiClient::ApiError => e
253
+ puts "Exception when calling MergeDocumentApi->merge_document_html_multi: #{e}"
254
+ end
255
+ ```
256
+
257
+ ### Parameters
258
+
259
+ Name | Type | Description | Notes
260
+ ------------- | ------------- | ------------- | -------------
261
+ **input_file1** | **File**| First input file to perform the operation on. |
262
+ **input_file2** | **File**| Second input file to perform the operation on. |
263
+ **input_file3** | **File**| Third input file to perform the operation on. | [optional]
264
+ **input_file4** | **File**| Fourth input file to perform the operation on. | [optional]
265
+ **input_file5** | **File**| Fifth input file to perform the operation on. | [optional]
266
+ **input_file6** | **File**| Sixth input file to perform the operation on. | [optional]
267
+ **input_file7** | **File**| Seventh input file to perform the operation on. | [optional]
268
+ **input_file8** | **File**| Eighth input file to perform the operation on. | [optional]
269
+ **input_file9** | **File**| Ninth input file to perform the operation on. | [optional]
270
+ **input_file10** | **File**| Tenth input file to perform the operation on. | [optional]
271
+
272
+ ### Return type
273
+
274
+ **String**
275
+
276
+ ### Authorization
277
+
278
+ [Apikey](../README.md#Apikey)
279
+
280
+ ### HTTP request headers
281
+
282
+ - **Content-Type**: multipart/form-data
283
+ - **Accept**: application/octet-stream
284
+
285
+
286
+
153
287
  # **merge_document_pdf**
154
288
  > String merge_document_pdf(input_file1, input_file2)
155
289
 
@@ -10,17 +10,21 @@ Method | HTTP request | Description
10
10
  [**validate_document_eml_validation**](ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
11
11
  [**validate_document_executable_validation**](ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
12
12
  [**validate_document_g_zip_validation**](ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)
13
+ [**validate_document_html_ssrf_validation**](ValidateDocumentApi.md#validate_document_html_ssrf_validation) | **POST** /convert/validate/html/ssrf-threat-check | Validate an HTML file and checks for SSRF threats
13
14
  [**validate_document_html_validation**](ValidateDocumentApi.md#validate_document_html_validation) | **POST** /convert/validate/html | Validate an HTML file
14
15
  [**validate_document_image_validation**](ValidateDocumentApi.md#validate_document_image_validation) | **POST** /convert/validate/image | Validate an Image File
16
+ [**validate_document_jpg_validation**](ValidateDocumentApi.md#validate_document_jpg_validation) | **POST** /convert/validate/jpg | Validate a JPG File
15
17
  [**validate_document_json_validation**](ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
16
18
  [**validate_document_msg_validation**](ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
17
19
  [**validate_document_pdf_validation**](ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
20
+ [**validate_document_png_validation**](ValidateDocumentApi.md#validate_document_png_validation) | **POST** /convert/validate/png | Validate a PNG File
18
21
  [**validate_document_pptx_validation**](ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
19
22
  [**validate_document_rar_validation**](ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
20
23
  [**validate_document_tar_validation**](ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
21
24
  [**validate_document_txt_validation**](ValidateDocumentApi.md#validate_document_txt_validation) | **POST** /convert/validate/txt | Validate an TXT file
22
25
  [**validate_document_xlsx_validation**](ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
23
26
  [**validate_document_xml_validation**](ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
27
+ [**validate_document_xml_xxe_threat_validation**](ValidateDocumentApi.md#validate_document_xml_xxe_threat_validation) | **POST** /convert/validate/xml/xxe-threats | Validate an XML file for XML External Entity (XXE) threats
24
28
  [**validate_document_zip_validation**](ValidateDocumentApi.md#validate_document_zip_validation) | **POST** /convert/validate/zip | Validate a Zip Archive file (zip)
25
29
 
26
30
 
@@ -348,6 +352,60 @@ Name | Type | Description | Notes
348
352
 
349
353
 
350
354
 
355
+ # **validate_document_html_ssrf_validation**
356
+ > HtmlSsrfThreatCheckResult validate_document_html_ssrf_validation(input_file)
357
+
358
+ Validate an HTML file and checks for SSRF threats
359
+
360
+ Validate an HTML document file and checks for SSRF (Server-side Request Forgery) threats in the file; if the document is not valid, identifies the errors in the document
361
+
362
+ ### Example
363
+ ```ruby
364
+ # load the gem
365
+ require 'cloudmersive-convert-api-client'
366
+ # setup authorization
367
+ CloudmersiveConvertApiClient.configure do |config|
368
+ # Configure API key authorization: Apikey
369
+ config.api_key['Apikey'] = 'YOUR API KEY'
370
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
371
+ #config.api_key_prefix['Apikey'] = 'Bearer'
372
+ end
373
+
374
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
375
+
376
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
377
+
378
+
379
+ begin
380
+ #Validate an HTML file and checks for SSRF threats
381
+ result = api_instance.validate_document_html_ssrf_validation(input_file)
382
+ p result
383
+ rescue CloudmersiveConvertApiClient::ApiError => e
384
+ puts "Exception when calling ValidateDocumentApi->validate_document_html_ssrf_validation: #{e}"
385
+ end
386
+ ```
387
+
388
+ ### Parameters
389
+
390
+ Name | Type | Description | Notes
391
+ ------------- | ------------- | ------------- | -------------
392
+ **input_file** | **File**| Input file to perform the operation on. |
393
+
394
+ ### Return type
395
+
396
+ [**HtmlSsrfThreatCheckResult**](HtmlSsrfThreatCheckResult.md)
397
+
398
+ ### Authorization
399
+
400
+ [Apikey](../README.md#Apikey)
401
+
402
+ ### HTTP request headers
403
+
404
+ - **Content-Type**: multipart/form-data
405
+ - **Accept**: application/json, text/json, application/xml, text/xml
406
+
407
+
408
+
351
409
  # **validate_document_html_validation**
352
410
  > DocumentValidationResult validate_document_html_validation(input_file)
353
411
 
@@ -456,6 +514,60 @@ Name | Type | Description | Notes
456
514
 
457
515
 
458
516
 
517
+ # **validate_document_jpg_validation**
518
+ > DocumentValidationResult validate_document_jpg_validation(input_file)
519
+
520
+ Validate a JPG File
521
+
522
+ Validate a JPEG image file; if the document is not valid, identifies the errors in the document..
523
+
524
+ ### Example
525
+ ```ruby
526
+ # load the gem
527
+ require 'cloudmersive-convert-api-client'
528
+ # setup authorization
529
+ CloudmersiveConvertApiClient.configure do |config|
530
+ # Configure API key authorization: Apikey
531
+ config.api_key['Apikey'] = 'YOUR API KEY'
532
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
533
+ #config.api_key_prefix['Apikey'] = 'Bearer'
534
+ end
535
+
536
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
537
+
538
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
539
+
540
+
541
+ begin
542
+ #Validate a JPG File
543
+ result = api_instance.validate_document_jpg_validation(input_file)
544
+ p result
545
+ rescue CloudmersiveConvertApiClient::ApiError => e
546
+ puts "Exception when calling ValidateDocumentApi->validate_document_jpg_validation: #{e}"
547
+ end
548
+ ```
549
+
550
+ ### Parameters
551
+
552
+ Name | Type | Description | Notes
553
+ ------------- | ------------- | ------------- | -------------
554
+ **input_file** | **File**| Input file to perform the operation on. |
555
+
556
+ ### Return type
557
+
558
+ [**DocumentValidationResult**](DocumentValidationResult.md)
559
+
560
+ ### Authorization
561
+
562
+ [Apikey](../README.md#Apikey)
563
+
564
+ ### HTTP request headers
565
+
566
+ - **Content-Type**: multipart/form-data
567
+ - **Accept**: application/json, text/json, application/xml, text/xml
568
+
569
+
570
+
459
571
  # **validate_document_json_validation**
460
572
  > DocumentValidationResult validate_document_json_validation(input_file)
461
573
 
@@ -618,6 +730,60 @@ Name | Type | Description | Notes
618
730
 
619
731
 
620
732
 
733
+ # **validate_document_png_validation**
734
+ > DocumentValidationResult validate_document_png_validation(input_file)
735
+
736
+ Validate a PNG File
737
+
738
+ Validate a PNG image file; if the document is not valid, identifies the errors in the document.
739
+
740
+ ### Example
741
+ ```ruby
742
+ # load the gem
743
+ require 'cloudmersive-convert-api-client'
744
+ # setup authorization
745
+ CloudmersiveConvertApiClient.configure do |config|
746
+ # Configure API key authorization: Apikey
747
+ config.api_key['Apikey'] = 'YOUR API KEY'
748
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
749
+ #config.api_key_prefix['Apikey'] = 'Bearer'
750
+ end
751
+
752
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
753
+
754
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
755
+
756
+
757
+ begin
758
+ #Validate a PNG File
759
+ result = api_instance.validate_document_png_validation(input_file)
760
+ p result
761
+ rescue CloudmersiveConvertApiClient::ApiError => e
762
+ puts "Exception when calling ValidateDocumentApi->validate_document_png_validation: #{e}"
763
+ end
764
+ ```
765
+
766
+ ### Parameters
767
+
768
+ Name | Type | Description | Notes
769
+ ------------- | ------------- | ------------- | -------------
770
+ **input_file** | **File**| Input file to perform the operation on. |
771
+
772
+ ### Return type
773
+
774
+ [**DocumentValidationResult**](DocumentValidationResult.md)
775
+
776
+ ### Authorization
777
+
778
+ [Apikey](../README.md#Apikey)
779
+
780
+ ### HTTP request headers
781
+
782
+ - **Content-Type**: multipart/form-data
783
+ - **Accept**: application/json, text/json, application/xml, text/xml
784
+
785
+
786
+
621
787
  # **validate_document_pptx_validation**
622
788
  > DocumentValidationResult validate_document_pptx_validation(input_file)
623
789
 
@@ -942,6 +1108,60 @@ Name | Type | Description | Notes
942
1108
 
943
1109
 
944
1110
 
1111
+ # **validate_document_xml_xxe_threat_validation**
1112
+ > XxeThreatDetectionResult validate_document_xml_xxe_threat_validation(input_file)
1113
+
1114
+ Validate an XML file for XML External Entity (XXE) threats
1115
+
1116
+ Validate an XML document file for XML External Entity (XXE) threats; if the document is not valid, identifies the errors in the document. XXE threats are a type of threat that exploits vulnerabilities in the XML standard relating to external or local entity URIs in XML documents.
1117
+
1118
+ ### Example
1119
+ ```ruby
1120
+ # load the gem
1121
+ require 'cloudmersive-convert-api-client'
1122
+ # setup authorization
1123
+ CloudmersiveConvertApiClient.configure do |config|
1124
+ # Configure API key authorization: Apikey
1125
+ config.api_key['Apikey'] = 'YOUR API KEY'
1126
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1127
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1128
+ end
1129
+
1130
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
1131
+
1132
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1133
+
1134
+
1135
+ begin
1136
+ #Validate an XML file for XML External Entity (XXE) threats
1137
+ result = api_instance.validate_document_xml_xxe_threat_validation(input_file)
1138
+ p result
1139
+ rescue CloudmersiveConvertApiClient::ApiError => e
1140
+ puts "Exception when calling ValidateDocumentApi->validate_document_xml_xxe_threat_validation: #{e}"
1141
+ end
1142
+ ```
1143
+
1144
+ ### Parameters
1145
+
1146
+ Name | Type | Description | Notes
1147
+ ------------- | ------------- | ------------- | -------------
1148
+ **input_file** | **File**| Input file to perform the operation on. |
1149
+
1150
+ ### Return type
1151
+
1152
+ [**XxeThreatDetectionResult**](XxeThreatDetectionResult.md)
1153
+
1154
+ ### Authorization
1155
+
1156
+ [Apikey](../README.md#Apikey)
1157
+
1158
+ ### HTTP request headers
1159
+
1160
+ - **Content-Type**: multipart/form-data
1161
+ - **Accept**: application/json, text/json, application/xml, text/xml
1162
+
1163
+
1164
+
945
1165
  # **validate_document_zip_validation**
946
1166
  > DocumentValidationResult validate_document_zip_validation(input_file)
947
1167
 
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::XxeThreatDetectionResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **contains_xxe_threat** | **BOOLEAN** | True if the XML input contains XXE threats, false otherwise | [optional]
8
+
9
+
@@ -7,6 +7,7 @@ Method | HTTP request | Description
7
7
  [**zip_archive_zip_create**](ZipArchiveApi.md#zip_archive_zip_create) | **POST** /convert/archive/zip/create | Compress files to create a new zip archive
8
8
  [**zip_archive_zip_create_advanced**](ZipArchiveApi.md#zip_archive_zip_create_advanced) | **POST** /convert/archive/zip/create/advanced | Compress files and folders to create a new zip archive with advanced options
9
9
  [**zip_archive_zip_create_encrypted**](ZipArchiveApi.md#zip_archive_zip_create_encrypted) | **POST** /convert/archive/zip/create/encrypted | Compress files to create a new, encrypted and password-protected zip archive
10
+ [**zip_archive_zip_create_quarantine**](ZipArchiveApi.md#zip_archive_zip_create_quarantine) | **POST** /convert/archive/zip/create/quarantine | Create an encrypted zip file to quarantine a dangerous file
10
11
  [**zip_archive_zip_decrypt**](ZipArchiveApi.md#zip_archive_zip_decrypt) | **POST** /convert/archive/zip/decrypt | Decrypt and remove password protection on a zip file
11
12
  [**zip_archive_zip_encrypt_advanced**](ZipArchiveApi.md#zip_archive_zip_encrypt_advanced) | **POST** /convert/archive/zip/encrypt/advanced | Encrypt and password protect a zip file
12
13
  [**zip_archive_zip_extract**](ZipArchiveApi.md#zip_archive_zip_extract) | **POST** /convert/archive/zip/extract | Extract, decompress files and folders from a zip archive
@@ -219,6 +220,67 @@ Name | Type | Description | Notes
219
220
 
220
221
 
221
222
 
223
+ # **zip_archive_zip_create_quarantine**
224
+ > Object zip_archive_zip_create_quarantine(password, input_file1, opts)
225
+
226
+ Create an encrypted zip file to quarantine a dangerous file
227
+
228
+ Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip, for the purposes of quarantining the underlyikng file.
229
+
230
+ ### Example
231
+ ```ruby
232
+ # load the gem
233
+ require 'cloudmersive-convert-api-client'
234
+ # setup authorization
235
+ CloudmersiveConvertApiClient.configure do |config|
236
+ # Configure API key authorization: Apikey
237
+ config.api_key['Apikey'] = 'YOUR API KEY'
238
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
239
+ #config.api_key_prefix['Apikey'] = 'Bearer'
240
+ end
241
+
242
+ api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
243
+
244
+ password = 'password_example' # String | Password to place on the Zip file; the longer the password, the more secure
245
+
246
+ input_file1 = File.new('/path/to/file.txt') # File | First input file to perform the operation on.
247
+
248
+ opts = {
249
+ encryption_algorithm: 'encryption_algorithm_example' # String | Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.
250
+ }
251
+
252
+ begin
253
+ #Create an encrypted zip file to quarantine a dangerous file
254
+ result = api_instance.zip_archive_zip_create_quarantine(password, input_file1, opts)
255
+ p result
256
+ rescue CloudmersiveConvertApiClient::ApiError => e
257
+ puts "Exception when calling ZipArchiveApi->zip_archive_zip_create_quarantine: #{e}"
258
+ end
259
+ ```
260
+
261
+ ### Parameters
262
+
263
+ Name | Type | Description | Notes
264
+ ------------- | ------------- | ------------- | -------------
265
+ **password** | **String**| Password to place on the Zip file; the longer the password, the more secure |
266
+ **input_file1** | **File**| First input file to perform the operation on. |
267
+ **encryption_algorithm** | **String**| Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256. | [optional]
268
+
269
+ ### Return type
270
+
271
+ **Object**
272
+
273
+ ### Authorization
274
+
275
+ [Apikey](../README.md#Apikey)
276
+
277
+ ### HTTP request headers
278
+
279
+ - **Content-Type**: Not defined
280
+ - **Accept**: application/octet-stream
281
+
282
+
283
+
222
284
  # **zip_archive_zip_decrypt**
223
285
  > Object zip_archive_zip_decrypt(input_file, zip_password)
224
286