cloudmersive-convert-api-client 1.7.3 → 1.7.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +45 -5
  3. data/docs/AutodetectToThumbnailsResult.md +9 -0
  4. data/docs/ConvertDataApi.md +6 -2
  5. data/docs/ConvertDocumentApi.md +794 -84
  6. data/docs/CsvCollection.md +10 -0
  7. data/docs/CsvFileResult.md +9 -0
  8. data/docs/DocumentValidationResult.md +1 -0
  9. data/docs/DocxParagraph.md +1 -1
  10. data/docs/DocxRun.md +1 -1
  11. data/docs/DocxText.md +1 -1
  12. data/docs/DocxToPngResult.md +9 -0
  13. data/docs/EditDocumentApi.md +110 -0
  14. data/docs/EmlAttachment.md +9 -0
  15. data/docs/EmlToHtmlResult.md +16 -0
  16. data/docs/FindDocxParagraphRequest.md +11 -0
  17. data/docs/FindDocxParagraphResponse.md +10 -0
  18. data/docs/GetFileTypeIconResult.md +10 -0
  19. data/docs/MsgAttachment.md +9 -0
  20. data/docs/MsgToHtmlResult.md +16 -0
  21. data/docs/PptxToPngResult.md +9 -0
  22. data/docs/ReplaceDocxParagraphRequest.md +12 -0
  23. data/docs/ReplaceDocxParagraphResponse.md +9 -0
  24. data/docs/Thumbnail.md +9 -0
  25. data/docs/ValidateDocumentApi.md +386 -1
  26. data/docs/XlsxToPngResult.md +9 -0
  27. data/docs/ZipArchiveApi.md +144 -5
  28. data/docs/ZipEncryptionAdvancedRequest.md +10 -0
  29. data/lib/cloudmersive-convert-api-client.rb +17 -0
  30. data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +3 -0
  31. data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +722 -6
  32. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +110 -0
  33. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +394 -2
  34. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +160 -6
  35. data/lib/cloudmersive-convert-api-client/models/autodetect_to_thumbnails_result.rb +201 -0
  36. data/lib/cloudmersive-convert-api-client/models/csv_collection.rb +211 -0
  37. data/lib/cloudmersive-convert-api-client/models/csv_file_result.rb +215 -0
  38. data/lib/cloudmersive-convert-api-client/models/document_validation_result.rb +11 -1
  39. data/lib/cloudmersive-convert-api-client/models/docx_paragraph.rb +1 -1
  40. data/lib/cloudmersive-convert-api-client/models/docx_run.rb +1 -1
  41. data/lib/cloudmersive-convert-api-client/models/docx_text.rb +1 -1
  42. data/lib/cloudmersive-convert-api-client/models/docx_to_png_result.rb +201 -0
  43. data/lib/cloudmersive-convert-api-client/models/eml_attachment.rb +215 -0
  44. data/lib/cloudmersive-convert-api-client/models/eml_to_html_result.rb +271 -0
  45. data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_request.rb +235 -0
  46. data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_response.rb +211 -0
  47. data/lib/cloudmersive-convert-api-client/models/get_file_type_icon_result.rb +225 -0
  48. data/lib/cloudmersive-convert-api-client/models/msg_attachment.rb +215 -0
  49. data/lib/cloudmersive-convert-api-client/models/msg_to_html_result.rb +271 -0
  50. data/lib/cloudmersive-convert-api-client/models/pptx_to_png_result.rb +201 -0
  51. data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_request.rb +245 -0
  52. data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_response.rb +199 -0
  53. data/lib/cloudmersive-convert-api-client/models/thumbnail.rb +215 -0
  54. data/lib/cloudmersive-convert-api-client/models/xlsx_to_png_result.rb +201 -0
  55. data/lib/cloudmersive-convert-api-client/models/zip_encryption_advanced_request.rb +225 -0
  56. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  57. data/spec/api/convert_data_api_spec.rb +1 -0
  58. data/spec/api/convert_document_api_spec.rb +163 -3
  59. data/spec/api/edit_document_api_spec.rb +24 -0
  60. data/spec/api/validate_document_api_spec.rb +85 -1
  61. data/spec/api/zip_archive_api_spec.rb +36 -1
  62. data/spec/models/autodetect_to_thumbnails_result_spec.rb +48 -0
  63. data/spec/models/csv_collection_spec.rb +54 -0
  64. data/spec/models/csv_file_result_spec.rb +48 -0
  65. data/spec/models/document_validation_result_spec.rb +6 -0
  66. data/spec/models/docx_to_png_result_spec.rb +48 -0
  67. data/spec/models/eml_attachment_spec.rb +48 -0
  68. data/spec/models/eml_to_html_result_spec.rb +90 -0
  69. data/spec/models/find_docx_paragraph_request_spec.rb +60 -0
  70. data/spec/models/find_docx_paragraph_response_spec.rb +54 -0
  71. data/spec/models/get_file_type_icon_result_spec.rb +54 -0
  72. data/spec/models/msg_attachment_spec.rb +48 -0
  73. data/spec/models/msg_to_html_result_spec.rb +90 -0
  74. data/spec/models/pptx_to_png_result_spec.rb +48 -0
  75. data/spec/models/replace_docx_paragraph_request_spec.rb +66 -0
  76. data/spec/models/replace_docx_paragraph_response_spec.rb +48 -0
  77. data/spec/models/thumbnail_spec.rb +48 -0
  78. data/spec/models/xlsx_to_png_result_spec.rb +48 -0
  79. data/spec/models/zip_encryption_advanced_request_spec.rb +54 -0
  80. metadata +53 -2
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::CsvCollection
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **csv_files** | [**Array<CsvFileResult>**](CsvFileResult.md) | Array of CSV File results | [optional]
8
+ **file_count** | **Integer** | Count of the number of CSV files produced | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::CsvFileResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **title** | **String** | Title of the CSV file | [optional]
7
+ **file_contents** | **String** | Contents of the CSV file | [optional]
8
+
9
+
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **document_is_valid** | **BOOLEAN** | True if the document is valid and has no errors, false otherwise | [optional]
7
+ **password_protected** | **BOOLEAN** | True if the document is password protected, false otherwise | [optional]
7
8
  **error_count** | **Integer** | Number of validation errors found in the document | [optional]
