cloudmersive-convert-api-client 1.7.6 → 1.7.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -4
  3. data/docs/AutodetectToThumbnailsResult.md +9 -0
  4. data/docs/ConvertDocumentApi.md +742 -91
  5. data/docs/DocxToPngResult.md +9 -0
  6. data/docs/EmlAttachment.md +9 -0
  7. data/docs/EmlToHtmlResult.md +18 -0
  8. data/docs/GetFileTypeIconResult.md +10 -0
  9. data/docs/MsgAttachment.md +9 -0
  10. data/docs/MsgToHtmlResult.md +16 -0
  11. data/docs/PptxToPngResult.md +9 -0
  12. data/docs/Thumbnail.md +9 -0
  13. data/docs/ValidateDocumentApi.md +110 -0
  14. data/docs/XlsxToPngResult.md +9 -0
  15. data/lib/cloudmersive-convert-api-client.rb +10 -0
  16. data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +657 -0
  17. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +112 -0
  18. data/lib/cloudmersive-convert-api-client/models/autodetect_to_thumbnails_result.rb +201 -0
  19. data/lib/cloudmersive-convert-api-client/models/docx_to_png_result.rb +201 -0
  20. data/lib/cloudmersive-convert-api-client/models/eml_attachment.rb +215 -0
  21. data/lib/cloudmersive-convert-api-client/models/eml_to_html_result.rb +291 -0
  22. data/lib/cloudmersive-convert-api-client/models/get_file_type_icon_result.rb +225 -0
  23. data/lib/cloudmersive-convert-api-client/models/msg_attachment.rb +215 -0
  24. data/lib/cloudmersive-convert-api-client/models/msg_to_html_result.rb +271 -0
  25. data/lib/cloudmersive-convert-api-client/models/pptx_to_png_result.rb +201 -0
  26. data/lib/cloudmersive-convert-api-client/models/thumbnail.rb +215 -0
  27. data/lib/cloudmersive-convert-api-client/models/xlsx_to_png_result.rb +201 -0
  28. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  29. data/spec/api/convert_document_api_spec.rb +147 -0
  30. data/spec/api/validate_document_api_spec.rb +24 -0
  31. data/spec/models/autodetect_to_thumbnails_result_spec.rb +48 -0
  32. data/spec/models/docx_to_png_result_spec.rb +48 -0
  33. data/spec/models/eml_attachment_spec.rb +48 -0
  34. data/spec/models/eml_to_html_result_spec.rb +102 -0
  35. data/spec/models/get_file_type_icon_result_spec.rb +54 -0
  36. data/spec/models/msg_attachment_spec.rb +48 -0
  37. data/spec/models/msg_to_html_result_spec.rb +90 -0
  38. data/spec/models/pptx_to_png_result_spec.rb +48 -0
  39. data/spec/models/thumbnail_spec.rb +48 -0
  40. data/spec/models/xlsx_to_png_result_spec.rb +48 -0
  41. metadata +32 -2
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::DocxToPngResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **png_result_pages** | [**Array<ConvertedPngPage>**](ConvertedPngPage.md) | Array of converted pages | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::EmlAttachment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Name of the attachment, including file extension | [optional]
7
+ **content** | **String** | The EML attachment as a byte[] | [optional]
8
+
9
+
@@ -0,0 +1,18 @@
1
+ # CloudmersiveConvertApiClient::EmlToHtmlResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **content** | **String** | An HTML string version of the EML file | [optional]
8
+ **body** | **String** | The main body of the EML file's email as an HTML string | [optional]
9
+ **from** | **String** | The From sender of the EML file's email | [optional]
10
+ **to** | **String** | The To recipients of the EML file's email | [optional]
11
+ **cc** | **String** | The CC recipients of the EML file's email | [optional]
12
+ **bcc** | **String** | The BCC recipients of the EML file's email | [optional]
13
+ **received_time** | **String** | The time that the EML file's email was received | [optional]
14
+ **subject** | **String** | The subject of the EML file's email | [optional]
15
+ **organization** | **String** | The Organization of the EML file's email | [optional]
16
+ **attachments** | [**Array<EmlAttachment>**](EmlAttachment.md) | List of all attachments for the EML file | [optional]
17
+
18
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::GetFileTypeIconResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **icon** | **String** | PNG icon as a byte array | [optional]
8
+ **extension** | **String** | Extension used for the icon | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::MsgAttachment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Name of the attachment, including file extension | [optional]
7
+ **content** | **String** | The MSG attachment as a byte[] | [optional]
8
+
9
+
@@ -0,0 +1,16 @@
1
+ # CloudmersiveConvertApiClient::MsgToHtmlResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **content** | **String** | An HTML string version of the MSG file | [optional]
8
+ **body** | **String** | The main body of the MSG file's email as an HTML string | [optional]
9
+ **from** | **String** | The From sender of the MSG file's email | [optional]
10
+ **to** | **String** | The To recipients of the MSG file's email | [optional]
11
+ **cc** | **String** | The CC recipients of the MSG file's email | [optional]
12
+ **received_time** | **String** | The time that the MSG file's email was received | [optional]
13
+ **subject** | **String** | The subject of the MSG file's email | [optional]
14
+ **attachments** | [**Array<MsgAttachment>**](MsgAttachment.md) | List of all attachments for the MSG file | [optional]
15
+
16
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::PptxToPngResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **png_result_pages** | [**Array<ConvertedPngPage>**](ConvertedPngPage.md) | Array of converted pages | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::Thumbnail
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **index** | **Integer** | Index of this thumbnail | [optional]
7
+ **content** | **String** | A PNG thumbnail of the document page | [optional]
8
+
9
+
@@ -7,9 +7,11 @@ Method | HTTP request | Description
7
7
  [**validate_document_autodetect_validation**](ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
8
8
  [**validate_document_csv_validation**](ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
9
9
  [**validate_document_docx_validation**](ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
10
+ [**validate_document_eml_validation**](ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
10
11
  [**validate_document_executable_validation**](ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
11
12
  [**validate_document_g_zip_validation**](ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)
12
13
  [**validate_document_json_validation**](ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
14
+ [**validate_document_msg_validation**](ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
13
15
  [**validate_document_pdf_validation**](ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
14
16
  [**validate_document_pptx_validation**](ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
15
17
  [**validate_document_rar_validation**](ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
@@ -181,6 +183,60 @@ Name | Type | Description | Notes
181
183
 
182
184
 
183
185
 
186
+ # **validate_document_eml_validation**
187
+ > DocumentValidationResult validate_document_eml_validation(input_file)
188
+
189
+ Validate if an EML file is executable
190
+
191
+ Validate if an input file is an EML email file; if the document is not valid
192
+
193
+ ### Example
194
+ ```ruby
195
+ # load the gem
196
+ require 'cloudmersive-convert-api-client'
197
+ # setup authorization
198
+ CloudmersiveConvertApiClient.configure do |config|
199
+ # Configure API key authorization: Apikey
200
+ config.api_key['Apikey'] = 'YOUR API KEY'
201
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
202
+ #config.api_key_prefix['Apikey'] = 'Bearer'
203
+ end
204
+
205
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
206
+
207
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
208
+
209
+
210
+ begin
211
+ #Validate if an EML file is executable
212
+ result = api_instance.validate_document_eml_validation(input_file)
213
+ p result
214
+ rescue CloudmersiveConvertApiClient::ApiError => e
215
+ puts "Exception when calling ValidateDocumentApi->validate_document_eml_validation: #{e}"
216
+ end
217
+ ```
218
+
219
+ ### Parameters
220
+
221
+ Name | Type | Description | Notes
222
+ ------------- | ------------- | ------------- | -------------
223
+ **input_file** | **File**| Input file to perform the operation on. |
224
+
225
+ ### Return type
226
+
227
+ [**DocumentValidationResult**](DocumentValidationResult.md)
228
+
229
+ ### Authorization
230
+
231
+ [Apikey](../README.md#Apikey)
232
+
233
+ ### HTTP request headers
234
+
235
+ - **Content-Type**: multipart/form-data
236
+ - **Accept**: application/json, text/json, application/xml, text/xml
237
+
238
+
239
+
184
240
  # **validate_document_executable_validation**
185
241
  > DocumentValidationResult validate_document_executable_validation(input_file)
186
242
 
@@ -343,6 +399,60 @@ Name | Type | Description | Notes
343
399
 
344
400
 
345
401
 
402
+ # **validate_document_msg_validation**
403
+ > DocumentValidationResult validate_document_msg_validation(input_file)
404
+
405
+ Validate if an MSG file is executable
406
+
407
+ Validate if an input file is an MSG email file; if the document is not valid
408
+
409
+ ### Example
410
+ ```ruby
411
+ # load the gem
412
+ require 'cloudmersive-convert-api-client'
413
+ # setup authorization
414
+ CloudmersiveConvertApiClient.configure do |config|
415
+ # Configure API key authorization: Apikey
416
+ config.api_key['Apikey'] = 'YOUR API KEY'
417
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
418
+ #config.api_key_prefix['Apikey'] = 'Bearer'
419
+ end
420
+
421
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
422
+
423
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
424
+
425
+
426
+ begin
427
+ #Validate if an MSG file is executable
428
+ result = api_instance.validate_document_msg_validation(input_file)
429
+ p result
430
+ rescue CloudmersiveConvertApiClient::ApiError => e
431
+ puts "Exception when calling ValidateDocumentApi->validate_document_msg_validation: #{e}"
432
+ end
433
+ ```
434
+
435
+ ### Parameters
436
+
437
+ Name | Type | Description | Notes
438
+ ------------- | ------------- | ------------- | -------------
439
+ **input_file** | **File**| Input file to perform the operation on. |
440
+
441
+ ### Return type
442
+
443
+ [**DocumentValidationResult**](DocumentValidationResult.md)
444
+
445
+ ### Authorization
446
+
447
+ [Apikey](../README.md#Apikey)
448
+
449
+ ### HTTP request headers
450
+
451
+ - **Content-Type**: multipart/form-data
452
+ - **Accept**: application/json, text/json, application/xml, text/xml
453
+
454
+
455
+
346
456
  # **validate_document_pdf_validation**
347
457
  > DocumentValidationResult validate_document_pdf_validation(input_file)
348
458
 
@@ -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
+
@@ -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'
@@ -77,7 +78,10 @@ require 'cloudmersive-convert-api-client/models/docx_table_row'
77
78
  require 'cloudmersive-convert-api-client/models/docx_template_application_request'
78
79
  require 'cloudmersive-convert-api-client/models/docx_template_operation'
79
80
  require 'cloudmersive-convert-api-client/models/docx_text'
81
+ require 'cloudmersive-convert-api-client/models/docx_to_png_result'
80
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'
81
85
  require 'cloudmersive-convert-api-client/models/enable_shared_workbook_request'
82
86
  require 'cloudmersive-convert-api-client/models/enable_shared_workbook_response'
83
87
  require 'cloudmersive-convert-api-client/models/exif_value'
@@ -112,6 +116,7 @@ require 'cloudmersive-convert-api-client/models/get_docx_table_row_request'
112
116
  require 'cloudmersive-convert-api-client/models/get_docx_table_row_response'
113
117
  require 'cloudmersive-convert-api-client/models/get_docx_tables_request'
114
118
  require 'cloudmersive-convert-api-client/models/get_docx_tables_response'
119
+ require 'cloudmersive-convert-api-client/models/get_file_type_icon_result'
115
120
  require 'cloudmersive-convert-api-client/models/get_image_info_result'
116
121
  require 'cloudmersive-convert-api-client/models/get_pdf_annotations_result'
117
122
  require 'cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_request'
@@ -146,6 +151,8 @@ require 'cloudmersive-convert-api-client/models/insert_docx_tables_request'
146
151
  require 'cloudmersive-convert-api-client/models/insert_docx_tables_response'
147
152
  require 'cloudmersive-convert-api-client/models/insert_xlsx_worksheet_request'
148
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'
149
156
  require 'cloudmersive-convert-api-client/models/multipage_image_format_conversion_result'
150
157
  require 'cloudmersive-convert-api-client/models/page_conversion_result'
151
158
  require 'cloudmersive-convert-api-client/models/pdf_annotation'
@@ -156,6 +163,7 @@ require 'cloudmersive-convert-api-client/models/pdf_metadata'
156
163
  require 'cloudmersive-convert-api-client/models/pdf_page_text'
157
164
  require 'cloudmersive-convert-api-client/models/pdf_text_by_page_result'
158
165
  require 'cloudmersive-convert-api-client/models/pdf_to_png_result'
166
+ require 'cloudmersive-convert-api-client/models/pptx_to_png_result'
159
167
  require 'cloudmersive-convert-api-client/models/presentation_result'
160
168
  require 'cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_request'
161
169
  require 'cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_response'
@@ -192,6 +200,7 @@ require 'cloudmersive-convert-api-client/models/text_conversion_result'
192
200
  require 'cloudmersive-convert-api-client/models/text_document_element'
193
201
  require 'cloudmersive-convert-api-client/models/text_document_line'
194
202
  require 'cloudmersive-convert-api-client/models/text_encoding_detect_response'
203
+ require 'cloudmersive-convert-api-client/models/thumbnail'
195
204
  require 'cloudmersive-convert-api-client/models/update_docx_table_cell_request'
196
205
  require 'cloudmersive-convert-api-client/models/update_docx_table_cell_response'
197
206
  require 'cloudmersive-convert-api-client/models/update_docx_table_row_request'
@@ -205,6 +214,7 @@ require 'cloudmersive-convert-api-client/models/xlsx_image'
205
214
  require 'cloudmersive-convert-api-client/models/xlsx_spreadsheet_cell'
206
215
  require 'cloudmersive-convert-api-client/models/xlsx_spreadsheet_column'
207
216
  require 'cloudmersive-convert-api-client/models/xlsx_spreadsheet_row'
217
+ require 'cloudmersive-convert-api-client/models/xlsx_to_png_result'
208
218
  require 'cloudmersive-convert-api-client/models/xlsx_worksheet'
209
219
  require 'cloudmersive-convert-api-client/models/xml_add_attribute_with_x_path_result'
210
220
  require 'cloudmersive-convert-api-client/models/xml_add_child_with_x_path_result'
@@ -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 [Object]
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<(Object, Fixnum, Hash)>] Object 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 => 'Object')
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 [Object]
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<(Object, Fixnum, Hash)>] Object 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 => 'Object')
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 [Object]
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<(Object, Fixnum, Hash)>] Object 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 => 'Object')
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 [Object]
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<(Object, Fixnum, Hash)>] Object 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 => 'Object')
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.
@@ -1746,6 +2347,62 @@ module CloudmersiveConvertApiClient
1746
2347
  return data, status_code, headers
1747
2348
  end
1748
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
+
1749
2406
  # Convert Excel XLSX Spreadsheet to Text (txt)
1750
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.
1751
2408
  # @param input_file Input file to perform the operation on.