cloudmersive-convert-api-client 1.7.4 → 1.7.5

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 (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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2d75ce766690c505454afacec20fb89f7672b3cfc13813703eb35ad9801f1cc6
4
- data.tar.gz: 7eac89d54269fbb3f2ab53aefbaf9339f5bce46ea865e967c0bdfe4dc293ad95
3
+ metadata.gz: fd33579cf5967f09473a0affa369671112c65be5284192f24f99f4307b7a9d19
4
+ data.tar.gz: cf649e84729034b5abf1da7ab61fc8bb9609008433bccf4ac971df0222979a3e
5
5
  SHA512:
6
- metadata.gz: c1f574fdaef9c6a74f07794117a6f0f5ba0109a8796362257ba3ecefea0a5cf8d88c513000d2475792a748966b541d7854c0cdeaf34251b3ac357975e0b014f9
7
- data.tar.gz: b8b823a6fcbc8d7a519e909aacd0b628928fafa4fc797ca469df0e18a8da69ca684c1cbb9f450a717ce2ffb01cfbc143e50e5528cc95cc2d0f620222ad3e5f68
6
+ metadata.gz: 889df1a634674598296ba5ef89f9b9a207f70e7e36fcf960b3e3cca2e136563c011833df72e206b115b191a5e2e487be42b8801fe1fee43a29fe1dcc5d49ba28
7
+ data.tar.gz: 4e9e541beedef3d83d33b7eec3441b373ebb3b1093e03c4f18d20fc827445654d482e9d8e8b3e19b7948b73fcd4ff9cceefe27f86c7f703a3b7e4c1afc6d7bd3
data/README.md CHANGED
@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 1.7.4
10
+ - Package version: 1.7.5
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-convert-api-client-1.7.4.gem
26
+ gem install ./cloudmersive-convert-api-client-1.7.5.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.7.4.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.7.5.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'cloudmersive-convert-api-client', '~> 1.7.4'
34
+ gem 'cloudmersive-convert-api-client', '~> 1.7.5'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -152,6 +152,7 @@ Class | Method | HTTP request | Description
152
152
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_delete_pages**](docs/EditDocumentApi.md#edit_document_docx_delete_pages) | **POST** /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document
153
153
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_delete_table_row**](docs/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
154
154
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_delete_table_row_range**](docs/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
155
+ *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_find_paragraph**](docs/EditDocumentApi.md#edit_document_docx_find_paragraph) | **POST** /convert/edit/docx/find/paragraph | Find matching paragraphs in a Word DOCX document
155
156
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_comments**](docs/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
156
157
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_comments_hierarchical**](docs/EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
157
158
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_headers_and_footers**](docs/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
@@ -170,6 +171,7 @@ Class | Method | HTTP request | Description
170
171
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_remove_headers_and_footers**](docs/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
171
172
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_remove_object**](docs/EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
172
173
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace**](docs/EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
174
+ *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace_paragraph**](docs/EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
173
175
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_footer**](docs/EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
174
176
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_footer_add_page_number**](docs/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
175
177
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_header**](docs/EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
@@ -246,14 +248,20 @@ Class | Method | HTTP request | Description
246
248
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_autodetect_validation**](docs/ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
247
249
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_docx_validation**](docs/ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
248
250
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_executable_validation**](docs/ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
251
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_g_zip_validation**](docs/ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)
249
252
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_json_validation**](docs/ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
250
253
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pdf_validation**](docs/ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
251
254
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pptx_validation**](docs/ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
255
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_rar_validation**](docs/ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
256
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_tar_validation**](docs/ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
252
257
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xlsx_validation**](docs/ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
253
258
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xml_validation**](docs/ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
259
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_zip_validation**](docs/ValidateDocumentApi.md#validate_document_zip_validation) | **POST** /convert/validate/zip | Validate a Zip Archive file (zip)
254
260
  *CloudmersiveConvertApiClient::ViewerToolsApi* | [**viewer_tools_create_simple**](docs/ViewerToolsApi.md#viewer_tools_create_simple) | **POST** /convert/viewer/create/web/simple | Create a web-based viewer
255
261
  *CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_create**](docs/ZipArchiveApi.md#zip_archive_zip_create) | **POST** /convert/archive/zip/create | Compress files to create a new zip archive
256
262
  *CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_create_advanced**](docs/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
263
+ *CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_decrypt**](docs/ZipArchiveApi.md#zip_archive_zip_decrypt) | **POST** /convert/archive/zip/decrypt | Decrypt and remove password protection on a zip file
264
+ *CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_encrypt_advanced**](docs/ZipArchiveApi.md#zip_archive_zip_encrypt_advanced) | **POST** /convert/archive/zip/encrypt/advanced | Encrypt and password protect a zip file
257
265
  *CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_extract**](docs/ZipArchiveApi.md#zip_archive_zip_extract) | **POST** /convert/archive/zip/extract | Extract, decompress files and folders from a zip archive
258
266
 
259
267
 
@@ -323,6 +331,8 @@ Class | Method | HTTP request | Description
323
331
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookRequest](docs/EnableSharedWorkbookRequest.md)
324
332
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookResponse](docs/EnableSharedWorkbookResponse.md)
325
333
  - [CloudmersiveConvertApiClient::ExifValue](docs/ExifValue.md)
