cloudmersive-convert-api-client 2.0.8 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +11 -4
- data/docs/EditDocumentApi.md +220 -0
- data/docs/ValidateDocumentApi.md +110 -0
- data/docs/ZipArchiveApi.md +80 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +220 -0
- data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +110 -0
- data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +92 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/edit_document_api_spec.rb +48 -0
- data/spec/api/validate_document_api_spec.rb +24 -0
- data/spec/api/zip_archive_api_spec.rb +23 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6db51fd461262851da88db3981588736d26ce5e7b61ef9e9779142c746aba2ec
|
|
4
|
+
data.tar.gz: 9c533041cf98e9e70a21436262b40ee23df0df873a28f7a7a05a9a2f722349b7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7fd5b6a478005dc3285bd8957fb03d97efc54207892876b3e4a8b6f1f980510c9f912603bfe07cccbcdde718f9fcc2acbf5a99723fc038be17518c25b5044bf2
|
|
7
|
+
data.tar.gz: 496272536aa8f1a883e504cb98bf33b3f74a6505d65ba727712c6b92cf79a6af32ffc44ce3def5d7dac1b32b106db2b278ab1a5e0dce0e964649bfe43d992b18
|
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: 2.0
|
|
10
|
+
- Package version: 2.1.0
|
|
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-2.0.
|
|
26
|
+
gem install ./cloudmersive-convert-api-client-2.1.0.gem
|
|
27
27
|
```
|
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.0.
|
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.0.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', '~> 2.0
|
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 2.1.0'
|
|
35
35
|
|
|
36
36
|
### Install from Git
|
|
37
37
|
|
|
@@ -192,11 +192,14 @@ Class | Method | HTTP request | Description
|
|
|
192
192
|
*CloudmersiveConvertApiClient::ConvertWebApi* | [**convert_web_url_to_screenshot**](docs/ConvertWebApi.md#convert_web_url_to_screenshot) | **POST** /convert/web/url/to/screenshot | Take screenshot of URL
|
|
193
193
|
*CloudmersiveConvertApiClient::ConvertWebApi* | [**convert_web_url_to_txt**](docs/ConvertWebApi.md#convert_web_url_to_txt) | **POST** /convert/web/url/to/txt | Convert website URL page to text (txt)
|
|
194
194
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_begin_editing**](docs/EditDocumentApi.md#edit_document_begin_editing) | **POST** /convert/edit/begin-editing | Begin editing a document
|
|
195
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_accept_all_track_changes**](docs/EditDocumentApi.md#edit_document_docx_accept_all_track_changes) | **POST** /convert/edit/docx/track-changes/accept-all | Accept all tracked changes, revisions in a Word DOCX document
|
|
195
196
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_body**](docs/EditDocumentApi.md#edit_document_docx_body) | **POST** /convert/edit/docx/get-body | Get body from a Word DOCX document
|
|
196
197
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_create_blank_document**](docs/EditDocumentApi.md#edit_document_docx_create_blank_document) | **POST** /convert/edit/docx/create/blank | Create a blank Word DOCX document
|
|
197
198
|
*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
|
|
198
199
|
*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
|
|
199
200
|
*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
|
|
201
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_disable_track_changes**](docs/EditDocumentApi.md#edit_document_docx_disable_track_changes) | **POST** /convert/edit/docx/track-changes/disable | Disable track changes, revisions in a Word DOCX document
|
|
202
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_enable_track_changes**](docs/EditDocumentApi.md#edit_document_docx_enable_track_changes) | **POST** /convert/edit/docx/track-changes/enable | Enable track changes, revisions in a Word DOCX document
|
|
200
203
|
*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
|
|
201
204
|
*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
|
|
202
205
|
*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
|
|
@@ -213,6 +216,7 @@ Class | Method | HTTP request | Description
|
|
|
213
216
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_insert_table**](docs/EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a Word DOCX document
|
|
214
217
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_insert_table_row**](docs/EditDocumentApi.md#edit_document_docx_insert_table_row) | **POST** /convert/edit/docx/insert-table-row | Insert a new row into an existing table in a Word DOCX document
|
|
215
218
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_pages**](docs/EditDocumentApi.md#edit_document_docx_pages) | **POST** /convert/edit/docx/get-pages | Get pages and content from a Word DOCX document
|
|
219
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_remove_all_comments**](docs/EditDocumentApi.md#edit_document_docx_remove_all_comments) | **POST** /convert/edit/docx/comments/remove-all | Remove all comments from a Word DOCX document
|
|
216
220
|
*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
|
|
217
221
|
*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
|
|
218
222
|
*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
|
|
@@ -309,6 +313,8 @@ Class | Method | HTTP request | Description
|
|
|
309
313
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_eml_validation**](docs/ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
|
|
310
314
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_executable_validation**](docs/ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
|
|
311
315
|
*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)
|
|
316
|
+
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_html_validation**](docs/ValidateDocumentApi.md#validate_document_html_validation) | **POST** /convert/validate/html | Validate an HTML file
|
|
317
|
+
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_image_validation**](docs/ValidateDocumentApi.md#validate_document_image_validation) | **POST** /convert/validate/image | Validate an Image File
|
|
312
318
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_json_validation**](docs/ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
|
|
313
319
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_msg_validation**](docs/ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
|
|
314
320
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pdf_validation**](docs/ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
|
|
@@ -321,6 +327,7 @@ Class | Method | HTTP request | Description
|
|
|
321
327
|
*CloudmersiveConvertApiClient::ViewerToolsApi* | [**viewer_tools_create_simple**](docs/ViewerToolsApi.md#viewer_tools_create_simple) | **POST** /convert/viewer/create/web/simple | Create a web-based viewer
|
|
322
328
|
*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
|
|
323
329
|
*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
|
|
330
|
+
*CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_create_encrypted**](docs/ZipArchiveApi.md#zip_archive_zip_create_encrypted) | **POST** /convert/archive/zip/create/encrypted | Compress files to create a new, encrypted and password-protected zip archive
|
|
324
331
|
*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
|
|
325
332
|
*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
|
|
326
333
|
*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
|
data/docs/EditDocumentApi.md
CHANGED
|
@@ -5,11 +5,14 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**edit_document_begin_editing**](EditDocumentApi.md#edit_document_begin_editing) | **POST** /convert/edit/begin-editing | Begin editing a document
|
|
8
|
+
[**edit_document_docx_accept_all_track_changes**](EditDocumentApi.md#edit_document_docx_accept_all_track_changes) | **POST** /convert/edit/docx/track-changes/accept-all | Accept all tracked changes, revisions in a Word DOCX document
|
|
8
9
|
[**edit_document_docx_body**](EditDocumentApi.md#edit_document_docx_body) | **POST** /convert/edit/docx/get-body | Get body from a Word DOCX document
|
|
9
10
|
[**edit_document_docx_create_blank_document**](EditDocumentApi.md#edit_document_docx_create_blank_document) | **POST** /convert/edit/docx/create/blank | Create a blank Word DOCX document
|
|
10
11
|
[**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
12
|
[**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
13
|
[**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
|
|
14
|
+
[**edit_document_docx_disable_track_changes**](EditDocumentApi.md#edit_document_docx_disable_track_changes) | **POST** /convert/edit/docx/track-changes/disable | Disable track changes, revisions in a Word DOCX document
|
|
15
|
+
[**edit_document_docx_enable_track_changes**](EditDocumentApi.md#edit_document_docx_enable_track_changes) | **POST** /convert/edit/docx/track-changes/enable | Enable track changes, revisions in a Word DOCX document
|
|
13
16
|
[**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
|
|
14
17
|
[**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
|
|
15
18
|
[**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
|
|
@@ -26,6 +29,7 @@ Method | HTTP request | Description
|
|
|
26
29
|
[**edit_document_docx_insert_table**](EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a Word DOCX document
|
|
27
30
|
[**edit_document_docx_insert_table_row**](EditDocumentApi.md#edit_document_docx_insert_table_row) | **POST** /convert/edit/docx/insert-table-row | Insert a new row into an existing table in a Word DOCX document
|
|
28
31
|
[**edit_document_docx_pages**](EditDocumentApi.md#edit_document_docx_pages) | **POST** /convert/edit/docx/get-pages | Get pages and content from a Word DOCX document
|
|
32
|
+
[**edit_document_docx_remove_all_comments**](EditDocumentApi.md#edit_document_docx_remove_all_comments) | **POST** /convert/edit/docx/comments/remove-all | Remove all comments from a Word DOCX document
|
|
29
33
|
[**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
|
|
30
34
|
[**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
|
|
31
35
|
[**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
|
|
@@ -115,6 +119,60 @@ Name | Type | Description | Notes
|
|
|
115
119
|
|
|
116
120
|
|
|
117
121
|
|
|
122
|
+
# **edit_document_docx_accept_all_track_changes**
|
|
123
|
+
> String edit_document_docx_accept_all_track_changes(input_file)
|
|
124
|
+
|
|
125
|
+
Accept all tracked changes, revisions in a Word DOCX document
|
|
126
|
+
|
|
127
|
+
Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.
|
|
128
|
+
|
|
129
|
+
### Example
|
|
130
|
+
```ruby
|
|
131
|
+
# load the gem
|
|
132
|
+
require 'cloudmersive-convert-api-client'
|
|
133
|
+
# setup authorization
|
|
134
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
135
|
+
# Configure API key authorization: Apikey
|
|
136
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
137
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
138
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
142
|
+
|
|
143
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
begin
|
|
147
|
+
#Accept all tracked changes, revisions in a Word DOCX document
|
|
148
|
+
result = api_instance.edit_document_docx_accept_all_track_changes(input_file)
|
|
149
|
+
p result
|
|
150
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
151
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_accept_all_track_changes: #{e}"
|
|
152
|
+
end
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
Name | Type | Description | Notes
|
|
158
|
+
------------- | ------------- | ------------- | -------------
|
|
159
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
|
160
|
+
|
|
161
|
+
### Return type
|
|
162
|
+
|
|
163
|
+
**String**
|
|
164
|
+
|
|
165
|
+
### Authorization
|
|
166
|
+
|
|
167
|
+
[Apikey](../README.md#Apikey)
|
|
168
|
+
|
|
169
|
+
### HTTP request headers
|
|
170
|
+
|
|
171
|
+
- **Content-Type**: multipart/form-data
|
|
172
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
118
176
|
# **edit_document_docx_body**
|
|
119
177
|
> GetDocxBodyResponse edit_document_docx_body(req_config)
|
|
120
178
|
|
|
@@ -385,6 +443,114 @@ Name | Type | Description | Notes
|
|
|
385
443
|
|
|
386
444
|
|
|
387
445
|
|
|
446
|
+
# **edit_document_docx_disable_track_changes**
|
|
447
|
+
> String edit_document_docx_disable_track_changes(input_file)
|
|
448
|
+
|
|
449
|
+
Disable track changes, revisions in a Word DOCX document
|
|
450
|
+
|
|
451
|
+
Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.
|
|
452
|
+
|
|
453
|
+
### Example
|
|
454
|
+
```ruby
|
|
455
|
+
# load the gem
|
|
456
|
+
require 'cloudmersive-convert-api-client'
|
|
457
|
+
# setup authorization
|
|
458
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
459
|
+
# Configure API key authorization: Apikey
|
|
460
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
461
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
462
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
463
|
+
end
|
|
464
|
+
|
|
465
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
466
|
+
|
|
467
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
begin
|
|
471
|
+
#Disable track changes, revisions in a Word DOCX document
|
|
472
|
+
result = api_instance.edit_document_docx_disable_track_changes(input_file)
|
|
473
|
+
p result
|
|
474
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
475
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_disable_track_changes: #{e}"
|
|
476
|
+
end
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
### Parameters
|
|
480
|
+
|
|
481
|
+
Name | Type | Description | Notes
|
|
482
|
+
------------- | ------------- | ------------- | -------------
|
|
483
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
|
484
|
+
|
|
485
|
+
### Return type
|
|
486
|
+
|
|
487
|
+
**String**
|
|
488
|
+
|
|
489
|
+
### Authorization
|
|
490
|
+
|
|
491
|
+
[Apikey](../README.md#Apikey)
|
|
492
|
+
|
|
493
|
+
### HTTP request headers
|
|
494
|
+
|
|
495
|
+
- **Content-Type**: multipart/form-data
|
|
496
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
# **edit_document_docx_enable_track_changes**
|
|
501
|
+
> String edit_document_docx_enable_track_changes(input_file)
|
|
502
|
+
|
|
503
|
+
Enable track changes, revisions in a Word DOCX document
|
|
504
|
+
|
|
505
|
+
Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.
|
|
506
|
+
|
|
507
|
+
### Example
|
|
508
|
+
```ruby
|
|
509
|
+
# load the gem
|
|
510
|
+
require 'cloudmersive-convert-api-client'
|
|
511
|
+
# setup authorization
|
|
512
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
513
|
+
# Configure API key authorization: Apikey
|
|
514
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
515
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
516
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
517
|
+
end
|
|
518
|
+
|
|
519
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
520
|
+
|
|
521
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
begin
|
|
525
|
+
#Enable track changes, revisions in a Word DOCX document
|
|
526
|
+
result = api_instance.edit_document_docx_enable_track_changes(input_file)
|
|
527
|
+
p result
|
|
528
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
529
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_enable_track_changes: #{e}"
|
|
530
|
+
end
|
|
531
|
+
```
|
|
532
|
+
|
|
533
|
+
### Parameters
|
|
534
|
+
|
|
535
|
+
Name | Type | Description | Notes
|
|
536
|
+
------------- | ------------- | ------------- | -------------
|
|
537
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
|
538
|
+
|
|
539
|
+
### Return type
|
|
540
|
+
|
|
541
|
+
**String**
|
|
542
|
+
|
|
543
|
+
### Authorization
|
|
544
|
+
|
|
545
|
+
[Apikey](../README.md#Apikey)
|
|
546
|
+
|
|
547
|
+
### HTTP request headers
|
|
548
|
+
|
|
549
|
+
- **Content-Type**: multipart/form-data
|
|
550
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
388
554
|
# **edit_document_docx_find_paragraph**
|
|
389
555
|
> FindDocxParagraphResponse edit_document_docx_find_paragraph(req_config)
|
|
390
556
|
|
|
@@ -1249,6 +1415,60 @@ Name | Type | Description | Notes
|
|
|
1249
1415
|
|
|
1250
1416
|
|
|
1251
1417
|
|
|
1418
|
+
# **edit_document_docx_remove_all_comments**
|
|
1419
|
+
> String edit_document_docx_remove_all_comments(input_file)
|
|
1420
|
+
|
|
1421
|
+
Remove all comments from a Word DOCX document
|
|
1422
|
+
|
|
1423
|
+
Removes all of the comments from a Word Document.
|
|
1424
|
+
|
|
1425
|
+
### Example
|
|
1426
|
+
```ruby
|
|
1427
|
+
# load the gem
|
|
1428
|
+
require 'cloudmersive-convert-api-client'
|
|
1429
|
+
# setup authorization
|
|
1430
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1431
|
+
# Configure API key authorization: Apikey
|
|
1432
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1433
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1434
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1435
|
+
end
|
|
1436
|
+
|
|
1437
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1438
|
+
|
|
1439
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
|
1440
|
+
|
|
1441
|
+
|
|
1442
|
+
begin
|
|
1443
|
+
#Remove all comments from a Word DOCX document
|
|
1444
|
+
result = api_instance.edit_document_docx_remove_all_comments(input_file)
|
|
1445
|
+
p result
|
|
1446
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1447
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_remove_all_comments: #{e}"
|
|
1448
|
+
end
|
|
1449
|
+
```
|
|
1450
|
+
|
|
1451
|
+
### Parameters
|
|
1452
|
+
|
|
1453
|
+
Name | Type | Description | Notes
|
|
1454
|
+
------------- | ------------- | ------------- | -------------
|
|
1455
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
|
1456
|
+
|
|
1457
|
+
### Return type
|
|
1458
|
+
|
|
1459
|
+
**String**
|
|
1460
|
+
|
|
1461
|
+
### Authorization
|
|
1462
|
+
|
|
1463
|
+
[Apikey](../README.md#Apikey)
|
|
1464
|
+
|
|
1465
|
+
### HTTP request headers
|
|
1466
|
+
|
|
1467
|
+
- **Content-Type**: multipart/form-data
|
|
1468
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
|
|
1252
1472
|
# **edit_document_docx_remove_headers_and_footers**
|
|
1253
1473
|
> RemoveDocxHeadersAndFootersResponse edit_document_docx_remove_headers_and_footers(req_config)
|
|
1254
1474
|
|
data/docs/ValidateDocumentApi.md
CHANGED
|
@@ -10,6 +10,8 @@ Method | HTTP request | Description
|
|
|
10
10
|
[**validate_document_eml_validation**](ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
|
|
11
11
|
[**validate_document_executable_validation**](ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
|
|
12
12
|
[**validate_document_g_zip_validation**](ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)
|
|
13
|
+
[**validate_document_html_validation**](ValidateDocumentApi.md#validate_document_html_validation) | **POST** /convert/validate/html | Validate an HTML file
|
|
14
|
+
[**validate_document_image_validation**](ValidateDocumentApi.md#validate_document_image_validation) | **POST** /convert/validate/image | Validate an Image File
|
|
13
15
|
[**validate_document_json_validation**](ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
|
|
14
16
|
[**validate_document_msg_validation**](ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
|
|
15
17
|
[**validate_document_pdf_validation**](ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
|
|
@@ -345,6 +347,114 @@ Name | Type | Description | Notes
|
|
|
345
347
|
|
|
346
348
|
|
|
347
349
|
|
|
350
|
+
# **validate_document_html_validation**
|
|
351
|
+
> DocumentValidationResult validate_document_html_validation(input_file)
|
|
352
|
+
|
|
353
|
+
Validate an HTML file
|
|
354
|
+
|
|
355
|
+
Validate an HTML document file; if the document is not valid, identifies the errors in the document
|
|
356
|
+
|
|
357
|
+
### Example
|
|
358
|
+
```ruby
|
|
359
|
+
# load the gem
|
|
360
|
+
require 'cloudmersive-convert-api-client'
|
|
361
|
+
# setup authorization
|
|
362
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
363
|
+
# Configure API key authorization: Apikey
|
|
364
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
365
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
366
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
367
|
+
end
|
|
368
|
+
|
|
369
|
+
api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
|
|
370
|
+
|
|
371
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
begin
|
|
375
|
+
#Validate an HTML file
|
|
376
|
+
result = api_instance.validate_document_html_validation(input_file)
|
|
377
|
+
p result
|
|
378
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
379
|
+
puts "Exception when calling ValidateDocumentApi->validate_document_html_validation: #{e}"
|
|
380
|
+
end
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
### Parameters
|
|
384
|
+
|
|
385
|
+
Name | Type | Description | Notes
|
|
386
|
+
------------- | ------------- | ------------- | -------------
|
|
387
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
|
388
|
+
|
|
389
|
+
### Return type
|
|
390
|
+
|
|
391
|
+
[**DocumentValidationResult**](DocumentValidationResult.md)
|
|
392
|
+
|
|
393
|
+
### Authorization
|
|
394
|
+
|
|
395
|
+
[Apikey](../README.md#Apikey)
|
|
396
|
+
|
|
397
|
+
### HTTP request headers
|
|
398
|
+
|
|
399
|
+
- **Content-Type**: multipart/form-data
|
|
400
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
# **validate_document_image_validation**
|
|
405
|
+
> DocumentValidationResult validate_document_image_validation(input_file)
|
|
406
|
+
|
|
407
|
+
Validate an Image File
|
|
408
|
+
|
|
409
|
+
Validate an image file; if the document is not valid, identifies the errors in the document. Formats supported include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
|
410
|
+
|
|
411
|
+
### Example
|
|
412
|
+
```ruby
|
|
413
|
+
# load the gem
|
|
414
|
+
require 'cloudmersive-convert-api-client'
|
|
415
|
+
# setup authorization
|
|
416
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
417
|
+
# Configure API key authorization: Apikey
|
|
418
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
419
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
420
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
421
|
+
end
|
|
422
|
+
|
|
423
|
+
api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
|
|
424
|
+
|
|
425
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
begin
|
|
429
|
+
#Validate an Image File
|
|
430
|
+
result = api_instance.validate_document_image_validation(input_file)
|
|
431
|
+
p result
|
|
432
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
433
|
+
puts "Exception when calling ValidateDocumentApi->validate_document_image_validation: #{e}"
|
|
434
|
+
end
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
### Parameters
|
|
438
|
+
|
|
439
|
+
Name | Type | Description | Notes
|
|
440
|
+
------------- | ------------- | ------------- | -------------
|
|
441
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
|
442
|
+
|
|
443
|
+
### Return type
|
|
444
|
+
|
|
445
|
+
[**DocumentValidationResult**](DocumentValidationResult.md)
|
|
446
|
+
|
|
447
|
+
### Authorization
|
|
448
|
+
|
|
449
|
+
[Apikey](../README.md#Apikey)
|
|
450
|
+
|
|
451
|
+
### HTTP request headers
|
|
452
|
+
|
|
453
|
+
- **Content-Type**: multipart/form-data
|
|
454
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
348
458
|
# **validate_document_json_validation**
|
|
349
459
|
> DocumentValidationResult validate_document_json_validation(input_file)
|
|
350
460
|
|
data/docs/ZipArchiveApi.md
CHANGED
|
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**zip_archive_zip_create**](ZipArchiveApi.md#zip_archive_zip_create) | **POST** /convert/archive/zip/create | Compress files to create a new zip archive
|
|
8
8
|
[**zip_archive_zip_create_advanced**](ZipArchiveApi.md#zip_archive_zip_create_advanced) | **POST** /convert/archive/zip/create/advanced | Compress files and folders to create a new zip archive with advanced options
|
|
9
|
+
[**zip_archive_zip_create_encrypted**](ZipArchiveApi.md#zip_archive_zip_create_encrypted) | **POST** /convert/archive/zip/create/encrypted | Compress files to create a new, encrypted and password-protected zip archive
|
|
9
10
|
[**zip_archive_zip_decrypt**](ZipArchiveApi.md#zip_archive_zip_decrypt) | **POST** /convert/archive/zip/decrypt | Decrypt and remove password protection on a zip file
|
|
10
11
|
[**zip_archive_zip_encrypt_advanced**](ZipArchiveApi.md#zip_archive_zip_encrypt_advanced) | **POST** /convert/archive/zip/encrypt/advanced | Encrypt and password protect a zip file
|
|
11
12
|
[**zip_archive_zip_extract**](ZipArchiveApi.md#zip_archive_zip_extract) | **POST** /convert/archive/zip/extract | Extract, decompress files and folders from a zip archive
|
|
@@ -139,6 +140,85 @@ Name | Type | Description | Notes
|
|
|
139
140
|
|
|
140
141
|
|
|
141
142
|
|
|
143
|
+
# **zip_archive_zip_create_encrypted**
|
|
144
|
+
> String zip_archive_zip_create_encrypted(password, input_file1, opts)
|
|
145
|
+
|
|
146
|
+
Compress files to create a new, encrypted and password-protected zip archive
|
|
147
|
+
|
|
148
|
+
Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip.
|
|
149
|
+
|
|
150
|
+
### Example
|
|
151
|
+
```ruby
|
|
152
|
+
# load the gem
|
|
153
|
+
require 'cloudmersive-convert-api-client'
|
|
154
|
+
# setup authorization
|
|
155
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
156
|
+
# Configure API key authorization: Apikey
|
|
157
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
158
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
159
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
|
|
163
|
+
|
|
164
|
+
password = 'password_example' # String | Password to place on the Zip file; the longer the password, the more secure
|
|
165
|
+
|
|
166
|
+
input_file1 = File.new('/path/to/file.txt') # File | First input file to perform the operation on.
|
|
167
|
+
|
|
168
|
+
opts = {
|
|
169
|
+
encryption_algorithm: 'encryption_algorithm_example', # String | Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.
|
|
170
|
+
input_file2: File.new('/path/to/file.txt'), # File | Second input file to perform the operation on.
|
|
171
|
+
input_file3: File.new('/path/to/file.txt'), # File | Third input file to perform the operation on.
|
|
172
|
+
input_file4: File.new('/path/to/file.txt'), # File | Fourth input file to perform the operation on.
|
|
173
|
+
input_file5: File.new('/path/to/file.txt'), # File | Fifth input file to perform the operation on.
|
|
174
|
+
input_file6: File.new('/path/to/file.txt'), # File | Sixth input file to perform the operation on.
|
|
175
|
+
input_file7: File.new('/path/to/file.txt'), # File | Seventh input file to perform the operation on.
|
|
176
|
+
input_file8: File.new('/path/to/file.txt'), # File | Eighth input file to perform the operation on.
|
|
177
|
+
input_file9: File.new('/path/to/file.txt'), # File | Ninth input file to perform the operation on.
|
|
178
|
+
input_file10: File.new('/path/to/file.txt') # File | Tenth input file to perform the operation on.
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
begin
|
|
182
|
+
#Compress files to create a new, encrypted and password-protected zip archive
|
|
183
|
+
result = api_instance.zip_archive_zip_create_encrypted(password, input_file1, opts)
|
|
184
|
+
p result
|
|
185
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
186
|
+
puts "Exception when calling ZipArchiveApi->zip_archive_zip_create_encrypted: #{e}"
|
|
187
|
+
end
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### Parameters
|
|
191
|
+
|
|
192
|
+
Name | Type | Description | Notes
|
|
193
|
+
------------- | ------------- | ------------- | -------------
|
|
194
|
+
**password** | **String**| Password to place on the Zip file; the longer the password, the more secure |
|
|
195
|
+
**input_file1** | **File**| First input file to perform the operation on. |
|
|
196
|
+
**encryption_algorithm** | **String**| Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256. | [optional]
|
|
197
|
+
**input_file2** | **File**| Second input file to perform the operation on. | [optional]
|
|
198
|
+
**input_file3** | **File**| Third input file to perform the operation on. | [optional]
|
|
199
|
+
**input_file4** | **File**| Fourth input file to perform the operation on. | [optional]
|
|
200
|
+
**input_file5** | **File**| Fifth input file to perform the operation on. | [optional]
|
|
201
|
+
**input_file6** | **File**| Sixth input file to perform the operation on. | [optional]
|
|
202
|
+
**input_file7** | **File**| Seventh input file to perform the operation on. | [optional]
|
|
203
|
+
**input_file8** | **File**| Eighth input file to perform the operation on. | [optional]
|
|
204
|
+
**input_file9** | **File**| Ninth input file to perform the operation on. | [optional]
|
|
205
|
+
**input_file10** | **File**| Tenth input file to perform the operation on. | [optional]
|
|
206
|
+
|
|
207
|
+
### Return type
|
|
208
|
+
|
|
209
|
+
**String**
|
|
210
|
+
|
|
211
|
+
### Authorization
|
|
212
|
+
|
|
213
|
+
[Apikey](../README.md#Apikey)
|
|
214
|
+
|
|
215
|
+
### HTTP request headers
|
|
216
|
+
|
|
217
|
+
- **Content-Type**: multipart/form-data
|
|
218
|
+
- **Accept**: application/octet-stream
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
142
222
|
# **zip_archive_zip_decrypt**
|
|
143
223
|
> Object zip_archive_zip_decrypt(input_file, zip_password)
|
|
144
224
|
|
|
@@ -74,6 +74,61 @@ module CloudmersiveConvertApiClient
|
|
|
74
74
|
end
|
|
75
75
|
return data, status_code, headers
|
|
76
76
|
end
|
|
77
|
+
# Accept all tracked changes, revisions in a Word DOCX document
|
|
78
|
+
# Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.
|
|
79
|
+
# @param input_file Input file to perform the operation on.
|
|
80
|
+
# @param [Hash] opts the optional parameters
|
|
81
|
+
# @return [String]
|
|
82
|
+
def edit_document_docx_accept_all_track_changes(input_file, opts = {})
|
|
83
|
+
data, _status_code, _headers = edit_document_docx_accept_all_track_changes_with_http_info(input_file, opts)
|
|
84
|
+
data
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Accept all tracked changes, revisions in a Word DOCX document
|
|
88
|
+
# Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.
|
|
89
|
+
# @param input_file Input file to perform the operation on.
|
|
90
|
+
# @param [Hash] opts the optional parameters
|
|
91
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
92
|
+
def edit_document_docx_accept_all_track_changes_with_http_info(input_file, opts = {})
|
|
93
|
+
if @api_client.config.debugging
|
|
94
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_accept_all_track_changes ...'
|
|
95
|
+
end
|
|
96
|
+
# verify the required parameter 'input_file' is set
|
|
97
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
|
98
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_accept_all_track_changes"
|
|
99
|
+
end
|
|
100
|
+
# resource path
|
|
101
|
+
local_var_path = '/convert/edit/docx/track-changes/accept-all'
|
|
102
|
+
|
|
103
|
+
# query parameters
|
|
104
|
+
query_params = {}
|
|
105
|
+
|
|
106
|
+
# header parameters
|
|
107
|
+
header_params = {}
|
|
108
|
+
# HTTP header 'Accept' (if needed)
|
|
109
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
|
110
|
+
# HTTP header 'Content-Type'
|
|
111
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
112
|
+
|
|
113
|
+
# form parameters
|
|
114
|
+
form_params = {}
|
|
115
|
+
form_params['inputFile'] = input_file
|
|
116
|
+
|
|
117
|
+
# http body (model)
|
|
118
|
+
post_body = nil
|
|
119
|
+
auth_names = ['Apikey']
|
|
120
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
121
|
+
:header_params => header_params,
|
|
122
|
+
:query_params => query_params,
|
|
123
|
+
:form_params => form_params,
|
|
124
|
+
:body => post_body,
|
|
125
|
+
:auth_names => auth_names,
|
|
126
|
+
:return_type => 'String')
|
|
127
|
+
if @api_client.config.debugging
|
|
128
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_accept_all_track_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
129
|
+
end
|
|
130
|
+
return data, status_code, headers
|
|
131
|
+
end
|
|
77
132
|
# Get body from a Word DOCX document
|
|
78
133
|
# Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
|
|
79
134
|
# @param req_config Document input request
|
|
@@ -344,6 +399,116 @@ module CloudmersiveConvertApiClient
|
|
|
344
399
|
end
|
|
345
400
|
return data, status_code, headers
|
|
346
401
|
end
|
|
402
|
+
# Disable track changes, revisions in a Word DOCX document
|
|
403
|
+
# Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.
|
|
404
|
+
# @param input_file Input file to perform the operation on.
|
|
405
|
+
# @param [Hash] opts the optional parameters
|
|
406
|
+
# @return [String]
|
|
407
|
+
def edit_document_docx_disable_track_changes(input_file, opts = {})
|
|
408
|
+
data, _status_code, _headers = edit_document_docx_disable_track_changes_with_http_info(input_file, opts)
|
|
409
|
+
data
|
|
410
|
+
end
|
|
411
|
+
|
|
412
|
+
# Disable track changes, revisions in a Word DOCX document
|
|
413
|
+
# Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.
|
|
414
|
+
# @param input_file Input file to perform the operation on.
|
|
415
|
+
# @param [Hash] opts the optional parameters
|
|
416
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
417
|
+
def edit_document_docx_disable_track_changes_with_http_info(input_file, opts = {})
|
|
418
|
+
if @api_client.config.debugging
|
|
419
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_disable_track_changes ...'
|
|
420
|
+
end
|
|
421
|
+
# verify the required parameter 'input_file' is set
|
|
422
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
|
423
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_disable_track_changes"
|
|
424
|
+
end
|
|
425
|
+
# resource path
|
|
426
|
+
local_var_path = '/convert/edit/docx/track-changes/disable'
|
|
427
|
+
|
|
428
|
+
# query parameters
|
|
429
|
+
query_params = {}
|
|
430
|
+
|
|
431
|
+
# header parameters
|
|
432
|
+
header_params = {}
|
|
433
|
+
# HTTP header 'Accept' (if needed)
|
|
434
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
|
435
|
+
# HTTP header 'Content-Type'
|
|
436
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
437
|
+
|
|
438
|
+
# form parameters
|
|
439
|
+
form_params = {}
|
|
440
|
+
form_params['inputFile'] = input_file
|
|
441
|
+
|
|
442
|
+
# http body (model)
|
|
443
|
+
post_body = nil
|
|
444
|
+
auth_names = ['Apikey']
|
|
445
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
446
|
+
:header_params => header_params,
|
|
447
|
+
:query_params => query_params,
|
|
448
|
+
:form_params => form_params,
|
|
449
|
+
:body => post_body,
|
|
450
|
+
:auth_names => auth_names,
|
|
451
|
+
:return_type => 'String')
|
|
452
|
+
if @api_client.config.debugging
|
|
453
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_disable_track_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
454
|
+
end
|
|
455
|
+
return data, status_code, headers
|
|
456
|
+
end
|
|
457
|
+
# Enable track changes, revisions in a Word DOCX document
|
|
458
|
+
# Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.
|
|
459
|
+
# @param input_file Input file to perform the operation on.
|
|
460
|
+
# @param [Hash] opts the optional parameters
|
|
461
|
+
# @return [String]
|
|
462
|
+
def edit_document_docx_enable_track_changes(input_file, opts = {})
|
|
463
|
+
data, _status_code, _headers = edit_document_docx_enable_track_changes_with_http_info(input_file, opts)
|
|
464
|
+
data
|
|
465
|
+
end
|
|
466
|
+
|
|
467
|
+
# Enable track changes, revisions in a Word DOCX document
|
|
468
|
+
# Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.
|
|
469
|
+
# @param input_file Input file to perform the operation on.
|
|
470
|
+
# @param [Hash] opts the optional parameters
|
|
471
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
472
|
+
def edit_document_docx_enable_track_changes_with_http_info(input_file, opts = {})
|
|
473
|
+
if @api_client.config.debugging
|
|
474
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_enable_track_changes ...'
|
|
475
|
+
end
|
|
476
|
+
# verify the required parameter 'input_file' is set
|
|
477
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
|
478
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_enable_track_changes"
|
|
479
|
+
end
|
|
480
|
+
# resource path
|
|
481
|
+
local_var_path = '/convert/edit/docx/track-changes/enable'
|
|
482
|
+
|
|
483
|
+
# query parameters
|
|
484
|
+
query_params = {}
|
|
485
|
+
|
|
486
|
+
# header parameters
|
|
487
|
+
header_params = {}
|
|
488
|
+
# HTTP header 'Accept' (if needed)
|
|
489
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
|
490
|
+
# HTTP header 'Content-Type'
|
|
491
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
492
|
+
|
|
493
|
+
# form parameters
|
|
494
|
+
form_params = {}
|
|
495
|
+
form_params['inputFile'] = input_file
|
|
496
|
+
|
|
497
|
+
# http body (model)
|
|
498
|
+
post_body = nil
|
|
499
|
+
auth_names = ['Apikey']
|
|
500
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
501
|
+
:header_params => header_params,
|
|
502
|
+
:query_params => query_params,
|
|
503
|
+
:form_params => form_params,
|
|
504
|
+
:body => post_body,
|
|
505
|
+
:auth_names => auth_names,
|
|
506
|
+
:return_type => 'String')
|
|
507
|
+
if @api_client.config.debugging
|
|
508
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_enable_track_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
509
|
+
end
|
|
510
|
+
return data, status_code, headers
|
|
511
|
+
end
|
|
347
512
|
# Find matching paragraphs in a Word DOCX document
|
|
348
513
|
# Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria
|
|
349
514
|
# @param req_config Document input request
|
|
@@ -1208,6 +1373,61 @@ module CloudmersiveConvertApiClient
|
|
|
1208
1373
|
end
|
|
1209
1374
|
return data, status_code, headers
|
|
1210
1375
|
end
|
|
1376
|
+
# Remove all comments from a Word DOCX document
|
|
1377
|
+
# Removes all of the comments from a Word Document.
|
|
1378
|
+
# @param input_file Input file to perform the operation on.
|
|
1379
|
+
# @param [Hash] opts the optional parameters
|
|
1380
|
+
# @return [String]
|
|
1381
|
+
def edit_document_docx_remove_all_comments(input_file, opts = {})
|
|
1382
|
+
data, _status_code, _headers = edit_document_docx_remove_all_comments_with_http_info(input_file, opts)
|
|
1383
|
+
data
|
|
1384
|
+
end
|
|
1385
|
+
|
|
1386
|
+
# Remove all comments from a Word DOCX document
|
|
1387
|
+
# Removes all of the comments from a Word Document.
|
|
1388
|
+
# @param input_file Input file to perform the operation on.
|
|
1389
|
+
# @param [Hash] opts the optional parameters
|
|
1390
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
1391
|
+
def edit_document_docx_remove_all_comments_with_http_info(input_file, opts = {})
|
|
1392
|
+
if @api_client.config.debugging
|
|
1393
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_remove_all_comments ...'
|
|
1394
|
+
end
|
|
1395
|
+
# verify the required parameter 'input_file' is set
|
|
1396
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
|
1397
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_remove_all_comments"
|
|
1398
|
+
end
|
|
1399
|
+
# resource path
|
|
1400
|
+
local_var_path = '/convert/edit/docx/comments/remove-all'
|
|
1401
|
+
|
|
1402
|
+
# query parameters
|
|
1403
|
+
query_params = {}
|
|
1404
|
+
|
|
1405
|
+
# header parameters
|
|
1406
|
+
header_params = {}
|
|
1407
|
+
# HTTP header 'Accept' (if needed)
|
|
1408
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
|
1409
|
+
# HTTP header 'Content-Type'
|
|
1410
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
1411
|
+
|
|
1412
|
+
# form parameters
|
|
1413
|
+
form_params = {}
|
|
1414
|
+
form_params['inputFile'] = input_file
|
|
1415
|
+
|
|
1416
|
+
# http body (model)
|
|
1417
|
+
post_body = nil
|
|
1418
|
+
auth_names = ['Apikey']
|
|
1419
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
1420
|
+
:header_params => header_params,
|
|
1421
|
+
:query_params => query_params,
|
|
1422
|
+
:form_params => form_params,
|
|
1423
|
+
:body => post_body,
|
|
1424
|
+
:auth_names => auth_names,
|
|
1425
|
+
:return_type => 'String')
|
|
1426
|
+
if @api_client.config.debugging
|
|
1427
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_remove_all_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1428
|
+
end
|
|
1429
|
+
return data, status_code, headers
|
|
1430
|
+
end
|
|
1211
1431
|
# Remove headers and footers from Word DOCX document
|
|
1212
1432
|
# Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
|
1213
1433
|
# @param req_config Document input request
|
|
@@ -349,6 +349,116 @@ module CloudmersiveConvertApiClient
|
|
|
349
349
|
end
|
|
350
350
|
return data, status_code, headers
|
|
351
351
|
end
|
|
352
|
+
# Validate an HTML file
|
|
353
|
+
# Validate an HTML document file; if the document is not valid, identifies the errors in the document
|
|
354
|
+
# @param input_file Input file to perform the operation on.
|
|
355
|
+
# @param [Hash] opts the optional parameters
|
|
356
|
+
# @return [DocumentValidationResult]
|
|
357
|
+
def validate_document_html_validation(input_file, opts = {})
|
|
358
|
+
data, _status_code, _headers = validate_document_html_validation_with_http_info(input_file, opts)
|
|
359
|
+
data
|
|
360
|
+
end
|
|
361
|
+
|
|
362
|
+
# Validate an HTML file
|
|
363
|
+
# Validate an HTML document file; if the document is not valid, identifies the errors in the document
|
|
364
|
+
# @param input_file Input file to perform the operation on.
|
|
365
|
+
# @param [Hash] opts the optional parameters
|
|
366
|
+
# @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
|
|
367
|
+
def validate_document_html_validation_with_http_info(input_file, opts = {})
|
|
368
|
+
if @api_client.config.debugging
|
|
369
|
+
@api_client.config.logger.debug 'Calling API: ValidateDocumentApi.validate_document_html_validation ...'
|
|
370
|
+
end
|
|
371
|
+
# verify the required parameter 'input_file' is set
|
|
372
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
|
373
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_html_validation"
|
|
374
|
+
end
|
|
375
|
+
# resource path
|
|
376
|
+
local_var_path = '/convert/validate/html'
|
|
377
|
+
|
|
378
|
+
# query parameters
|
|
379
|
+
query_params = {}
|
|
380
|
+
|
|
381
|
+
# header parameters
|
|
382
|
+
header_params = {}
|
|
383
|
+
# HTTP header 'Accept' (if needed)
|
|
384
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
|
385
|
+
# HTTP header 'Content-Type'
|
|
386
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
387
|
+
|
|
388
|
+
# form parameters
|
|
389
|
+
form_params = {}
|
|
390
|
+
form_params['inputFile'] = input_file
|
|
391
|
+
|
|
392
|
+
# http body (model)
|
|
393
|
+
post_body = nil
|
|
394
|
+
auth_names = ['Apikey']
|
|
395
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
396
|
+
:header_params => header_params,
|
|
397
|
+
:query_params => query_params,
|
|
398
|
+
:form_params => form_params,
|
|
399
|
+
:body => post_body,
|
|
400
|
+
:auth_names => auth_names,
|
|
401
|
+
:return_type => 'DocumentValidationResult')
|
|
402
|
+
if @api_client.config.debugging
|
|
403
|
+
@api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_html_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
404
|
+
end
|
|
405
|
+
return data, status_code, headers
|
|
406
|
+
end
|
|
407
|
+
# Validate an Image File
|
|
408
|
+
# Validate an image file; if the document is not valid, identifies the errors in the document. Formats supported include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
|
409
|
+
# @param input_file Input file to perform the operation on.
|
|
410
|
+
# @param [Hash] opts the optional parameters
|
|
411
|
+
# @return [DocumentValidationResult]
|
|
412
|
+
def validate_document_image_validation(input_file, opts = {})
|
|
413
|
+
data, _status_code, _headers = validate_document_image_validation_with_http_info(input_file, opts)
|
|
414
|
+
data
|
|
415
|
+
end
|
|
416
|
+
|
|
417
|
+
# Validate an Image File
|
|
418
|
+
# Validate an image file; if the document is not valid, identifies the errors in the document. Formats supported include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
|
419
|
+
# @param input_file Input file to perform the operation on.
|
|
420
|
+
# @param [Hash] opts the optional parameters
|
|
421
|
+
# @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
|
|
422
|
+
def validate_document_image_validation_with_http_info(input_file, opts = {})
|
|
423
|
+
if @api_client.config.debugging
|
|
424
|
+
@api_client.config.logger.debug 'Calling API: ValidateDocumentApi.validate_document_image_validation ...'
|
|
425
|
+
end
|
|
426
|
+
# verify the required parameter 'input_file' is set
|
|
427
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
|
428
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_image_validation"
|
|
429
|
+
end
|
|
430
|
+
# resource path
|
|
431
|
+
local_var_path = '/convert/validate/image'
|
|
432
|
+
|
|
433
|
+
# query parameters
|
|
434
|
+
query_params = {}
|
|
435
|
+
|
|
436
|
+
# header parameters
|
|
437
|
+
header_params = {}
|
|
438
|
+
# HTTP header 'Accept' (if needed)
|
|
439
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
|
440
|
+
# HTTP header 'Content-Type'
|
|
441
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
442
|
+
|
|
443
|
+
# form parameters
|
|
444
|
+
form_params = {}
|
|
445
|
+
form_params['inputFile'] = input_file
|
|
446
|
+
|
|
447
|
+
# http body (model)
|
|
448
|
+
post_body = nil
|
|
449
|
+
auth_names = ['Apikey']
|
|
450
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
451
|
+
:header_params => header_params,
|
|
452
|
+
:query_params => query_params,
|
|
453
|
+
:form_params => form_params,
|
|
454
|
+
:body => post_body,
|
|
455
|
+
:auth_names => auth_names,
|
|
456
|
+
:return_type => 'DocumentValidationResult')
|
|
457
|
+
if @api_client.config.debugging
|
|
458
|
+
@api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_image_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
459
|
+
end
|
|
460
|
+
return data, status_code, headers
|
|
461
|
+
end
|
|
352
462
|
# Validate a JSON file
|
|
353
463
|
# Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document
|
|
354
464
|
# @param input_file Input file to perform the operation on.
|
|
@@ -155,6 +155,98 @@ module CloudmersiveConvertApiClient
|
|
|
155
155
|
end
|
|
156
156
|
return data, status_code, headers
|
|
157
157
|
end
|
|
158
|
+
# Compress files to create a new, encrypted and password-protected zip archive
|
|
159
|
+
# Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip.
|
|
160
|
+
# @param password Password to place on the Zip file; the longer the password, the more secure
|
|
161
|
+
# @param input_file1 First input file to perform the operation on.
|
|
162
|
+
# @param [Hash] opts the optional parameters
|
|
163
|
+
# @option opts [String] :encryption_algorithm Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.
|
|
164
|
+
# @option opts [File] :input_file2 Second input file to perform the operation on.
|
|
165
|
+
# @option opts [File] :input_file3 Third input file to perform the operation on.
|
|
166
|
+
# @option opts [File] :input_file4 Fourth input file to perform the operation on.
|
|
167
|
+
# @option opts [File] :input_file5 Fifth input file to perform the operation on.
|
|
168
|
+
# @option opts [File] :input_file6 Sixth input file to perform the operation on.
|
|
169
|
+
# @option opts [File] :input_file7 Seventh input file to perform the operation on.
|
|
170
|
+
# @option opts [File] :input_file8 Eighth input file to perform the operation on.
|
|
171
|
+
# @option opts [File] :input_file9 Ninth input file to perform the operation on.
|
|
172
|
+
# @option opts [File] :input_file10 Tenth input file to perform the operation on.
|
|
173
|
+
# @return [String]
|
|
174
|
+
def zip_archive_zip_create_encrypted(password, input_file1, opts = {})
|
|
175
|
+
data, _status_code, _headers = zip_archive_zip_create_encrypted_with_http_info(password, input_file1, opts)
|
|
176
|
+
data
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
# Compress files to create a new, encrypted and password-protected zip archive
|
|
180
|
+
# Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip.
|
|
181
|
+
# @param password Password to place on the Zip file; the longer the password, the more secure
|
|
182
|
+
# @param input_file1 First input file to perform the operation on.
|
|
183
|
+
# @param [Hash] opts the optional parameters
|
|
184
|
+
# @option opts [String] :encryption_algorithm Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.
|
|
185
|
+
# @option opts [File] :input_file2 Second input file to perform the operation on.
|
|
186
|
+
# @option opts [File] :input_file3 Third input file to perform the operation on.
|
|
187
|
+
# @option opts [File] :input_file4 Fourth input file to perform the operation on.
|
|
188
|
+
# @option opts [File] :input_file5 Fifth input file to perform the operation on.
|
|
189
|
+
# @option opts [File] :input_file6 Sixth input file to perform the operation on.
|
|
190
|
+
# @option opts [File] :input_file7 Seventh input file to perform the operation on.
|
|
191
|
+
# @option opts [File] :input_file8 Eighth input file to perform the operation on.
|
|
192
|
+
# @option opts [File] :input_file9 Ninth input file to perform the operation on.
|
|
193
|
+
# @option opts [File] :input_file10 Tenth input file to perform the operation on.
|
|
194
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
195
|
+
def zip_archive_zip_create_encrypted_with_http_info(password, input_file1, opts = {})
|
|
196
|
+
if @api_client.config.debugging
|
|
197
|
+
@api_client.config.logger.debug 'Calling API: ZipArchiveApi.zip_archive_zip_create_encrypted ...'
|
|
198
|
+
end
|
|
199
|
+
# verify the required parameter 'password' is set
|
|
200
|
+
if @api_client.config.client_side_validation && password.nil?
|
|
201
|
+
fail ArgumentError, "Missing the required parameter 'password' when calling ZipArchiveApi.zip_archive_zip_create_encrypted"
|
|
202
|
+
end
|
|
203
|
+
# verify the required parameter 'input_file1' is set
|
|
204
|
+
if @api_client.config.client_side_validation && input_file1.nil?
|
|
205
|
+
fail ArgumentError, "Missing the required parameter 'input_file1' when calling ZipArchiveApi.zip_archive_zip_create_encrypted"
|
|
206
|
+
end
|
|
207
|
+
# resource path
|
|
208
|
+
local_var_path = '/convert/archive/zip/create/encrypted'
|
|
209
|
+
|
|
210
|
+
# query parameters
|
|
211
|
+
query_params = {}
|
|
212
|
+
|
|
213
|
+
# header parameters
|
|
214
|
+
header_params = {}
|
|
215
|
+
# HTTP header 'Accept' (if needed)
|
|
216
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
|
217
|
+
# HTTP header 'Content-Type'
|
|
218
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
219
|
+
header_params[:'password'] = password
|
|
220
|
+
header_params[:'encryptionAlgorithm'] = opts[:'encryption_algorithm'] if !opts[:'encryption_algorithm'].nil?
|
|
221
|
+
|
|
222
|
+
# form parameters
|
|
223
|
+
form_params = {}
|
|
224
|
+
form_params['inputFile1'] = input_file1
|
|
225
|
+
form_params['inputFile2'] = opts[:'input_file2'] if !opts[:'input_file2'].nil?
|
|
226
|
+
form_params['inputFile3'] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
|
|
227
|
+
form_params['inputFile4'] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
|
|
228
|
+
form_params['inputFile5'] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
|
|
229
|
+
form_params['inputFile6'] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
|
|
230
|
+
form_params['inputFile7'] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
|
|
231
|
+
form_params['inputFile8'] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
|
|
232
|
+
form_params['inputFile9'] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
|
|
233
|
+
form_params['inputFile10'] = opts[:'input_file10'] if !opts[:'input_file10'].nil?
|
|
234
|
+
|
|
235
|
+
# http body (model)
|
|
236
|
+
post_body = nil
|
|
237
|
+
auth_names = ['Apikey']
|
|
238
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
239
|
+
:header_params => header_params,
|
|
240
|
+
:query_params => query_params,
|
|
241
|
+
:form_params => form_params,
|
|
242
|
+
:body => post_body,
|
|
243
|
+
:auth_names => auth_names,
|
|
244
|
+
:return_type => 'String')
|
|
245
|
+
if @api_client.config.debugging
|
|
246
|
+
@api_client.config.logger.debug "API called: ZipArchiveApi#zip_archive_zip_create_encrypted\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
247
|
+
end
|
|
248
|
+
return data, status_code, headers
|
|
249
|
+
end
|
|
158
250
|
# Decrypt and remove password protection on a zip file
|
|
159
251
|
# Decrypts and removes password protection from an encrypted zip file with the specified password
|
|
160
252
|
# @param input_file Input file to perform the operation on.
|
|
@@ -44,6 +44,18 @@ describe 'EditDocumentApi' do
|
|
|
44
44
|
end
|
|
45
45
|
end
|
|
46
46
|
|
|
47
|
+
# unit tests for edit_document_docx_accept_all_track_changes
|
|
48
|
+
# Accept all tracked changes, revisions in a Word DOCX document
|
|
49
|
+
# Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.
|
|
50
|
+
# @param input_file Input file to perform the operation on.
|
|
51
|
+
# @param [Hash] opts the optional parameters
|
|
52
|
+
# @return [String]
|
|
53
|
+
describe 'edit_document_docx_accept_all_track_changes test' do
|
|
54
|
+
it 'should work' do
|
|
55
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
|
|
47
59
|
# unit tests for edit_document_docx_body
|
|
48
60
|
# Get body from a Word DOCX document
|
|
49
61
|
# Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
|
|
@@ -104,6 +116,30 @@ describe 'EditDocumentApi' do
|
|
|
104
116
|
end
|
|
105
117
|
end
|
|
106
118
|
|
|
119
|
+
# unit tests for edit_document_docx_disable_track_changes
|
|
120
|
+
# Disable track changes, revisions in a Word DOCX document
|
|
121
|
+
# Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.
|
|
122
|
+
# @param input_file Input file to perform the operation on.
|
|
123
|
+
# @param [Hash] opts the optional parameters
|
|
124
|
+
# @return [String]
|
|
125
|
+
describe 'edit_document_docx_disable_track_changes test' do
|
|
126
|
+
it 'should work' do
|
|
127
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
128
|
+
end
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# unit tests for edit_document_docx_enable_track_changes
|
|
132
|
+
# Enable track changes, revisions in a Word DOCX document
|
|
133
|
+
# Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.
|
|
134
|
+
# @param input_file Input file to perform the operation on.
|
|
135
|
+
# @param [Hash] opts the optional parameters
|
|
136
|
+
# @return [String]
|
|
137
|
+
describe 'edit_document_docx_enable_track_changes test' do
|
|
138
|
+
it 'should work' do
|
|
139
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
140
|
+
end
|
|
141
|
+
end
|
|
142
|
+
|
|
107
143
|
# unit tests for edit_document_docx_find_paragraph
|
|
108
144
|
# Find matching paragraphs in a Word DOCX document
|
|
109
145
|
# Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria
|
|
@@ -296,6 +332,18 @@ describe 'EditDocumentApi' do
|
|
|
296
332
|
end
|
|
297
333
|
end
|
|
298
334
|
|
|
335
|
+
# unit tests for edit_document_docx_remove_all_comments
|
|
336
|
+
# Remove all comments from a Word DOCX document
|
|
337
|
+
# Removes all of the comments from a Word Document.
|
|
338
|
+
# @param input_file Input file to perform the operation on.
|
|
339
|
+
# @param [Hash] opts the optional parameters
|
|
340
|
+
# @return [String]
|
|
341
|
+
describe 'edit_document_docx_remove_all_comments test' do
|
|
342
|
+
it 'should work' do
|
|
343
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
344
|
+
end
|
|
345
|
+
end
|
|
346
|
+
|
|
299
347
|
# unit tests for edit_document_docx_remove_headers_and_footers
|
|
300
348
|
# Remove headers and footers from Word DOCX document
|
|
301
349
|
# Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
|
@@ -104,6 +104,30 @@ describe 'ValidateDocumentApi' do
|
|
|
104
104
|
end
|
|
105
105
|
end
|
|
106
106
|
|
|
107
|
+
# unit tests for validate_document_html_validation
|
|
108
|
+
# Validate an HTML file
|
|
109
|
+
# Validate an HTML document file; if the document is not valid, identifies the errors in the document
|
|
110
|
+
# @param input_file Input file to perform the operation on.
|
|
111
|
+
# @param [Hash] opts the optional parameters
|
|
112
|
+
# @return [DocumentValidationResult]
|
|
113
|
+
describe 'validate_document_html_validation test' do
|
|
114
|
+
it 'should work' do
|
|
115
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# unit tests for validate_document_image_validation
|
|
120
|
+
# Validate an Image File
|
|
121
|
+
# Validate an image file; if the document is not valid, identifies the errors in the document. Formats supported include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
|
122
|
+
# @param input_file Input file to perform the operation on.
|
|
123
|
+
# @param [Hash] opts the optional parameters
|
|
124
|
+
# @return [DocumentValidationResult]
|
|
125
|
+
describe 'validate_document_image_validation test' do
|
|
126
|
+
it 'should work' do
|
|
127
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
128
|
+
end
|
|
129
|
+
end
|
|
130
|
+
|
|
107
131
|
# unit tests for validate_document_json_validation
|
|
108
132
|
# Validate a JSON file
|
|
109
133
|
# Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document
|
|
@@ -65,6 +65,29 @@ describe 'ZipArchiveApi' do
|
|
|
65
65
|
end
|
|
66
66
|
end
|
|
67
67
|
|
|
68
|
+
# unit tests for zip_archive_zip_create_encrypted
|
|
69
|
+
# Compress files to create a new, encrypted and password-protected zip archive
|
|
70
|
+
# Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip.
|
|
71
|
+
# @param password Password to place on the Zip file; the longer the password, the more secure
|
|
72
|
+
# @param input_file1 First input file to perform the operation on.
|
|
73
|
+
# @param [Hash] opts the optional parameters
|
|
74
|
+
# @option opts [String] :encryption_algorithm Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.
|
|
75
|
+
# @option opts [File] :input_file2 Second input file to perform the operation on.
|
|
76
|
+
# @option opts [File] :input_file3 Third input file to perform the operation on.
|
|
77
|
+
# @option opts [File] :input_file4 Fourth input file to perform the operation on.
|
|
78
|
+
# @option opts [File] :input_file5 Fifth input file to perform the operation on.
|
|
79
|
+
# @option opts [File] :input_file6 Sixth input file to perform the operation on.
|
|
80
|
+
# @option opts [File] :input_file7 Seventh input file to perform the operation on.
|
|
81
|
+
# @option opts [File] :input_file8 Eighth input file to perform the operation on.
|
|
82
|
+
# @option opts [File] :input_file9 Ninth input file to perform the operation on.
|
|
83
|
+
# @option opts [File] :input_file10 Tenth input file to perform the operation on.
|
|
84
|
+
# @return [String]
|
|
85
|
+
describe 'zip_archive_zip_create_encrypted test' do
|
|
86
|
+
it 'should work' do
|
|
87
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
|
|
68
91
|
# unit tests for zip_archive_zip_decrypt
|
|
69
92
|
# Decrypt and remove password protection on a zip file
|
|
70
93
|
# Decrypts and removes password protection from an encrypted zip file with the specified password
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: cloudmersive-convert-api-client
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.0
|
|
4
|
+
version: 2.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Cloudmersive
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2020-
|
|
11
|
+
date: 2020-10-19 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|