cloudmersive-convert-api-client 1.7.3 → 1.7.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +45 -5
- data/docs/AutodetectToThumbnailsResult.md +9 -0
- data/docs/ConvertDataApi.md +6 -2
- data/docs/ConvertDocumentApi.md +794 -84
- data/docs/CsvCollection.md +10 -0
- data/docs/CsvFileResult.md +9 -0
- data/docs/DocumentValidationResult.md +1 -0
- data/docs/DocxParagraph.md +1 -1
- data/docs/DocxRun.md +1 -1
- data/docs/DocxText.md +1 -1
- data/docs/DocxToPngResult.md +9 -0
- data/docs/EditDocumentApi.md +110 -0
- data/docs/EmlAttachment.md +9 -0
- data/docs/EmlToHtmlResult.md +16 -0
- data/docs/FindDocxParagraphRequest.md +11 -0
- data/docs/FindDocxParagraphResponse.md +10 -0
- data/docs/GetFileTypeIconResult.md +10 -0
- data/docs/MsgAttachment.md +9 -0
- data/docs/MsgToHtmlResult.md +16 -0
- data/docs/PptxToPngResult.md +9 -0
- data/docs/ReplaceDocxParagraphRequest.md +12 -0
- data/docs/ReplaceDocxParagraphResponse.md +9 -0
- data/docs/Thumbnail.md +9 -0
- data/docs/ValidateDocumentApi.md +386 -1
- data/docs/XlsxToPngResult.md +9 -0
- data/docs/ZipArchiveApi.md +144 -5
- data/docs/ZipEncryptionAdvancedRequest.md +10 -0
- data/lib/cloudmersive-convert-api-client.rb +17 -0
- data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +3 -0
- data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +722 -6
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +110 -0
- data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +394 -2
- data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +160 -6
- data/lib/cloudmersive-convert-api-client/models/autodetect_to_thumbnails_result.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/csv_collection.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/csv_file_result.rb +215 -0
- data/lib/cloudmersive-convert-api-client/models/document_validation_result.rb +11 -1
- data/lib/cloudmersive-convert-api-client/models/docx_paragraph.rb +1 -1
- data/lib/cloudmersive-convert-api-client/models/docx_run.rb +1 -1
- data/lib/cloudmersive-convert-api-client/models/docx_text.rb +1 -1
- data/lib/cloudmersive-convert-api-client/models/docx_to_png_result.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/eml_attachment.rb +215 -0
- data/lib/cloudmersive-convert-api-client/models/eml_to_html_result.rb +271 -0
- data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_request.rb +235 -0
- data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_response.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_file_type_icon_result.rb +225 -0
- data/lib/cloudmersive-convert-api-client/models/msg_attachment.rb +215 -0
- data/lib/cloudmersive-convert-api-client/models/msg_to_html_result.rb +271 -0
- data/lib/cloudmersive-convert-api-client/models/pptx_to_png_result.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_request.rb +245 -0
- data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/thumbnail.rb +215 -0
- data/lib/cloudmersive-convert-api-client/models/xlsx_to_png_result.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/zip_encryption_advanced_request.rb +225 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/convert_data_api_spec.rb +1 -0
- data/spec/api/convert_document_api_spec.rb +163 -3
- data/spec/api/edit_document_api_spec.rb +24 -0
- data/spec/api/validate_document_api_spec.rb +85 -1
- data/spec/api/zip_archive_api_spec.rb +36 -1
- data/spec/models/autodetect_to_thumbnails_result_spec.rb +48 -0
- data/spec/models/csv_collection_spec.rb +54 -0
- data/spec/models/csv_file_result_spec.rb +48 -0
- data/spec/models/document_validation_result_spec.rb +6 -0
- data/spec/models/docx_to_png_result_spec.rb +48 -0
- data/spec/models/eml_attachment_spec.rb +48 -0
- data/spec/models/eml_to_html_result_spec.rb +90 -0
- data/spec/models/find_docx_paragraph_request_spec.rb +60 -0
- data/spec/models/find_docx_paragraph_response_spec.rb +54 -0
- data/spec/models/get_file_type_icon_result_spec.rb +54 -0
- data/spec/models/msg_attachment_spec.rb +48 -0
- data/spec/models/msg_to_html_result_spec.rb +90 -0
- data/spec/models/pptx_to_png_result_spec.rb +48 -0
- data/spec/models/replace_docx_paragraph_request_spec.rb +66 -0
- data/spec/models/replace_docx_paragraph_response_spec.rb +48 -0
- data/spec/models/thumbnail_spec.rb +48 -0
- data/spec/models/xlsx_to_png_result_spec.rb +48 -0
- data/spec/models/zip_encryption_advanced_request_spec.rb +54 -0
- metadata +53 -2
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::XlsxToPngResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**png_result_pages** | [**Array<ConvertedPngPage>**](ConvertedPngPage.md) | Array of converted pages | [optional]
|
8
|
+
|
9
|
+
|
data/docs/ZipArchiveApi.md
CHANGED
@@ -6,11 +6,13 @@ 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_decrypt**](ZipArchiveApi.md#zip_archive_zip_decrypt) | **POST** /convert/archive/zip/decrypt | Decrypt and remove password protection on a zip file
|
10
|
+
[**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
|
9
11
|
[**zip_archive_zip_extract**](ZipArchiveApi.md#zip_archive_zip_extract) | **POST** /convert/archive/zip/extract | Extract, decompress files and folders from a zip archive
|
10
12
|
|
11
13
|
|
12
14
|
# **zip_archive_zip_create**
|
13
|
-
>
|
15
|
+
> String zip_archive_zip_create(input_file1, opts)
|
14
16
|
|
15
17
|
Compress files to create a new zip archive
|
16
18
|
|
@@ -30,9 +32,23 @@ end
|
|
30
32
|
|
31
33
|
api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
|
32
34
|
|
35
|
+
input_file1 = File.new("/path/to/file.txt") # File | First input file to perform the operation on.
|
36
|
+
|
37
|
+
opts = {
|
38
|
+
input_file2: File.new("/path/to/file.txt"), # File | Second input file to perform the operation on.
|
39
|
+
input_file3: File.new("/path/to/file.txt"), # File | Third input file to perform the operation on.
|
40
|
+
input_file4: File.new("/path/to/file.txt"), # File | Fourth input file to perform the operation on.
|
41
|
+
input_file5: File.new("/path/to/file.txt"), # File | Fifth input file to perform the operation on.
|
42
|
+
input_file6: File.new("/path/to/file.txt"), # File | Sixth input file to perform the operation on.
|
43
|
+
input_file7: File.new("/path/to/file.txt"), # File | Seventh input file to perform the operation on.
|
44
|
+
input_file8: File.new("/path/to/file.txt"), # File | Eighth input file to perform the operation on.
|
45
|
+
input_file9: File.new("/path/to/file.txt"), # File | Ninth input file to perform the operation on.
|
46
|
+
input_file10: File.new("/path/to/file.txt") # File | Tenth input file to perform the operation on.
|
47
|
+
}
|
48
|
+
|
33
49
|
begin
|
34
50
|
#Compress files to create a new zip archive
|
35
|
-
result = api_instance.zip_archive_zip_create
|
51
|
+
result = api_instance.zip_archive_zip_create(input_file1, opts)
|
36
52
|
p result
|
37
53
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
38
54
|
puts "Exception when calling ZipArchiveApi->zip_archive_zip_create: #{e}"
|
@@ -40,11 +56,23 @@ end
|
|
40
56
|
```
|
41
57
|
|
42
58
|
### Parameters
|
43
|
-
|
59
|
+
|
60
|
+
Name | Type | Description | Notes
|
61
|
+
------------- | ------------- | ------------- | -------------
|
62
|
+
**input_file1** | **File**| First input file to perform the operation on. |
|
63
|
+
**input_file2** | **File**| Second input file to perform the operation on. | [optional]
|
64
|
+
**input_file3** | **File**| Third input file to perform the operation on. | [optional]
|
65
|
+
**input_file4** | **File**| Fourth input file to perform the operation on. | [optional]
|
66
|
+
**input_file5** | **File**| Fifth input file to perform the operation on. | [optional]
|
67
|
+
**input_file6** | **File**| Sixth input file to perform the operation on. | [optional]
|
68
|
+
**input_file7** | **File**| Seventh input file to perform the operation on. | [optional]
|
69
|
+
**input_file8** | **File**| Eighth input file to perform the operation on. | [optional]
|
70
|
+
**input_file9** | **File**| Ninth input file to perform the operation on. | [optional]
|
71
|
+
**input_file10** | **File**| Tenth input file to perform the operation on. | [optional]
|
44
72
|
|
45
73
|
### Return type
|
46
74
|
|
47
|
-
**
|
75
|
+
**String**
|
48
76
|
|
49
77
|
### Authorization
|
50
78
|
|
@@ -52,7 +80,7 @@ This endpoint does not need any parameter.
|
|
52
80
|
|
53
81
|
### HTTP request headers
|
54
82
|
|
55
|
-
- **Content-Type**:
|
83
|
+
- **Content-Type**: multipart/form-data
|
56
84
|
- **Accept**: application/octet-stream
|
57
85
|
|
58
86
|
|
@@ -111,6 +139,117 @@ Name | Type | Description | Notes
|
|
111
139
|
|
112
140
|
|
113
141
|
|
142
|
+
# **zip_archive_zip_decrypt**
|
143
|
+
> Object zip_archive_zip_decrypt(input_file, zip_password)
|
144
|
+
|
145
|
+
Decrypt and remove password protection on a zip file
|
146
|
+
|
147
|
+
Decrypts and removes password protection from an encrypted zip file with the specified password
|
148
|
+
|
149
|
+
### Example
|
150
|
+
```ruby
|
151
|
+
# load the gem
|
152
|
+
require 'cloudmersive-convert-api-client'
|
153
|
+
# setup authorization
|
154
|
+
CloudmersiveConvertApiClient.configure do |config|
|
155
|
+
# Configure API key authorization: Apikey
|
156
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
157
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
158
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
159
|
+
end
|
160
|
+
|
161
|
+
api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
|
162
|
+
|
163
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
164
|
+
|
165
|
+
zip_password = "zip_password_example" # String | Required; Password for the input archive
|
166
|
+
|
167
|
+
|
168
|
+
begin
|
169
|
+
#Decrypt and remove password protection on a zip file
|
170
|
+
result = api_instance.zip_archive_zip_decrypt(input_file, zip_password)
|
171
|
+
p result
|
172
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
173
|
+
puts "Exception when calling ZipArchiveApi->zip_archive_zip_decrypt: #{e}"
|
174
|
+
end
|
175
|
+
```
|
176
|
+
|
177
|
+
### Parameters
|
178
|
+
|
179
|
+
Name | Type | Description | Notes
|
180
|
+
------------- | ------------- | ------------- | -------------
|
181
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
182
|
+
**zip_password** | **String**| Required; Password for the input archive |
|
183
|
+
|
184
|
+
### Return type
|
185
|
+
|
186
|
+
**Object**
|
187
|
+
|
188
|
+
### Authorization
|
189
|
+
|
190
|
+
[Apikey](../README.md#Apikey)
|
191
|
+
|
192
|
+
### HTTP request headers
|
193
|
+
|
194
|
+
- **Content-Type**: multipart/form-data
|
195
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
# **zip_archive_zip_encrypt_advanced**
|
200
|
+
> Object zip_archive_zip_encrypt_advanced(encryption_request)
|
201
|
+
|
202
|
+
Encrypt and password protect a zip file
|
203
|
+
|
204
|
+
Encrypts and password protects an existing zip file with the specified password and encryption algorithm
|
205
|
+
|
206
|
+
### Example
|
207
|
+
```ruby
|
208
|
+
# load the gem
|
209
|
+
require 'cloudmersive-convert-api-client'
|
210
|
+
# setup authorization
|
211
|
+
CloudmersiveConvertApiClient.configure do |config|
|
212
|
+
# Configure API key authorization: Apikey
|
213
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
214
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
215
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
216
|
+
end
|
217
|
+
|
218
|
+
api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
|
219
|
+
|
220
|
+
encryption_request = CloudmersiveConvertApiClient::ZipEncryptionAdvancedRequest.new # ZipEncryptionAdvancedRequest | Encryption request
|
221
|
+
|
222
|
+
|
223
|
+
begin
|
224
|
+
#Encrypt and password protect a zip file
|
225
|
+
result = api_instance.zip_archive_zip_encrypt_advanced(encryption_request)
|
226
|
+
p result
|
227
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
228
|
+
puts "Exception when calling ZipArchiveApi->zip_archive_zip_encrypt_advanced: #{e}"
|
229
|
+
end
|
230
|
+
```
|
231
|
+
|
232
|
+
### Parameters
|
233
|
+
|
234
|
+
Name | Type | Description | Notes
|
235
|
+
------------- | ------------- | ------------- | -------------
|
236
|
+
**encryption_request** | [**ZipEncryptionAdvancedRequest**](ZipEncryptionAdvancedRequest.md)| Encryption request |
|
237
|
+
|
238
|
+
### Return type
|
239
|
+
|
240
|
+
**Object**
|
241
|
+
|
242
|
+
### Authorization
|
243
|
+
|
244
|
+
[Apikey](../README.md#Apikey)
|
245
|
+
|
246
|
+
### HTTP request headers
|
247
|
+
|
248
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
249
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
250
|
+
|
251
|
+
|
252
|
+
|
114
253
|
# **zip_archive_zip_extract**
|
115
254
|
> ZipExtractResponse zip_archive_zip_extract(input_file)
|
116
255
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::ZipEncryptionAdvancedRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**input_file_contents** | **String** | Input Zip File archive contents in bytes | [optional]
|
7
|
+
**password** | **String** | Password to place on the Zip file; the longer the password, the more secure | [optional]
|
8
|
+
**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]
|
9
|
+
|
10
|
+
|
@@ -22,6 +22,7 @@ require 'cloudmersive-convert-api-client/models/alternate_file_format_candidate'
|
|
22
22
|
require 'cloudmersive-convert-api-client/models/autodetect_document_validation_result'
|
23
23
|
require 'cloudmersive-convert-api-client/models/autodetect_get_info_result'
|
24
24
|
require 'cloudmersive-convert-api-client/models/autodetect_to_png_result'
|
25
|
+
require 'cloudmersive-convert-api-client/models/autodetect_to_thumbnails_result'
|
25
26
|
require 'cloudmersive-convert-api-client/models/base64_decode_request'
|
26
27
|
require 'cloudmersive-convert-api-client/models/base64_decode_response'
|
27
28
|
require 'cloudmersive-convert-api-client/models/base64_detect_request'
|
@@ -39,6 +40,8 @@ require 'cloudmersive-convert-api-client/models/create_blank_spreadsheet_respons
|
|
39
40
|
require 'cloudmersive-convert-api-client/models/create_spreadsheet_from_data_request'
|
40
41
|
require 'cloudmersive-convert-api-client/models/create_spreadsheet_from_data_response'
|
41
42
|
require 'cloudmersive-convert-api-client/models/create_zip_archive_request'
|
43
|
+
require 'cloudmersive-convert-api-client/models/csv_collection'
|
44
|
+
require 'cloudmersive-convert-api-client/models/csv_file_result'
|
42
45
|
require 'cloudmersive-convert-api-client/models/delete_docx_table_row_range_request'
|
43
46
|
require 'cloudmersive-convert-api-client/models/delete_docx_table_row_range_response'
|
44
47
|
require 'cloudmersive-convert-api-client/models/delete_docx_table_row_request'
|
@@ -75,10 +78,15 @@ require 'cloudmersive-convert-api-client/models/docx_table_row'
|
|
75
78
|
require 'cloudmersive-convert-api-client/models/docx_template_application_request'
|
76
79
|
require 'cloudmersive-convert-api-client/models/docx_template_operation'
|
77
80
|
require 'cloudmersive-convert-api-client/models/docx_text'
|
81
|
+
require 'cloudmersive-convert-api-client/models/docx_to_png_result'
|
78
82
|
require 'cloudmersive-convert-api-client/models/docx_top_level_comment'
|
83
|
+
require 'cloudmersive-convert-api-client/models/eml_attachment'
|
84
|
+
require 'cloudmersive-convert-api-client/models/eml_to_html_result'
|
79
85
|
require 'cloudmersive-convert-api-client/models/enable_shared_workbook_request'
|
80
86
|
require 'cloudmersive-convert-api-client/models/enable_shared_workbook_response'
|
81
87
|
require 'cloudmersive-convert-api-client/models/exif_value'
|
88
|
+
require 'cloudmersive-convert-api-client/models/find_docx_paragraph_request'
|
89
|
+
require 'cloudmersive-convert-api-client/models/find_docx_paragraph_response'
|
82
90
|
require 'cloudmersive-convert-api-client/models/find_regex_match'
|
83
91
|
require 'cloudmersive-convert-api-client/models/find_string_match'
|
84
92
|
require 'cloudmersive-convert-api-client/models/find_string_regex_request'
|
@@ -108,6 +116,7 @@ require 'cloudmersive-convert-api-client/models/get_docx_table_row_request'
|
|
108
116
|
require 'cloudmersive-convert-api-client/models/get_docx_table_row_response'
|
109
117
|
require 'cloudmersive-convert-api-client/models/get_docx_tables_request'
|
110
118
|
require 'cloudmersive-convert-api-client/models/get_docx_tables_response'
|
119
|
+
require 'cloudmersive-convert-api-client/models/get_file_type_icon_result'
|
111
120
|
require 'cloudmersive-convert-api-client/models/get_image_info_result'
|
112
121
|
require 'cloudmersive-convert-api-client/models/get_pdf_annotations_result'
|
113
122
|
require 'cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_request'
|
@@ -142,6 +151,8 @@ require 'cloudmersive-convert-api-client/models/insert_docx_tables_request'
|
|
142
151
|
require 'cloudmersive-convert-api-client/models/insert_docx_tables_response'
|
143
152
|
require 'cloudmersive-convert-api-client/models/insert_xlsx_worksheet_request'
|
144
153
|
require 'cloudmersive-convert-api-client/models/insert_xlsx_worksheet_response'
|
154
|
+
require 'cloudmersive-convert-api-client/models/msg_attachment'
|
155
|
+
require 'cloudmersive-convert-api-client/models/msg_to_html_result'
|
145
156
|
require 'cloudmersive-convert-api-client/models/multipage_image_format_conversion_result'
|
146
157
|
require 'cloudmersive-convert-api-client/models/page_conversion_result'
|
147
158
|
require 'cloudmersive-convert-api-client/models/pdf_annotation'
|
@@ -152,6 +163,7 @@ require 'cloudmersive-convert-api-client/models/pdf_metadata'
|
|
152
163
|
require 'cloudmersive-convert-api-client/models/pdf_page_text'
|
153
164
|
require 'cloudmersive-convert-api-client/models/pdf_text_by_page_result'
|
154
165
|
require 'cloudmersive-convert-api-client/models/pdf_to_png_result'
|
166
|
+
require 'cloudmersive-convert-api-client/models/pptx_to_png_result'
|
155
167
|
require 'cloudmersive-convert-api-client/models/presentation_result'
|
156
168
|
require 'cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_request'
|
157
169
|
require 'cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_response'
|
@@ -162,6 +174,8 @@ require 'cloudmersive-convert-api-client/models/remove_pptx_slides_request'
|
|
162
174
|
require 'cloudmersive-convert-api-client/models/remove_whitespace_from_text_request'
|
163
175
|
require 'cloudmersive-convert-api-client/models/remove_whitespace_from_text_response'
|
164
176
|
require 'cloudmersive-convert-api-client/models/remove_xlsx_worksheet_request'
|
177
|
+
require 'cloudmersive-convert-api-client/models/replace_docx_paragraph_request'
|
178
|
+
require 'cloudmersive-convert-api-client/models/replace_docx_paragraph_response'
|
165
179
|
require 'cloudmersive-convert-api-client/models/replace_string_regex_request'
|
166
180
|
require 'cloudmersive-convert-api-client/models/replace_string_regex_response'
|
167
181
|
require 'cloudmersive-convert-api-client/models/replace_string_request'
|
@@ -186,6 +200,7 @@ require 'cloudmersive-convert-api-client/models/text_conversion_result'
|
|
186
200
|
require 'cloudmersive-convert-api-client/models/text_document_element'
|
187
201
|
require 'cloudmersive-convert-api-client/models/text_document_line'
|
188
202
|
require 'cloudmersive-convert-api-client/models/text_encoding_detect_response'
|
203
|
+
require 'cloudmersive-convert-api-client/models/thumbnail'
|
189
204
|
require 'cloudmersive-convert-api-client/models/update_docx_table_cell_request'
|
190
205
|
require 'cloudmersive-convert-api-client/models/update_docx_table_cell_response'
|
191
206
|
require 'cloudmersive-convert-api-client/models/update_docx_table_row_request'
|
@@ -199,6 +214,7 @@ require 'cloudmersive-convert-api-client/models/xlsx_image'
|
|
199
214
|
require 'cloudmersive-convert-api-client/models/xlsx_spreadsheet_cell'
|
200
215
|
require 'cloudmersive-convert-api-client/models/xlsx_spreadsheet_column'
|
201
216
|
require 'cloudmersive-convert-api-client/models/xlsx_spreadsheet_row'
|
217
|
+
require 'cloudmersive-convert-api-client/models/xlsx_to_png_result'
|
202
218
|
require 'cloudmersive-convert-api-client/models/xlsx_worksheet'
|
203
219
|
require 'cloudmersive-convert-api-client/models/xml_add_attribute_with_x_path_result'
|
204
220
|
require 'cloudmersive-convert-api-client/models/xml_add_child_with_x_path_result'
|
@@ -210,6 +226,7 @@ require 'cloudmersive-convert-api-client/models/xml_remove_with_x_path_result'
|
|
210
226
|
require 'cloudmersive-convert-api-client/models/xml_replace_with_x_path_result'
|
211
227
|
require 'cloudmersive-convert-api-client/models/xml_set_value_with_x_path_result'
|
212
228
|
require 'cloudmersive-convert-api-client/models/zip_directory'
|
229
|
+
require 'cloudmersive-convert-api-client/models/zip_encryption_advanced_request'
|
213
230
|
require 'cloudmersive-convert-api-client/models/zip_extract_response'
|
214
231
|
require 'cloudmersive-convert-api-client/models/zip_file'
|
215
232
|
|
@@ -24,6 +24,7 @@ module CloudmersiveConvertApiClient
|
|
24
24
|
# Convert a CSV file to a JSON object array
|
25
25
|
# @param input_file Input file to perform the operation on.
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
|
+
# @option opts [BOOLEAN] :column_names_from_first_row 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.
|
27
28
|
# @return [Object]
|
28
29
|
def convert_data_csv_to_json(input_file, opts = {})
|
29
30
|
data, _status_code, _headers = convert_data_csv_to_json_with_http_info(input_file, opts)
|
@@ -34,6 +35,7 @@ module CloudmersiveConvertApiClient
|
|
34
35
|
# Convert a CSV file to a JSON object array
|
35
36
|
# @param input_file Input file to perform the operation on.
|
36
37
|
# @param [Hash] opts the optional parameters
|
38
|
+
# @option opts [BOOLEAN] :column_names_from_first_row 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.
|
37
39
|
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
38
40
|
def convert_data_csv_to_json_with_http_info(input_file, opts = {})
|
39
41
|
if @api_client.config.debugging
|
@@ -55,6 +57,7 @@ module CloudmersiveConvertApiClient
|
|
55
57
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
56
58
|
# HTTP header 'Content-Type'
|
57
59
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
60
|
+
header_params[:'columnNamesFromFirstRow'] = opts[:'column_names_from_first_row'] if !opts[:'column_names_from_first_row'].nil?
|
58
61
|
|
59
62
|
# form parameters
|
60
63
|
form_params = {}
|
@@ -188,6 +188,139 @@ module CloudmersiveConvertApiClient
|
|
188
188
|
return data, status_code, headers
|
189
189
|
end
|
190
190
|
|
191
|
+
# Convert File to Thumbnail Image
|
192
|
+
# Automatically detect file type and convert it to a PNG thumbnail. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files. Returns a generic PNG thumbnail for unsupported formats.
|
193
|
+
# @param input_file Input file to perform the operation on.
|
194
|
+
# @param [Hash] opts the optional parameters
|
195
|
+
# @option opts [Integer] :max_width Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
|
196
|
+
# @option opts [Integer] :max_height Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
|
197
|
+
# @option opts [String] :extension Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon.
|
198
|
+
# @return [String]
|
199
|
+
def convert_document_autodetect_to_thumbnail(input_file, opts = {})
|
200
|
+
data, _status_code, _headers = convert_document_autodetect_to_thumbnail_with_http_info(input_file, opts)
|
201
|
+
return data
|
202
|
+
end
|
203
|
+
|
204
|
+
# Convert File to Thumbnail Image
|
205
|
+
# Automatically detect file type and convert it to a PNG thumbnail. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files. Returns a generic PNG thumbnail for unsupported formats.
|
206
|
+
# @param input_file Input file to perform the operation on.
|
207
|
+
# @param [Hash] opts the optional parameters
|
208
|
+
# @option opts [Integer] :max_width Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
|
209
|
+
# @option opts [Integer] :max_height Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
|
210
|
+
# @option opts [String] :extension Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon.
|
211
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
212
|
+
def convert_document_autodetect_to_thumbnail_with_http_info(input_file, opts = {})
|
213
|
+
if @api_client.config.debugging
|
214
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_autodetect_to_thumbnail ..."
|
215
|
+
end
|
216
|
+
# verify the required parameter 'input_file' is set
|
217
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
218
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_autodetect_to_thumbnail"
|
219
|
+
end
|
220
|
+
# resource path
|
221
|
+
local_var_path = "/convert/autodetect/to/thumbnail"
|
222
|
+
|
223
|
+
# query parameters
|
224
|
+
query_params = {}
|
225
|
+
|
226
|
+
# header parameters
|
227
|
+
header_params = {}
|
228
|
+
# HTTP header 'Accept' (if needed)
|
229
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
230
|
+
# HTTP header 'Content-Type'
|
231
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
232
|
+
header_params[:'maxWidth'] = opts[:'max_width'] if !opts[:'max_width'].nil?
|
233
|
+
header_params[:'maxHeight'] = opts[:'max_height'] if !opts[:'max_height'].nil?
|
234
|
+
header_params[:'extension'] = opts[:'extension'] if !opts[:'extension'].nil?
|
235
|
+
|
236
|
+
# form parameters
|
237
|
+
form_params = {}
|
238
|
+
form_params["inputFile"] = input_file
|
239
|
+
|
240
|
+
# http body (model)
|
241
|
+
post_body = nil
|
242
|
+
auth_names = ['Apikey']
|
243
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
244
|
+
:header_params => header_params,
|
245
|
+
:query_params => query_params,
|
246
|
+
:form_params => form_params,
|
247
|
+
:body => post_body,
|
248
|
+
:auth_names => auth_names,
|
249
|
+
:return_type => 'String')
|
250
|
+
if @api_client.config.debugging
|
251
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_autodetect_to_thumbnail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
252
|
+
end
|
253
|
+
return data, status_code, headers
|
254
|
+
end
|
255
|
+
|
256
|
+
# Convert File to Thumbnail Image Object
|
257
|
+
# Automatically detect file type and convert it to an array of PNG thumbnails, returned as an object. May specify the number of pages for multiple thumbnails; default is one thumbnail. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files. Returns a generic PNG thumbnail for unsupported formats.
|
258
|
+
# @param input_file Input file to perform the operation on.
|
259
|
+
# @param [Hash] opts the optional parameters
|
260
|
+
# @option opts [Integer] :pages Optional; Specify how many pages of the document will be converted to thumbnails. Default is 1 page.
|
261
|
+
# @option opts [Integer] :max_width Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
|
262
|
+
# @option opts [Integer] :max_height Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
|
263
|
+
# @option opts [String] :extension Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon.
|
264
|
+
# @return [AutodetectToThumbnailsResult]
|
265
|
+
def convert_document_autodetect_to_thumbnails_advanced(input_file, opts = {})
|
266
|
+
data, _status_code, _headers = convert_document_autodetect_to_thumbnails_advanced_with_http_info(input_file, opts)
|
267
|
+
return data
|
268
|
+
end
|
269
|
+
|
270
|
+
# Convert File to Thumbnail Image Object
|
271
|
+
# Automatically detect file type and convert it to an array of PNG thumbnails, returned as an object. May specify the number of pages for multiple thumbnails; default is one thumbnail. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files. Returns a generic PNG thumbnail for unsupported formats.
|
272
|
+
# @param input_file Input file to perform the operation on.
|
273
|
+
# @param [Hash] opts the optional parameters
|
274
|
+
# @option opts [Integer] :pages Optional; Specify how many pages of the document will be converted to thumbnails. Default is 1 page.
|
275
|
+
# @option opts [Integer] :max_width Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
|
276
|
+
# @option opts [Integer] :max_height Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
|
277
|
+
# @option opts [String] :extension Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon.
|
278
|
+
# @return [Array<(AutodetectToThumbnailsResult, Fixnum, Hash)>] AutodetectToThumbnailsResult data, response status code and response headers
|
279
|
+
def convert_document_autodetect_to_thumbnails_advanced_with_http_info(input_file, opts = {})
|
280
|
+
if @api_client.config.debugging
|
281
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_autodetect_to_thumbnails_advanced ..."
|
282
|
+
end
|
283
|
+
# verify the required parameter 'input_file' is set
|
284
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
285
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_autodetect_to_thumbnails_advanced"
|
286
|
+
end
|
287
|
+
# resource path
|
288
|
+
local_var_path = "/convert/autodetect/to/thumbnail/advanced"
|
289
|
+
|
290
|
+
# query parameters
|
291
|
+
query_params = {}
|
292
|
+
|
293
|
+
# header parameters
|
294
|
+
header_params = {}
|
295
|
+
# HTTP header 'Accept' (if needed)
|
296
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
297
|
+
# HTTP header 'Content-Type'
|
298
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
299
|
+
header_params[:'pages'] = opts[:'pages'] if !opts[:'pages'].nil?
|
300
|
+
header_params[:'maxWidth'] = opts[:'max_width'] if !opts[:'max_width'].nil?
|
301
|
+
header_params[:'maxHeight'] = opts[:'max_height'] if !opts[:'max_height'].nil?
|
302
|
+
header_params[:'extension'] = opts[:'extension'] if !opts[:'extension'].nil?
|
303
|
+
|
304
|
+
# form parameters
|
305
|
+
form_params = {}
|
306
|
+
form_params["inputFile"] = input_file
|
307
|
+
|
308
|
+
# http body (model)
|
309
|
+
post_body = nil
|
310
|
+
auth_names = ['Apikey']
|
311
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
312
|
+
:header_params => header_params,
|
313
|
+
:query_params => query_params,
|
314
|
+
:form_params => form_params,
|
315
|
+
:body => post_body,
|
316
|
+
:auth_names => auth_names,
|
317
|
+
:return_type => 'AutodetectToThumbnailsResult')
|
318
|
+
if @api_client.config.debugging
|
319
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_autodetect_to_thumbnails_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
320
|
+
end
|
321
|
+
return data, status_code, headers
|
322
|
+
end
|
323
|
+
|
191
324
|
# Convert Document to Text (txt)
|
192
325
|
# Automatically detect file type and convert it to Text. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files. For spreadsheets, all worksheets will be included. If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.
|
193
326
|
# @param input_file Input file to perform the operation on.
|
@@ -527,6 +660,62 @@ module CloudmersiveConvertApiClient
|
|
527
660
|
return data, status_code, headers
|
528
661
|
end
|
529
662
|
|
663
|
+
# Convert DOCX document to PNG image array
|
664
|
+
# Converts an Office Word Document (DOCX) file to an array of PNG images, one for each page.
|
665
|
+
# @param input_file Input file to perform the operation on.
|
666
|
+
# @param [Hash] opts the optional parameters
|
667
|
+
# @return [DocxToPngResult]
|
668
|
+
def convert_document_docx_to_png(input_file, opts = {})
|
669
|
+
data, _status_code, _headers = convert_document_docx_to_png_with_http_info(input_file, opts)
|
670
|
+
return data
|
671
|
+
end
|
672
|
+
|
673
|
+
# Convert DOCX document to PNG image array
|
674
|
+
# Converts an Office Word Document (DOCX) file to an array of PNG images, one for each page.
|
675
|
+
# @param input_file Input file to perform the operation on.
|
676
|
+
# @param [Hash] opts the optional parameters
|
677
|
+
# @return [Array<(DocxToPngResult, Fixnum, Hash)>] DocxToPngResult data, response status code and response headers
|
678
|
+
def convert_document_docx_to_png_with_http_info(input_file, opts = {})
|
679
|
+
if @api_client.config.debugging
|
680
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_docx_to_png ..."
|
681
|
+
end
|
682
|
+
# verify the required parameter 'input_file' is set
|
683
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
684
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_docx_to_png"
|
685
|
+
end
|
686
|
+
# resource path
|
687
|
+
local_var_path = "/convert/docx/to/png"
|
688
|
+
|
689
|
+
# query parameters
|
690
|
+
query_params = {}
|
691
|
+
|
692
|
+
# header parameters
|
693
|
+
header_params = {}
|
694
|
+
# HTTP header 'Accept' (if needed)
|
695
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
696
|
+
# HTTP header 'Content-Type'
|
697
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
698
|
+
|
699
|
+
# form parameters
|
700
|
+
form_params = {}
|
701
|
+
form_params["inputFile"] = input_file
|
702
|
+
|
703
|
+
# http body (model)
|
704
|
+
post_body = nil
|
705
|
+
auth_names = ['Apikey']
|
706
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
707
|
+
:header_params => header_params,
|
708
|
+
:query_params => query_params,
|
709
|
+
:form_params => form_params,
|
710
|
+
:body => post_body,
|
711
|
+
:auth_names => auth_names,
|
712
|
+
:return_type => 'DocxToPngResult')
|
713
|
+
if @api_client.config.debugging
|
714
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_docx_to_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
715
|
+
end
|
716
|
+
return data, status_code, headers
|
717
|
+
end
|
718
|
+
|
530
719
|
# Convert Word DOCX Document to Text (txt)
|
531
720
|
# Convert Office Word Documents (docx) to text
|
532
721
|
# @param input_file Input file to perform the operation on.
|
@@ -586,6 +775,241 @@ module CloudmersiveConvertApiClient
|
|
586
775
|
return data, status_code, headers
|
587
776
|
end
|
588
777
|
|
778
|
+
# Convert Email EML file to HTML string
|
779
|
+
# Convert Outlook Email EML file to HTML string and attachments. Supports images if they are base 64 inline.
|
780
|
+
# @param input_file Input file to perform the operation on.
|
781
|
+
# @param [Hash] opts the optional parameters
|
782
|
+
# @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
|
783
|
+
# @option opts [BOOLEAN] :include_attachments Optional; If false, the response object will not include any attachment files from the input file. Default is true.
|
784
|
+
# @return [EmlToHtmlResult]
|
785
|
+
def convert_document_eml_to_html(input_file, opts = {})
|
786
|
+
data, _status_code, _headers = convert_document_eml_to_html_with_http_info(input_file, opts)
|
787
|
+
return data
|
788
|
+
end
|
789
|
+
|
790
|
+
# Convert Email EML file to HTML string
|
791
|
+
# Convert Outlook Email EML file to HTML string and attachments. Supports images if they are base 64 inline.
|
792
|
+
# @param input_file Input file to perform the operation on.
|
793
|
+
# @param [Hash] opts the optional parameters
|
794
|
+
# @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
|
795
|
+
# @option opts [BOOLEAN] :include_attachments Optional; If false, the response object will not include any attachment files from the input file. Default is true.
|
796
|
+
# @return [Array<(EmlToHtmlResult, Fixnum, Hash)>] EmlToHtmlResult data, response status code and response headers
|
797
|
+
def convert_document_eml_to_html_with_http_info(input_file, opts = {})
|
798
|
+
if @api_client.config.debugging
|
799
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_eml_to_html ..."
|
800
|
+
end
|
801
|
+
# verify the required parameter 'input_file' is set
|
802
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
803
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_eml_to_html"
|
804
|
+
end
|
805
|
+
# resource path
|
806
|
+
local_var_path = "/convert/eml/to/html"
|
807
|
+
|
808
|
+
# query parameters
|
809
|
+
query_params = {}
|
810
|
+
|
811
|
+
# header parameters
|
812
|
+
header_params = {}
|
813
|
+
# HTTP header 'Accept' (if needed)
|
814
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
815
|
+
# HTTP header 'Content-Type'
|
816
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
817
|
+
header_params[:'bodyOnly'] = opts[:'body_only'] if !opts[:'body_only'].nil?
|
818
|
+
header_params[:'includeAttachments'] = opts[:'include_attachments'] if !opts[:'include_attachments'].nil?
|
819
|
+
|
820
|
+
# form parameters
|
821
|
+
form_params = {}
|
822
|
+
form_params["inputFile"] = input_file
|
823
|
+
|
824
|
+
# http body (model)
|
825
|
+
post_body = nil
|
826
|
+
auth_names = ['Apikey']
|
827
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
828
|
+
:header_params => header_params,
|
829
|
+
:query_params => query_params,
|
830
|
+
:form_params => form_params,
|
831
|
+
:body => post_body,
|
832
|
+
:auth_names => auth_names,
|
833
|
+
:return_type => 'EmlToHtmlResult')
|
834
|
+
if @api_client.config.debugging
|
835
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_eml_to_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
836
|
+
end
|
837
|
+
return data, status_code, headers
|
838
|
+
end
|
839
|
+
|
840
|
+
# Convert Email EML file to PDF document
|
841
|
+
# Convert Outlook Email EML file to PDF document. Supports images if they are base 64 inline.
|
842
|
+
# @param input_file Input file to perform the operation on.
|
843
|
+
# @param [Hash] opts the optional parameters
|
844
|
+
# @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
|
845
|
+
# @return [String]
|
846
|
+
def convert_document_eml_to_pdf(input_file, opts = {})
|
847
|
+
data, _status_code, _headers = convert_document_eml_to_pdf_with_http_info(input_file, opts)
|
848
|
+
return data
|
849
|
+
end
|
850
|
+
|
851
|
+
# Convert Email EML file to PDF document
|
852
|
+
# Convert Outlook Email EML file to PDF document. Supports images if they are base 64 inline.
|
853
|
+
# @param input_file Input file to perform the operation on.
|
854
|
+
# @param [Hash] opts the optional parameters
|
855
|
+
# @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
|
856
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
857
|
+
def convert_document_eml_to_pdf_with_http_info(input_file, opts = {})
|
858
|
+
if @api_client.config.debugging
|
859
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_eml_to_pdf ..."
|
860
|
+
end
|
861
|
+
# verify the required parameter 'input_file' is set
|
862
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
863
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_eml_to_pdf"
|
864
|
+
end
|
865
|
+
# resource path
|
866
|
+
local_var_path = "/convert/eml/to/pdf"
|
867
|
+
|
868
|
+
# query parameters
|
869
|
+
query_params = {}
|
870
|
+
|
871
|
+
# header parameters
|
872
|
+
header_params = {}
|
873
|
+
# HTTP header 'Accept' (if needed)
|
874
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
875
|
+
# HTTP header 'Content-Type'
|
876
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
877
|
+
header_params[:'bodyOnly'] = opts[:'body_only'] if !opts[:'body_only'].nil?
|
878
|
+
|
879
|
+
# form parameters
|
880
|
+
form_params = {}
|
881
|
+
form_params["inputFile"] = input_file
|
882
|
+
|
883
|
+
# http body (model)
|
884
|
+
post_body = nil
|
885
|
+
auth_names = ['Apikey']
|
886
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
887
|
+
:header_params => header_params,
|
888
|
+
:query_params => query_params,
|
889
|
+
:form_params => form_params,
|
890
|
+
:body => post_body,
|
891
|
+
:auth_names => auth_names,
|
892
|
+
:return_type => 'String')
|
893
|
+
if @api_client.config.debugging
|
894
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_eml_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
895
|
+
end
|
896
|
+
return data, status_code, headers
|
897
|
+
end
|
898
|
+
|
899
|
+
# Get PNG icon file for the file extension
|
900
|
+
# Returns a PNG icon for the given file format extension as a file for download. User may specify the icon size. Supports over 100 file formats, with a generic icon for unsupported formats.
|
901
|
+
# @param file_extension Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
|
902
|
+
# @param [Hash] opts the optional parameters
|
903
|
+
# @option opts [Integer] :icon_size Optional; The desired width of the icon, preserving its aspect ratio.
|
904
|
+
# @return [String]
|
905
|
+
def convert_document_get_file_type_icon(file_extension, opts = {})
|
906
|
+
data, _status_code, _headers = convert_document_get_file_type_icon_with_http_info(file_extension, opts)
|
907
|
+
return data
|
908
|
+
end
|
909
|
+
|
910
|
+
# Get PNG icon file for the file extension
|
911
|
+
# Returns a PNG icon for the given file format extension as a file for download. User may specify the icon size. Supports over 100 file formats, with a generic icon for unsupported formats.
|
912
|
+
# @param file_extension Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
|
913
|
+
# @param [Hash] opts the optional parameters
|
914
|
+
# @option opts [Integer] :icon_size Optional; The desired width of the icon, preserving its aspect ratio.
|
915
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
916
|
+
def convert_document_get_file_type_icon_with_http_info(file_extension, opts = {})
|
917
|
+
if @api_client.config.debugging
|
918
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_get_file_type_icon ..."
|
919
|
+
end
|
920
|
+
# verify the required parameter 'file_extension' is set
|
921
|
+
if @api_client.config.client_side_validation && file_extension.nil?
|
922
|
+
fail ArgumentError, "Missing the required parameter 'file_extension' when calling ConvertDocumentApi.convert_document_get_file_type_icon"
|
923
|
+
end
|
924
|
+
# resource path
|
925
|
+
local_var_path = "/convert/autodetect/get-icon"
|
926
|
+
|
927
|
+
# query parameters
|
928
|
+
query_params = {}
|
929
|
+
|
930
|
+
# header parameters
|
931
|
+
header_params = {}
|
932
|
+
# HTTP header 'Accept' (if needed)
|
933
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
934
|
+
header_params[:'fileExtension'] = file_extension
|
935
|
+
header_params[:'iconSize'] = opts[:'icon_size'] if !opts[:'icon_size'].nil?
|
936
|
+
|
937
|
+
# form parameters
|
938
|
+
form_params = {}
|
939
|
+
|
940
|
+
# http body (model)
|
941
|
+
post_body = nil
|
942
|
+
auth_names = ['Apikey']
|
943
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
944
|
+
:header_params => header_params,
|
945
|
+
:query_params => query_params,
|
946
|
+
:form_params => form_params,
|
947
|
+
:body => post_body,
|
948
|
+
:auth_names => auth_names,
|
949
|
+
:return_type => 'String')
|
950
|
+
if @api_client.config.debugging
|
951
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_get_file_type_icon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
952
|
+
end
|
953
|
+
return data, status_code, headers
|
954
|
+
end
|
955
|
+
|
956
|
+
# Get PNG icon byte array for the file extension
|
957
|
+
# Returns a PNG icon for the given file format extension directly as a byte array. User may specify the icon size. Supports over 100 file formats, with a generic icon for unsupported formats.
|
958
|
+
# @param file_extension Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
|
959
|
+
# @param [Hash] opts the optional parameters
|
960
|
+
# @option opts [Integer] :icon_size Optional; The desired width of the icon, preserving its aspect ratio.
|
961
|
+
# @return [GetFileTypeIconResult]
|
962
|
+
def convert_document_get_file_type_icon_advanced(file_extension, opts = {})
|
963
|
+
data, _status_code, _headers = convert_document_get_file_type_icon_advanced_with_http_info(file_extension, opts)
|
964
|
+
return data
|
965
|
+
end
|
966
|
+
|
967
|
+
# Get PNG icon byte array for the file extension
|
968
|
+
# Returns a PNG icon for the given file format extension directly as a byte array. User may specify the icon size. Supports over 100 file formats, with a generic icon for unsupported formats.
|
969
|
+
# @param file_extension Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
|
970
|
+
# @param [Hash] opts the optional parameters
|
971
|
+
# @option opts [Integer] :icon_size Optional; The desired width of the icon, preserving its aspect ratio.
|
972
|
+
# @return [Array<(GetFileTypeIconResult, Fixnum, Hash)>] GetFileTypeIconResult data, response status code and response headers
|
973
|
+
def convert_document_get_file_type_icon_advanced_with_http_info(file_extension, opts = {})
|
974
|
+
if @api_client.config.debugging
|
975
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_get_file_type_icon_advanced ..."
|
976
|
+
end
|
977
|
+
# verify the required parameter 'file_extension' is set
|
978
|
+
if @api_client.config.client_side_validation && file_extension.nil?
|
979
|
+
fail ArgumentError, "Missing the required parameter 'file_extension' when calling ConvertDocumentApi.convert_document_get_file_type_icon_advanced"
|
980
|
+
end
|
981
|
+
# resource path
|
982
|
+
local_var_path = "/convert/autodetect/get-icon/advanced"
|
983
|
+
|
984
|
+
# query parameters
|
985
|
+
query_params = {}
|
986
|
+
|
987
|
+
# header parameters
|
988
|
+
header_params = {}
|
989
|
+
# HTTP header 'Accept' (if needed)
|
990
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
991
|
+
header_params[:'fileExtension'] = file_extension
|
992
|
+
header_params[:'iconSize'] = opts[:'icon_size'] if !opts[:'icon_size'].nil?
|
993
|
+
|
994
|
+
# form parameters
|
995
|
+
form_params = {}
|
996
|
+
|
997
|
+
# http body (model)
|
998
|
+
post_body = nil
|
999
|
+
auth_names = ['Apikey']
|
1000
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1001
|
+
:header_params => header_params,
|
1002
|
+
:query_params => query_params,
|
1003
|
+
:form_params => form_params,
|
1004
|
+
:body => post_body,
|
1005
|
+
:auth_names => auth_names,
|
1006
|
+
:return_type => 'GetFileTypeIconResult')
|
1007
|
+
if @api_client.config.debugging
|
1008
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_get_file_type_icon_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1009
|
+
end
|
1010
|
+
return data, status_code, headers
|
1011
|
+
end
|
1012
|
+
|
589
1013
|
# Convert HTML document file to PDF Document
|
590
1014
|
# Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.
|
591
1015
|
# @param input_file Input file to perform the operation on.
|
@@ -754,6 +1178,127 @@ module CloudmersiveConvertApiClient
|
|
754
1178
|
return data, status_code, headers
|
755
1179
|
end
|
756
1180
|
|
1181
|
+
# Convert Email MSG file to HTML string
|
1182
|
+
# Convert Outlook Email MSG file to HTML string and attachments. Supports images if they are base 64 inline. Supports most, but not all, RTF bodied MSG files.
|
1183
|
+
# @param input_file Input file to perform the operation on.
|
1184
|
+
# @param [Hash] opts the optional parameters
|
1185
|
+
# @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the MSG. Other information such as subject will still be given as properties in the response object. Default is false.
|
1186
|
+
# @option opts [BOOLEAN] :include_attachments Optional; If false, the response object will not include any attachment files from the input file. Default is true.
|
1187
|
+
# @return [MsgToHtmlResult]
|
1188
|
+
def convert_document_msg_to_html(input_file, opts = {})
|
1189
|
+
data, _status_code, _headers = convert_document_msg_to_html_with_http_info(input_file, opts)
|
1190
|
+
return data
|
1191
|
+
end
|
1192
|
+
|
1193
|
+
# Convert Email MSG file to HTML string
|
1194
|
+
# Convert Outlook Email MSG file to HTML string and attachments. Supports images if they are base 64 inline. Supports most, but not all, RTF bodied MSG files.
|
1195
|
+
# @param input_file Input file to perform the operation on.
|
1196
|
+
# @param [Hash] opts the optional parameters
|
1197
|
+
# @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the MSG. Other information such as subject will still be given as properties in the response object. Default is false.
|
1198
|
+
# @option opts [BOOLEAN] :include_attachments Optional; If false, the response object will not include any attachment files from the input file. Default is true.
|
1199
|
+
# @return [Array<(MsgToHtmlResult, Fixnum, Hash)>] MsgToHtmlResult data, response status code and response headers
|
1200
|
+
def convert_document_msg_to_html_with_http_info(input_file, opts = {})
|
1201
|
+
if @api_client.config.debugging
|
1202
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_msg_to_html ..."
|
1203
|
+
end
|
1204
|
+
# verify the required parameter 'input_file' is set
|
1205
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
1206
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_msg_to_html"
|
1207
|
+
end
|
1208
|
+
# resource path
|
1209
|
+
local_var_path = "/convert/msg/to/html"
|
1210
|
+
|
1211
|
+
# query parameters
|
1212
|
+
query_params = {}
|
1213
|
+
|
1214
|
+
# header parameters
|
1215
|
+
header_params = {}
|
1216
|
+
# HTTP header 'Accept' (if needed)
|
1217
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
1218
|
+
# HTTP header 'Content-Type'
|
1219
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
1220
|
+
header_params[:'bodyOnly'] = opts[:'body_only'] if !opts[:'body_only'].nil?
|
1221
|
+
header_params[:'includeAttachments'] = opts[:'include_attachments'] if !opts[:'include_attachments'].nil?
|
1222
|
+
|
1223
|
+
# form parameters
|
1224
|
+
form_params = {}
|
1225
|
+
form_params["inputFile"] = input_file
|
1226
|
+
|
1227
|
+
# http body (model)
|
1228
|
+
post_body = nil
|
1229
|
+
auth_names = ['Apikey']
|
1230
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1231
|
+
:header_params => header_params,
|
1232
|
+
:query_params => query_params,
|
1233
|
+
:form_params => form_params,
|
1234
|
+
:body => post_body,
|
1235
|
+
:auth_names => auth_names,
|
1236
|
+
:return_type => 'MsgToHtmlResult')
|
1237
|
+
if @api_client.config.debugging
|
1238
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_msg_to_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1239
|
+
end
|
1240
|
+
return data, status_code, headers
|
1241
|
+
end
|
1242
|
+
|
1243
|
+
# Convert Email MSG file to PDF document
|
1244
|
+
# Convert Outlook Email MSG file to PDF document. Supports images if they are base 64 inline. Supports most, but not all, RTF bodied MSG files.
|
1245
|
+
# @param input_file Input file to perform the operation on.
|
1246
|
+
# @param [Hash] opts the optional parameters
|
1247
|
+
# @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
|
1248
|
+
# @return [String]
|
1249
|
+
def convert_document_msg_to_pdf(input_file, opts = {})
|
1250
|
+
data, _status_code, _headers = convert_document_msg_to_pdf_with_http_info(input_file, opts)
|
1251
|
+
return data
|
1252
|
+
end
|
1253
|
+
|
1254
|
+
# Convert Email MSG file to PDF document
|
1255
|
+
# Convert Outlook Email MSG file to PDF document. Supports images if they are base 64 inline. Supports most, but not all, RTF bodied MSG files.
|
1256
|
+
# @param input_file Input file to perform the operation on.
|
1257
|
+
# @param [Hash] opts the optional parameters
|
1258
|
+
# @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
|
1259
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
1260
|
+
def convert_document_msg_to_pdf_with_http_info(input_file, opts = {})
|
1261
|
+
if @api_client.config.debugging
|
1262
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_msg_to_pdf ..."
|
1263
|
+
end
|
1264
|
+
# verify the required parameter 'input_file' is set
|
1265
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
1266
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_msg_to_pdf"
|
1267
|
+
end
|
1268
|
+
# resource path
|
1269
|
+
local_var_path = "/convert/msg/to/pdf"
|
1270
|
+
|
1271
|
+
# query parameters
|
1272
|
+
query_params = {}
|
1273
|
+
|
1274
|
+
# header parameters
|
1275
|
+
header_params = {}
|
1276
|
+
# HTTP header 'Accept' (if needed)
|
1277
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
1278
|
+
# HTTP header 'Content-Type'
|
1279
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
1280
|
+
header_params[:'bodyOnly'] = opts[:'body_only'] if !opts[:'body_only'].nil?
|
1281
|
+
|
1282
|
+
# form parameters
|
1283
|
+
form_params = {}
|
1284
|
+
form_params["inputFile"] = input_file
|
1285
|
+
|
1286
|
+
# http body (model)
|
1287
|
+
post_body = nil
|
1288
|
+
auth_names = ['Apikey']
|
1289
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1290
|
+
:header_params => header_params,
|
1291
|
+
:query_params => query_params,
|
1292
|
+
:form_params => form_params,
|
1293
|
+
:body => post_body,
|
1294
|
+
:auth_names => auth_names,
|
1295
|
+
:return_type => 'String')
|
1296
|
+
if @api_client.config.debugging
|
1297
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_msg_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1298
|
+
end
|
1299
|
+
return data, status_code, headers
|
1300
|
+
end
|
1301
|
+
|
757
1302
|
# Convert PDF to Word DOCX Document
|
758
1303
|
# Convert standard PDF to Office Word Documents (docx). Converts a PDF at high fidelity into Word format, where it can be easily edited and processed.
|
759
1304
|
# @param input_file Input file to perform the operation on.
|
@@ -1348,6 +1893,62 @@ module CloudmersiveConvertApiClient
|
|
1348
1893
|
return data, status_code, headers
|
1349
1894
|
end
|
1350
1895
|
|
1896
|
+
# Convert PowerPoint PPTX to PNG image array
|
1897
|
+
# Converts a PowerPoint Presentation (PPTX) file to an array of PNG images, one for each page.
|
1898
|
+
# @param input_file Input file to perform the operation on.
|
1899
|
+
# @param [Hash] opts the optional parameters
|
1900
|
+
# @return [PptxToPngResult]
|
1901
|
+
def convert_document_pptx_to_png(input_file, opts = {})
|
1902
|
+
data, _status_code, _headers = convert_document_pptx_to_png_with_http_info(input_file, opts)
|
1903
|
+
return data
|
1904
|
+
end
|
1905
|
+
|
1906
|
+
# Convert PowerPoint PPTX to PNG image array
|
1907
|
+
# Converts a PowerPoint Presentation (PPTX) file to an array of PNG images, one for each page.
|
1908
|
+
# @param input_file Input file to perform the operation on.
|
1909
|
+
# @param [Hash] opts the optional parameters
|
1910
|
+
# @return [Array<(PptxToPngResult, Fixnum, Hash)>] PptxToPngResult data, response status code and response headers
|
1911
|
+
def convert_document_pptx_to_png_with_http_info(input_file, opts = {})
|
1912
|
+
if @api_client.config.debugging
|
1913
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_pptx_to_png ..."
|
1914
|
+
end
|
1915
|
+
# verify the required parameter 'input_file' is set
|
1916
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
1917
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_pptx_to_png"
|
1918
|
+
end
|
1919
|
+
# resource path
|
1920
|
+
local_var_path = "/convert/pptx/to/png"
|
1921
|
+
|
1922
|
+
# query parameters
|
1923
|
+
query_params = {}
|
1924
|
+
|
1925
|
+
# header parameters
|
1926
|
+
header_params = {}
|
1927
|
+
# HTTP header 'Accept' (if needed)
|
1928
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
1929
|
+
# HTTP header 'Content-Type'
|
1930
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
1931
|
+
|
1932
|
+
# form parameters
|
1933
|
+
form_params = {}
|
1934
|
+
form_params["inputFile"] = input_file
|
1935
|
+
|
1936
|
+
# http body (model)
|
1937
|
+
post_body = nil
|
1938
|
+
auth_names = ['Apikey']
|
1939
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1940
|
+
:header_params => header_params,
|
1941
|
+
:query_params => query_params,
|
1942
|
+
:form_params => form_params,
|
1943
|
+
:body => post_body,
|
1944
|
+
:auth_names => auth_names,
|
1945
|
+
:return_type => 'PptxToPngResult')
|
1946
|
+
if @api_client.config.debugging
|
1947
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_pptx_to_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1948
|
+
end
|
1949
|
+
return data, status_code, headers
|
1950
|
+
end
|
1951
|
+
|
1351
1952
|
# Convert PowerPoint PPTX Presentation to Text (txt)
|
1352
1953
|
# Convert Office PowerPoint Documents (pptx) to standard Text
|
1353
1954
|
# @param input_file Input file to perform the operation on.
|
@@ -1572,22 +2173,22 @@ module CloudmersiveConvertApiClient
|
|
1572
2173
|
return data, status_code, headers
|
1573
2174
|
end
|
1574
2175
|
|
1575
|
-
# Convert Excel XLSX Spreadsheet to CSV
|
1576
|
-
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.
|
2176
|
+
# Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
|
2177
|
+
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats. If the input file contains multiple worksheets, the first one is used. If you wish to convert all of the worksheets (not just the first one), be sure to use the xlsx/to/csv/multi API.
|
1577
2178
|
# @param input_file Input file to perform the operation on.
|
1578
2179
|
# @param [Hash] opts the optional parameters
|
1579
|
-
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8 and UTF-32. Default is UTF-
|
2180
|
+
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
1580
2181
|
# @return [String]
|
1581
2182
|
def convert_document_xlsx_to_csv(input_file, opts = {})
|
1582
2183
|
data, _status_code, _headers = convert_document_xlsx_to_csv_with_http_info(input_file, opts)
|
1583
2184
|
return data
|
1584
2185
|
end
|
1585
2186
|
|
1586
|
-
# Convert Excel XLSX Spreadsheet to CSV
|
1587
|
-
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.
|
2187
|
+
# Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
|
2188
|
+
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats. If the input file contains multiple worksheets, the first one is used. If you wish to convert all of the worksheets (not just the first one), be sure to use the xlsx/to/csv/multi API.
|
1588
2189
|
# @param input_file Input file to perform the operation on.
|
1589
2190
|
# @param [Hash] opts the optional parameters
|
1590
|
-
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8 and UTF-32. Default is UTF-
|
2191
|
+
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
1591
2192
|
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
1592
2193
|
def convert_document_xlsx_to_csv_with_http_info(input_file, opts = {})
|
1593
2194
|
if @api_client.config.debugging
|
@@ -1631,6 +2232,65 @@ module CloudmersiveConvertApiClient
|
|
1631
2232
|
return data, status_code, headers
|
1632
2233
|
end
|
1633
2234
|
|
2235
|
+
# Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
|
2236
|
+
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format, with support for multiple worksheets. Supports both XLSX and XLSB file Excel formats. Returns multiple CSV files, one for each worksheet (tab) in the spreadsheet.
|
2237
|
+
# @param input_file Input file to perform the operation on.
|
2238
|
+
# @param [Hash] opts the optional parameters
|
2239
|
+
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
2240
|
+
# @return [CsvCollection]
|
2241
|
+
def convert_document_xlsx_to_csv_multi(input_file, opts = {})
|
2242
|
+
data, _status_code, _headers = convert_document_xlsx_to_csv_multi_with_http_info(input_file, opts)
|
2243
|
+
return data
|
2244
|
+
end
|
2245
|
+
|
2246
|
+
# Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
|
2247
|
+
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format, with support for multiple worksheets. Supports both XLSX and XLSB file Excel formats. Returns multiple CSV files, one for each worksheet (tab) in the spreadsheet.
|
2248
|
+
# @param input_file Input file to perform the operation on.
|
2249
|
+
# @param [Hash] opts the optional parameters
|
2250
|
+
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
2251
|
+
# @return [Array<(CsvCollection, Fixnum, Hash)>] CsvCollection data, response status code and response headers
|
2252
|
+
def convert_document_xlsx_to_csv_multi_with_http_info(input_file, opts = {})
|
2253
|
+
if @api_client.config.debugging
|
2254
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_xlsx_to_csv_multi ..."
|
2255
|
+
end
|
2256
|
+
# verify the required parameter 'input_file' is set
|
2257
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
2258
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_xlsx_to_csv_multi"
|
2259
|
+
end
|
2260
|
+
# resource path
|
2261
|
+
local_var_path = "/convert/xlsx/to/csv/multi"
|
2262
|
+
|
2263
|
+
# query parameters
|
2264
|
+
query_params = {}
|
2265
|
+
|
2266
|
+
# header parameters
|
2267
|
+
header_params = {}
|
2268
|
+
# HTTP header 'Accept' (if needed)
|
2269
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
2270
|
+
# HTTP header 'Content-Type'
|
2271
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
2272
|
+
header_params[:'outputEncoding'] = opts[:'output_encoding'] if !opts[:'output_encoding'].nil?
|
2273
|
+
|
2274
|
+
# form parameters
|
2275
|
+
form_params = {}
|
2276
|
+
form_params["inputFile"] = input_file
|
2277
|
+
|
2278
|
+
# http body (model)
|
2279
|
+
post_body = nil
|
2280
|
+
auth_names = ['Apikey']
|
2281
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
2282
|
+
:header_params => header_params,
|
2283
|
+
:query_params => query_params,
|
2284
|
+
:form_params => form_params,
|
2285
|
+
:body => post_body,
|
2286
|
+
:auth_names => auth_names,
|
2287
|
+
:return_type => 'CsvCollection')
|
2288
|
+
if @api_client.config.debugging
|
2289
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_xlsx_to_csv_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2290
|
+
end
|
2291
|
+
return data, status_code, headers
|
2292
|
+
end
|
2293
|
+
|
1634
2294
|
# Convert Excel XLSX Spreadsheet to PDF
|
1635
2295
|
# Convert Office Excel Workbooks (XLSX) to standard PDF. Converts all worksheets in the workbook to PDF. Supports both XLSX and XLSB Excel file formats.
|
1636
2296
|
# @param input_file Input file to perform the operation on.
|
@@ -1687,6 +2347,62 @@ module CloudmersiveConvertApiClient
|
|
1687
2347
|
return data, status_code, headers
|
1688
2348
|
end
|
1689
2349
|
|
2350
|
+
# Convert Excel XLSX spreadsheet to PNG image array
|
2351
|
+
# Converts an Excel Spreadsheet (XLSX) file to an array of PNG images, one for each page.
|
2352
|
+
# @param input_file Input file to perform the operation on.
|
2353
|
+
# @param [Hash] opts the optional parameters
|
2354
|
+
# @return [XlsxToPngResult]
|
2355
|
+
def convert_document_xlsx_to_png(input_file, opts = {})
|
2356
|
+
data, _status_code, _headers = convert_document_xlsx_to_png_with_http_info(input_file, opts)
|
2357
|
+
return data
|
2358
|
+
end
|
2359
|
+
|
2360
|
+
# Convert Excel XLSX spreadsheet to PNG image array
|
2361
|
+
# Converts an Excel Spreadsheet (XLSX) file to an array of PNG images, one for each page.
|
2362
|
+
# @param input_file Input file to perform the operation on.
|
2363
|
+
# @param [Hash] opts the optional parameters
|
2364
|
+
# @return [Array<(XlsxToPngResult, Fixnum, Hash)>] XlsxToPngResult data, response status code and response headers
|
2365
|
+
def convert_document_xlsx_to_png_with_http_info(input_file, opts = {})
|
2366
|
+
if @api_client.config.debugging
|
2367
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_xlsx_to_png ..."
|
2368
|
+
end
|
2369
|
+
# verify the required parameter 'input_file' is set
|
2370
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
2371
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_xlsx_to_png"
|
2372
|
+
end
|
2373
|
+
# resource path
|
2374
|
+
local_var_path = "/convert/xlsx/to/png"
|
2375
|
+
|
2376
|
+
# query parameters
|
2377
|
+
query_params = {}
|
2378
|
+
|
2379
|
+
# header parameters
|
2380
|
+
header_params = {}
|
2381
|
+
# HTTP header 'Accept' (if needed)
|
2382
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
2383
|
+
# HTTP header 'Content-Type'
|
2384
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
2385
|
+
|
2386
|
+
# form parameters
|
2387
|
+
form_params = {}
|
2388
|
+
form_params["inputFile"] = input_file
|
2389
|
+
|
2390
|
+
# http body (model)
|
2391
|
+
post_body = nil
|
2392
|
+
auth_names = ['Apikey']
|
2393
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
2394
|
+
:header_params => header_params,
|
2395
|
+
:query_params => query_params,
|
2396
|
+
:form_params => form_params,
|
2397
|
+
:body => post_body,
|
2398
|
+
:auth_names => auth_names,
|
2399
|
+
:return_type => 'XlsxToPngResult')
|
2400
|
+
if @api_client.config.debugging
|
2401
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_xlsx_to_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2402
|
+
end
|
2403
|
+
return data, status_code, headers
|
2404
|
+
end
|
2405
|
+
|
1690
2406
|
# Convert Excel XLSX Spreadsheet to Text (txt)
|
1691
2407
|
# Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats. When a spreadsheet contains multiple worksheets, will export all of the text from all of the worksheets. If you wish to export the text from only one worksheet, try using the Split XLSX API to split the spreadsheet into multiple worksheet files, and then run XLSX to Text on the individual worksheet file that you need to extract the text from.
|
1692
2408
|
# @param input_file Input file to perform the operation on.
|