334
+ - [CloudmersiveConvertApiClient::FindDocxParagraphRequest](docs/FindDocxParagraphRequest.md)
335
+ - [CloudmersiveConvertApiClient::FindDocxParagraphResponse](docs/FindDocxParagraphResponse.md)
326
336
  - [CloudmersiveConvertApiClient::FindRegexMatch](docs/FindRegexMatch.md)
327
337
  - [CloudmersiveConvertApiClient::FindStringMatch](docs/FindStringMatch.md)
328
338
  - [CloudmersiveConvertApiClient::FindStringRegexRequest](docs/FindStringRegexRequest.md)
@@ -406,6 +416,8 @@ Class | Method | HTTP request | Description
406
416
  - [CloudmersiveConvertApiClient::RemoveWhitespaceFromTextRequest](docs/RemoveWhitespaceFromTextRequest.md)
407
417
  - [CloudmersiveConvertApiClient::RemoveWhitespaceFromTextResponse](docs/RemoveWhitespaceFromTextResponse.md)
408
418
  - [CloudmersiveConvertApiClient::RemoveXlsxWorksheetRequest](docs/RemoveXlsxWorksheetRequest.md)
419
+ - [CloudmersiveConvertApiClient::ReplaceDocxParagraphRequest](docs/ReplaceDocxParagraphRequest.md)
420
+ - [CloudmersiveConvertApiClient::ReplaceDocxParagraphResponse](docs/ReplaceDocxParagraphResponse.md)
409
421
  - [CloudmersiveConvertApiClient::ReplaceStringRegexRequest](docs/ReplaceStringRegexRequest.md)
410
422
  - [CloudmersiveConvertApiClient::ReplaceStringRegexResponse](docs/ReplaceStringRegexResponse.md)
411
423
  - [CloudmersiveConvertApiClient::ReplaceStringRequest](docs/ReplaceStringRequest.md)
@@ -454,6 +466,7 @@ Class | Method | HTTP request | Description
454
466
  - [CloudmersiveConvertApiClient::XmlReplaceWithXPathResult](docs/XmlReplaceWithXPathResult.md)
455
467
  - [CloudmersiveConvertApiClient::XmlSetValueWithXPathResult](docs/XmlSetValueWithXPathResult.md)
456
468
  - [CloudmersiveConvertApiClient::ZipDirectory](docs/ZipDirectory.md)
469
+ - [CloudmersiveConvertApiClient::ZipEncryptionAdvancedRequest](docs/ZipEncryptionAdvancedRequest.md)
457
470
  - [CloudmersiveConvertApiClient::ZipExtractResponse](docs/ZipExtractResponse.md)
458
471
  - [CloudmersiveConvertApiClient::ZipFile](docs/ZipFile.md)
459
472
 
@@ -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
 
