cloudmersive-convert-api-client 1.7.4 → 1.7.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -4
  3. data/docs/DocxParagraph.md +1 -1
  4. data/docs/DocxRun.md +1 -1
  5. data/docs/DocxText.md +1 -1
  6. data/docs/EditDocumentApi.md +110 -0
  7. data/docs/FindDocxParagraphRequest.md +11 -0
  8. data/docs/FindDocxParagraphResponse.md +10 -0
  9. data/docs/ReplaceDocxParagraphRequest.md +12 -0
  10. data/docs/ReplaceDocxParagraphResponse.md +9 -0
  11. data/docs/ValidateDocumentApi.md +220 -0
  12. data/docs/ZipArchiveApi.md +144 -5
  13. data/docs/ZipEncryptionAdvancedRequest.md +10 -0
  14. data/lib/cloudmersive-convert-api-client.rb +5 -0
  15. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +110 -0
  16. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +224 -0
  17. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +160 -6
  18. data/lib/cloudmersive-convert-api-client/models/docx_paragraph.rb +1 -1
  19. data/lib/cloudmersive-convert-api-client/models/docx_run.rb +1 -1
  20. data/lib/cloudmersive-convert-api-client/models/docx_text.rb +1 -1
  21. data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_request.rb +235 -0
  22. data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_response.rb +211 -0
  23. data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_request.rb +245 -0
  24. data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_response.rb +199 -0
  25. data/lib/cloudmersive-convert-api-client/models/zip_encryption_advanced_request.rb +225 -0
  26. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  27. data/spec/api/edit_document_api_spec.rb +24 -0
  28. data/spec/api/validate_document_api_spec.rb +48 -0
  29. data/spec/api/zip_archive_api_spec.rb +36 -1
  30. data/spec/models/find_docx_paragraph_request_spec.rb +60 -0
  31. data/spec/models/find_docx_paragraph_response_spec.rb +54 -0
  32. data/spec/models/replace_docx_paragraph_request_spec.rb +66 -0
  33. data/spec/models/replace_docx_paragraph_response_spec.rb +48 -0
  34. data/spec/models/zip_encryption_advanced_request_spec.rb +54 -0
  35. metadata +17 -2
