cloudmersive-convert-api-client 1.7.3 → 1.7.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +45 -5
- data/docs/AutodetectToThumbnailsResult.md +9 -0
- data/docs/ConvertDataApi.md +6 -2
- data/docs/ConvertDocumentApi.md +794 -84
- data/docs/CsvCollection.md +10 -0
- data/docs/CsvFileResult.md +9 -0
- data/docs/DocumentValidationResult.md +1 -0
- data/docs/DocxParagraph.md +1 -1
- data/docs/DocxRun.md +1 -1
- data/docs/DocxText.md +1 -1
- data/docs/DocxToPngResult.md +9 -0
- data/docs/EditDocumentApi.md +110 -0
- data/docs/EmlAttachment.md +9 -0
- data/docs/EmlToHtmlResult.md +16 -0
- data/docs/FindDocxParagraphRequest.md +11 -0
- data/docs/FindDocxParagraphResponse.md +10 -0
- data/docs/GetFileTypeIconResult.md +10 -0
- data/docs/MsgAttachment.md +9 -0
- data/docs/MsgToHtmlResult.md +16 -0
- data/docs/PptxToPngResult.md +9 -0
- data/docs/ReplaceDocxParagraphRequest.md +12 -0
- data/docs/ReplaceDocxParagraphResponse.md +9 -0
- data/docs/Thumbnail.md +9 -0
- data/docs/ValidateDocumentApi.md +386 -1
- data/docs/XlsxToPngResult.md +9 -0
- data/docs/ZipArchiveApi.md +144 -5
- data/docs/ZipEncryptionAdvancedRequest.md +10 -0
- data/lib/cloudmersive-convert-api-client.rb +17 -0
- data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +3 -0
- data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +722 -6
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +110 -0
- data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +394 -2
- data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +160 -6
- data/lib/cloudmersive-convert-api-client/models/autodetect_to_thumbnails_result.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/csv_collection.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/csv_file_result.rb +215 -0
- data/lib/cloudmersive-convert-api-client/models/document_validation_result.rb +11 -1
- data/lib/cloudmersive-convert-api-client/models/docx_paragraph.rb +1 -1
- data/lib/cloudmersive-convert-api-client/models/docx_run.rb +1 -1
- data/lib/cloudmersive-convert-api-client/models/docx_text.rb +1 -1
- data/lib/cloudmersive-convert-api-client/models/docx_to_png_result.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/eml_attachment.rb +215 -0
- data/lib/cloudmersive-convert-api-client/models/eml_to_html_result.rb +271 -0
- data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_request.rb +235 -0
- data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_response.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_file_type_icon_result.rb +225 -0
- data/lib/cloudmersive-convert-api-client/models/msg_attachment.rb +215 -0
- data/lib/cloudmersive-convert-api-client/models/msg_to_html_result.rb +271 -0
- data/lib/cloudmersive-convert-api-client/models/pptx_to_png_result.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_request.rb +245 -0
- data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/thumbnail.rb +215 -0
- data/lib/cloudmersive-convert-api-client/models/xlsx_to_png_result.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/zip_encryption_advanced_request.rb +225 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/convert_data_api_spec.rb +1 -0
- data/spec/api/convert_document_api_spec.rb +163 -3
- data/spec/api/edit_document_api_spec.rb +24 -0
- data/spec/api/validate_document_api_spec.rb +85 -1
- data/spec/api/zip_archive_api_spec.rb +36 -1
- data/spec/models/autodetect_to_thumbnails_result_spec.rb +48 -0
- data/spec/models/csv_collection_spec.rb +54 -0
- data/spec/models/csv_file_result_spec.rb +48 -0
- data/spec/models/document_validation_result_spec.rb +6 -0
- data/spec/models/docx_to_png_result_spec.rb +48 -0
- data/spec/models/eml_attachment_spec.rb +48 -0
- data/spec/models/eml_to_html_result_spec.rb +90 -0
- data/spec/models/find_docx_paragraph_request_spec.rb +60 -0
- data/spec/models/find_docx_paragraph_response_spec.rb +54 -0
- data/spec/models/get_file_type_icon_result_spec.rb +54 -0
- data/spec/models/msg_attachment_spec.rb +48 -0
- data/spec/models/msg_to_html_result_spec.rb +90 -0
- data/spec/models/pptx_to_png_result_spec.rb +48 -0
- data/spec/models/replace_docx_paragraph_request_spec.rb +66 -0
- data/spec/models/replace_docx_paragraph_response_spec.rb +48 -0
- data/spec/models/thumbnail_spec.rb +48 -0
- data/spec/models/xlsx_to_png_result_spec.rb +48 -0
- data/spec/models/zip_encryption_advanced_request_spec.rb +54 -0
- metadata +53 -2
@@ -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
|
@@ -76,6 +76,62 @@ module CloudmersiveConvertApiClient
|
|
76
76
|
return data, status_code, headers
|
77
77
|
end
|
78
78
|
|
79
|
+
# Validate a CSV file document (CSV)
|
80
|
+
# Validate a CSV file document (CSV); if the document is not valid, identifies the errors in the document
|
81
|
+
# @param input_file Input file to perform the operation on.
|
82
|
+
# @param [Hash] opts the optional parameters
|
83
|
+
# @return [DocumentValidationResult]
|
84
|
+
def validate_document_csv_validation(input_file, opts = {})
|
85
|
+
data, _status_code, _headers = validate_document_csv_validation_with_http_info(input_file, opts)
|
86
|
+
return data
|
87
|
+
end
|
88
|
+
|
89
|
+
# Validate a CSV file document (CSV)
|
90
|
+
# Validate a CSV file document (CSV); if the document is not valid, identifies the errors in the document
|
91
|
+
# @param input_file Input file to perform the operation on.
|
92
|
+
# @param [Hash] opts the optional parameters
|
93
|
+
# @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
|
94
|
+
def validate_document_csv_validation_with_http_info(input_file, opts = {})
|
95
|
+
if @api_client.config.debugging
|
96
|
+
@api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_csv_validation ..."
|
97
|
+
end
|
98
|
+
# verify the required parameter 'input_file' is set
|
99
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
100
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_csv_validation"
|
101
|
+
end
|
102
|
+
# resource path
|
103
|
+
local_var_path = "/convert/validate/csv"
|
104
|
+
|
105
|
+
# query parameters
|
106
|
+
query_params = {}
|
107
|
+
|
108
|
+
# header parameters
|
109
|
+
header_params = {}
|
110
|
+
# HTTP header 'Accept' (if needed)
|
111
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
112
|
+
# HTTP header 'Content-Type'
|
113
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
114
|
+
|
115
|
+
# form parameters
|
116
|
+
form_params = {}
|
117
|
+
form_params["inputFile"] = input_file
|
118
|
+
|
119
|
+
# http body (model)
|
120
|
+
post_body = nil
|
121
|
+
auth_names = ['Apikey']
|
122
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
123
|
+
:header_params => header_params,
|
124
|
+
:query_params => query_params,
|
125
|
+
:form_params => form_params,
|
126
|
+
:body => post_body,
|
127
|
+
:auth_names => auth_names,
|
128
|
+
:return_type => 'DocumentValidationResult')
|
129
|
+
if @api_client.config.debugging
|
130
|
+
@api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_csv_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
131
|
+
end
|
132
|
+
return data, status_code, headers
|
133
|
+
end
|
134
|
+
|
79
135
|
# Validate a Word document (DOCX)
|
80
136
|
# Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document
|
81
137
|
# @param input_file Input file to perform the operation on.
|
@@ -132,6 +188,62 @@ module CloudmersiveConvertApiClient
|
|
132
188
|
return data, status_code, headers
|
133
189
|
end
|
134
190
|
|
191
|
+
# Validate if an EML file is executable
|
192
|
+
# Validate if an input file is an EML email file; if the document is not valid
|
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_eml_validation(input_file, opts = {})
|
197
|
+
data, _status_code, _headers = validate_document_eml_validation_with_http_info(input_file, opts)
|
198
|
+
return data
|
199
|
+
end
|
200
|
+
|
201
|
+
# Validate if an EML file is executable
|
202
|
+
# Validate if an input file is an EML email file; if the document is not valid
|
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_eml_validation_with_http_info(input_file, opts = {})
|
207
|
+
if @api_client.config.debugging
|
208
|
+
@api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_eml_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_eml_validation"
|
213
|
+
end
|
214
|
+
# resource path
|
215
|
+
local_var_path = "/convert/validate/eml"
|
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_eml_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
243
|
+
end
|
244
|
+
return data, status_code, headers
|
245
|
+
end
|
246
|
+
|
135
247
|
# Validate if a file is executable
|
136
248
|
# Validate if an input file is a binary executable file; if the document is not valid
|
137
249
|
# @param input_file Input file to perform the operation on.
|
@@ -188,6 +300,62 @@ module CloudmersiveConvertApiClient
|
|
188
300
|
return data, status_code, headers
|
189
301
|
end
|
190
302
|
|
303
|
+
# Validate a GZip Archive file (gzip or gz)
|
304
|
+
# Validate a GZip archive file (GZIP or GZ)
|
305
|
+
# @param input_file Input file to perform the operation on.
|
306
|
+
# @param [Hash] opts the optional parameters
|
307
|
+
# @return [DocumentValidationResult]
|
308
|
+
def validate_document_g_zip_validation(input_file, opts = {})
|
309
|
+
data, _status_code, _headers = validate_document_g_zip_validation_with_http_info(input_file, opts)
|
310
|
+
return data
|
311
|
+
end
|
312
|
+
|
313
|
+
# Validate a GZip Archive file (gzip or gz)
|
314
|
+
# Validate a GZip archive file (GZIP or GZ)
|
315
|
+
# @param input_file Input file to perform the operation on.
|
316
|
+
# @param [Hash] opts the optional parameters
|
317
|
+
# @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
|
318
|
+
def validate_document_g_zip_validation_with_http_info(input_file, opts = {})
|
319
|
+
if @api_client.config.debugging
|
320
|
+
@api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_g_zip_validation ..."
|
321
|
+
end
|
322
|
+
# verify the required parameter 'input_file' is set
|
323
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
324
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_g_zip_validation"
|
325
|
+
end
|
326
|
+
# resource path
|
327
|
+
local_var_path = "/convert/validate/gzip"
|
328
|
+
|
329
|
+
# query parameters
|
330
|
+
query_params = {}
|
331
|
+
|
332
|
+
# header parameters
|
333
|
+
header_params = {}
|
334
|
+
# HTTP header 'Accept' (if needed)
|
335
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
336
|
+
# HTTP header 'Content-Type'
|
337
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
338
|
+
|
339
|
+
# form parameters
|
340
|
+
form_params = {}
|
341
|
+
form_params["inputFile"] = input_file
|
342
|
+
|
343
|
+
# http body (model)
|
344
|
+
post_body = nil
|
345
|
+
auth_names = ['Apikey']
|
346
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
347
|
+
:header_params => header_params,
|
348
|
+
:query_params => query_params,
|
349
|
+
:form_params => form_params,
|
350
|
+
:body => post_body,
|
351
|
+
:auth_names => auth_names,
|
352
|
+
:return_type => 'DocumentValidationResult')
|
353
|
+
if @api_client.config.debugging
|
354
|
+
@api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_g_zip_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
355
|
+
end
|
356
|
+
return data, status_code, headers
|
357
|
+
end
|
358
|
+
|
191
359
|
# Validate a JSON file
|
192
360
|
# Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document
|
193
361
|
# @param input_file Input file to perform the operation on.
|
@@ -244,8 +412,64 @@ module CloudmersiveConvertApiClient
|
|
244
412
|
return data, status_code, headers
|
245
413
|
end
|
246
414
|
|
415
|
+
# Validate if an MSG file is executable
|
416
|
+
# Validate if an input file is an MSG email file; if the document is not valid
|
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_msg_validation(input_file, opts = {})
|
421
|
+
data, _status_code, _headers = validate_document_msg_validation_with_http_info(input_file, opts)
|
422
|
+
return data
|
423
|
+
end
|
424
|
+
|
425
|
+
# Validate if an MSG file is executable
|
426
|
+
# Validate if an input file is an MSG email file; if the document is not valid
|
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_msg_validation_with_http_info(input_file, opts = {})
|
431
|
+
if @api_client.config.debugging
|
432
|
+
@api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_msg_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_msg_validation"
|
437
|
+
end
|
438
|
+
# resource path
|
439
|
+
local_var_path = "/convert/validate/msg"
|
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_msg_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
467
|
+
end
|
468
|
+
return data, status_code, headers
|
469
|
+
end
|
470
|
+
|
247
471
|
# Validate a PDF document file
|
248
|
-
# Validate a PDF document; if the document is not valid, identifies the errors in the document
|
472
|
+
# Validate a PDF document; if the document is not valid, identifies the errors in the document. Also checks if the PDF is password protected.
|
249
473
|
# @param input_file Input file to perform the operation on.
|
250
474
|
# @param [Hash] opts the optional parameters
|
251
475
|
# @return [DocumentValidationResult]
|
@@ -255,7 +479,7 @@ module CloudmersiveConvertApiClient
|
|
255
479
|
end
|
256
480
|
|
257
481
|
# Validate a PDF document file
|
258
|
-
# Validate a PDF document; if the document is not valid, identifies the errors in the document
|
482
|
+
# Validate a PDF document; if the document is not valid, identifies the errors in the document. Also checks if the PDF is password protected.
|
259
483
|
# @param input_file Input file to perform the operation on.
|
260
484
|
# @param [Hash] opts the optional parameters
|
261
485
|
# @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
|
@@ -356,6 +580,118 @@ module CloudmersiveConvertApiClient
|
|
356
580
|
return data, status_code, headers
|
357
581
|
end
|
358
582
|
|
583
|
+
# Validate a RAR Archive file (RAR)
|
584
|
+
# Validate a RAR archive file (RAR)
|
585
|
+
# @param input_file Input file to perform the operation on.
|
586
|
+
# @param [Hash] opts the optional parameters
|
587
|
+
# @return [DocumentValidationResult]
|
588
|
+
def validate_document_rar_validation(input_file, opts = {})
|
589
|
+
data, _status_code, _headers = validate_document_rar_validation_with_http_info(input_file, opts)
|
590
|
+
return data
|
591
|
+
end
|
592
|
+
|
593
|
+
# Validate a RAR Archive file (RAR)
|
594
|
+
# Validate a RAR archive file (RAR)
|
595
|
+
# @param input_file Input file to perform the operation on.
|
596
|
+
# @param [Hash] opts the optional parameters
|
597
|
+
# @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
|
598
|
+
def validate_document_rar_validation_with_http_info(input_file, opts = {})
|
599
|
+
if @api_client.config.debugging
|
600
|
+
@api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_rar_validation ..."
|
601
|
+
end
|
602
|
+
# verify the required parameter 'input_file' is set
|
603
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
604
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_rar_validation"
|
605
|
+
end
|
606
|
+
# resource path
|
607
|
+
local_var_path = "/convert/validate/rar"
|
608
|
+
|
609
|
+
# query parameters
|
610
|
+
query_params = {}
|
611
|
+
|
612
|
+
# header parameters
|
613
|
+
header_params = {}
|
614
|
+
# HTTP header 'Accept' (if needed)
|
615
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
616
|
+
# HTTP header 'Content-Type'
|
617
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
618
|
+
|
619
|
+
# form parameters
|
620
|
+
form_params = {}
|
621
|
+
form_params["inputFile"] = input_file
|
622
|
+
|
623
|
+
# http body (model)
|
624
|
+
post_body = nil
|
625
|
+
auth_names = ['Apikey']
|
626
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
627
|
+
:header_params => header_params,
|
628
|
+
:query_params => query_params,
|
629
|
+
:form_params => form_params,
|
630
|
+
:body => post_body,
|
631
|
+
:auth_names => auth_names,
|
632
|
+
:return_type => 'DocumentValidationResult')
|
633
|
+
if @api_client.config.debugging
|
634
|
+
@api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_rar_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
635
|
+
end
|
636
|
+
return data, status_code, headers
|
637
|
+
end
|
638
|
+
|
639
|
+
# Validate a TAR Tarball Archive file (TAR)
|
640
|
+
# Validate a TAR tarball archive file (TAR)
|
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_tar_validation(input_file, opts = {})
|
645
|
+
data, _status_code, _headers = validate_document_tar_validation_with_http_info(input_file, opts)
|
646
|
+
return data
|
647
|
+
end
|
648
|
+
|
649
|
+
# Validate a TAR Tarball Archive file (TAR)
|
650
|
+
# Validate a TAR tarball archive file (TAR)
|
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_tar_validation_with_http_info(input_file, opts = {})
|
655
|
+
if @api_client.config.debugging
|
656
|
+
@api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_tar_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_tar_validation"
|
661
|
+
end
|
662
|
+
# resource path
|
663
|
+
local_var_path = "/convert/validate/tar"
|
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_tar_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
691
|
+
end
|
692
|
+
return data, status_code, headers
|
693
|
+
end
|
694
|
+
|
359
695
|
# Validate a Excel document (XLSX)
|
360
696
|
# Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document
|
361
697
|
# @param input_file Input file to perform the operation on.
|
@@ -467,5 +803,61 @@ module CloudmersiveConvertApiClient
|
|
467
803
|
end
|
468
804
|
return data, status_code, headers
|
469
805
|
end
|
806
|
+
|
807
|
+
# Validate a Zip Archive file (zip)
|
808
|
+
# Validate a Zip archive file (ZIP)
|
809
|
+
# @param input_file Input file to perform the operation on.
|
810
|
+
# @param [Hash] opts the optional parameters
|
811
|
+
# @return [DocumentValidationResult]
|
812
|
+
def validate_document_zip_validation(input_file, opts = {})
|
813
|
+
data, _status_code, _headers = validate_document_zip_validation_with_http_info(input_file, opts)
|
814
|
+
return data
|
815
|
+
end
|
816
|
+
|
817
|
+
# Validate a Zip Archive file (zip)
|
818
|
+
# Validate a Zip archive file (ZIP)
|
819
|
+
# @param input_file Input file to perform the operation on.
|
820
|
+
# @param [Hash] opts the optional parameters
|
821
|
+
# @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
|
822
|
+
def validate_document_zip_validation_with_http_info(input_file, opts = {})
|
823
|
+
if @api_client.config.debugging
|
824
|
+
@api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_zip_validation ..."
|
825
|
+
end
|
826
|
+
# verify the required parameter 'input_file' is set
|
827
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
828
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_zip_validation"
|
829
|
+
end
|
830
|
+
# resource path
|
831
|
+
local_var_path = "/convert/validate/zip"
|
832
|
+
|
833
|
+
# query parameters
|
834
|
+
query_params = {}
|
835
|
+
|
836
|
+
# header parameters
|
837
|
+
header_params = {}
|
838
|
+
# HTTP header 'Accept' (if needed)
|
839
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
840
|
+
# HTTP header 'Content-Type'
|
841
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
842
|
+
|
843
|
+
# form parameters
|
844
|
+
form_params = {}
|
845
|
+
form_params["inputFile"] = input_file
|
846
|
+
|
847
|
+
# http body (model)
|
848
|
+
post_body = nil
|
849
|
+
auth_names = ['Apikey']
|
850
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
851
|
+
:header_params => header_params,
|
852
|
+
:query_params => query_params,
|
853
|
+
:form_params => form_params,
|
854
|
+
:body => post_body,
|
855
|
+
:auth_names => auth_names,
|
856
|
+
:return_type => 'DocumentValidationResult')
|
857
|
+
if @api_client.config.debugging
|
858
|
+
@api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_zip_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
859
|
+
end
|
860
|
+
return data, status_code, headers
|
861
|
+
end
|
470
862
|
end
|
471
863
|
end
|