8
9
  **warning_count** | **Integer** | Number of validation warnings found in the document | [optional]
9
10
  **errors_and_warnings** | [**Array<DocumentValidationError>**](DocumentValidationError.md) | Details of errors and warnings found | [optional]
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **paragraph_index** | **Integer** | The index of the paragraph; 0-based | [optional]
7
- **path** | **String** | The Path of the location of this object; leave blank for new tables | [optional]
7
+ **path** | **String** | The Path of the location of this Paragraph object; leave blank during creation | [optional]
8
8
  **content_runs** | [**Array<DocxRun>**](DocxRun.md) | The content runs in the paragraph - this is where text is stored; similar to a span in HTML | [optional]
9
9
  **style_id** | **String** | Style ID of the style applied to the paragraph; null if no style is applied | [optional]
10
10
 
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **run_index** | **Integer** | Index of the run, 0-based | [optional]
7
- **path** | **String** | The Path of the location of this object; leave blank for new tables | [optional]
7
+ **path** | **String** | The Path of the location of this Run object; leave blank for creation | [optional]
8
8
  **text_items** | [**Array<DocxText>**](DocxText.md) | Text items inside the run; this is where the actual text content is stored | [optional]
9
9
  **bold** | **BOOLEAN** | True to make the text bold, false otherwise | [optional]
10
10
  **italic** | **BOOLEAN** | True to make the text italic, false otherwise | [optional]
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **text_index** | **Integer** | Index of the text content in the run; 0-based | [optional]
7
- **path** | **String** | The Path of the location of this object; leave blank for new tables | [optional]
7
+ **path** | **String** | The Path of the location of this Text object; leave blank for creation | [optional]
8
8
  **text_content** | **String** | Text string containing the text content of this text content item | [optional]
9
9
 
