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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 03ebf8b3092912e7bb2347ac84cfc530be87dc42c157dda0409a8ab108738792
4
- data.tar.gz: ab778551b685b740f6a151d2dfb48a501eed8492438303005d5e896530ce4053
3
+ metadata.gz: 987398cc6f5af5e2ee1ec25836d37ec7b21c2fda513d13b04ac1904371120623
4
+ data.tar.gz: 64d4fdc661986915ba76dfb0c47f8335fac781ebeda50d13738890414533fbf8
5
5
  SHA512:
6
- metadata.gz: 435a627e9f6dc79aefcbfa8e9201f848840c8c18339e5f962f268f6866811e3030151988e46d3006c4393513e3b879e423ac9d4d8ce7adf11122e426b34c38c4
7
- data.tar.gz: d0197210a982e1956d16542e10bc06770296d77016308f6b8b57bfd5d710d5bb09f65351a6400ca3214577745ae9b1ac87b760977fc24175970ca483906cad18
6
+ metadata.gz: d6f62112ccb288a0f44ab236828da969625922101a1279d41cf67aecc18e29a608c6886b43a656c72d84907eefe94f5b6c2fc417e0a1751cd8f712873099ca2c
7
+ data.tar.gz: 9687366476f7d9157dd7dc26833b1b9e3ce320a232f683c3e8f613708c6b4e9549569182973c52da59de83a05e13fc60022c42661b60bd3b385d7d7e3d202171
data/README.md CHANGED
@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 1.7.6
10
+ - Package version: 1.7.7
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-convert-api-client-1.7.6.gem
26
+ gem install ./cloudmersive-convert-api-client-1.7.7.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.7.6.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.7.7.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'cloudmersive-convert-api-client', '~> 1.7.6'
34
+ gem 'cloudmersive-convert-api-client', '~> 1.7.7'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -104,16 +104,25 @@ Class | Method | HTTP request | Description
104
104
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_autodetect_get_info**](docs/ConvertDocumentApi.md#convert_document_autodetect_get_info) | **POST** /convert/autodetect/get-info | Get document type information
105
105
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_autodetect_to_pdf**](docs/ConvertDocumentApi.md#convert_document_autodetect_to_pdf) | **POST** /convert/autodetect/to/pdf | Convert Document to PDF
106
106
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_autodetect_to_png_array**](docs/ConvertDocumentApi.md#convert_document_autodetect_to_png_array) | **POST** /convert/autodetect/to/png | Convert Document to PNG array
107
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_autodetect_to_thumbnail**](docs/ConvertDocumentApi.md#convert_document_autodetect_to_thumbnail) | **POST** /convert/autodetect/to/thumbnail | Convert File to Thumbnail Image
108
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_autodetect_to_thumbnails_advanced**](docs/ConvertDocumentApi.md#convert_document_autodetect_to_thumbnails_advanced) | **POST** /convert/autodetect/to/thumbnail/advanced | Convert File to Thumbnail Image Object
107
109
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_autodetect_to_txt**](docs/ConvertDocumentApi.md#convert_document_autodetect_to_txt) | **POST** /convert/autodetect/to/txt | Convert Document to Text (txt)
108
110
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_csv_to_xlsx**](docs/ConvertDocumentApi.md#convert_document_csv_to_xlsx) | **POST** /convert/csv/to/xlsx | Convert CSV to Excel XLSX Spreadsheet
109
111
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_doc_to_docx**](docs/ConvertDocumentApi.md#convert_document_doc_to_docx) | **POST** /convert/doc/to/docx | Convert Word DOC (97-03) Document to DOCX
110
112
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_doc_to_pdf**](docs/ConvertDocumentApi.md#convert_document_doc_to_pdf) | **POST** /convert/doc/to/pdf | Convert Word DOC (97-03) Document to PDF
111
113
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_doc_to_txt**](docs/ConvertDocumentApi.md#convert_document_doc_to_txt) | **POST** /convert/doc/to/txt | Convert Word DOC (97-03) Document to Text (txt)
112
114
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_docx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_docx_to_pdf) | **POST** /convert/docx/to/pdf | Convert Word DOCX Document to PDF
115
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_docx_to_png**](docs/ConvertDocumentApi.md#convert_document_docx_to_png) | **POST** /convert/docx/to/png | Convert DOCX document to PNG image array
113
116
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_docx_to_txt**](docs/ConvertDocumentApi.md#convert_document_docx_to_txt) | **POST** /convert/docx/to/txt | Convert Word DOCX Document to Text (txt)
117
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_eml_to_html**](docs/ConvertDocumentApi.md#convert_document_eml_to_html) | **POST** /convert/eml/to/html | Convert Email EML file to HTML string
118
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_eml_to_pdf**](docs/ConvertDocumentApi.md#convert_document_eml_to_pdf) | **POST** /convert/eml/to/pdf | Convert Email EML file to PDF document
119
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_get_file_type_icon**](docs/ConvertDocumentApi.md#convert_document_get_file_type_icon) | **POST** /convert/autodetect/get-icon | Get PNG icon file for the file extension
120
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_get_file_type_icon_advanced**](docs/ConvertDocumentApi.md#convert_document_get_file_type_icon_advanced) | **POST** /convert/autodetect/get-icon-advanced | Get PNG icon byte array for the file extension
114
121
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_html_to_pdf**](docs/ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | Convert HTML document file to PDF Document
115
122
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_html_to_png**](docs/ConvertDocumentApi.md#convert_document_html_to_png) | **POST** /convert/html/to/png | Convert HTML document file to PNG image array
116
123
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_html_to_txt**](docs/ConvertDocumentApi.md#convert_document_html_to_txt) | **POST** /convert/html/to/txt | HTML Document file to Text (txt)
124
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_msg_to_html**](docs/ConvertDocumentApi.md#convert_document_msg_to_html) | **POST** /convert/msg/to/html | Convert Email MSG file to HTML string
125
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_msg_to_pdf**](docs/ConvertDocumentApi.md#convert_document_msg_to_pdf) | **POST** /convert/msg/to/pdf | Convert Email MSG file to PDF document
117
126
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_docx**](docs/ConvertDocumentApi.md#convert_document_pdf_to_docx) | **POST** /convert/pdf/to/docx | Convert PDF to Word DOCX Document
118
127
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_docx_rasterize**](docs/ConvertDocumentApi.md#convert_document_pdf_to_docx_rasterize) | **POST** /convert/pdf/to/docx/rasterize | Convert PDF to Word DOCX Document based on rasterized version of the PDF
119
128
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_png_array**](docs/ConvertDocumentApi.md#convert_document_pdf_to_png_array) | **POST** /convert/pdf/to/png | Convert PDF to PNG Image Array
@@ -124,6 +133,7 @@ Class | Method | HTTP request | Description
124
133
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_ppt_to_pdf**](docs/ConvertDocumentApi.md#convert_document_ppt_to_pdf) | **POST** /convert/ppt/to/pdf | Convert PowerPoint PPT (97-03) Presentation to PDF
125
134
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_ppt_to_pptx**](docs/ConvertDocumentApi.md#convert_document_ppt_to_pptx) | **POST** /convert/ppt/to/pptx | Convert PowerPoint PPT (97-03) Presentation to PPTX
126
135
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pptx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_pptx_to_pdf) | **POST** /convert/pptx/to/pdf | Convert PowerPoint PPTX Presentation to PDF
136
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pptx_to_png**](docs/ConvertDocumentApi.md#convert_document_pptx_to_png) | **POST** /convert/pptx/to/png | Convert PowerPoint PPTX to PNG image array
127
137
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pptx_to_txt**](docs/ConvertDocumentApi.md#convert_document_pptx_to_txt) | **POST** /convert/pptx/to/txt | Convert PowerPoint PPTX Presentation to Text (txt)
128
138
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xls_to_csv**](docs/ConvertDocumentApi.md#convert_document_xls_to_csv) | **POST** /convert/xls/to/csv | Convert Excel XLS (97-03) Spreadsheet to CSV
129
139
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xls_to_pdf**](docs/ConvertDocumentApi.md#convert_document_xls_to_pdf) | **POST** /convert/xls/to/pdf | Convert Excel XLS (97-03) Spreadsheet to PDF
@@ -131,6 +141,7 @@ Class | Method | HTTP request | Description
131
141
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_csv**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_csv) | **POST** /convert/xlsx/to/csv | Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
132
142
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_csv_multi**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_csv_multi) | **POST** /convert/xlsx/to/csv/multi | Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
133
143
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_pdf) | **POST** /convert/xlsx/to/pdf | Convert Excel XLSX Spreadsheet to PDF
144
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_png**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_png) | **POST** /convert/xlsx/to/png | Convert Excel XLSX spreadsheet to PNG image array
134
145
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_txt**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_txt) | **POST** /convert/xlsx/to/txt | Convert Excel XLSX Spreadsheet to Text (txt)
135
146
  *CloudmersiveConvertApiClient::ConvertImageApi* | [**convert_image_get_image_info**](docs/ConvertImageApi.md#convert_image_get_image_info) | **POST** /convert/image/get-info | Get information about an image
136
147
  *CloudmersiveConvertApiClient::ConvertImageApi* | [**convert_image_image_format_convert**](docs/ConvertImageApi.md#convert_image_image_format_convert) | **POST** /convert/image/{format1}/to/{format2} | Image format conversion
@@ -248,9 +259,11 @@ Class | Method | HTTP request | Description
248
259
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_autodetect_validation**](docs/ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
249
260
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_csv_validation**](docs/ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
250
261
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_docx_validation**](docs/ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
262
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_eml_validation**](docs/ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
251
263
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_executable_validation**](docs/ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
252
264
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_g_zip_validation**](docs/ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)
253
265
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_json_validation**](docs/ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
266
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_msg_validation**](docs/ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
254
267
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pdf_validation**](docs/ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
255
268
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pptx_validation**](docs/ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
256
269
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_rar_validation**](docs/ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
@@ -273,6 +286,7 @@ Class | Method | HTTP request | Description
273
286
  - [CloudmersiveConvertApiClient::AutodetectDocumentValidationResult](docs/AutodetectDocumentValidationResult.md)
274
287
  - [CloudmersiveConvertApiClient::AutodetectGetInfoResult](docs/AutodetectGetInfoResult.md)
275
288
  - [CloudmersiveConvertApiClient::AutodetectToPngResult](docs/AutodetectToPngResult.md)
289
+ - [CloudmersiveConvertApiClient::AutodetectToThumbnailsResult](docs/AutodetectToThumbnailsResult.md)
276
290
  - [CloudmersiveConvertApiClient::Base64DecodeRequest](docs/Base64DecodeRequest.md)
277
291
  - [CloudmersiveConvertApiClient::Base64DecodeResponse](docs/Base64DecodeResponse.md)
278
292
  - [CloudmersiveConvertApiClient::Base64DetectRequest](docs/Base64DetectRequest.md)
@@ -328,7 +342,10 @@ Class | Method | HTTP request | Description
328
342
  - [CloudmersiveConvertApiClient::DocxTemplateApplicationRequest](docs/DocxTemplateApplicationRequest.md)
329
343
  - [CloudmersiveConvertApiClient::DocxTemplateOperation](docs/DocxTemplateOperation.md)
330
344
  - [CloudmersiveConvertApiClient::DocxText](docs/DocxText.md)
345
+ - [CloudmersiveConvertApiClient::DocxToPngResult](docs/DocxToPngResult.md)
331
346
  - [CloudmersiveConvertApiClient::DocxTopLevelComment](docs/DocxTopLevelComment.md)
347
+ - [CloudmersiveConvertApiClient::EmlAttachment](docs/EmlAttachment.md)
348
+ - [CloudmersiveConvertApiClient::EmlToHtmlResult](docs/EmlToHtmlResult.md)
332
349
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookRequest](docs/EnableSharedWorkbookRequest.md)
333
350
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookResponse](docs/EnableSharedWorkbookResponse.md)
334
351
  - [CloudmersiveConvertApiClient::ExifValue](docs/ExifValue.md)