@@ -6,11 +6,13 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
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
+ [**zip_archive_zip_decrypt**](ZipArchiveApi.md#zip_archive_zip_decrypt) | **POST** /convert/archive/zip/decrypt | Decrypt and remove password protection on a zip file
10
+ [**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
9
11
  [**zip_archive_zip_extract**](ZipArchiveApi.md#zip_archive_zip_extract) | **POST** /convert/archive/zip/extract | Extract, decompress files and folders from a zip archive
10
12
 
11
13
 
12
14
  # **zip_archive_zip_create**
13
- > Object zip_archive_zip_create
15
+ > String zip_archive_zip_create(input_file1, opts)
14
16
 
15
17
  Compress files to create a new zip archive
16
18
 
@@ -30,9 +32,23 @@ end
30
32
 
31
33
  api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
32
34
 
35
+ input_file1 = File.new("/path/to/file.txt") # File | First input file to perform the operation on.
36
+
37
+ opts = {
38
+ input_file2: File.new("/path/to/file.txt"), # File | Second input file to perform the operation on.
39
+ input_file3: File.new("/path/to/file.txt"), # File | Third input file to perform the operation on.
40
+ input_file4: File.new("/path/to/file.txt"), # File | Fourth input file to perform the operation on.
41
+ input_file5: File.new("/path/to/file.txt"), # File | Fifth input file to perform the operation on.
42
+ input_file6: File.new("/path/to/file.txt"), # File | Sixth input file to perform the operation on.
43
+ input_file7: File.new("/path/to/file.txt"), # File | Seventh input file to perform the operation on.
44
+ input_file8: File.new("/path/to/file.txt"), # File | Eighth input file to perform the operation on.
45
+ input_file9: File.new("/path/to/file.txt"), # File | Ninth input file to perform the operation on.
46
+ input_file10: File.new("/path/to/file.txt") # File | Tenth input file to perform the operation on.
47
+ }
48
+
33
49
  begin
34
50
  #Compress files to create a new zip archive
35
- result = api_instance.zip_archive_zip_create
51
+ result = api_instance.zip_archive_zip_create(input_file1, opts)
36
52
  p result
37
53
  rescue CloudmersiveConvertApiClient::ApiError => e
38
54
  puts "Exception when calling ZipArchiveApi->zip_archive_zip_create: #{e}"
@@ -40,11 +56,23 @@ end
40
56
  ```
41
57
 
42
58
  ### Parameters
43
- This endpoint does not need any parameter.
59
+
60
+ Name | Type | Description | Notes
61
+ ------------- | ------------- | ------------- | -------------
62
+ **input_file1** | **File**| First input file to perform the operation on. |
63
+ **input_file2** | **File**| Second input file to perform the operation on. | [optional]
64
+ **input_file3** | **File**| Third input file to perform the operation on. | [optional]
65
+ **input_file4** | **File**| Fourth input file to perform the operation on. | [optional]
66
+ **input_file5** | **File**| Fifth input file to perform the operation on. | [optional]
67
+ **input_file6** | **File**| Sixth input file to perform the operation on. | [optional]
68
+ **input_file7** | **File**| Seventh input file to perform the operation on. | [optional]
69
+ **input_file8** | **File**| Eighth input file to perform the operation on. | [optional]
70
+ **input_file9** | **File**| Ninth input file to perform the operation on. | [optional]
71
+ **input_file10** | **File**| Tenth input file to perform the operation on. | [optional]
44
72
 
45
73
  ### Return type
46
74
 
47
- **Object**
75
+ **String**
48
76
 
49
77
  ### Authorization
50
78
 
@@ -52,7 +80,7 @@ This endpoint does not need any parameter.
52
80
 
53
81
  ### HTTP request headers
54
82
 
55
- - **Content-Type**: Not defined
83
+ - **Content-Type**: multipart/form-data
56
84
  - **Accept**: application/octet-stream
57
85
 
58
86
 
@@ -111,6 +139,117 @@ Name | Type | Description | Notes
111
139
 
112
140
 
113
141
 
142
+ # **zip_archive_zip_decrypt**
143
+ > Object zip_archive_zip_decrypt(input_file, zip_password)
144
+
145
+ Decrypt and remove password protection on a zip file
146
+
147
+ Decrypts and removes password protection from an encrypted zip file with the specified password
148
+
149
+ ### Example
150
+ ```ruby
151
+ # load the gem
152
+ require 'cloudmersive-convert-api-client'
153
+ # setup authorization
154
+ CloudmersiveConvertApiClient.configure do |config|
155
+ # Configure API key authorization: Apikey
156
+ config.api_key['Apikey'] = 'YOUR API KEY'
157
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
158
+ #config.api_key_prefix['Apikey'] = 'Bearer'
159
+ end
160
+
161
+ api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
162
+
163
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
164
+
165
+ zip_password = "zip_password_example" # String | Required; Password for the input archive
166
+
167
+
168
+ begin
169
+ #Decrypt and remove password protection on a zip file
170
+ result = api_instance.zip_archive_zip_decrypt(input_file, zip_password)
171
+ p result
172
+ rescue CloudmersiveConvertApiClient::ApiError => e
173
+ puts "Exception when calling ZipArchiveApi->zip_archive_zip_decrypt: #{e}"
174
+ end
175
+ ```
176
+
177
+ ### Parameters
178
+
179
+ Name | Type | Description | Notes
180
+ ------------- | ------------- | ------------- | -------------
181
+ **input_file** | **File**| Input file to perform the operation on. |
182
+ **zip_password** | **String**| Required; Password for the input archive |
183
+
184
+ ### Return type
185
+
186
+ **Object**
187
+
188
+ ### Authorization
189
+
190
+ [Apikey](../README.md#Apikey)
191
+
192
+ ### HTTP request headers
193
+
194
+ - **Content-Type**: multipart/form-data
195
+ - **Accept**: application/json, text/json, application/xml, text/xml
196
+
197
+
198
+
199
+ # **zip_archive_zip_encrypt_advanced**
200
+ > Object zip_archive_zip_encrypt_advanced(encryption_request)
201
+
202
+ Encrypt and password protect a zip file
203
+
204
+ Encrypts and password protects an existing zip file with the specified password and encryption algorithm
205
+
206
+ ### Example
207
+ ```ruby
208
+ # load the gem
209
+ require 'cloudmersive-convert-api-client'
210
+ # setup authorization
211
+ CloudmersiveConvertApiClient.configure do |config|
212
+ # Configure API key authorization: Apikey
213
+ config.api_key['Apikey'] = 'YOUR API KEY'
214
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
215
+ #config.api_key_prefix['Apikey'] = 'Bearer'
216
+ end
217
+
218
+ api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
219
+
220
+ encryption_request = CloudmersiveConvertApiClient::ZipEncryptionAdvancedRequest.new # ZipEncryptionAdvancedRequest | Encryption request
221
+
222
+
223
+ begin
224
+ #Encrypt and password protect a zip file
225
+ result = api_instance.zip_archive_zip_encrypt_advanced(encryption_request)
226
+ p result
227
+ rescue CloudmersiveConvertApiClient::ApiError => e
228
+ puts "Exception when calling ZipArchiveApi->zip_archive_zip_encrypt_advanced: #{e}"
229
+ end
230
+ ```
231
+
232
+ ### Parameters
233
+
234
+ Name | Type | Description | Notes
235
+ ------------- | ------------- | ------------- | -------------
236
+ **encryption_request** | [**ZipEncryptionAdvancedRequest**](ZipEncryptionAdvancedRequest.md)| Encryption request |
237
+
238
+ ### Return type
239
+
240
+ **Object**
241
+
242
+ ### Authorization
243
+
244
+ [Apikey](../README.md#Apikey)
245
+
246
+ ### HTTP request headers
247
+
248
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
249
+ - **Accept**: application/json, text/json, application/xml, text/xml
250
+
251
+
252
+
114
253
  # **zip_archive_zip_extract**
115
254
  > ZipExtractResponse zip_archive_zip_extract(input_file)
116
255
 
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::ZipEncryptionAdvancedRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_file_contents** | **String** | Input Zip File archive contents in bytes | [optional]
7
+ **password** | **String** | Password to place on the Zip file; the longer the password, the more secure | [optional]
8
+ **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]
9
+
10
+
@@ -81,6 +81,8 @@ require 'cloudmersive-convert-api-client/models/docx_top_level_comment'
81
81
  require 'cloudmersive-convert-api-client/models/enable_shared_workbook_request'
82
82
  require 'cloudmersive-convert-api-client/models/enable_shared_workbook_response'
83
83
  require 'cloudmersive-convert-api-client/models/exif_value'
84
+ require 'cloudmersive-convert-api-client/models/find_docx_paragraph_request'
85
+ require 'cloudmersive-convert-api-client/models/find_docx_paragraph_response'
84
86
  require 'cloudmersive-convert-api-client/models/find_regex_match'
85
87
  require 'cloudmersive-convert-api-client/models/find_string_match'
86
88
  require 'cloudmersive-convert-api-client/models/find_string_regex_request'
@@ -164,6 +166,8 @@ require 'cloudmersive-convert-api-client/models/remove_pptx_slides_request'
164
166
  require 'cloudmersive-convert-api-client/models/remove_whitespace_from_text_request'
165
167
  require 'cloudmersive-convert-api-client/models/remove_whitespace_from_text_response'
166
168
  require 'cloudmersive-convert-api-client/models/remove_xlsx_worksheet_request'
169
+ require 'cloudmersive-convert-api-client/models/replace_docx_paragraph_request'
170
+ require 'cloudmersive-convert-api-client/models/replace_docx_paragraph_response'
167
171
  require 'cloudmersive-convert-api-client/models/replace_string_regex_request'
168
172
  require 'cloudmersive-convert-api-client/models/replace_string_regex_response'
169
173
  require 'cloudmersive-convert-api-client/models/replace_string_request'
@@ -212,6 +216,7 @@ require 'cloudmersive-convert-api-client/models/xml_remove_with_x_path_result'
212
216
  require 'cloudmersive-convert-api-client/models/xml_replace_with_x_path_result'
213
217
  require 'cloudmersive-convert-api-client/models/xml_set_value_with_x_path_result'
214
218
  require 'cloudmersive-convert-api-client/models/zip_directory'
219
+ require 'cloudmersive-convert-api-client/models/zip_encryption_advanced_request'
215
220
  require 'cloudmersive-convert-api-client/models/zip_extract_response'
216
221
  require 'cloudmersive-convert-api-client/models/zip_file'
217
222
 
@@ -351,6 +351,61 @@ module CloudmersiveConvertApiClient
351
351
  return data, status_code, headers
352
352
  end
353
353
 
354
+ # Find matching paragraphs in a Word DOCX document
355
+ # Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria
356
+ # @param req_config Document input request
357
+ # @param [Hash] opts the optional parameters
358
+ # @return [FindDocxParagraphResponse]
359
+ def edit_document_docx_find_paragraph(req_config, opts = {})
360
+ data, _status_code, _headers = edit_document_docx_find_paragraph_with_http_info(req_config, opts)
361
+ return data
362
+ end
363
+
364
+ # Find matching paragraphs in a Word DOCX document
365
+ # Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria
366
+ # @param req_config Document input request
367
+ # @param [Hash] opts the optional parameters
368
+ # @return [Array<(FindDocxParagraphResponse, Fixnum, Hash)>] FindDocxParagraphResponse data, response status code and response headers
369
+ def edit_document_docx_find_paragraph_with_http_info(req_config, opts = {})
370
+ if @api_client.config.debugging
371
+ @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_find_paragraph ..."
372
+ end
373
+ # verify the required parameter 'req_config' is set
374
+ if @api_client.config.client_side_validation && req_config.nil?
375
+ fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_find_paragraph"
376
+ end
377
+ # resource path
378
+ local_var_path = "/convert/edit/docx/find/paragraph"
379
+
380
+ # query parameters
381
+ query_params = {}
382
+
383
+ # header parameters
384
+ header_params = {}
385
+ # HTTP header 'Accept' (if needed)
386
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
387
+ # HTTP header 'Content-Type'
388
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
389
+
390
+ # form parameters
391
+ form_params = {}
392
+
393
+ # http body (model)
394
+ post_body = @api_client.object_to_http_body(req_config)
395
+ auth_names = ['Apikey']
396
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
397
+ :header_params => header_params,
398
+ :query_params => query_params,
399
+ :form_params => form_params,
400
+ :body => post_body,
401
+ :auth_names => auth_names,
402
+ :return_type => 'FindDocxParagraphResponse')
403
+ if @api_client.config.debugging
404
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_find_paragraph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
405
+ end
406
+ return data, status_code, headers
407
+ end
408
+
354
409
  # Get comments from a Word DOCX document as a flat list
355
410
  # Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).
356
411
  # @param req_config Document input request
@@ -1341,6 +1396,61 @@ module CloudmersiveConvertApiClient
1341
1396
  return data, status_code, headers
1342
1397
  end
1343
1398
 
1399
+ # Replace matching paragraphs in a Word DOCX document
1400
+ # Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested. Replace a paragraph with another object such as an image. Useful for performing templating operations.
1401
+ # @param req_config Document input request
1402
+ # @param [Hash] opts the optional parameters
1403
+ # @return [ReplaceDocxParagraphResponse]
1404
+ def edit_document_docx_replace_paragraph(req_config, opts = {})
1405
+ data, _status_code, _headers = edit_document_docx_replace_paragraph_with_http_info(req_config, opts)
1406
+ return data
1407
+ end
1408
+
1409
+ # Replace matching paragraphs in a Word DOCX document
1410
+ # Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested. Replace a paragraph with another object such as an image. Useful for performing templating operations.
1411
+ # @param req_config Document input request
1412
+ # @param [Hash] opts the optional parameters
1413
+ # @return [Array<(ReplaceDocxParagraphResponse, Fixnum, Hash)>] ReplaceDocxParagraphResponse data, response status code and response headers
1414
+ def edit_document_docx_replace_paragraph_with_http_info(req_config, opts = {})
1415
+ if @api_client.config.debugging
1416
+ @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_replace_paragraph ..."
1417
+ end
1418
+ # verify the required parameter 'req_config' is set
1419
+ if @api_client.config.client_side_validation && req_config.nil?
1420
+ fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_replace_paragraph"
1421
+ end
1422
+ # resource path
1423
+ local_var_path = "/convert/edit/docx/replace/paragraph"
1424
+
1425
+ # query parameters
1426
+ query_params = {}
1427
+
1428
+ # header parameters
1429
+ header_params = {}
1430
+ # HTTP header 'Accept' (if needed)
1431
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
1432
+ # HTTP header 'Content-Type'
1433
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
1434
+
1435
+ # form parameters
1436
+ form_params = {}
1437
+
1438
+ # http body (model)
1439
+ post_body = @api_client.object_to_http_body(req_config)
1440
+ auth_names = ['Apikey']
1441
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1442
+ :header_params => header_params,
1443
+ :query_params => query_params,
1444
+ :form_params => form_params,
1445
+ :body => post_body,
1446
+ :auth_names => auth_names,
1447
+ :return_type => 'ReplaceDocxParagraphResponse')
1448
+ if @api_client.config.debugging
1449
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_replace_paragraph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1450
+ end
1451
+ return data, status_code, headers
1452
+ end
1453
+
1344
1454
  # Set the footer in a Word DOCX document
1345
1455
  # Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
1346
1456
  # @param req_config Document input request
@@ -188,6 +188,62 @@ module CloudmersiveConvertApiClient
188
188
  return data, status_code, headers
189
189
  end
190
190
 
191
+ # Validate a GZip Archive file (gzip or gz)
192
+ # Validate a GZip archive file (GZIP or GZ)
193
+ # @param input_file Input file to perform the operation on.
194
+ # @param [Hash] opts the optional parameters
195
+ # @return [DocumentValidationResult]
196
+ def validate_document_g_zip_validation(input_file, opts = {})
197
+ data, _status_code, _headers = validate_document_g_zip_validation_with_http_info(input_file, opts)
198
+ return data
199
+ end
200
+
201
+ # Validate a GZip Archive file (gzip or gz)
202
+ # Validate a GZip archive file (GZIP or GZ)
203
+ # @param input_file Input file to perform the operation on.
204
+ # @param [Hash] opts the optional parameters
205
+ # @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
206
+ def validate_document_g_zip_validation_with_http_info(input_file, opts = {})
207
+ if @api_client.config.debugging
208
+ @api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_g_zip_validation ..."
209
+ end
210
+ # verify the required parameter 'input_file' is set
211
+ if @api_client.config.client_side_validation && input_file.nil?
212
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_g_zip_validation"
213
+ end
214
+ # resource path
215
+ local_var_path = "/convert/validate/gzip"
216
+
217
+ # query parameters
218
+ query_params = {}
219
+
220
+ # header parameters
221
+ header_params = {}
222
+ # HTTP header 'Accept' (if needed)
223
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
224
+ # HTTP header 'Content-Type'
225
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
226
+
227
+ # form parameters
228
+ form_params = {}
229
+ form_params["inputFile"] = input_file
230
+
231
+ # http body (model)
232
+ post_body = nil
233
+ auth_names = ['Apikey']
234
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
235
+ :header_params => header_params,
236
+ :query_params => query_params,
237
+ :form_params => form_params,
238
+ :body => post_body,
239
+ :auth_names => auth_names,
240
+ :return_type => 'DocumentValidationResult')
241
+ if @api_client.config.debugging
242
+ @api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_g_zip_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
243
+ end
244
+ return data, status_code, headers
245
+ end
246
+
191
247
  # Validate a JSON file
192
248
  # Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document
193
249
  # @param input_file Input file to perform the operation on.
@@ -356,6 +412,118 @@ module CloudmersiveConvertApiClient
356
412
  return data, status_code, headers
357
413
  end
358
414
 
415
+ # Validate a RAR Archive file (RAR)
416
+ # Validate a RAR archive file (RAR)
417
+ # @param input_file Input file to perform the operation on.
418
+ # @param [Hash] opts the optional parameters
419
+ # @return [DocumentValidationResult]
420
+ def validate_document_rar_validation(input_file, opts = {})
421
+ data, _status_code, _headers = validate_document_rar_validation_with_http_info(input_file, opts)
422
+ return data
423
+ end
424
+
425
+ # Validate a RAR Archive file (RAR)
426
+ # Validate a RAR archive file (RAR)
427
+ # @param input_file Input file to perform the operation on.
428
+ # @param [Hash] opts the optional parameters
429
+ # @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
430
+ def validate_document_rar_validation_with_http_info(input_file, opts = {})
431
+ if @api_client.config.debugging
432
+ @api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_rar_validation ..."
433
+ end
434
+ # verify the required parameter 'input_file' is set
435
+ if @api_client.config.client_side_validation && input_file.nil?
436
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_rar_validation"
437
+ end
438
+ # resource path
439
+ local_var_path = "/convert/validate/rar"
440
+
441
+ # query parameters
442
+ query_params = {}
443
+
444
+ # header parameters
445
+ header_params = {}
446
+ # HTTP header 'Accept' (if needed)
447
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
448
+ # HTTP header 'Content-Type'
449
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
450
+
451
+ # form parameters
452
+ form_params = {}
453
+ form_params["inputFile"] = input_file
454
+
455
+ # http body (model)
456
+ post_body = nil
457
+ auth_names = ['Apikey']
458
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
459
+ :header_params => header_params,
460
+ :query_params => query_params,
461
+ :form_params => form_params,
462
+ :body => post_body,
463
+ :auth_names => auth_names,
464
+ :return_type => 'DocumentValidationResult')
465
+ if @api_client.config.debugging
466
+ @api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_rar_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
467
+ end
468
+ return data, status_code, headers
469
+ end
470
+
471
+ # Validate a TAR Tarball Archive file (TAR)
472
+ # Validate a TAR tarball archive file (TAR)
473
+ # @param input_file Input file to perform the operation on.
474
+ # @param [Hash] opts the optional parameters
475
+ # @return [DocumentValidationResult]
476
+ def validate_document_tar_validation(input_file, opts = {})
477
+ data, _status_code, _headers = validate_document_tar_validation_with_http_info(input_file, opts)
478
+ return data
479
+ end
480
+
481
+ # Validate a TAR Tarball Archive file (TAR)
482
+ # Validate a TAR tarball archive file (TAR)
483
+ # @param input_file Input file to perform the operation on.
484
+ # @param [Hash] opts the optional parameters
485
+ # @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
486
+ def validate_document_tar_validation_with_http_info(input_file, opts = {})
487
+ if @api_client.config.debugging
488
+ @api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_tar_validation ..."
489
+ end
490
+ # verify the required parameter 'input_file' is set
491
+ if @api_client.config.client_side_validation && input_file.nil?
492
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_tar_validation"
493
+ end
494
+ # resource path
495
+ local_var_path = "/convert/validate/tar"
496
+
497
+ # query parameters
498
+ query_params = {}
499
+
500
+ # header parameters
501
+ header_params = {}
502
+ # HTTP header 'Accept' (if needed)
503
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
504
+ # HTTP header 'Content-Type'
505
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
506
+
507
+ # form parameters
508
+ form_params = {}
509
+ form_params["inputFile"] = input_file
510
+
511
+ # http body (model)
512
+ post_body = nil
513
+ auth_names = ['Apikey']
514
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
515
+ :header_params => header_params,
516
+ :query_params => query_params,
517
+ :form_params => form_params,
518
+ :body => post_body,
519
+ :auth_names => auth_names,
520
+ :return_type => 'DocumentValidationResult')
521
+ if @api_client.config.debugging
522
+ @api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_tar_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
523
+ end
524
+ return data, status_code, headers
525
+ end
526
+
359
527
  # Validate a Excel document (XLSX)
360
528
  # Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document
361
529
  # @param input_file Input file to perform the operation on.
@@ -467,5 +635,61 @@ module CloudmersiveConvertApiClient
467
635
  end
468
636
  return data, status_code, headers
469
637
  end
638
+
639
+ # Validate a Zip Archive file (zip)
640
+ # Validate a Zip archive file (ZIP)
641
+ # @param input_file Input file to perform the operation on.
642
+ # @param [Hash] opts the optional parameters
643
+ # @return [DocumentValidationResult]
644
+ def validate_document_zip_validation(input_file, opts = {})
645
+ data, _status_code, _headers = validate_document_zip_validation_with_http_info(input_file, opts)
646
+ return data
647
+ end
648
+
649
+ # Validate a Zip Archive file (zip)
650
+ # Validate a Zip archive file (ZIP)
651
+ # @param input_file Input file to perform the operation on.
652
+ # @param [Hash] opts the optional parameters
653
+ # @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
654
+ def validate_document_zip_validation_with_http_info(input_file, opts = {})
655
+ if @api_client.config.debugging
656
+ @api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_zip_validation ..."
657
+ end
658
+ # verify the required parameter 'input_file' is set
659
+ if @api_client.config.client_side_validation && input_file.nil?
660
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_zip_validation"
661
+ end
662
+ # resource path
663
+ local_var_path = "/convert/validate/zip"
664
+
665
+ # query parameters
666
+ query_params = {}
667
+
668
+ # header parameters
669
+ header_params = {}
670
+ # HTTP header 'Accept' (if needed)
671
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
672
+ # HTTP header 'Content-Type'
673
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
674
+
675
+ # form parameters
676
+ form_params = {}
677
+ form_params["inputFile"] = input_file
678
+
679
+ # http body (model)
680
+ post_body = nil
681
+ auth_names = ['Apikey']
682
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
683
+ :header_params => header_params,
684
+ :query_params => query_params,
685
+ :form_params => form_params,
686
+ :body => post_body,
687
+ :auth_names => auth_names,
688
+ :return_type => 'DocumentValidationResult')
689
+ if @api_client.config.debugging
690
+ @api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_zip_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
691
+ end
692
+ return data, status_code, headers
693
+ end
470
694
  end
471
695
  end