10
10
 
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::DocxToPngResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **png_result_pages** | [**Array<ConvertedPngPage>**](ConvertedPngPage.md) | Array of converted pages | [optional]
8
+
9
+
@@ -10,6 +10,7 @@ Method | HTTP request | Description
10
10
  [**edit_document_docx_delete_pages**](EditDocumentApi.md#edit_document_docx_delete_pages) | **POST** /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document
11
11
  [**edit_document_docx_delete_table_row**](EditDocumentApi.md#edit_document_docx_delete_table_row) | **POST** /convert/edit/docx/delete-table-row | Deletes a table row in an existing table in a Word DOCX document
12
12
  [**edit_document_docx_delete_table_row_range**](EditDocumentApi.md#edit_document_docx_delete_table_row_range) | **POST** /convert/edit/docx/delete-table-row/range | Deletes a range of multiple table rows in an existing table in a Word DOCX document
13
+ [**edit_document_docx_find_paragraph**](EditDocumentApi.md#edit_document_docx_find_paragraph) | **POST** /convert/edit/docx/find/paragraph | Find matching paragraphs in a Word DOCX document
13
14
  [**edit_document_docx_get_comments**](EditDocumentApi.md#edit_document_docx_get_comments) | **POST** /convert/edit/docx/get-comments/flat-list | Get comments from a Word DOCX document as a flat list
14
15
  [**edit_document_docx_get_comments_hierarchical**](EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
15
16
  [**edit_document_docx_get_headers_and_footers**](EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
@@ -28,6 +29,7 @@ Method | HTTP request | Description
28
29
  [**edit_document_docx_remove_headers_and_footers**](EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from Word DOCX document
29
30
  [**edit_document_docx_remove_object**](EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
30
31
  [**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
32
+ [**edit_document_docx_replace_paragraph**](EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
31
33
  [**edit_document_docx_set_footer**](EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
32
34
  [**edit_document_docx_set_footer_add_page_number**](EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
33
35
  [**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
@@ -378,6 +380,60 @@ Name | Type | Description | Notes
378
380
 
379
381
 
380
382
 
383
+ # **edit_document_docx_find_paragraph**
384
+ > FindDocxParagraphResponse edit_document_docx_find_paragraph(req_config)
385
+
386
+ Find matching paragraphs in a Word DOCX document
387
+
388
+ Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria
389
+
390
+ ### Example
391
+ ```ruby
392
+ # load the gem
393
+ require 'cloudmersive-convert-api-client'
394
+ # setup authorization
395
+ CloudmersiveConvertApiClient.configure do |config|
396
+ # Configure API key authorization: Apikey
397
+ config.api_key['Apikey'] = 'YOUR API KEY'
398
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
399
+ #config.api_key_prefix['Apikey'] = 'Bearer'
400
+ end
401
+
402
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
403
+
404
+ req_config = CloudmersiveConvertApiClient::FindDocxParagraphRequest.new # FindDocxParagraphRequest | Document input request
405
+
406
+
407
+ begin
408
+ #Find matching paragraphs in a Word DOCX document
409
+ result = api_instance.edit_document_docx_find_paragraph(req_config)
410
+ p result
411
+ rescue CloudmersiveConvertApiClient::ApiError => e
412
+ puts "Exception when calling EditDocumentApi->edit_document_docx_find_paragraph: #{e}"
413
+ end
414
+ ```
415
+
416
+ ### Parameters
417
+
418
+ Name | Type | Description | Notes
419
+ ------------- | ------------- | ------------- | -------------
420
+ **req_config** | [**FindDocxParagraphRequest**](FindDocxParagraphRequest.md)| Document input request |
421
+
422
+ ### Return type
423
+
424
+ [**FindDocxParagraphResponse**](FindDocxParagraphResponse.md)
425
+
426
+ ### Authorization
427
+
428
+ [Apikey](../README.md#Apikey)
429
+
430
+ ### HTTP request headers
431
+
432
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
433
+ - **Accept**: application/json, text/json, application/xml, text/xml
434
+
435
+
436
+
381
437
  # **edit_document_docx_get_comments**
382
438
  > GetDocxCommentsResponse edit_document_docx_get_comments(req_config)
383
439
 
@@ -1350,6 +1406,60 @@ Name | Type | Description | Notes
1350
1406
 
1351
1407
 
1352
1408
 
1409
+ # **edit_document_docx_replace_paragraph**
1410
+ > ReplaceDocxParagraphResponse edit_document_docx_replace_paragraph(req_config)
1411
+
1412
+ Replace matching paragraphs in a Word DOCX document
1413
+
1414
+ 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.
1415
+
1416
+ ### Example
1417
+ ```ruby
1418
+ # load the gem
1419
+ require 'cloudmersive-convert-api-client'
1420
+ # setup authorization
1421
+ CloudmersiveConvertApiClient.configure do |config|
1422
+ # Configure API key authorization: Apikey
1423
+ config.api_key['Apikey'] = 'YOUR API KEY'
1424
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1425
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1426
+ end
1427
+
1428
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1429
+
1430
+ req_config = CloudmersiveConvertApiClient::ReplaceDocxParagraphRequest.new # ReplaceDocxParagraphRequest | Document input request
1431
+
1432
+
1433
+ begin
1434
+ #Replace matching paragraphs in a Word DOCX document
1435
+ result = api_instance.edit_document_docx_replace_paragraph(req_config)
1436
+ p result
1437
+ rescue CloudmersiveConvertApiClient::ApiError => e
1438
+ puts "Exception when calling EditDocumentApi->edit_document_docx_replace_paragraph: #{e}"
1439
+ end
1440
+ ```
1441
+
1442
+ ### Parameters
1443
+
1444
+ Name | Type | Description | Notes
1445
+ ------------- | ------------- | ------------- | -------------
1446
+ **req_config** | [**ReplaceDocxParagraphRequest**](ReplaceDocxParagraphRequest.md)| Document input request |
1447
+
1448
+ ### Return type
1449
+
1450
+ [**ReplaceDocxParagraphResponse**](ReplaceDocxParagraphResponse.md)
1451
+
1452
+ ### Authorization
1453
+
1454
+ [Apikey](../README.md#Apikey)
1455
+
1456
+ ### HTTP request headers
1457
+
1458
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1459
+ - **Accept**: application/json, text/json, application/xml, text/xml
1460
+
1461
+
1462
+
1353
1463
  # **edit_document_docx_set_footer**
1354
1464
  > DocxSetFooterResponse edit_document_docx_set_footer(req_config)
1355
1465
 
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::EmlAttachment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Name of the attachment, including file extension | [optional]
7
+ **content** | **String** | The EML attachment as a byte[] | [optional]
8
+
9
+
@@ -0,0 +1,16 @@
1
+ # CloudmersiveConvertApiClient::EmlToHtmlResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **content** | **String** | An HTML string version of the EML file | [optional]
8
+ **body** | **String** | The main body of the EML file's email as an HTML string | [optional]
9
+ **from** | **String** | The From sender of the EML file's email | [optional]
10
+ **to** | **String** | The To recipients of the EML file's email | [optional]
11
+ **cc** | **String** | The CC recipients of the EML file's email | [optional]
12
+ **date_sent** | **String** | The date and time that the EML file's email was sent | [optional]
13
+ **subject** | **String** | The subject of the EML file's email | [optional]
14
+ **attachments** | [**Array<EmlAttachment>**](EmlAttachment.md) | List of all attachments for the EML file | [optional]
15
+
16
+
@@ -0,0 +1,11 @@
1
+ # CloudmersiveConvertApiClient::FindDocxParagraphRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional]
7
+ **input_file_url** | **String** | Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional]
8
+ **find_string** | **String** | Required: The target string to search for in the paragraphs of the document | [optional]
9
+ **match_case** | **BOOLEAN** | Optional: True to match case, false to ignore case when matching | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::FindDocxParagraphResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful; false otherwise | [optional]
7
+ **matching_paragraphs** | [**Array<DocxParagraph>**](DocxParagraph.md) | Matching paragraphs | [optional]
8
+ **count** | **Integer** | Count of matching paragraphs | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::GetFileTypeIconResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **icon** | **String** | PNG icon as a byte array | [optional]
8
+ **extension** | **String** | Extension used for the icon | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::MsgAttachment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Name of the attachment, including file extension | [optional]
7
+ **content** | **String** | The MSG attachment as a byte[] | [optional]
8
+
9
+
@@ -0,0 +1,16 @@
1
+ # CloudmersiveConvertApiClient::MsgToHtmlResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **content** | **String** | An HTML string version of the MSG file | [optional]
8
+ **body** | **String** | The main body of the MSG file's email as an HTML string | [optional]
9
+ **from** | **String** | The From sender of the MSG file's email | [optional]
10
+ **to** | **String** | The To recipients of the MSG file's email | [optional]
11
+ **cc** | **String** | The CC recipients of the MSG file's email | [optional]
12
+ **received_time** | **String** | The time that the MSG file's email was received | [optional]
13
+ **subject** | **String** | The subject of the MSG file's email | [optional]
14
+ **attachments** | [**Array<MsgAttachment>**](MsgAttachment.md) | List of all attachments for the MSG file | [optional]
15
+
16
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::PptxToPngResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **png_result_pages** | [**Array<ConvertedPngPage>**](ConvertedPngPage.md) | Array of converted pages | [optional]
8
+
9
+
@@ -0,0 +1,12 @@
1
+ # CloudmersiveConvertApiClient::ReplaceDocxParagraphRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional]
7
+ **input_file_url** | **String** | Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional]
8
+ **find_string** | **String** | Required: The target string to search for in the paragraphs of the document | [optional]
9
+ **match_case** | **BOOLEAN** | Optional: True to match case, false to ignore case when matching | [optional]
10
+ **replacement_image** | [**DocxImage**](DocxImage.md) | Optional: Image to replace the paragraph with; note that most of the fields in this object are optional and do not need to be supplied | [optional]
11
+
12
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::ReplaceDocxParagraphResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful; false otherwise | [optional]
7
+ **edited_document_url** | **String** | URL of the edited document | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::Thumbnail
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **index** | **Integer** | Index of this thumbnail | [optional]
7
+ **content** | **String** | A PNG thumbnail of the document page | [optional]
8
+
9
+
@@ -5,13 +5,20 @@ All URIs are relative to *https://api.cloudmersive.com*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**validate_document_autodetect_validation**](ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
8
+ [**validate_document_csv_validation**](ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
8
9
  [**validate_document_docx_validation**](ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
10
+ [**validate_document_eml_validation**](ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
9
11
  [**validate_document_executable_validation**](ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
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)
10
13
  [**validate_document_json_validation**](ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
14
+ [**validate_document_msg_validation**](ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
11
15
  [**validate_document_pdf_validation**](ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
12
16
  [**validate_document_pptx_validation**](ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
17
+ [**validate_document_rar_validation**](ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
18
+ [**validate_document_tar_validation**](ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
13
19
  [**validate_document_xlsx_validation**](ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
14
20
  [**validate_document_xml_validation**](ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
21
+ [**validate_document_zip_validation**](ValidateDocumentApi.md#validate_document_zip_validation) | **POST** /convert/validate/zip | Validate a Zip Archive file (zip)
15
22
 
16
23
 
17
24
  # **validate_document_autodetect_validation**
@@ -68,6 +75,60 @@ Name | Type | Description | Notes
68
75
 
69
76
 
70
77
 
78
+ # **validate_document_csv_validation**
79
+ > DocumentValidationResult validate_document_csv_validation(input_file)
80
+
81
+ Validate a CSV file document (CSV)
82
+
83
+ Validate a CSV file document (CSV); if the document is not valid, identifies the errors in the document
84
+
85
+ ### Example
86
+ ```ruby
87
+ # load the gem
88
+ require 'cloudmersive-convert-api-client'
89
+ # setup authorization
90
+ CloudmersiveConvertApiClient.configure do |config|
91
+ # Configure API key authorization: Apikey
92
+ config.api_key['Apikey'] = 'YOUR API KEY'
93
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
94
+ #config.api_key_prefix['Apikey'] = 'Bearer'
95
+ end
96
+
97
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
98
+
99
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
100
+
101
+
102
+ begin
103
+ #Validate a CSV file document (CSV)
104
+ result = api_instance.validate_document_csv_validation(input_file)
105
+ p result
106
+ rescue CloudmersiveConvertApiClient::ApiError => e
107
+ puts "Exception when calling ValidateDocumentApi->validate_document_csv_validation: #{e}"
108
+ end
109
+ ```
110
+
111
+ ### Parameters
112
+
113
+ Name | Type | Description | Notes
114
+ ------------- | ------------- | ------------- | -------------
115
+ **input_file** | **File**| Input file to perform the operation on. |
116
+
117
+ ### Return type
118
+
119
+ [**DocumentValidationResult**](DocumentValidationResult.md)
120
+
121
+ ### Authorization
122
+
123
+ [Apikey](../README.md#Apikey)
124
+
125
+ ### HTTP request headers
126
+
127
+ - **Content-Type**: multipart/form-data
128
+ - **Accept**: application/json, text/json, application/xml, text/xml
129
+
130
+
131
+
71
132
  # **validate_document_docx_validation**
72
133
  > DocumentValidationResult validate_document_docx_validation(input_file)
73
134
 
@@ -122,6 +183,60 @@ Name | Type | Description | Notes
122
183
 
123
184
 
124
185
 
186
+ # **validate_document_eml_validation**
187
+ > DocumentValidationResult validate_document_eml_validation(input_file)
188
+
189
+ Validate if an EML file is executable
190
+
191
+ Validate if an input file is an EML email file; if the document is not valid
192
+
193
+ ### Example
194
+ ```ruby
195
+ # load the gem
196
+ require 'cloudmersive-convert-api-client'
197
+ # setup authorization
198
+ CloudmersiveConvertApiClient.configure do |config|
199
+ # Configure API key authorization: Apikey
200
+ config.api_key['Apikey'] = 'YOUR API KEY'
201
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
202
+ #config.api_key_prefix['Apikey'] = 'Bearer'
203
+ end
204
+
205
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
206
+
207
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
208
+
209
+
210
+ begin
211
+ #Validate if an EML file is executable
212
+ result = api_instance.validate_document_eml_validation(input_file)
213
+ p result
214
+ rescue CloudmersiveConvertApiClient::ApiError => e
215
+ puts "Exception when calling ValidateDocumentApi->validate_document_eml_validation: #{e}"
216
+ end
217
+ ```
218
+
219
+ ### Parameters
220
+
221
+ Name | Type | Description | Notes
222
+ ------------- | ------------- | ------------- | -------------
223
+ **input_file** | **File**| Input file to perform the operation on. |
224
+
225
+ ### Return type
226
+
227
+ [**DocumentValidationResult**](DocumentValidationResult.md)
228
+
229
+ ### Authorization
230
+
231
+ [Apikey](../README.md#Apikey)
232
+
233
+ ### HTTP request headers
234
+
235
+ - **Content-Type**: multipart/form-data
236
+ - **Accept**: application/json, text/json, application/xml, text/xml
237
+
238
+
239
+
125
240
  # **validate_document_executable_validation**
126
241
  > DocumentValidationResult validate_document_executable_validation(input_file)
127
242
 
@@ -176,6 +291,60 @@ Name | Type | Description | Notes
176
291
 
177
292
 
178
293
 
294
+ # **validate_document_g_zip_validation**
295
+ > DocumentValidationResult validate_document_g_zip_validation(input_file)
296
+
297
+ Validate a GZip Archive file (gzip or gz)
298
+
299
+ Validate a GZip archive file (GZIP or GZ)
300
+
301
+ ### Example
302
+ ```ruby
303
+ # load the gem
304
+ require 'cloudmersive-convert-api-client'
305
+ # setup authorization
306
+ CloudmersiveConvertApiClient.configure do |config|
307
+ # Configure API key authorization: Apikey
308
+ config.api_key['Apikey'] = 'YOUR API KEY'
309
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
310
+ #config.api_key_prefix['Apikey'] = 'Bearer'
311
+ end
312
+
313
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
314
+
315
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
316
+
317
+
318
+ begin
319
+ #Validate a GZip Archive file (gzip or gz)
320
+ result = api_instance.validate_document_g_zip_validation(input_file)
321
+ p result
322
+ rescue CloudmersiveConvertApiClient::ApiError => e
323
+ puts "Exception when calling ValidateDocumentApi->validate_document_g_zip_validation: #{e}"
324
+ end
325
+ ```
326
+
327
+ ### Parameters
328
+
329
+ Name | Type | Description | Notes
330
+ ------------- | ------------- | ------------- | -------------
331
+ **input_file** | **File**| Input file to perform the operation on. |
332
+
333
+ ### Return type
334
+
335
+ [**DocumentValidationResult**](DocumentValidationResult.md)
336
+
337
+ ### Authorization
338
+
339
+ [Apikey](../README.md#Apikey)
340
+
341
+ ### HTTP request headers
342
+
343
+ - **Content-Type**: multipart/form-data
344
+ - **Accept**: application/json, text/json, application/xml, text/xml
345
+
346
+
347
+
179
348
  # **validate_document_json_validation**
180
349
  > DocumentValidationResult validate_document_json_validation(input_file)
181
350
 
@@ -230,12 +399,66 @@ Name | Type | Description | Notes
230
399
 
231
400
 
232
401
 
402
+ # **validate_document_msg_validation**
403
+ > DocumentValidationResult validate_document_msg_validation(input_file)
404
+
405
+ Validate if an MSG file is executable
406
+
407
+ Validate if an input file is an MSG email file; if the document is not valid
408
+
409
+ ### Example
410
+ ```ruby
411
+ # load the gem
412
+ require 'cloudmersive-convert-api-client'
413
+ # setup authorization
414
+ CloudmersiveConvertApiClient.configure do |config|
415
+ # Configure API key authorization: Apikey
416
+ config.api_key['Apikey'] = 'YOUR API KEY'
417
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
418
+ #config.api_key_prefix['Apikey'] = 'Bearer'
419
+ end
420
+
421
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
422
+
423
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
424
+
425
+
426
+ begin
427
+ #Validate if an MSG file is executable
428
+ result = api_instance.validate_document_msg_validation(input_file)
429
+ p result
430
+ rescue CloudmersiveConvertApiClient::ApiError => e
431
+ puts "Exception when calling ValidateDocumentApi->validate_document_msg_validation: #{e}"
432
+ end
433
+ ```
434
+
435
+ ### Parameters
436
+
437
+ Name | Type | Description | Notes
438
+ ------------- | ------------- | ------------- | -------------
439
+ **input_file** | **File**| Input file to perform the operation on. |
440
+
441
+ ### Return type
442
+
443
+ [**DocumentValidationResult**](DocumentValidationResult.md)
444
+
445
+ ### Authorization
446
+
447
+ [Apikey](../README.md#Apikey)
448
+
449
+ ### HTTP request headers
450
+
451
+ - **Content-Type**: multipart/form-data
452
+ - **Accept**: application/json, text/json, application/xml, text/xml
453
+
454
+
455
+
233
456
  # **validate_document_pdf_validation**
234
457
  > DocumentValidationResult validate_document_pdf_validation(input_file)
235
458
 
236
459
  Validate a PDF document file
237
460
 
238
- Validate a PDF document; if the document is not valid, identifies the errors in the document
461
+ Validate a PDF document; if the document is not valid, identifies the errors in the document. Also checks if the PDF is password protected.
239
462
 
240
463
  ### Example
241
464
  ```ruby
@@ -338,6 +561,114 @@ Name | Type | Description | Notes
338
561
 
339
562
 
340
563
 
564
+ # **validate_document_rar_validation**
565
+ > DocumentValidationResult validate_document_rar_validation(input_file)
566
+
567
+ Validate a RAR Archive file (RAR)
568
+
569
+ Validate a RAR archive file (RAR)
570
+
571
+ ### Example
572
+ ```ruby
573
+ # load the gem
574
+ require 'cloudmersive-convert-api-client'
575
+ # setup authorization
576
+ CloudmersiveConvertApiClient.configure do |config|
577
+ # Configure API key authorization: Apikey
578
+ config.api_key['Apikey'] = 'YOUR API KEY'
579
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
580
+ #config.api_key_prefix['Apikey'] = 'Bearer'
581
+ end
582
+
583
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
584
+
585
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
586
+
587
+
588
+ begin
589
+ #Validate a RAR Archive file (RAR)
590
+ result = api_instance.validate_document_rar_validation(input_file)
591
+ p result
592
+ rescue CloudmersiveConvertApiClient::ApiError => e
593
+ puts "Exception when calling ValidateDocumentApi->validate_document_rar_validation: #{e}"
594
+ end
595
+ ```
596
+
597
+ ### Parameters
598
+
599
+ Name | Type | Description | Notes
600
+ ------------- | ------------- | ------------- | -------------
601
+ **input_file** | **File**| Input file to perform the operation on. |
602
+
603
+ ### Return type
604
+
605
+ [**DocumentValidationResult**](DocumentValidationResult.md)
606
+
607
+ ### Authorization
608
+
609
+ [Apikey](../README.md#Apikey)
610
+
611
+ ### HTTP request headers
612
+
613
+ - **Content-Type**: multipart/form-data
614
+ - **Accept**: application/json, text/json, application/xml, text/xml
615
+
616
+
617
+
618
+ # **validate_document_tar_validation**
619
+ > DocumentValidationResult validate_document_tar_validation(input_file)
620
+
621
+ Validate a TAR Tarball Archive file (TAR)
622
+
623
+ Validate a TAR tarball archive file (TAR)
624
+
625
+ ### Example
626
+ ```ruby
627
+ # load the gem
628
+ require 'cloudmersive-convert-api-client'
629
+ # setup authorization
630
+ CloudmersiveConvertApiClient.configure do |config|
631
+ # Configure API key authorization: Apikey
632
+ config.api_key['Apikey'] = 'YOUR API KEY'
633
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
634
+ #config.api_key_prefix['Apikey'] = 'Bearer'
635
+ end
636
+
637
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
638
+
639
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
640
+
641
+
642
+ begin
643
+ #Validate a TAR Tarball Archive file (TAR)
644
+ result = api_instance.validate_document_tar_validation(input_file)
645
+ p result
646
+ rescue CloudmersiveConvertApiClient::ApiError => e
647
+ puts "Exception when calling ValidateDocumentApi->validate_document_tar_validation: #{e}"
648
+ end
649
+ ```
650
+
651
+ ### Parameters
652
+
653
+ Name | Type | Description | Notes
654
+ ------------- | ------------- | ------------- | -------------
655
+ **input_file** | **File**| Input file to perform the operation on. |
656
+
657
+ ### Return type
658
+
659
+ [**DocumentValidationResult**](DocumentValidationResult.md)
660
+
661
+ ### Authorization
662
+
663
+ [Apikey](../README.md#Apikey)
664
+
665
+ ### HTTP request headers
666
+
667
+ - **Content-Type**: multipart/form-data
668
+ - **Accept**: application/json, text/json, application/xml, text/xml
669
+
670
+
671
+
341
672
  # **validate_document_xlsx_validation**
342
673
  > DocumentValidationResult validate_document_xlsx_validation(input_file)
343
674
 
@@ -446,3 +777,57 @@ Name | Type | Description | Notes
446
777
 
447
778
 
448
779
 
780
+ # **validate_document_zip_validation**
781
+ > DocumentValidationResult validate_document_zip_validation(input_file)
782
+
783
+ Validate a Zip Archive file (zip)
784
+
785
+ Validate a Zip archive file (ZIP)
786
+
787
+ ### Example
788
+ ```ruby
789
+ # load the gem
790
+ require 'cloudmersive-convert-api-client'
791
+ # setup authorization
792
+ CloudmersiveConvertApiClient.configure do |config|
793
+ # Configure API key authorization: Apikey
794
+ config.api_key['Apikey'] = 'YOUR API KEY'
795
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
796
+ #config.api_key_prefix['Apikey'] = 'Bearer'
797
+ end
798
+
799
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
800
+
801
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
802
+
803
+
804
+ begin
805
+ #Validate a Zip Archive file (zip)
806
+ result = api_instance.validate_document_zip_validation(input_file)
807
+ p result
808
+ rescue CloudmersiveConvertApiClient::ApiError => e
809
+ puts "Exception when calling ValidateDocumentApi->validate_document_zip_validation: #{e}"
810
+ end
811
+ ```
812
+
813
+ ### Parameters
814
+
815
+ Name | Type | Description | Notes
816
+ ------------- | ------------- | ------------- | -------------
817
+ **input_file** | **File**| Input file to perform the operation on. |
818
+
819
+ ### Return type
820
+
821
+ [**DocumentValidationResult**](DocumentValidationResult.md)
822
+
823
+ ### Authorization
824
+
825
+ [Apikey](../README.md#Apikey)
826
+
827
+ ### HTTP request headers
828
+
829
+ - **Content-Type**: multipart/form-data
830
+ - **Accept**: application/json, text/json, application/xml, text/xml
831
+
832
+
833
+