@@ -363,6 +380,7 @@ Class | Method | HTTP request | Description
363
380
  - [CloudmersiveConvertApiClient::GetDocxTableRowResponse](docs/GetDocxTableRowResponse.md)
364
381
  - [CloudmersiveConvertApiClient::GetDocxTablesRequest](docs/GetDocxTablesRequest.md)
365
382
  - [CloudmersiveConvertApiClient::GetDocxTablesResponse](docs/GetDocxTablesResponse.md)
383
+ - [CloudmersiveConvertApiClient::GetFileTypeIconResult](docs/GetFileTypeIconResult.md)
366
384
  - [CloudmersiveConvertApiClient::GetImageInfoResult](docs/GetImageInfoResult.md)
367
385
  - [CloudmersiveConvertApiClient::GetPdfAnnotationsResult](docs/GetPdfAnnotationsResult.md)
368
386
  - [CloudmersiveConvertApiClient::GetXlsxCellByIdentifierRequest](docs/GetXlsxCellByIdentifierRequest.md)
@@ -397,6 +415,8 @@ Class | Method | HTTP request | Description
397
415
  - [CloudmersiveConvertApiClient::InsertDocxTablesResponse](docs/InsertDocxTablesResponse.md)
398
416
  - [CloudmersiveConvertApiClient::InsertXlsxWorksheetRequest](docs/InsertXlsxWorksheetRequest.md)
399
417
  - [CloudmersiveConvertApiClient::InsertXlsxWorksheetResponse](docs/InsertXlsxWorksheetResponse.md)
418
+ - [CloudmersiveConvertApiClient::MsgAttachment](docs/MsgAttachment.md)
419
+ - [CloudmersiveConvertApiClient::MsgToHtmlResult](docs/MsgToHtmlResult.md)
400
420
  - [CloudmersiveConvertApiClient::MultipageImageFormatConversionResult](docs/MultipageImageFormatConversionResult.md)
401
421
  - [CloudmersiveConvertApiClient::PageConversionResult](docs/PageConversionResult.md)
402
422
  - [CloudmersiveConvertApiClient::PdfAnnotation](docs/PdfAnnotation.md)
@@ -407,6 +427,7 @@ Class | Method | HTTP request | Description
407
427
  - [CloudmersiveConvertApiClient::PdfPageText](docs/PdfPageText.md)
408
428
  - [CloudmersiveConvertApiClient::PdfTextByPageResult](docs/PdfTextByPageResult.md)
409
429
  - [CloudmersiveConvertApiClient::PdfToPngResult](docs/PdfToPngResult.md)
430
+ - [CloudmersiveConvertApiClient::PptxToPngResult](docs/PptxToPngResult.md)
410
431
  - [CloudmersiveConvertApiClient::PresentationResult](docs/PresentationResult.md)
411
432
  - [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest](docs/RemoveDocxHeadersAndFootersRequest.md)
412
433
  - [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersResponse](docs/RemoveDocxHeadersAndFootersResponse.md)
@@ -443,6 +464,7 @@ Class | Method | HTTP request | Description
443
464
  - [CloudmersiveConvertApiClient::TextDocumentElement](docs/TextDocumentElement.md)
444
465
  - [CloudmersiveConvertApiClient::TextDocumentLine](docs/TextDocumentLine.md)
445
466
  - [CloudmersiveConvertApiClient::TextEncodingDetectResponse](docs/TextEncodingDetectResponse.md)
467
+ - [CloudmersiveConvertApiClient::Thumbnail](docs/Thumbnail.md)
446
468
  - [CloudmersiveConvertApiClient::UpdateDocxTableCellRequest](docs/UpdateDocxTableCellRequest.md)
447
469
  - [CloudmersiveConvertApiClient::UpdateDocxTableCellResponse](docs/UpdateDocxTableCellResponse.md)
448
470
  - [CloudmersiveConvertApiClient::UpdateDocxTableRowRequest](docs/UpdateDocxTableRowRequest.md)
@@ -456,6 +478,7 @@ Class | Method | HTTP request | Description
456
478
  - [CloudmersiveConvertApiClient::XlsxSpreadsheetCell](docs/XlsxSpreadsheetCell.md)
457
479
  - [CloudmersiveConvertApiClient::XlsxSpreadsheetColumn](docs/XlsxSpreadsheetColumn.md)
458
480
  - [CloudmersiveConvertApiClient::XlsxSpreadsheetRow](docs/XlsxSpreadsheetRow.md)
481
+ - [CloudmersiveConvertApiClient::XlsxToPngResult](docs/XlsxToPngResult.md)
459
482
  - [CloudmersiveConvertApiClient::XlsxWorksheet](docs/XlsxWorksheet.md)
