cloudmersive-convert-api-client 2.1.0 → 2.1.1
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.
- checksums.yaml +4 -4
- data/README.md +12 -4
- data/docs/ConvertDataApi.md +117 -3
- data/docs/ConvertDocumentApi.md +159 -0
- data/docs/EditPdfApi.md +169 -0
- data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +117 -4
- data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +156 -0
- data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +168 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/convert_data_api_spec.rb +26 -1
- data/spec/api/convert_document_api_spec.rb +35 -0
- data/spec/api/edit_pdf_api_spec.rb +37 -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: 7caefd9807e6b0c3b5dcd64d0f812f1c5c86ca85fcce9bcaa0a16042043e68be
|
4
|
+
data.tar.gz: 4be6b68efc5efddae3ce6a1d2c375f4cbf55e15a40b1c1724c628ebf5c39c95a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5069819906277a81ccb3e868e0f2bdeab07828a6aa67313e27886e3e4cdb93ef2d1d69efde384ea93040b630c936ad8e27b30d68d8f4305a99bf5121bf326bc1
|
7
|
+
data.tar.gz: 2ba3feecda4c8d77487892eb19fdfb2e757c4e54d329e2591c76ec15b538d7ad5c906f3c5e55d92a979bdee75ea9020fb259eb7fb92c41dc8ed27ca41add4e37
|
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.1.
|
10
|
+
- Package version: 2.1.1
|
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.1.
|
26
|
+
gem install ./cloudmersive-convert-api-client-2.1.1.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.1.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.1.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 2.1.1'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -87,9 +87,11 @@ Class | Method | HTTP request | Description
|
|
87
87
|
------------ | ------------- | ------------- | -------------
|
88
88
|
*CloudmersiveConvertApiClient::CompareDocumentApi* | [**compare_document_docx**](docs/CompareDocumentApi.md#compare_document_docx) | **POST** /convert/compare/docx | Compare Two Word DOCX
|
89
89
|
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_csv_to_json**](docs/ConvertDataApi.md#convert_data_csv_to_json) | **POST** /convert/csv/to/json | Convert CSV to JSON conversion
|
90
|
+
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_csv_to_xml**](docs/ConvertDataApi.md#convert_data_csv_to_xml) | **POST** /convert/csv/to/xml | Convert CSV to XML conversion
|
90
91
|
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_json_to_xml**](docs/ConvertDataApi.md#convert_data_json_to_xml) | **POST** /convert/json/to/xml | Convert JSON to XML conversion
|
91
92
|
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xls_to_json**](docs/ConvertDataApi.md#convert_data_xls_to_json) | **POST** /convert/xls/to/json | Convert Excel (97-2003) XLS to JSON conversion
|
92
93
|
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xlsx_to_json**](docs/ConvertDataApi.md#convert_data_xlsx_to_json) | **POST** /convert/xlsx/to/json | Convert Excel XLSX to JSON conversion
|
94
|
+
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xlsx_to_xml**](docs/ConvertDataApi.md#convert_data_xlsx_to_xml) | **POST** /convert/xlsx/to/xml | Convert Excel XLSX to XML conversion
|
93
95
|
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xml_edit_add_attribute_with_x_path**](docs/ConvertDataApi.md#convert_data_xml_edit_add_attribute_with_x_path) | **POST** /convert/xml/edit/xpath/add-attribute | Adds an attribute to all XML nodes matching XPath expression
|
94
96
|
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xml_edit_add_child_with_x_path**](docs/ConvertDataApi.md#convert_data_xml_edit_add_child_with_x_path) | **POST** /convert/xml/edit/xpath/add-child | Adds an XML node as a child to XML nodes matching XPath expression
|
95
97
|
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xml_edit_remove_all_child_nodes_with_x_path**](docs/ConvertDataApi.md#convert_data_xml_edit_remove_all_child_nodes_with_x_path) | **POST** /convert/xml/edit/xpath/remove-all-children | Removes, deletes all children of nodes matching XPath expression, but does not remove the nodes
|
@@ -115,6 +117,7 @@ Class | Method | HTTP request | Description
|
|
115
117
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_doc_to_docx**](docs/ConvertDocumentApi.md#convert_document_doc_to_docx) | **POST** /convert/doc/to/docx | Convert Word DOC (97-03) Document to DOCX
|
116
118
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_doc_to_pdf**](docs/ConvertDocumentApi.md#convert_document_doc_to_pdf) | **POST** /convert/doc/to/pdf | Convert Word DOC (97-03) Document to PDF
|
117
119
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_doc_to_txt**](docs/ConvertDocumentApi.md#convert_document_doc_to_txt) | **POST** /convert/doc/to/txt | Convert Word DOC (97-03) Document to Text (txt)
|
120
|
+
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_docx_to_doc**](docs/ConvertDocumentApi.md#convert_document_docx_to_doc) | **POST** /convert/docx/to/doc | Convert Word DOCX Document to Legacy Word DOC (97-03)
|
118
121
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_docx_to_html**](docs/ConvertDocumentApi.md#convert_document_docx_to_html) | **POST** /convert/docx/to/html | Convert Word DOCX Document to HTML Document
|
119
122
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_docx_to_jpg**](docs/ConvertDocumentApi.md#convert_document_docx_to_jpg) | **POST** /convert/docx/to/jpg | Convert Word DOCX Document to JPG/JPEG image array
|
120
123
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_docx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_docx_to_pdf) | **POST** /convert/docx/to/pdf | Convert Word DOCX Document to PDF
|
@@ -162,6 +165,7 @@ Class | Method | HTTP request | Description
|
|
162
165
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_ppt_to_pptx**](docs/ConvertDocumentApi.md#convert_document_ppt_to_pptx) | **POST** /convert/ppt/to/pptx | Convert PowerPoint PPT (97-03) Presentation to PPTX
|
163
166
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pptx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_pptx_to_pdf) | **POST** /convert/pptx/to/pdf | Convert PowerPoint PPTX Presentation to PDF
|
164
167
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pptx_to_png**](docs/ConvertDocumentApi.md#convert_document_pptx_to_png) | **POST** /convert/pptx/to/png | Convert PowerPoint PPTX to PNG image array
|
168
|
+
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pptx_to_ppt**](docs/ConvertDocumentApi.md#convert_document_pptx_to_ppt) | **POST** /convert/pptx/to/ppt | Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
|
165
169
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pptx_to_txt**](docs/ConvertDocumentApi.md#convert_document_pptx_to_txt) | **POST** /convert/pptx/to/txt | Convert PowerPoint PPTX Presentation to Text (txt)
|
166
170
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_rtf_to_docx**](docs/ConvertDocumentApi.md#convert_document_rtf_to_docx) | **POST** /convert/rtf/to/docx | Convert Rich Text Format RTF to DOCX Document
|
167
171
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_rtf_to_html**](docs/ConvertDocumentApi.md#convert_document_rtf_to_html) | **POST** /convert/rtf/to/html | Convert Rich Text Format RTF to HTML Document
|
@@ -177,6 +181,7 @@ Class | Method | HTTP request | Description
|
|
177
181
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_pdf) | **POST** /convert/xlsx/to/pdf | Convert Excel XLSX Spreadsheet to PDF
|
178
182
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_png**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_png) | **POST** /convert/xlsx/to/png | Convert Excel XLSX spreadsheet to PNG image array
|
179
183
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_txt**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_txt) | **POST** /convert/xlsx/to/txt | Convert Excel XLSX Spreadsheet to Text (txt)
|
184
|
+
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_xls**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_xls) | **POST** /convert/xlsx/to/xls | Convert Excel XLSX Spreadsheet to Legacy Excel XLS (97-03)
|
180
185
|
*CloudmersiveConvertApiClient::ConvertImageApi* | [**convert_image_get_image_info**](docs/ConvertImageApi.md#convert_image_get_image_info) | **POST** /convert/image/get-info | Get information about an image
|
181
186
|
*CloudmersiveConvertApiClient::ConvertImageApi* | [**convert_image_image_format_convert**](docs/ConvertImageApi.md#convert_image_image_format_convert) | **POST** /convert/image/{format1}/to/{format2} | Image format conversion
|
182
187
|
*CloudmersiveConvertApiClient::ConvertImageApi* | [**convert_image_image_set_dpi**](docs/ConvertImageApi.md#convert_image_image_set_dpi) | **POST** /convert/image/set-dpi/{dpi} | Change image DPI
|
@@ -256,6 +261,7 @@ Class | Method | HTTP request | Description
|
|
256
261
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_append_paragraph**](docs/EditHtmlApi.md#edit_html_html_append_paragraph) | **POST** /convert/edit/html/append/paragraph | Append a Paragraph to an HTML Document
|
257
262
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_create_blank_document**](docs/EditHtmlApi.md#edit_html_html_create_blank_document) | **POST** /convert/edit/html/create/blank | Create a Blank HTML Document
|
258
263
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_add_annotations**](docs/EditPdfApi.md#edit_pdf_add_annotations) | **POST** /convert/edit/pdf/annotations/add-item | Add one or more PDF annotations, comments in the PDF document
|
264
|
+
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_convert_to_pdf_a**](docs/EditPdfApi.md#edit_pdf_convert_to_pdf_a) | **POST** /convert/edit/pdf/optimize/pdf-a | Convert a PDF file to PDF/A
|
259
265
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_decrypt**](docs/EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
|
260
266
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_delete_pages**](docs/EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove, delete pages from a PDF document
|
261
267
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_encrypt**](docs/EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
|
@@ -264,7 +270,9 @@ Class | Method | HTTP request | Description
|
|
264
270
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_metadata**](docs/EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
|
265
271
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_pdf_text_by_pages**](docs/EditPdfApi.md#edit_pdf_get_pdf_text_by_pages) | **POST** /convert/edit/pdf/pages/get-text | Get text in a PDF document by page
|
266
272
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_insert_pages**](docs/EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert, copy pages from one PDF document into another
|
273
|
+
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_linearize**](docs/EditPdfApi.md#edit_pdf_linearize) | **POST** /convert/edit/pdf/optimize/linearize | Linearize and optimize a PDF for streaming download
|
267
274
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_rasterize**](docs/EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
|
275
|
+
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_reduce_file_size**](docs/EditPdfApi.md#edit_pdf_reduce_file_size) | **POST** /convert/edit/pdf/optimize/reduce-file-size | Reduce the file size and optimize a PDF
|
268
276
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_remove_all_annotations**](docs/EditPdfApi.md#edit_pdf_remove_all_annotations) | **POST** /convert/edit/pdf/annotations/remove-all | Remove all PDF annotations, including comments in the document
|
269
277
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_remove_annotation_item**](docs/EditPdfApi.md#edit_pdf_remove_annotation_item) | **POST** /convert/edit/pdf/annotations/remove-item | Remove a specific PDF annotation, comment in the document
|
270
278
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_resize**](docs/EditPdfApi.md#edit_pdf_resize) | **POST** /convert/edit/pdf/resize | Change PDF Document's Paper Size
|
data/docs/ConvertDataApi.md
CHANGED
@@ -5,9 +5,11 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**convert_data_csv_to_json**](ConvertDataApi.md#convert_data_csv_to_json) | **POST** /convert/csv/to/json | Convert CSV to JSON conversion
|
8
|
+
[**convert_data_csv_to_xml**](ConvertDataApi.md#convert_data_csv_to_xml) | **POST** /convert/csv/to/xml | Convert CSV to XML conversion
|
8
9
|
[**convert_data_json_to_xml**](ConvertDataApi.md#convert_data_json_to_xml) | **POST** /convert/json/to/xml | Convert JSON to XML conversion
|
9
10
|
[**convert_data_xls_to_json**](ConvertDataApi.md#convert_data_xls_to_json) | **POST** /convert/xls/to/json | Convert Excel (97-2003) XLS to JSON conversion
|
10
11
|
[**convert_data_xlsx_to_json**](ConvertDataApi.md#convert_data_xlsx_to_json) | **POST** /convert/xlsx/to/json | Convert Excel XLSX to JSON conversion
|
12
|
+
[**convert_data_xlsx_to_xml**](ConvertDataApi.md#convert_data_xlsx_to_xml) | **POST** /convert/xlsx/to/xml | Convert Excel XLSX to XML conversion
|
11
13
|
[**convert_data_xml_edit_add_attribute_with_x_path**](ConvertDataApi.md#convert_data_xml_edit_add_attribute_with_x_path) | **POST** /convert/xml/edit/xpath/add-attribute | Adds an attribute to all XML nodes matching XPath expression
|
12
14
|
[**convert_data_xml_edit_add_child_with_x_path**](ConvertDataApi.md#convert_data_xml_edit_add_child_with_x_path) | **POST** /convert/xml/edit/xpath/add-child | Adds an XML node as a child to XML nodes matching XPath expression
|
13
15
|
[**convert_data_xml_edit_remove_all_child_nodes_with_x_path**](ConvertDataApi.md#convert_data_xml_edit_remove_all_child_nodes_with_x_path) | **POST** /convert/xml/edit/xpath/remove-all-children | Removes, deletes all children of nodes matching XPath expression, but does not remove the nodes
|
@@ -79,6 +81,64 @@ Name | Type | Description | Notes
|
|
79
81
|
|
80
82
|
|
81
83
|
|
84
|
+
# **convert_data_csv_to_xml**
|
85
|
+
> String convert_data_csv_to_xml(input_file, opts)
|
86
|
+
|
87
|
+
Convert CSV to XML conversion
|
88
|
+
|
89
|
+
Convert a CSV file to a XML file
|
90
|
+
|
91
|
+
### Example
|
92
|
+
```ruby
|
93
|
+
# load the gem
|
94
|
+
require 'cloudmersive-convert-api-client'
|
95
|
+
# setup authorization
|
96
|
+
CloudmersiveConvertApiClient.configure do |config|
|
97
|
+
# Configure API key authorization: Apikey
|
98
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
99
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
100
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
101
|
+
end
|
102
|
+
|
103
|
+
api_instance = CloudmersiveConvertApiClient::ConvertDataApi.new
|
104
|
+
|
105
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
106
|
+
|
107
|
+
opts = {
|
108
|
+
column_names_from_first_row: true # BOOLEAN | Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc. Default is true. Set to false if you are not using column headings, or have an irregular column structure.
|
109
|
+
}
|
110
|
+
|
111
|
+
begin
|
112
|
+
#Convert CSV to XML conversion
|
113
|
+
result = api_instance.convert_data_csv_to_xml(input_file, opts)
|
114
|
+
p result
|
115
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
116
|
+
puts "Exception when calling ConvertDataApi->convert_data_csv_to_xml: #{e}"
|
117
|
+
end
|
118
|
+
```
|
119
|
+
|
120
|
+
### Parameters
|
121
|
+
|
122
|
+
Name | Type | Description | Notes
|
123
|
+
------------- | ------------- | ------------- | -------------
|
124
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
125
|
+
**column_names_from_first_row** | **BOOLEAN**| Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc. Default is true. Set to false if you are not using column headings, or have an irregular column structure. | [optional]
|
126
|
+
|
127
|
+
### Return type
|
128
|
+
|
129
|
+
**String**
|
130
|
+
|
131
|
+
### Authorization
|
132
|
+
|
133
|
+
[Apikey](../README.md#Apikey)
|
134
|
+
|
135
|
+
### HTTP request headers
|
136
|
+
|
137
|
+
- **Content-Type**: multipart/form-data
|
138
|
+
- **Accept**: application/octet-stream
|
139
|
+
|
140
|
+
|
141
|
+
|
82
142
|
# **convert_data_json_to_xml**
|
83
143
|
> String convert_data_json_to_xml(json_object)
|
84
144
|
|
@@ -188,7 +248,7 @@ Name | Type | Description | Notes
|
|
188
248
|
|
189
249
|
|
190
250
|
# **convert_data_xlsx_to_json**
|
191
|
-
>
|
251
|
+
> String convert_data_xlsx_to_json(input_file)
|
192
252
|
|
193
253
|
Convert Excel XLSX to JSON conversion
|
194
254
|
|
@@ -228,7 +288,7 @@ Name | Type | Description | Notes
|
|
228
288
|
|
229
289
|
### Return type
|
230
290
|
|
231
|
-
**
|
291
|
+
**String**
|
232
292
|
|
233
293
|
### Authorization
|
234
294
|
|
@@ -237,7 +297,61 @@ Name | Type | Description | Notes
|
|
237
297
|
### HTTP request headers
|
238
298
|
|
239
299
|
- **Content-Type**: multipart/form-data
|
240
|
-
- **Accept**: application/
|
300
|
+
- **Accept**: application/octet-stream
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
# **convert_data_xlsx_to_xml**
|
305
|
+
> String convert_data_xlsx_to_xml(input_file)
|
306
|
+
|
307
|
+
Convert Excel XLSX to XML conversion
|
308
|
+
|
309
|
+
Convert an Excel XLSX file to a XML file
|
310
|
+
|
311
|
+
### Example
|
312
|
+
```ruby
|
313
|
+
# load the gem
|
314
|
+
require 'cloudmersive-convert-api-client'
|
315
|
+
# setup authorization
|
316
|
+
CloudmersiveConvertApiClient.configure do |config|
|
317
|
+
# Configure API key authorization: Apikey
|
318
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
319
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
320
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
321
|
+
end
|
322
|
+
|
323
|
+
api_instance = CloudmersiveConvertApiClient::ConvertDataApi.new
|
324
|
+
|
325
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
326
|
+
|
327
|
+
|
328
|
+
begin
|
329
|
+
#Convert Excel XLSX to XML conversion
|
330
|
+
result = api_instance.convert_data_xlsx_to_xml(input_file)
|
331
|
+
p result
|
332
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
333
|
+
puts "Exception when calling ConvertDataApi->convert_data_xlsx_to_xml: #{e}"
|
334
|
+
end
|
335
|
+
```
|
336
|
+
|
337
|
+
### Parameters
|
338
|
+
|
339
|
+
Name | Type | Description | Notes
|
340
|
+
------------- | ------------- | ------------- | -------------
|
341
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
342
|
+
|
343
|
+
### Return type
|
344
|
+
|
345
|
+
**String**
|
346
|
+
|
347
|
+
### Authorization
|
348
|
+
|
349
|
+
[Apikey](../README.md#Apikey)
|
350
|
+
|
351
|
+
### HTTP request headers
|
352
|
+
|
353
|
+
- **Content-Type**: multipart/form-data
|
354
|
+
- **Accept**: application/octet-stream
|
241
355
|
|
242
356
|
|
243
357
|
|
data/docs/ConvertDocumentApi.md
CHANGED
@@ -18,6 +18,7 @@ Method | HTTP request | Description
|
|
18
18
|
[**convert_document_doc_to_docx**](ConvertDocumentApi.md#convert_document_doc_to_docx) | **POST** /convert/doc/to/docx | Convert Word DOC (97-03) Document to DOCX
|
19
19
|
[**convert_document_doc_to_pdf**](ConvertDocumentApi.md#convert_document_doc_to_pdf) | **POST** /convert/doc/to/pdf | Convert Word DOC (97-03) Document to PDF
|
20
20
|
[**convert_document_doc_to_txt**](ConvertDocumentApi.md#convert_document_doc_to_txt) | **POST** /convert/doc/to/txt | Convert Word DOC (97-03) Document to Text (txt)
|
21
|
+
[**convert_document_docx_to_doc**](ConvertDocumentApi.md#convert_document_docx_to_doc) | **POST** /convert/docx/to/doc | Convert Word DOCX Document to Legacy Word DOC (97-03)
|
21
22
|
[**convert_document_docx_to_html**](ConvertDocumentApi.md#convert_document_docx_to_html) | **POST** /convert/docx/to/html | Convert Word DOCX Document to HTML Document
|
22
23
|
[**convert_document_docx_to_jpg**](ConvertDocumentApi.md#convert_document_docx_to_jpg) | **POST** /convert/docx/to/jpg | Convert Word DOCX Document to JPG/JPEG image array
|
23
24
|
[**convert_document_docx_to_pdf**](ConvertDocumentApi.md#convert_document_docx_to_pdf) | **POST** /convert/docx/to/pdf | Convert Word DOCX Document to PDF
|
@@ -65,6 +66,7 @@ Method | HTTP request | Description
|
|
65
66
|
[**convert_document_ppt_to_pptx**](ConvertDocumentApi.md#convert_document_ppt_to_pptx) | **POST** /convert/ppt/to/pptx | Convert PowerPoint PPT (97-03) Presentation to PPTX
|
66
67
|
[**convert_document_pptx_to_pdf**](ConvertDocumentApi.md#convert_document_pptx_to_pdf) | **POST** /convert/pptx/to/pdf | Convert PowerPoint PPTX Presentation to PDF
|
67
68
|
[**convert_document_pptx_to_png**](ConvertDocumentApi.md#convert_document_pptx_to_png) | **POST** /convert/pptx/to/png | Convert PowerPoint PPTX to PNG image array
|
69
|
+
[**convert_document_pptx_to_ppt**](ConvertDocumentApi.md#convert_document_pptx_to_ppt) | **POST** /convert/pptx/to/ppt | Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
|
68
70
|
[**convert_document_pptx_to_txt**](ConvertDocumentApi.md#convert_document_pptx_to_txt) | **POST** /convert/pptx/to/txt | Convert PowerPoint PPTX Presentation to Text (txt)
|
69
71
|
[**convert_document_rtf_to_docx**](ConvertDocumentApi.md#convert_document_rtf_to_docx) | **POST** /convert/rtf/to/docx | Convert Rich Text Format RTF to DOCX Document
|
70
72
|
[**convert_document_rtf_to_html**](ConvertDocumentApi.md#convert_document_rtf_to_html) | **POST** /convert/rtf/to/html | Convert Rich Text Format RTF to HTML Document
|
@@ -80,6 +82,7 @@ Method | HTTP request | Description
|
|
80
82
|
[**convert_document_xlsx_to_pdf**](ConvertDocumentApi.md#convert_document_xlsx_to_pdf) | **POST** /convert/xlsx/to/pdf | Convert Excel XLSX Spreadsheet to PDF
|
81
83
|
[**convert_document_xlsx_to_png**](ConvertDocumentApi.md#convert_document_xlsx_to_png) | **POST** /convert/xlsx/to/png | Convert Excel XLSX spreadsheet to PNG image array
|
82
84
|
[**convert_document_xlsx_to_txt**](ConvertDocumentApi.md#convert_document_xlsx_to_txt) | **POST** /convert/xlsx/to/txt | Convert Excel XLSX Spreadsheet to Text (txt)
|
85
|
+
[**convert_document_xlsx_to_xls**](ConvertDocumentApi.md#convert_document_xlsx_to_xls) | **POST** /convert/xlsx/to/xls | Convert Excel XLSX Spreadsheet to Legacy Excel XLS (97-03)
|
83
86
|
|
84
87
|
|
85
88
|
# **convert_document_autodetect_get_info**
|
@@ -887,6 +890,60 @@ Name | Type | Description | Notes
|
|
887
890
|
|
888
891
|
|
889
892
|
|
893
|
+
# **convert_document_docx_to_doc**
|
894
|
+
> String convert_document_docx_to_doc(input_file)
|
895
|
+
|
896
|
+
Convert Word DOCX Document to Legacy Word DOC (97-03)
|
897
|
+
|
898
|
+
Convert/downgrade modern Office Word DOCX Documents (DOCX) to the legacy Word DOC (97-2003 Format) format
|
899
|
+
|
900
|
+
### Example
|
901
|
+
```ruby
|
902
|
+
# load the gem
|
903
|
+
require 'cloudmersive-convert-api-client'
|
904
|
+
# setup authorization
|
905
|
+
CloudmersiveConvertApiClient.configure do |config|
|
906
|
+
# Configure API key authorization: Apikey
|
907
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
908
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
909
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
910
|
+
end
|
911
|
+
|
912
|
+
api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
|
913
|
+
|
914
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
915
|
+
|
916
|
+
|
917
|
+
begin
|
918
|
+
#Convert Word DOCX Document to Legacy Word DOC (97-03)
|
919
|
+
result = api_instance.convert_document_docx_to_doc(input_file)
|
920
|
+
p result
|
921
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
922
|
+
puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_doc: #{e}"
|
923
|
+
end
|
924
|
+
```
|
925
|
+
|
926
|
+
### Parameters
|
927
|
+
|
928
|
+
Name | Type | Description | Notes
|
929
|
+
------------- | ------------- | ------------- | -------------
|
930
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
931
|
+
|
932
|
+
### Return type
|
933
|
+
|
934
|
+
**String**
|
935
|
+
|
936
|
+
### Authorization
|
937
|
+
|
938
|
+
[Apikey](../README.md#Apikey)
|
939
|
+
|
940
|
+
### HTTP request headers
|
941
|
+
|
942
|
+
- **Content-Type**: multipart/form-data
|
943
|
+
- **Accept**: application/octet-stream
|
944
|
+
|
945
|
+
|
946
|
+
|
890
947
|
# **convert_document_docx_to_html**
|
891
948
|
> String convert_document_docx_to_html(input_file)
|
892
949
|
|
@@ -3520,6 +3577,54 @@ Name | Type | Description | Notes
|
|
3520
3577
|
|
3521
3578
|
|
3522
3579
|
|
3580
|
+
# **convert_document_pptx_to_ppt**
|
3581
|
+
> Object convert_document_pptx_to_ppt
|
3582
|
+
|
3583
|
+
Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
|
3584
|
+
|
3585
|
+
Convert/downgrade modern Office PowerPoint PPTX Presentation to the legacy PowerPoint PPT (97-2003 Format) format
|
3586
|
+
|
3587
|
+
### Example
|
3588
|
+
```ruby
|
3589
|
+
# load the gem
|
3590
|
+
require 'cloudmersive-convert-api-client'
|
3591
|
+
# setup authorization
|
3592
|
+
CloudmersiveConvertApiClient.configure do |config|
|
3593
|
+
# Configure API key authorization: Apikey
|
3594
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
3595
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3596
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
3597
|
+
end
|
3598
|
+
|
3599
|
+
api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
|
3600
|
+
|
3601
|
+
begin
|
3602
|
+
#Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
|
3603
|
+
result = api_instance.convert_document_pptx_to_ppt
|
3604
|
+
p result
|
3605
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
3606
|
+
puts "Exception when calling ConvertDocumentApi->convert_document_pptx_to_ppt: #{e}"
|
3607
|
+
end
|
3608
|
+
```
|
3609
|
+
|
3610
|
+
### Parameters
|
3611
|
+
This endpoint does not need any parameter.
|
3612
|
+
|
3613
|
+
### Return type
|
3614
|
+
|
3615
|
+
**Object**
|
3616
|
+
|
3617
|
+
### Authorization
|
3618
|
+
|
3619
|
+
[Apikey](../README.md#Apikey)
|
3620
|
+
|
3621
|
+
### HTTP request headers
|
3622
|
+
|
3623
|
+
- **Content-Type**: Not defined
|
3624
|
+
- **Accept**: application/octet-stream
|
3625
|
+
|
3626
|
+
|
3627
|
+
|
3523
3628
|
# **convert_document_pptx_to_txt**
|
3524
3629
|
> TextConversionResult convert_document_pptx_to_txt(input_file)
|
3525
3630
|
|
@@ -4342,3 +4447,57 @@ Name | Type | Description | Notes
|
|
4342
4447
|
|
4343
4448
|
|
4344
4449
|
|
4450
|
+
# **convert_document_xlsx_to_xls**
|
4451
|
+
> String convert_document_xlsx_to_xls(input_file)
|
4452
|
+
|
4453
|
+
Convert Excel XLSX Spreadsheet to Legacy Excel XLS (97-03)
|
4454
|
+
|
4455
|
+
Convert/downgrade modern Office Excel XLSX Spreadsheet to the legacy Excel XLS (97-2003 Format) format
|
4456
|
+
|
4457
|
+
### Example
|
4458
|
+
```ruby
|
4459
|
+
# load the gem
|
4460
|
+
require 'cloudmersive-convert-api-client'
|
4461
|
+
# setup authorization
|
4462
|
+
CloudmersiveConvertApiClient.configure do |config|
|
4463
|
+
# Configure API key authorization: Apikey
|
4464
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
4465
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4466
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
4467
|
+
end
|
4468
|
+
|
4469
|
+
api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
|
4470
|
+
|
4471
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
4472
|
+
|
4473
|
+
|
4474
|
+
begin
|
4475
|
+
#Convert Excel XLSX Spreadsheet to Legacy Excel XLS (97-03)
|
4476
|
+
result = api_instance.convert_document_xlsx_to_xls(input_file)
|
4477
|
+
p result
|
4478
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
4479
|
+
puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_xls: #{e}"
|
4480
|
+
end
|
4481
|
+
```
|
4482
|
+
|
4483
|
+
### Parameters
|
4484
|
+
|
4485
|
+
Name | Type | Description | Notes
|
4486
|
+
------------- | ------------- | ------------- | -------------
|
4487
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
4488
|
+
|
4489
|
+
### Return type
|
4490
|
+
|
4491
|
+
**String**
|
4492
|
+
|
4493
|
+
### Authorization
|
4494
|
+
|
4495
|
+
[Apikey](../README.md#Apikey)
|
4496
|
+
|
4497
|
+
### HTTP request headers
|
4498
|
+
|
4499
|
+
- **Content-Type**: multipart/form-data
|
4500
|
+
- **Accept**: application/octet-stream
|
4501
|
+
|
4502
|
+
|
4503
|
+
|
data/docs/EditPdfApi.md
CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**edit_pdf_add_annotations**](EditPdfApi.md#edit_pdf_add_annotations) | **POST** /convert/edit/pdf/annotations/add-item | Add one or more PDF annotations, comments in the PDF document
|
8
|
+
[**edit_pdf_convert_to_pdf_a**](EditPdfApi.md#edit_pdf_convert_to_pdf_a) | **POST** /convert/edit/pdf/optimize/pdf-a | Convert a PDF file to PDF/A
|
8
9
|
[**edit_pdf_decrypt**](EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
|
9
10
|
[**edit_pdf_delete_pages**](EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove, delete pages from a PDF document
|
10
11
|
[**edit_pdf_encrypt**](EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
|
@@ -13,7 +14,9 @@ Method | HTTP request | Description
|
|
13
14
|
[**edit_pdf_get_metadata**](EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
|
14
15
|
[**edit_pdf_get_pdf_text_by_pages**](EditPdfApi.md#edit_pdf_get_pdf_text_by_pages) | **POST** /convert/edit/pdf/pages/get-text | Get text in a PDF document by page
|
15
16
|
[**edit_pdf_insert_pages**](EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert, copy pages from one PDF document into another
|
17
|
+
[**edit_pdf_linearize**](EditPdfApi.md#edit_pdf_linearize) | **POST** /convert/edit/pdf/optimize/linearize | Linearize and optimize a PDF for streaming download
|
16
18
|
[**edit_pdf_rasterize**](EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
|
19
|
+
[**edit_pdf_reduce_file_size**](EditPdfApi.md#edit_pdf_reduce_file_size) | **POST** /convert/edit/pdf/optimize/reduce-file-size | Reduce the file size and optimize a PDF
|
17
20
|
[**edit_pdf_remove_all_annotations**](EditPdfApi.md#edit_pdf_remove_all_annotations) | **POST** /convert/edit/pdf/annotations/remove-all | Remove all PDF annotations, including comments in the document
|
18
21
|
[**edit_pdf_remove_annotation_item**](EditPdfApi.md#edit_pdf_remove_annotation_item) | **POST** /convert/edit/pdf/annotations/remove-item | Remove a specific PDF annotation, comment in the document
|
19
22
|
[**edit_pdf_resize**](EditPdfApi.md#edit_pdf_resize) | **POST** /convert/edit/pdf/resize | Change PDF Document's Paper Size
|
@@ -79,6 +82,64 @@ Name | Type | Description | Notes
|
|
79
82
|
|
80
83
|
|
81
84
|
|
85
|
+
# **edit_pdf_convert_to_pdf_a**
|
86
|
+
> String edit_pdf_convert_to_pdf_a(input_file, opts)
|
87
|
+
|
88
|
+
Convert a PDF file to PDF/A
|
89
|
+
|
90
|
+
Converts the input PDF file to a PDF/A-1b or PDF/A-2b standardized PDF.
|
91
|
+
|
92
|
+
### Example
|
93
|
+
```ruby
|
94
|
+
# load the gem
|
95
|
+
require 'cloudmersive-convert-api-client'
|
96
|
+
# setup authorization
|
97
|
+
CloudmersiveConvertApiClient.configure do |config|
|
98
|
+
# Configure API key authorization: Apikey
|
99
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
100
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
101
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
102
|
+
end
|
103
|
+
|
104
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
105
|
+
|
106
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
107
|
+
|
108
|
+
opts = {
|
109
|
+
conformance_level: 'conformance_level_example' # String | Optional: Select the conformance level for PDF/A - specify '1b' for PDF/A-1b or specify '2b' for PDF/A-2b; default is PDF/A-1b
|
110
|
+
}
|
111
|
+
|
112
|
+
begin
|
113
|
+
#Convert a PDF file to PDF/A
|
114
|
+
result = api_instance.edit_pdf_convert_to_pdf_a(input_file, opts)
|
115
|
+
p result
|
116
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
117
|
+
puts "Exception when calling EditPdfApi->edit_pdf_convert_to_pdf_a: #{e}"
|
118
|
+
end
|
119
|
+
```
|
120
|
+
|
121
|
+
### Parameters
|
122
|
+
|
123
|
+
Name | Type | Description | Notes
|
124
|
+
------------- | ------------- | ------------- | -------------
|
125
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
126
|
+
**conformance_level** | **String**| Optional: Select the conformance level for PDF/A - specify '1b' for PDF/A-1b or specify '2b' for PDF/A-2b; default is PDF/A-1b | [optional]
|
127
|
+
|
128
|
+
### Return type
|
129
|
+
|
130
|
+
**String**
|
131
|
+
|
132
|
+
### Authorization
|
133
|
+
|
134
|
+
[Apikey](../README.md#Apikey)
|
135
|
+
|
136
|
+
### HTTP request headers
|
137
|
+
|
138
|
+
- **Content-Type**: multipart/form-data
|
139
|
+
- **Accept**: application/octet-stream
|
140
|
+
|
141
|
+
|
142
|
+
|
82
143
|
# **edit_pdf_decrypt**
|
83
144
|
> String edit_pdf_decrypt(password, input_file)
|
84
145
|
|
@@ -544,6 +605,60 @@ Name | Type | Description | Notes
|
|
544
605
|
|
545
606
|
|
546
607
|
|
608
|
+
# **edit_pdf_linearize**
|
609
|
+
> String edit_pdf_linearize(input_file)
|
610
|
+
|
611
|
+
Linearize and optimize a PDF for streaming download
|
612
|
+
|
613
|
+
Linearizes the content of a PDF to optimize it for streaming download, particularly over web streaming.
|
614
|
+
|
615
|
+
### Example
|
616
|
+
```ruby
|
617
|
+
# load the gem
|
618
|
+
require 'cloudmersive-convert-api-client'
|
619
|
+
# setup authorization
|
620
|
+
CloudmersiveConvertApiClient.configure do |config|
|
621
|
+
# Configure API key authorization: Apikey
|
622
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
623
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
624
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
625
|
+
end
|
626
|
+
|
627
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
628
|
+
|
629
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
630
|
+
|
631
|
+
|
632
|
+
begin
|
633
|
+
#Linearize and optimize a PDF for streaming download
|
634
|
+
result = api_instance.edit_pdf_linearize(input_file)
|
635
|
+
p result
|
636
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
637
|
+
puts "Exception when calling EditPdfApi->edit_pdf_linearize: #{e}"
|
638
|
+
end
|
639
|
+
```
|
640
|
+
|
641
|
+
### Parameters
|
642
|
+
|
643
|
+
Name | Type | Description | Notes
|
644
|
+
------------- | ------------- | ------------- | -------------
|
645
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
646
|
+
|
647
|
+
### Return type
|
648
|
+
|
649
|
+
**String**
|
650
|
+
|
651
|
+
### Authorization
|
652
|
+
|
653
|
+
[Apikey](../README.md#Apikey)
|
654
|
+
|
655
|
+
### HTTP request headers
|
656
|
+
|
657
|
+
- **Content-Type**: multipart/form-data
|
658
|
+
- **Accept**: application/octet-stream
|
659
|
+
|
660
|
+
|
661
|
+
|
547
662
|
# **edit_pdf_rasterize**
|
548
663
|
> String edit_pdf_rasterize(input_file)
|
549
664
|
|
@@ -598,6 +713,60 @@ Name | Type | Description | Notes
|
|
598
713
|
|
599
714
|
|
600
715
|
|
716
|
+
# **edit_pdf_reduce_file_size**
|
717
|
+
> String edit_pdf_reduce_file_size(input_file)
|
718
|
+
|
719
|
+
Reduce the file size and optimize a PDF
|
720
|
+
|
721
|
+
Reduces the file size and optimizes the content of a PDF to minimize its file size.
|
722
|
+
|
723
|
+
### Example
|
724
|
+
```ruby
|
725
|
+
# load the gem
|
726
|
+
require 'cloudmersive-convert-api-client'
|
727
|
+
# setup authorization
|
728
|
+
CloudmersiveConvertApiClient.configure do |config|
|
729
|
+
# Configure API key authorization: Apikey
|
730
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
731
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
732
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
733
|
+
end
|
734
|
+
|
735
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
736
|
+
|
737
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
738
|
+
|
739
|
+
|
740
|
+
begin
|
741
|
+
#Reduce the file size and optimize a PDF
|
742
|
+
result = api_instance.edit_pdf_reduce_file_size(input_file)
|
743
|
+
p result
|
744
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
745
|
+
puts "Exception when calling EditPdfApi->edit_pdf_reduce_file_size: #{e}"
|
746
|
+
end
|
747
|
+
```
|
748
|
+
|
749
|
+
### Parameters
|
750
|
+
|
751
|
+
Name | Type | Description | Notes
|
752
|
+
------------- | ------------- | ------------- | -------------
|
753
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
754
|
+
|
755
|
+
### Return type
|
756
|
+
|
757
|
+
**String**
|
758
|
+
|
759
|
+
### Authorization
|
760
|
+
|
761
|
+
[Apikey](../README.md#Apikey)
|
762
|
+
|
763
|
+
### HTTP request headers
|
764
|
+
|
765
|
+
- **Content-Type**: multipart/form-data
|
766
|
+
- **Accept**: application/octet-stream
|
767
|
+
|
768
|
+
|
769
|
+
|
601
770
|
# **edit_pdf_remove_all_annotations**
|
602
771
|
> String edit_pdf_remove_all_annotations(input_file)
|
603
772
|
|