@@ -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,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,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
+
@@ -7,11 +7,15 @@ Method | HTTP request | Description
7
7
  [**validate_document_autodetect_validation**](ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
8
8
  [**validate_document_docx_validation**](ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
9
9
  [**validate_document_executable_validation**](ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
10
+ [**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
11
  [**validate_document_json_validation**](ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
11
12
  [**validate_document_pdf_validation**](ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
12
13
  [**validate_document_pptx_validation**](ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
14
+ [**validate_document_rar_validation**](ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
15
+ [**validate_document_tar_validation**](ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
13
16
  [**validate_document_xlsx_validation**](ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
14
17
  [**validate_document_xml_validation**](ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
18
+ [**validate_document_zip_validation**](ValidateDocumentApi.md#validate_document_zip_validation) | **POST** /convert/validate/zip | Validate a Zip Archive file (zip)
15
19
 
16
20
 
17
21
  # **validate_document_autodetect_validation**
@@ -176,6 +180,60 @@ Name | Type | Description | Notes
176
180
 
177
181
 
178
182
 
183
+ # **validate_document_g_zip_validation**
184
+ > DocumentValidationResult validate_document_g_zip_validation(input_file)
185
+
186
+ Validate a GZip Archive file (gzip or gz)
187
+
188
+ Validate a GZip archive file (GZIP or GZ)
189
+
190
+ ### Example
191
+ ```ruby
192
+ # load the gem
193
+ require 'cloudmersive-convert-api-client'
194
+ # setup authorization
195
+ CloudmersiveConvertApiClient.configure do |config|
196
+ # Configure API key authorization: Apikey
197
+ config.api_key['Apikey'] = 'YOUR API KEY'
198
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
199
+ #config.api_key_prefix['Apikey'] = 'Bearer'
200
+ end
201
+
202
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
203
+
204
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
205
+
206
+
207
+ begin
208
+ #Validate a GZip Archive file (gzip or gz)
209
+ result = api_instance.validate_document_g_zip_validation(input_file)
210
+ p result
211
+ rescue CloudmersiveConvertApiClient::ApiError => e
212
+ puts "Exception when calling ValidateDocumentApi->validate_document_g_zip_validation: #{e}"
213
+ end
214
+ ```
215
+
216
+ ### Parameters
217
+
218
+ Name | Type | Description | Notes
219
+ ------------- | ------------- | ------------- | -------------
220
+ **input_file** | **File**| Input file to perform the operation on. |
221
+
222
+ ### Return type
223
+
224
+ [**DocumentValidationResult**](DocumentValidationResult.md)
225
+
226
+ ### Authorization
227
+
228
+ [Apikey](../README.md#Apikey)
229
+
230
+ ### HTTP request headers
231
+
232
+ - **Content-Type**: multipart/form-data
233
+ - **Accept**: application/json, text/json, application/xml, text/xml
234
+
235
+
236
+
179
237
  # **validate_document_json_validation**
180
238
  > DocumentValidationResult validate_document_json_validation(input_file)
181
239
 
@@ -338,6 +396,114 @@ Name | Type | Description | Notes
338
396
 
339
397
 
340
398
 
399
+ # **validate_document_rar_validation**
400
+ > DocumentValidationResult validate_document_rar_validation(input_file)
401
+
402
+ Validate a RAR Archive file (RAR)
403
+
404
+ Validate a RAR archive file (RAR)
405
+
406
+ ### Example
407
+ ```ruby
408
+ # load the gem
409
+ require 'cloudmersive-convert-api-client'
410
+ # setup authorization
411
+ CloudmersiveConvertApiClient.configure do |config|
412
+ # Configure API key authorization: Apikey
413
+ config.api_key['Apikey'] = 'YOUR API KEY'
414
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
415
+ #config.api_key_prefix['Apikey'] = 'Bearer'
416
+ end
417
+
418
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
419
+
420
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
421
+
422
+
423
+ begin
424
+ #Validate a RAR Archive file (RAR)
425
+ result = api_instance.validate_document_rar_validation(input_file)
426
+ p result
427
+ rescue CloudmersiveConvertApiClient::ApiError => e
428
+ puts "Exception when calling ValidateDocumentApi->validate_document_rar_validation: #{e}"
429
+ end
430
+ ```
431
+
432
+ ### Parameters
433
+
434
+ Name | Type | Description | Notes
435
+ ------------- | ------------- | ------------- | -------------
436
+ **input_file** | **File**| Input file to perform the operation on. |
437
+
438
+ ### Return type
439
+
440
+ [**DocumentValidationResult**](DocumentValidationResult.md)
441
+
442
+ ### Authorization
443
+
444
+ [Apikey](../README.md#Apikey)
445
+
446
+ ### HTTP request headers
447
+
448
+ - **Content-Type**: multipart/form-data
449
+ - **Accept**: application/json, text/json, application/xml, text/xml
450
+
451
+
452
+
453
+ # **validate_document_tar_validation**
454
+ > DocumentValidationResult validate_document_tar_validation(input_file)
455
+
456
+ Validate a TAR Tarball Archive file (TAR)
457
+
458
+ Validate a TAR tarball archive file (TAR)
459
+
460
+ ### Example
461
+ ```ruby
462
+ # load the gem
463
+ require 'cloudmersive-convert-api-client'
464
+ # setup authorization
465
+ CloudmersiveConvertApiClient.configure do |config|
466
+ # Configure API key authorization: Apikey
467
+ config.api_key['Apikey'] = 'YOUR API KEY'
468
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
469
+ #config.api_key_prefix['Apikey'] = 'Bearer'
470
+ end
471
+
472
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
473
+
474
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
475
+
476
+
477
+ begin
478
+ #Validate a TAR Tarball Archive file (TAR)
479
+ result = api_instance.validate_document_tar_validation(input_file)
480
+ p result
481
+ rescue CloudmersiveConvertApiClient::ApiError => e
482
+ puts "Exception when calling ValidateDocumentApi->validate_document_tar_validation: #{e}"
483
+ end
484
+ ```
485
+
486
+ ### Parameters
487
+
488
+ Name | Type | Description | Notes
489
+ ------------- | ------------- | ------------- | -------------
490
+ **input_file** | **File**| Input file to perform the operation on. |
491
+
492
+ ### Return type
493
+
494
+ [**DocumentValidationResult**](DocumentValidationResult.md)
495
+
496
+ ### Authorization
497
+
498
+ [Apikey](../README.md#Apikey)
499
+
500
+ ### HTTP request headers
501
+
502
+ - **Content-Type**: multipart/form-data
503
+ - **Accept**: application/json, text/json, application/xml, text/xml
504
+
505
+
506
+
341
507
  # **validate_document_xlsx_validation**
342
508
  > DocumentValidationResult validate_document_xlsx_validation(input_file)
343
509
 
@@ -446,3 +612,57 @@ Name | Type | Description | Notes
446
612
 
447
613
 
448
614
 
615
+ # **validate_document_zip_validation**
616
+ > DocumentValidationResult validate_document_zip_validation(input_file)
617
+
618
+ Validate a Zip Archive file (zip)
619
+
620
+ Validate a Zip archive file (ZIP)
621
+
622
+ ### Example
623
+ ```ruby
624
+ # load the gem
625
+ require 'cloudmersive-convert-api-client'
626
+ # setup authorization
627
+ CloudmersiveConvertApiClient.configure do |config|
628
+ # Configure API key authorization: Apikey
629
+ config.api_key['Apikey'] = 'YOUR API KEY'
630
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
631
+ #config.api_key_prefix['Apikey'] = 'Bearer'
632
+ end
633
+
634
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
635
+
636
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
637
+
638
+
639
+ begin
640
+ #Validate a Zip Archive file (zip)
641
+ result = api_instance.validate_document_zip_validation(input_file)
642
+ p result
643
+ rescue CloudmersiveConvertApiClient::ApiError => e
644
+ puts "Exception when calling ValidateDocumentApi->validate_document_zip_validation: #{e}"
645
+ end
646
+ ```
647
+
648
+ ### Parameters
649
+
650
+ Name | Type | Description | Notes
651
+ ------------- | ------------- | ------------- | -------------
652
+ **input_file** | **File**| Input file to perform the operation on. |
653
+
654
+ ### Return type
655
+
656
+ [**DocumentValidationResult**](DocumentValidationResult.md)
657
+
658
+ ### Authorization
659
+
660
+ [Apikey](../README.md#Apikey)
661
+
662
+ ### HTTP request headers
663
+
664
+ - **Content-Type**: multipart/form-data
665
+ - **Accept**: application/json, text/json, application/xml, text/xml
666
+
667
+
668
+