460
483
  - [CloudmersiveConvertApiClient::XmlAddAttributeWithXPathResult](docs/XmlAddAttributeWithXPathResult.md)
461
484
  - [CloudmersiveConvertApiClient::XmlAddChildWithXPathResult](docs/XmlAddChildWithXPathResult.md)
data/docs/AutodetectToThumbnailsResult.md ADDED
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::AutodetectToThumbnailsResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | Index of this thumbnail | [optional]
7
+ **thumbnail_pages** | [**Array<Thumbnail>**](Thumbnail.md) | A PNG thumbnail of the document page | [optional]
8
+
9
+
data/docs/ConvertDocumentApi.md CHANGED
@@ -7,16 +7,25 @@ Method | HTTP request | Description
7
7
  [**convert_document_autodetect_get_info**](ConvertDocumentApi.md#convert_document_autodetect_get_info) | **POST** /convert/autodetect/get-info | Get document type information
8
8
  [**convert_document_autodetect_to_pdf**](ConvertDocumentApi.md#convert_document_autodetect_to_pdf) | **POST** /convert/autodetect/to/pdf | Convert Document to PDF
9
9
  [**convert_document_autodetect_to_png_array**](ConvertDocumentApi.md#convert_document_autodetect_to_png_array) | **POST** /convert/autodetect/to/png | Convert Document to PNG array
10
+ [**convert_document_autodetect_to_thumbnail**](ConvertDocumentApi.md#convert_document_autodetect_to_thumbnail) | **POST** /convert/autodetect/to/thumbnail | Convert File to Thumbnail Image
11
+ [**convert_document_autodetect_to_thumbnails_advanced**](ConvertDocumentApi.md#convert_document_autodetect_to_thumbnails_advanced) | **POST** /convert/autodetect/to/thumbnail/advanced | Convert File to Thumbnail Image Object
10
12
  [**convert_document_autodetect_to_txt**](ConvertDocumentApi.md#convert_document_autodetect_to_txt) | **POST** /convert/autodetect/to/txt | Convert Document to Text (txt)
11
13
  [**convert_document_csv_to_xlsx**](ConvertDocumentApi.md#convert_document_csv_to_xlsx) | **POST** /convert/csv/to/xlsx | Convert CSV to Excel XLSX Spreadsheet
12
14
  [**convert_document_doc_to_docx**](ConvertDocumentApi.md#convert_document_doc_to_docx) | **POST** /convert/doc/to/docx | Convert Word DOC (97-03) Document to DOCX
13
15
  [**convert_document_doc_to_pdf**](ConvertDocumentApi.md#convert_document_doc_to_pdf) | **POST** /convert/doc/to/pdf | Convert Word DOC (97-03) Document to PDF
14
16
  [**convert_document_doc_to_txt**](ConvertDocumentApi.md#convert_document_doc_to_txt) | **POST** /convert/doc/to/txt | Convert Word DOC (97-03) Document to Text (txt)
15
17
  [**convert_document_docx_to_pdf**](ConvertDocumentApi.md#convert_document_docx_to_pdf) | **POST** /convert/docx/to/pdf | Convert Word DOCX Document to PDF
18
+ [**convert_document_docx_to_png**](ConvertDocumentApi.md#convert_document_docx_to_png) | **POST** /convert/docx/to/png | Convert DOCX document to PNG image array
16
19
  [**convert_document_docx_to_txt**](ConvertDocumentApi.md#convert_document_docx_to_txt) | **POST** /convert/docx/to/txt | Convert Word DOCX Document to Text (txt)
20
+ [**convert_document_eml_to_html**](ConvertDocumentApi.md#convert_document_eml_to_html) | **POST** /convert/eml/to/html | Convert Email EML file to HTML string
21
+ [**convert_document_eml_to_pdf**](ConvertDocumentApi.md#convert_document_eml_to_pdf) | **POST** /convert/eml/to/pdf | Convert Email EML file to PDF document
22
+ [**convert_document_get_file_type_icon**](ConvertDocumentApi.md#convert_document_get_file_type_icon) | **POST** /convert/autodetect/get-icon | Get PNG icon file for the file extension
23
+ [**convert_document_get_file_type_icon_advanced**](ConvertDocumentApi.md#convert_document_get_file_type_icon_advanced) | **POST** /convert/autodetect/get-icon-advanced | Get PNG icon byte array for the file extension
17
24
  [**convert_document_html_to_pdf**](ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | Convert HTML document file to PDF Document
18
25
  [**convert_document_html_to_png**](ConvertDocumentApi.md#convert_document_html_to_png) | **POST** /convert/html/to/png | Convert HTML document file to PNG image array
19
26
  [**convert_document_html_to_txt**](ConvertDocumentApi.md#convert_document_html_to_txt) | **POST** /convert/html/to/txt | HTML Document file to Text (txt)
27
+ [**convert_document_msg_to_html**](ConvertDocumentApi.md#convert_document_msg_to_html) | **POST** /convert/msg/to/html | Convert Email MSG file to HTML string
28
+ [**convert_document_msg_to_pdf**](ConvertDocumentApi.md#convert_document_msg_to_pdf) | **POST** /convert/msg/to/pdf | Convert Email MSG file to PDF document
20
29
  [**convert_document_pdf_to_docx**](ConvertDocumentApi.md#convert_document_pdf_to_docx) | **POST** /convert/pdf/to/docx | Convert PDF to Word DOCX Document
21
30
  [**convert_document_pdf_to_docx_rasterize**](ConvertDocumentApi.md#convert_document_pdf_to_docx_rasterize) | **POST** /convert/pdf/to/docx/rasterize | Convert PDF to Word DOCX Document based on rasterized version of the PDF
22
31
  [**convert_document_pdf_to_png_array**](ConvertDocumentApi.md#convert_document_pdf_to_png_array) | **POST** /convert/pdf/to/png | Convert PDF to PNG Image Array
@@ -27,6 +36,7 @@ Method | HTTP request | Description
27
36
  [**convert_document_ppt_to_pdf**](ConvertDocumentApi.md#convert_document_ppt_to_pdf) | **POST** /convert/ppt/to/pdf | Convert PowerPoint PPT (97-03) Presentation to PDF
28
37
  [**convert_document_ppt_to_pptx**](ConvertDocumentApi.md#convert_document_ppt_to_pptx) | **POST** /convert/ppt/to/pptx | Convert PowerPoint PPT (97-03) Presentation to PPTX
29
38
  [**convert_document_pptx_to_pdf**](ConvertDocumentApi.md#convert_document_pptx_to_pdf) | **POST** /convert/pptx/to/pdf | Convert PowerPoint PPTX Presentation to PDF
39
+ [**convert_document_pptx_to_png**](ConvertDocumentApi.md#convert_document_pptx_to_png) | **POST** /convert/pptx/to/png | Convert PowerPoint PPTX to PNG image array
30
40
  [**convert_document_pptx_to_txt**](ConvertDocumentApi.md#convert_document_pptx_to_txt) | **POST** /convert/pptx/to/txt | Convert PowerPoint PPTX Presentation to Text (txt)
31
41
  [**convert_document_xls_to_csv**](ConvertDocumentApi.md#convert_document_xls_to_csv) | **POST** /convert/xls/to/csv | Convert Excel XLS (97-03) Spreadsheet to CSV
32
42
  [**convert_document_xls_to_pdf**](ConvertDocumentApi.md#convert_document_xls_to_pdf) | **POST** /convert/xls/to/pdf | Convert Excel XLS (97-03) Spreadsheet to PDF
@@ -34,6 +44,7 @@ Method | HTTP request | Description
34
44
  [**convert_document_xlsx_to_csv**](ConvertDocumentApi.md#convert_document_xlsx_to_csv) | **POST** /convert/xlsx/to/csv | Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
35
45
  [**convert_document_xlsx_to_csv_multi**](ConvertDocumentApi.md#convert_document_xlsx_to_csv_multi) | **POST** /convert/xlsx/to/csv/multi | Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
36
46
  [**convert_document_xlsx_to_pdf**](ConvertDocumentApi.md#convert_document_xlsx_to_pdf) | **POST** /convert/xlsx/to/pdf | Convert Excel XLSX Spreadsheet to PDF
47
+ [**convert_document_xlsx_to_png**](ConvertDocumentApi.md#convert_document_xlsx_to_png) | **POST** /convert/xlsx/to/png | Convert Excel XLSX spreadsheet to PNG image array
37
48
  [**convert_document_xlsx_to_txt**](ConvertDocumentApi.md#convert_document_xlsx_to_txt) | **POST** /convert/xlsx/to/txt | Convert Excel XLSX Spreadsheet to Text (txt)
38
49
 
39
50
 
@@ -199,12 +210,520 @@ Name | Type | Description | Notes
199
210
 
200
211
 
201
212
 
213
+ # **convert_document_autodetect_to_thumbnail**
214
+ > Object convert_document_autodetect_to_thumbnail(input_file, opts)
215
+
216
+ Convert File to Thumbnail Image
217
+
218
+ 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.
219
+
220
+ ### Example
221
+ ```ruby
222
+ # load the gem
223
+ require 'cloudmersive-convert-api-client'
224
+ # setup authorization
225
+ CloudmersiveConvertApiClient.configure do |config|
226
+ # Configure API key authorization: Apikey
227
+ config.api_key['Apikey'] = 'YOUR API KEY'
228
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
229
+ #config.api_key_prefix['Apikey'] = 'Bearer'
230
+ end
231
+
232
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
233
+
234
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
235
+
236
+ opts = {
237
+ max_width: 56, # Integer | 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.
238
+ max_height: 56, # Integer | 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.
239
+ extension: "extension_example" # String | 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.
240
+ }
241
+
242
+ begin
243
+ #Convert File to Thumbnail Image
244
+ result = api_instance.convert_document_autodetect_to_thumbnail(input_file, opts)
245
+ p result
246
+ rescue CloudmersiveConvertApiClient::ApiError => e
247
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_thumbnail: #{e}"
248
+ end
249
+ ```
250
+
251
+ ### Parameters
252
+
253
+ Name | Type | Description | Notes
254
+ ------------- | ------------- | ------------- | -------------
255
+ **input_file** | **File**| Input file to perform the operation on. |
256
+ **max_width** | **Integer**| 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. | [optional]
257
+ **max_height** | **Integer**| 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. | [optional]
258
+ **extension** | **String**| 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. | [optional]
259
+
260
+ ### Return type
261
+
262
+ **Object**
263
+
264
+ ### Authorization
265
+
266
+ [Apikey](../README.md#Apikey)
267
+
268
+ ### HTTP request headers
269
+
270
+ - **Content-Type**: multipart/form-data
271
+ - **Accept**: application/octet-stream
272
+
273
+
274
+
275
+ # **convert_document_autodetect_to_thumbnails_advanced**
276
+ > AutodetectToThumbnailsResult convert_document_autodetect_to_thumbnails_advanced(input_file, opts)
277
+
278
+ Convert File to Thumbnail Image Object
279
+
280
+ 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.
281
+
282
+ ### Example
283
+ ```ruby
284
+ # load the gem
285
+ require 'cloudmersive-convert-api-client'
286
+ # setup authorization
287
+ CloudmersiveConvertApiClient.configure do |config|
288
+ # Configure API key authorization: Apikey
289
+ config.api_key['Apikey'] = 'YOUR API KEY'
290
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
291
+ #config.api_key_prefix['Apikey'] = 'Bearer'
292
+ end
293
+
294
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
295
+
296
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
297
+
298
+ opts = {
299
+ pages: 56, # Integer | Optional; Specify how many pages of the document will be converted to thumbnails. Default is 1 page.
300
+ max_width: 56, # Integer | 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.
301
+ max_height: 56, # Integer | 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.
302
+ extension: "extension_example" # String | 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.
303
+ }
304
+
305
+ begin
306
+ #Convert File to Thumbnail Image Object
307
+ result = api_instance.convert_document_autodetect_to_thumbnails_advanced(input_file, opts)
308
+ p result
309
+ rescue CloudmersiveConvertApiClient::ApiError => e
310
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_thumbnails_advanced: #{e}"
311
+ end
312
+ ```
313
+
314
+ ### Parameters
315
+
316
+ Name | Type | Description | Notes
317
+ ------------- | ------------- | ------------- | -------------
318
+ **input_file** | **File**| Input file to perform the operation on. |
319
+ **pages** | **Integer**| Optional; Specify how many pages of the document will be converted to thumbnails. Default is 1 page. | [optional]
320
+ **max_width** | **Integer**| 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. | [optional]
321
+ **max_height** | **Integer**| 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. | [optional]
322
+ **extension** | **String**| 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. | [optional]
323
+
324
+ ### Return type
325
+
326
+ [**AutodetectToThumbnailsResult**](AutodetectToThumbnailsResult.md)
327
+
328
+ ### Authorization
329
+
330
+ [Apikey](../README.md#Apikey)
331
+
332
+ ### HTTP request headers
333
+
334
+ - **Content-Type**: multipart/form-data
335
+ - **Accept**: application/json, text/json, application/xml, text/xml
336
+
337
+
338
+
202
339
  # **convert_document_autodetect_to_txt**
203
340
  > TextConversionResult convert_document_autodetect_to_txt(input_file, opts)
204
341
 
205
- Convert Document to Text (txt)
342
+ Convert Document to Text (txt)
343
+
344
+ 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.
345
+
346
+ ### Example
347
+ ```ruby
348
+ # load the gem
349
+ require 'cloudmersive-convert-api-client'
350
+ # setup authorization
351
+ CloudmersiveConvertApiClient.configure do |config|
352
+ # Configure API key authorization: Apikey
353
+ config.api_key['Apikey'] = 'YOUR API KEY'
354
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
355
+ #config.api_key_prefix['Apikey'] = 'Bearer'
356
+ end
357
+
358
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
359
+
360
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
361
+
362
+ opts = {
363
+ text_formatting_mode: "text_formatting_mode_example" # String | Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'.
364
+ }
365
+
366
+ begin
367
+ #Convert Document to Text (txt)
368
+ result = api_instance.convert_document_autodetect_to_txt(input_file, opts)
369
+ p result
370
+ rescue CloudmersiveConvertApiClient::ApiError => e
371
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_txt: #{e}"
372
+ end
373
+ ```
374
+
375
+ ### Parameters
376
+
377
+ Name | Type | Description | Notes
378
+ ------------- | ------------- | ------------- | -------------
379
+ **input_file** | **File**| Input file to perform the operation on. |
380
+ **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'. | [optional]
381
+
382
+ ### Return type
383
+
384
+ [**TextConversionResult**](TextConversionResult.md)
385
+
386
+ ### Authorization
387
+
388
+ [Apikey](../README.md#Apikey)
389
+
390
+ ### HTTP request headers
391
+
392
+ - **Content-Type**: multipart/form-data
393
+ - **Accept**: application/json, text/json, application/xml, text/xml
394
+
395
+
396
+
397
+ # **convert_document_csv_to_xlsx**
398
+ > String convert_document_csv_to_xlsx(input_file)
399
+
400
+ Convert CSV to Excel XLSX Spreadsheet
401
+
402
+ Convert CSV file to Office Excel XLSX Workbooks file format.
403
+
404
+ ### Example
405
+ ```ruby
406
+ # load the gem
407
+ require 'cloudmersive-convert-api-client'
408
+ # setup authorization
409
+ CloudmersiveConvertApiClient.configure do |config|
410
+ # Configure API key authorization: Apikey
411
+ config.api_key['Apikey'] = 'YOUR API KEY'
412
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
413
+ #config.api_key_prefix['Apikey'] = 'Bearer'
414
+ end
415
+
416
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
417
+
418
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
419
+
420
+
421
+ begin
422
+ #Convert CSV to Excel XLSX Spreadsheet
423
+ result = api_instance.convert_document_csv_to_xlsx(input_file)
424
+ p result
425
+ rescue CloudmersiveConvertApiClient::ApiError => e
426
+ puts "Exception when calling ConvertDocumentApi->convert_document_csv_to_xlsx: #{e}"
427
+ end
428
+ ```
429
+
430
+ ### Parameters
431
+
432
+ Name | Type | Description | Notes
433
+ ------------- | ------------- | ------------- | -------------
434
+ **input_file** | **File**| Input file to perform the operation on. |
435
+
436
+ ### Return type
437
+
438
+ **String**
439
+
440
+ ### Authorization
441
+
442
+ [Apikey](../README.md#Apikey)
443
+
444
+ ### HTTP request headers
445
+
446
+ - **Content-Type**: multipart/form-data
447
+ - **Accept**: application/octet-stream
448
+
449
+
450
+
451
+ # **convert_document_doc_to_docx**
452
+ > String convert_document_doc_to_docx(input_file)
453
+
454
+ Convert Word DOC (97-03) Document to DOCX
455
+
456
+ Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format
457
+
458
+ ### Example
459
+ ```ruby
460
+ # load the gem
461
+ require 'cloudmersive-convert-api-client'
462
+ # setup authorization
463
+ CloudmersiveConvertApiClient.configure do |config|
464
+ # Configure API key authorization: Apikey
465
+ config.api_key['Apikey'] = 'YOUR API KEY'
466
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
467
+ #config.api_key_prefix['Apikey'] = 'Bearer'
468
+ end
469
+
470
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
471
+
472
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
473
+
474
+
475
+ begin
476
+ #Convert Word DOC (97-03) Document to DOCX
477
+ result = api_instance.convert_document_doc_to_docx(input_file)
478
+ p result
479
+ rescue CloudmersiveConvertApiClient::ApiError => e
480
+ puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_docx: #{e}"
481
+ end
482
+ ```
483
+
484
+ ### Parameters
485
+
486
+ Name | Type | Description | Notes
487
+ ------------- | ------------- | ------------- | -------------
488
+ **input_file** | **File**| Input file to perform the operation on. |
489
+
490
+ ### Return type
491
+
492
+ **String**
493
+
494
+ ### Authorization
495
+
496
+ [Apikey](../README.md#Apikey)
497
+
498
+ ### HTTP request headers
499
+
500
+ - **Content-Type**: multipart/form-data
501
+ - **Accept**: application/octet-stream
502
+
503
+
504
+
505
+ # **convert_document_doc_to_pdf**
506
+ > String convert_document_doc_to_pdf(input_file)
507
+
508
+ Convert Word DOC (97-03) Document to PDF
509
+
510
+ Convert Office Word (97-2003 Format) Documents (doc) to standard PDF
511
+
512
+ ### Example
513
+ ```ruby
514
+ # load the gem
515
+ require 'cloudmersive-convert-api-client'
516
+ # setup authorization
517
+ CloudmersiveConvertApiClient.configure do |config|
518
+ # Configure API key authorization: Apikey
519
+ config.api_key['Apikey'] = 'YOUR API KEY'
520
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
521
+ #config.api_key_prefix['Apikey'] = 'Bearer'
522
+ end
523
+
524
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
525
+
526
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
527
+
528
+
529
+ begin
530
+ #Convert Word DOC (97-03) Document to PDF
531
+ result = api_instance.convert_document_doc_to_pdf(input_file)
532
+ p result
533
+ rescue CloudmersiveConvertApiClient::ApiError => e
534
+ puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_pdf: #{e}"
535
+ end
536
+ ```
537
+
538
+ ### Parameters
539
+
540
+ Name | Type | Description | Notes
541
+ ------------- | ------------- | ------------- | -------------
542
+ **input_file** | **File**| Input file to perform the operation on. |
543
+
544
+ ### Return type
545
+
546
+ **String**
547
+
548
+ ### Authorization
549
+
550
+ [Apikey](../README.md#Apikey)
551
+
552
+ ### HTTP request headers
553
+
554
+ - **Content-Type**: multipart/form-data
555
+ - **Accept**: application/octet-stream
556
+
557
+
558
+
559
+ # **convert_document_doc_to_txt**
560
+ > TextConversionResult convert_document_doc_to_txt(input_file)
561
+
562
+ Convert Word DOC (97-03) Document to Text (txt)
563
+
564
+ Convert Office Word DOC (97-03) Document (doc) to text
565
+
566
+ ### Example
567
+ ```ruby
568
+ # load the gem
569
+ require 'cloudmersive-convert-api-client'
570
+ # setup authorization
571
+ CloudmersiveConvertApiClient.configure do |config|
572
+ # Configure API key authorization: Apikey
573
+ config.api_key['Apikey'] = 'YOUR API KEY'
574
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
575
+ #config.api_key_prefix['Apikey'] = 'Bearer'
576
+ end
577
+
578
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
579
+
580
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
581
+
582
+
583
+ begin
584
+ #Convert Word DOC (97-03) Document to Text (txt)
585
+ result = api_instance.convert_document_doc_to_txt(input_file)
586
+ p result
587
+ rescue CloudmersiveConvertApiClient::ApiError => e
588
+ puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_txt: #{e}"
589
+ end
590
+ ```
591
+
592
+ ### Parameters
593
+
594
+ Name | Type | Description | Notes
595
+ ------------- | ------------- | ------------- | -------------
596
+ **input_file** | **File**| Input file to perform the operation on. |
597
+
598
+ ### Return type
599
+
600
+ [**TextConversionResult**](TextConversionResult.md)
601
+
602
+ ### Authorization
603
+
604
+ [Apikey](../README.md#Apikey)
605
+
606
+ ### HTTP request headers
607
+
608
+ - **Content-Type**: multipart/form-data
609
+ - **Accept**: application/json, text/json, application/xml, text/xml
610
+
611
+
612
+
613
+ # **convert_document_docx_to_pdf**
614
+ > String convert_document_docx_to_pdf(input_file)
615
+
616
+ Convert Word DOCX Document to PDF
617
+
618
+ Convert Office Word Documents (docx) to standard PDF
619
+
620
+ ### Example
621
+ ```ruby
622
+ # load the gem
623
+ require 'cloudmersive-convert-api-client'
624
+ # setup authorization
625
+ CloudmersiveConvertApiClient.configure do |config|
626
+ # Configure API key authorization: Apikey
627
+ config.api_key['Apikey'] = 'YOUR API KEY'
628
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
629
+ #config.api_key_prefix['Apikey'] = 'Bearer'
630
+ end
631
+
632
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
633
+
634
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
635
+
636
+
637
+ begin
638
+ #Convert Word DOCX Document to PDF
639
+ result = api_instance.convert_document_docx_to_pdf(input_file)
640
+ p result
641
+ rescue CloudmersiveConvertApiClient::ApiError => e
642
+ puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_pdf: #{e}"
643
+ end
644
+ ```
645
+
646
+ ### Parameters
647
+
648
+ Name | Type | Description | Notes
649
+ ------------- | ------------- | ------------- | -------------
650
+ **input_file** | **File**| Input file to perform the operation on. |
651
+
652
+ ### Return type
653
+
654
+ **String**
655
+
656
+ ### Authorization
657
+
658
+ [Apikey](../README.md#Apikey)
659
+
660
+ ### HTTP request headers
661
+
662
+ - **Content-Type**: multipart/form-data
663
+ - **Accept**: application/octet-stream
664
+
665
+
666
+
667
+ # **convert_document_docx_to_png**
668
+ > DocxToPngResult convert_document_docx_to_png(input_file)
669
+
670
+ Convert DOCX document to PNG image array
671
+
672
+ Converts an Office Word Document (DOCX) file to an array of PNG images, one for each page.
673
+
674
+ ### Example
675
+ ```ruby
676
+ # load the gem
677
+ require 'cloudmersive-convert-api-client'
678
+ # setup authorization
679
+ CloudmersiveConvertApiClient.configure do |config|
680
+ # Configure API key authorization: Apikey
681
+ config.api_key['Apikey'] = 'YOUR API KEY'
682
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
683
+ #config.api_key_prefix['Apikey'] = 'Bearer'
684
+ end
685
+
686
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
687
+
688
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
689
+
690
+
691
+ begin
692
+ #Convert DOCX document to PNG image array
693
+ result = api_instance.convert_document_docx_to_png(input_file)
694
+ p result
695
+ rescue CloudmersiveConvertApiClient::ApiError => e
696
+ puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_png: #{e}"
697
+ end
698
+ ```
699
+
700
+ ### Parameters
206
701
 
207
- 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.
702
+ Name | Type | Description | Notes
703
+ ------------- | ------------- | ------------- | -------------
704
+ **input_file** | **File**| Input file to perform the operation on. |
705
+
706
+ ### Return type
707
+
708
+ [**DocxToPngResult**](DocxToPngResult.md)
709
+
710
+ ### Authorization
711
+
712
+ [Apikey](../README.md#Apikey)
713
+
714
+ ### HTTP request headers
715
+
716
+ - **Content-Type**: multipart/form-data
717
+ - **Accept**: application/json, text/json, application/xml, text/xml
718
+
719
+
720
+
721
+ # **convert_document_docx_to_txt**
722
+ > TextConversionResult convert_document_docx_to_txt(input_file, opts)
723
+
724
+ Convert Word DOCX Document to Text (txt)
725
+
726
+ Convert Office Word Documents (docx) to text
208
727
 
209
728
  ### Example
210
729
  ```ruby
@@ -223,15 +742,15 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
223
742
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
224
743
 
225
744
  opts = {
226
- text_formatting_mode: "text_formatting_mode_example" # String | Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'.
745
+ text_formatting_mode: "text_formatting_mode_example" # String | Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'minimizeWhitespace'.
227
746
  }
228
747
 
229
748
  begin
230
- #Convert Document to Text (txt)
231
- result = api_instance.convert_document_autodetect_to_txt(input_file, opts)
749
+ #Convert Word DOCX Document to Text (txt)
750
+ result = api_instance.convert_document_docx_to_txt(input_file, opts)
232
751
  p result
233
752
  rescue CloudmersiveConvertApiClient::ApiError => e
234
- puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_txt: #{e}"
753
+ puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_txt: #{e}"
235
754
  end
236
755
  ```
237
756
 
@@ -240,7 +759,7 @@ end
240
759
  Name | Type | Description | Notes
241
760
  ------------- | ------------- | ------------- | -------------
242
761
  **input_file** | **File**| Input file to perform the operation on. |
243
- **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'. | [optional]
762
+ **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'minimizeWhitespace'. | [optional]
244
763
 
245
764
  ### Return type
246
765
 
@@ -257,12 +776,12 @@ Name | Type | Description | Notes
257
776
 
258
777
 
259
778
 
260
- # **convert_document_csv_to_xlsx**
261
- > String convert_document_csv_to_xlsx(input_file)
779
+ # **convert_document_eml_to_html**
780
+ > EmlToHtmlResult convert_document_eml_to_html(input_file, opts)
262
781
 
263
- Convert CSV to Excel XLSX Spreadsheet
782
+ Convert Email EML file to HTML string
264
783
 
265
- Convert CSV file to Office Excel XLSX Workbooks file format.
784
+ Convert Outlook Email EML file to HTML string and attachments. Supports images if they are base 64 inline.
266
785
 
267
786
  ### Example
268
787
  ```ruby
@@ -280,13 +799,17 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
280
799
 
281
800
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
282
801
 
802
+ opts = {
803
+ body_only: true, # BOOLEAN | 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.
804
+ include_attachments: true # BOOLEAN | Optional; If false, the response object will not include any attachment files from the input file. Default is true.
805
+ }
283
806
 
284
807
  begin
285
- #Convert CSV to Excel XLSX Spreadsheet
286
- result = api_instance.convert_document_csv_to_xlsx(input_file)
808
+ #Convert Email EML file to HTML string
809
+ result = api_instance.convert_document_eml_to_html(input_file, opts)
287
810
  p result
288
811
  rescue CloudmersiveConvertApiClient::ApiError => e
289
- puts "Exception when calling ConvertDocumentApi->convert_document_csv_to_xlsx: #{e}"
812
+ puts "Exception when calling ConvertDocumentApi->convert_document_eml_to_html: #{e}"
290
813
  end
291
814
  ```
292
815
 
@@ -295,10 +818,12 @@ end
295
818
  Name | Type | Description | Notes
296
819
  ------------- | ------------- | ------------- | -------------
297
820
  **input_file** | **File**| Input file to perform the operation on. |
821
+ **body_only** | **BOOLEAN**| 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. | [optional]
822
+ **include_attachments** | **BOOLEAN**| Optional; If false, the response object will not include any attachment files from the input file. Default is true. | [optional]
298
823
 
299
824
  ### Return type
300
825
 
301
- **String**
826
+ [**EmlToHtmlResult**](EmlToHtmlResult.md)
302
827
 
303
828
  ### Authorization
304
829
 
@@ -307,16 +832,16 @@ Name | Type | Description | Notes
307
832
  ### HTTP request headers
308
833
 
309
834
  - **Content-Type**: multipart/form-data
310
- - **Accept**: application/octet-stream
835
+ - **Accept**: application/json, text/json, application/xml, text/xml
311
836
 
312
837
 
313
838
 
314
- # **convert_document_doc_to_docx**
315
- > String convert_document_doc_to_docx(input_file)
839
+ # **convert_document_eml_to_pdf**
840
+ > Object convert_document_eml_to_pdf(input_file, opts)
316
841
 
317
- Convert Word DOC (97-03) Document to DOCX
842
+ Convert Email EML file to PDF document
318
843
 
319
- Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format
844
+ Convert Outlook Email EML file to PDF document. Supports images if they are base 64 inline.
320
845
 
321
846
  ### Example
322
847
  ```ruby
@@ -334,13 +859,16 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
334
859
 
335
860
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
336
861
 
862
+ opts = {
863
+ body_only: true # BOOLEAN | 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.
864
+ }
337
865
 
338
866
  begin
339
- #Convert Word DOC (97-03) Document to DOCX
340
- result = api_instance.convert_document_doc_to_docx(input_file)
867
+ #Convert Email EML file to PDF document
868
+ result = api_instance.convert_document_eml_to_pdf(input_file, opts)
341
869
  p result
342
870
  rescue CloudmersiveConvertApiClient::ApiError => e
343
- puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_docx: #{e}"
871
+ puts "Exception when calling ConvertDocumentApi->convert_document_eml_to_pdf: #{e}"
344
872
  end
345
873
  ```
346
874
 
@@ -349,10 +877,11 @@ end
349
877
  Name | Type | Description | Notes
350
878
  ------------- | ------------- | ------------- | -------------
351
879
  **input_file** | **File**| Input file to perform the operation on. |
880
+ **body_only** | **BOOLEAN**| 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. | [optional]
352
881
 
353
882
  ### Return type
354
883
 
355
- **String**
884
+ **Object**
356
885
 
357
886
  ### Authorization
358
887
 
@@ -365,12 +894,12 @@ Name | Type | Description | Notes
365
894
 
366
895
 
367
896
 
368
- # **convert_document_doc_to_pdf**
369
- > String convert_document_doc_to_pdf(input_file)
897
+ # **convert_document_get_file_type_icon**
898
+ > Object convert_document_get_file_type_icon(file_extension, opts)
370
899
 
371
- Convert Word DOC (97-03) Document to PDF
900
+ Get PNG icon file for the file extension
372
901
 
373
- Convert Office Word (97-2003 Format) Documents (doc) to standard PDF
902
+ 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.
374
903
 
375
904
  ### Example
376
905
  ```ruby
@@ -386,15 +915,18 @@ end
386
915
 
387
916
  api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
388
917
 
389
- input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
918
+ file_extension = "file_extension_example" # String | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
390
919
 
920
+ opts = {
921
+ icon_size: 56 # Integer | Optional; The desired width of the icon, preserving its aspect ratio.
922
+ }
391
923
 
392
924
  begin
393
- #Convert Word DOC (97-03) Document to PDF
394
- result = api_instance.convert_document_doc_to_pdf(input_file)
925
+ #Get PNG icon file for the file extension
926
+ result = api_instance.convert_document_get_file_type_icon(file_extension, opts)
395
927
  p result
396
928
  rescue CloudmersiveConvertApiClient::ApiError => e
397
- puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_pdf: #{e}"
929
+ puts "Exception when calling ConvertDocumentApi->convert_document_get_file_type_icon: #{e}"
398
930
  end
399
931
  ```
400
932
 
@@ -402,11 +934,12 @@ end
402
934
 
403
935
  Name | Type | Description | Notes
404
936
  ------------- | ------------- | ------------- | -------------
405
- **input_file** | **File**| Input file to perform the operation on. |
937
+ **file_extension** | **String**| Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters. |
938
+ **icon_size** | **Integer**| Optional; The desired width of the icon, preserving its aspect ratio. | [optional]
406
939
 
407
940
  ### Return type
408
941
 
409
- **String**
942
+ **Object**
410
943
 
411
944
  ### Authorization
412
945
 
@@ -414,17 +947,17 @@ Name | Type | Description | Notes
414
947
 
415
948
  ### HTTP request headers
416
949
 
417
- - **Content-Type**: multipart/form-data
950
+ - **Content-Type**: Not defined
418
951
  - **Accept**: application/octet-stream
419
952
 
420
953
 
421
954
 
422
- # **convert_document_doc_to_txt**
423
- > TextConversionResult convert_document_doc_to_txt(input_file)
955
+ # **convert_document_get_file_type_icon_advanced**
956
+ > GetFileTypeIconResult convert_document_get_file_type_icon_advanced(file_extension, opts)
424
957
 
425
- Convert Word DOC (97-03) Document to Text (txt)
958
+ Get PNG icon byte array for the file extension
426
959
 
427
- Convert Office Word DOC (97-03) Document (doc) to text
960
+ 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.
428
961
 
429
962
  ### Example
430
963
  ```ruby
@@ -440,15 +973,18 @@ end
440
973
 
441
974
  api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
442
975
 
443
- input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
976
+ file_extension = "file_extension_example" # String | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
444
977
 
978
+ opts = {
979
+ icon_size: 56 # Integer | Optional; The desired width of the icon, preserving its aspect ratio.
980
+ }
445
981
 
446
982
  begin
447
- #Convert Word DOC (97-03) Document to Text (txt)
448
- result = api_instance.convert_document_doc_to_txt(input_file)
983
+ #Get PNG icon byte array for the file extension
984
+ result = api_instance.convert_document_get_file_type_icon_advanced(file_extension, opts)
449
985
  p result
450
986
  rescue CloudmersiveConvertApiClient::ApiError => e
451
- puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_txt: #{e}"
987
+ puts "Exception when calling ConvertDocumentApi->convert_document_get_file_type_icon_advanced: #{e}"
452
988
  end
453
989
  ```
454
990
 
@@ -456,11 +992,12 @@ end
456
992
 
457
993
  Name | Type | Description | Notes
458
994
  ------------- | ------------- | ------------- | -------------
459
- **input_file** | **File**| Input file to perform the operation on. |
995
+ **file_extension** | **String**| Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters. |
996
+ **icon_size** | **Integer**| Optional; The desired width of the icon, preserving its aspect ratio. | [optional]
460
997
 
461
998
  ### Return type
462
999
 
463
- [**TextConversionResult**](TextConversionResult.md)
1000
+ [**GetFileTypeIconResult**](GetFileTypeIconResult.md)
464
1001
 
465
1002
  ### Authorization
466
1003
 
@@ -468,17 +1005,17 @@ Name | Type | Description | Notes
468
1005
 
469
1006
  ### HTTP request headers
470
1007
 
471
- - **Content-Type**: multipart/form-data
1008
+ - **Content-Type**: Not defined
472
1009
  - **Accept**: application/json, text/json, application/xml, text/xml
473
1010
 
474
1011
 
475
1012
 
476
- # **convert_document_docx_to_pdf**
477
- > String convert_document_docx_to_pdf(input_file)
1013
+ # **convert_document_html_to_pdf**
1014
+ > String convert_document_html_to_pdf(input_file)
478
1015
 
479
- Convert Word DOCX Document to PDF
1016
+ Convert HTML document file to PDF Document
480
1017
 
481
- Convert Office Word Documents (docx) to standard PDF
1018
+ 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.
482
1019
 
483
1020
  ### Example
484
1021
  ```ruby
@@ -498,11 +1035,11 @@ input_file = File.new("/path/to/file.txt") # File | Input file to perform the op
498
1035
 
499
1036
 
500
1037
  begin
501
- #Convert Word DOCX Document to PDF
502
- result = api_instance.convert_document_docx_to_pdf(input_file)
1038
+ #Convert HTML document file to PDF Document
1039
+ result = api_instance.convert_document_html_to_pdf(input_file)
503
1040
  p result
504
1041
  rescue CloudmersiveConvertApiClient::ApiError => e
505
- puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_pdf: #{e}"
1042
+ puts "Exception when calling ConvertDocumentApi->convert_document_html_to_pdf: #{e}"
506
1043
  end
507
1044
  ```
508
1045
 
@@ -527,12 +1064,12 @@ Name | Type | Description | Notes
527
1064
 
528
1065
 
529
1066
 
530
- # **convert_document_docx_to_txt**
531
- > TextConversionResult convert_document_docx_to_txt(input_file, opts)
1067
+ # **convert_document_html_to_png**
1068
+ > PdfToPngResult convert_document_html_to_png(input_file)
532
1069
 
533
- Convert Word DOCX Document to Text (txt)
1070
+ Convert HTML document file to PNG image array
534
1071
 
535
- Convert Office Word Documents (docx) to text
1072
+ Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.
536
1073
 
537
1074
  ### Example
538
1075
  ```ruby
@@ -550,16 +1087,13 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
550
1087
 
551
1088
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
552
1089
 
553
- opts = {
554
- text_formatting_mode: "text_formatting_mode_example" # String | Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'minimizeWhitespace'.
555
- }
556
1090
 
557
1091
  begin
558
- #Convert Word DOCX Document to Text (txt)
559
- result = api_instance.convert_document_docx_to_txt(input_file, opts)
1092
+ #Convert HTML document file to PNG image array
1093
+ result = api_instance.convert_document_html_to_png(input_file)
560
1094
  p result
561
1095
  rescue CloudmersiveConvertApiClient::ApiError => e
562
- puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_txt: #{e}"
1096
+ puts "Exception when calling ConvertDocumentApi->convert_document_html_to_png: #{e}"
563
1097
  end
564
1098
  ```
565
1099
 
@@ -568,11 +1102,10 @@ end
568
1102
  Name | Type | Description | Notes
569
1103
  ------------- | ------------- | ------------- | -------------
570
1104
  **input_file** | **File**| Input file to perform the operation on. |
571
- **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'minimizeWhitespace'. | [optional]
572
1105
 
573
1106
  ### Return type
574
1107
 
575
- [**TextConversionResult**](TextConversionResult.md)
1108
+ [**PdfToPngResult**](PdfToPngResult.md)
576
1109
 
577
1110
  ### Authorization
578
1111
 
@@ -585,12 +1118,12 @@ Name | Type | Description | Notes
585
1118
 
586
1119
 
587
1120
 
588
- # **convert_document_html_to_pdf**
589
- > String convert_document_html_to_pdf(input_file)
1121
+ # **convert_document_html_to_txt**
1122
+ > TextConversionResult convert_document_html_to_txt(input_file)
590
1123
 
591
- Convert HTML document file to PDF Document
1124
+ HTML Document file to Text (txt)
592
1125
 
593
- 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.
1126
+ HTML document to text
594
1127
 
595
1128
  ### Example
596
1129
  ```ruby
@@ -610,11 +1143,11 @@ input_file = File.new("/path/to/file.txt") # File | Input file to perform the op
610
1143
 
611
1144
 
612
1145
  begin
613
- #Convert HTML document file to PDF Document
614
- result = api_instance.convert_document_html_to_pdf(input_file)
1146
+ #HTML Document file to Text (txt)
1147
+ result = api_instance.convert_document_html_to_txt(input_file)
615
1148
  p result
616
1149
  rescue CloudmersiveConvertApiClient::ApiError => e
617
- puts "Exception when calling ConvertDocumentApi->convert_document_html_to_pdf: #{e}"
1150
+ puts "Exception when calling ConvertDocumentApi->convert_document_html_to_txt: #{e}"
618
1151
  end
619
1152
  ```
620
1153
 
@@ -626,7 +1159,7 @@ Name | Type | Description | Notes
626
1159
 
627
1160
  ### Return type
628
1161
 
629
- **String**
1162
+ [**TextConversionResult**](TextConversionResult.md)
630
1163
 
631
1164
  ### Authorization
632
1165
 
@@ -635,16 +1168,16 @@ Name | Type | Description | Notes
635
1168
  ### HTTP request headers
636
1169
 
637
1170
  - **Content-Type**: multipart/form-data
638
- - **Accept**: application/octet-stream
1171
+ - **Accept**: application/json, text/json, application/xml, text/xml
639
1172
 
640
1173
 
641
1174
 
642
- # **convert_document_html_to_png**
643
- > PdfToPngResult convert_document_html_to_png(input_file)
1175
+ # **convert_document_msg_to_html**
1176
+ > MsgToHtmlResult convert_document_msg_to_html(input_file, opts)
644
1177
 
645
- Convert HTML document file to PNG image array
1178
+ Convert Email MSG file to HTML string
646
1179
 
647
- Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.
1180
+ 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.
648
1181
 
649
1182
  ### Example
650
1183
  ```ruby
@@ -662,13 +1195,17 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
662
1195
 
663
1196
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
664
1197
 
1198
+ opts = {
1199
+ body_only: true, # BOOLEAN | 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.
1200
+ include_attachments: true # BOOLEAN | Optional; If false, the response object will not include any attachment files from the input file. Default is true.
1201
+ }
665
1202
 
666
1203
  begin
667
- #Convert HTML document file to PNG image array
668
- result = api_instance.convert_document_html_to_png(input_file)
1204
+ #Convert Email MSG file to HTML string
1205
+ result = api_instance.convert_document_msg_to_html(input_file, opts)
669
1206
  p result
670
1207
  rescue CloudmersiveConvertApiClient::ApiError => e
671
- puts "Exception when calling ConvertDocumentApi->convert_document_html_to_png: #{e}"
1208
+ puts "Exception when calling ConvertDocumentApi->convert_document_msg_to_html: #{e}"
672
1209
  end
673
1210
  ```
674
1211
 
@@ -677,10 +1214,12 @@ end
677
1214
  Name | Type | Description | Notes
678
1215
  ------------- | ------------- | ------------- | -------------
679
1216
  **input_file** | **File**| Input file to perform the operation on. |
1217
+ **body_only** | **BOOLEAN**| 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. | [optional]
1218
+ **include_attachments** | **BOOLEAN**| Optional; If false, the response object will not include any attachment files from the input file. Default is true. | [optional]
680
1219
 
681
1220
  ### Return type
682
1221
 
683
- [**PdfToPngResult**](PdfToPngResult.md)
1222
+ [**MsgToHtmlResult**](MsgToHtmlResult.md)
684
1223
 
685
1224
  ### Authorization
686
1225
 
@@ -693,12 +1232,12 @@ Name | Type | Description | Notes
693
1232
 
694
1233
 
695
1234
 
696
- # **convert_document_html_to_txt**
697
- > TextConversionResult convert_document_html_to_txt(input_file)
1235
+ # **convert_document_msg_to_pdf**
1236
+ > Object convert_document_msg_to_pdf(input_file, opts)
698
1237
 
699
- HTML Document file to Text (txt)
1238
+ Convert Email MSG file to PDF document
700
1239
 
701
- HTML document to text
1240
+ 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.
702
1241
 
703
1242
  ### Example
704
1243
  ```ruby
@@ -716,13 +1255,16 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
716
1255
 
717
1256
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
718
1257
 
1258
+ opts = {
1259
+ body_only: true # BOOLEAN | 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.
1260
+ }
719
1261
 
720
1262
  begin
721
- #HTML Document file to Text (txt)
722
- result = api_instance.convert_document_html_to_txt(input_file)
1263
+ #Convert Email MSG file to PDF document
1264
+ result = api_instance.convert_document_msg_to_pdf(input_file, opts)
723
1265
  p result
724
1266
  rescue CloudmersiveConvertApiClient::ApiError => e
725
- puts "Exception when calling ConvertDocumentApi->convert_document_html_to_txt: #{e}"
1267
+ puts "Exception when calling ConvertDocumentApi->convert_document_msg_to_pdf: #{e}"
726
1268
  end
727
1269
  ```
728
1270
 
@@ -731,10 +1273,11 @@ end
731
1273
  Name | Type | Description | Notes
732
1274
  ------------- | ------------- | ------------- | -------------
733
1275
  **input_file** | **File**| Input file to perform the operation on. |
1276
+ **body_only** | **BOOLEAN**| 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. | [optional]
734
1277
 
735
1278
  ### Return type
736
1279
 
737
- [**TextConversionResult**](TextConversionResult.md)
1280
+ **Object**
738
1281
 
739
1282
  ### Authorization
740
1283
 
@@ -743,7 +1286,7 @@ Name | Type | Description | Notes
743
1286
  ### HTTP request headers
744
1287
 
745
1288
  - **Content-Type**: multipart/form-data
746
- - **Accept**: application/json, text/json, application/xml, text/xml
1289
+ - **Accept**: application/octet-stream
747
1290
 
748
1291
 
749
1292
 
@@ -1312,6 +1855,60 @@ Name | Type | Description | Notes
1312
1855
 
1313
1856
 
1314
1857
 
1858
+ # **convert_document_pptx_to_png**
1859
+ > PptxToPngResult convert_document_pptx_to_png(input_file)
1860
+
1861
+ Convert PowerPoint PPTX to PNG image array
1862
+
1863
+ Converts a PowerPoint Presentation (PPTX) file to an array of PNG images, one for each page.
1864
+
1865
+ ### Example
1866
+ ```ruby
1867
+ # load the gem
1868
+ require 'cloudmersive-convert-api-client'
1869
+ # setup authorization
1870
+ CloudmersiveConvertApiClient.configure do |config|
1871
+ # Configure API key authorization: Apikey
1872
+ config.api_key['Apikey'] = 'YOUR API KEY'
1873
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1874
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1875
+ end
1876
+
1877
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1878
+
1879
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
1880
+
1881
+
1882
+ begin
1883
+ #Convert PowerPoint PPTX to PNG image array
1884
+ result = api_instance.convert_document_pptx_to_png(input_file)
1885
+ p result
1886
+ rescue CloudmersiveConvertApiClient::ApiError => e
1887
+ puts "Exception when calling ConvertDocumentApi->convert_document_pptx_to_png: #{e}"
1888
+ end
1889
+ ```
1890
+
1891
+ ### Parameters
1892
+
1893
+ Name | Type | Description | Notes
1894
+ ------------- | ------------- | ------------- | -------------
1895
+ **input_file** | **File**| Input file to perform the operation on. |
1896
+
1897
+ ### Return type
1898
+
1899
+ [**PptxToPngResult**](PptxToPngResult.md)
1900
+
1901
+ ### Authorization
1902
+
1903
+ [Apikey](../README.md#Apikey)
1904
+
1905
+ ### HTTP request headers
1906
+
1907
+ - **Content-Type**: multipart/form-data
1908
+ - **Accept**: application/json, text/json, application/xml, text/xml
1909
+
1910
+
1911
+
1315
1912
  # **convert_document_pptx_to_txt**
1316
1913
  > TextConversionResult convert_document_pptx_to_txt(input_file)
1317
1914
 
@@ -1698,6 +2295,60 @@ Name | Type | Description | Notes
1698
2295
 
1699
2296
 
1700
2297
 
2298
+ # **convert_document_xlsx_to_png**
2299
+ > XlsxToPngResult convert_document_xlsx_to_png(input_file)
2300
+
2301
+ Convert Excel XLSX spreadsheet to PNG image array
2302
+
2303
+ Converts an Excel Spreadsheet (XLSX) file to an array of PNG images, one for each page.
2304
+
2305
+ ### Example
2306
+ ```ruby
2307
+ # load the gem
2308
+ require 'cloudmersive-convert-api-client'
2309
+ # setup authorization
2310
+ CloudmersiveConvertApiClient.configure do |config|
2311
+ # Configure API key authorization: Apikey
2312
+ config.api_key['Apikey'] = 'YOUR API KEY'
2313
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2314
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2315
+ end
2316
+
2317
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2318
+
2319
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
2320
+
2321
+
2322
+ begin
2323
+ #Convert Excel XLSX spreadsheet to PNG image array
2324
+ result = api_instance.convert_document_xlsx_to_png(input_file)
2325
+ p result
2326
+ rescue CloudmersiveConvertApiClient::ApiError => e
2327
+ puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_png: #{e}"
2328
+ end
2329
+ ```
2330
+
2331
+ ### Parameters
2332
+
2333
+ Name | Type | Description | Notes
2334
+ ------------- | ------------- | ------------- | -------------
2335
+ **input_file** | **File**| Input file to perform the operation on. |
2336
+
2337
+ ### Return type
2338
+
2339
+ [**XlsxToPngResult**](XlsxToPngResult.md)
2340
+
2341
+ ### Authorization
2342
+
2343
+ [Apikey](../README.md#Apikey)
2344
+
2345
+ ### HTTP request headers
2346
+
2347
+ - **Content-Type**: multipart/form-data
2348
+ - **Accept**: application/json, text/json, application/xml, text/xml
2349
+
2350
+
2351
+
1701
2352
  # **convert_document_xlsx_to_txt**
1702
2353
  > TextConversionResult convert_document_xlsx_to_txt(input_file)
1703
2354