cloudmersive-convert-api-client 1.7.3 → 1.7.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (80) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +45 -5
  3. data/docs/AutodetectToThumbnailsResult.md +9 -0
  4. data/docs/ConvertDataApi.md +6 -2
  5. data/docs/ConvertDocumentApi.md +794 -84
  6. data/docs/CsvCollection.md +10 -0
  7. data/docs/CsvFileResult.md +9 -0
  8. data/docs/DocumentValidationResult.md +1 -0
  9. data/docs/DocxParagraph.md +1 -1
  10. data/docs/DocxRun.md +1 -1
  11. data/docs/DocxText.md +1 -1
  12. data/docs/DocxToPngResult.md +9 -0
  13. data/docs/EditDocumentApi.md +110 -0
  14. data/docs/EmlAttachment.md +9 -0
  15. data/docs/EmlToHtmlResult.md +16 -0
  16. data/docs/FindDocxParagraphRequest.md +11 -0
  17. data/docs/FindDocxParagraphResponse.md +10 -0
  18. data/docs/GetFileTypeIconResult.md +10 -0
  19. data/docs/MsgAttachment.md +9 -0
  20. data/docs/MsgToHtmlResult.md +16 -0
  21. data/docs/PptxToPngResult.md +9 -0
  22. data/docs/ReplaceDocxParagraphRequest.md +12 -0
  23. data/docs/ReplaceDocxParagraphResponse.md +9 -0
  24. data/docs/Thumbnail.md +9 -0
  25. data/docs/ValidateDocumentApi.md +386 -1
  26. data/docs/XlsxToPngResult.md +9 -0
  27. data/docs/ZipArchiveApi.md +144 -5
  28. data/docs/ZipEncryptionAdvancedRequest.md +10 -0
  29. data/lib/cloudmersive-convert-api-client.rb +17 -0
  30. data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +3 -0
  31. data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +722 -6
  32. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +110 -0
  33. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +394 -2
  34. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +160 -6
  35. data/lib/cloudmersive-convert-api-client/models/autodetect_to_thumbnails_result.rb +201 -0
  36. data/lib/cloudmersive-convert-api-client/models/csv_collection.rb +211 -0
  37. data/lib/cloudmersive-convert-api-client/models/csv_file_result.rb +215 -0
  38. data/lib/cloudmersive-convert-api-client/models/document_validation_result.rb +11 -1
  39. data/lib/cloudmersive-convert-api-client/models/docx_paragraph.rb +1 -1
  40. data/lib/cloudmersive-convert-api-client/models/docx_run.rb +1 -1
  41. data/lib/cloudmersive-convert-api-client/models/docx_text.rb +1 -1
  42. data/lib/cloudmersive-convert-api-client/models/docx_to_png_result.rb +201 -0
  43. data/lib/cloudmersive-convert-api-client/models/eml_attachment.rb +215 -0
  44. data/lib/cloudmersive-convert-api-client/models/eml_to_html_result.rb +271 -0
  45. data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_request.rb +235 -0
  46. data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_response.rb +211 -0
  47. data/lib/cloudmersive-convert-api-client/models/get_file_type_icon_result.rb +225 -0
  48. data/lib/cloudmersive-convert-api-client/models/msg_attachment.rb +215 -0
  49. data/lib/cloudmersive-convert-api-client/models/msg_to_html_result.rb +271 -0
  50. data/lib/cloudmersive-convert-api-client/models/pptx_to_png_result.rb +201 -0
  51. data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_request.rb +245 -0
  52. data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_response.rb +199 -0
  53. data/lib/cloudmersive-convert-api-client/models/thumbnail.rb +215 -0
  54. data/lib/cloudmersive-convert-api-client/models/xlsx_to_png_result.rb +201 -0
  55. data/lib/cloudmersive-convert-api-client/models/zip_encryption_advanced_request.rb +225 -0
  56. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  57. data/spec/api/convert_data_api_spec.rb +1 -0
  58. data/spec/api/convert_document_api_spec.rb +163 -3
  59. data/spec/api/edit_document_api_spec.rb +24 -0
  60. data/spec/api/validate_document_api_spec.rb +85 -1
  61. data/spec/api/zip_archive_api_spec.rb +36 -1
  62. data/spec/models/autodetect_to_thumbnails_result_spec.rb +48 -0
  63. data/spec/models/csv_collection_spec.rb +54 -0
  64. data/spec/models/csv_file_result_spec.rb +48 -0
  65. data/spec/models/document_validation_result_spec.rb +6 -0
  66. data/spec/models/docx_to_png_result_spec.rb +48 -0
  67. data/spec/models/eml_attachment_spec.rb +48 -0
  68. data/spec/models/eml_to_html_result_spec.rb +90 -0
  69. data/spec/models/find_docx_paragraph_request_spec.rb +60 -0
  70. data/spec/models/find_docx_paragraph_response_spec.rb +54 -0
  71. data/spec/models/get_file_type_icon_result_spec.rb +54 -0
  72. data/spec/models/msg_attachment_spec.rb +48 -0
  73. data/spec/models/msg_to_html_result_spec.rb +90 -0
  74. data/spec/models/pptx_to_png_result_spec.rb +48 -0
  75. data/spec/models/replace_docx_paragraph_request_spec.rb +66 -0
  76. data/spec/models/replace_docx_paragraph_response_spec.rb +48 -0
  77. data/spec/models/thumbnail_spec.rb +48 -0
  78. data/spec/models/xlsx_to_png_result_spec.rb +48 -0
  79. data/spec/models/zip_encryption_advanced_request_spec.rb +54 -0
  80. metadata +53 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 32d818416ca08a5caa6a1c680908960fc645ef08b9de8d9682db3be88b1bf14e
4
- data.tar.gz: dead491305e0198ca2fec69ab6a06dcc2cd7f0e1b030a136077edc8440049c48
3
+ metadata.gz: 374c80f1fdcacafe0feef1681077cc81d96dc97e313d1761816fd9ed6c919633
4
+ data.tar.gz: fceb49e343575fedc5c0b6f965285a4f25455539d51e7715da85548ef05d52a8
5
5
  SHA512:
6
- metadata.gz: a98554532632fce600d17107fb82d5337a8ed00f5b09d3a0822386940bd0a947398e08719ab83192bce6e0383cad6eb64a56ac01ebf6caada85d976adc9ce23b
7
- data.tar.gz: 64429bee4aeed45268b13b8dbe9bb7810f5db08d13e142bd7c4385bb95c7ad44e7b87d570e9772f95a3e7a688e80e965a3672fe155a18e90f191b0459ee45e99
6
+ metadata.gz: d89ce63a1521d0772adce081af71036f4c26d93d02b813e42690485298b74223ee08a760261d8790a3e6b6c2891256dc7081d69aa507d5c7257b13a3f19562d6
7
+ data.tar.gz: 3897dbbe6d752b57ecc780d06a491f8b27b710971b0bfbe48e1efcdbd9307c8e6580361c4beb90c28ad1612f35f347b284c17ee32e6aa72d296cdd20a768b22e
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.3
10
+ - Package version: 1.7.8
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.3.gem
26
+ gem install ./cloudmersive-convert-api-client-1.7.8.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.7.3.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.7.8.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.3'
34
+ gem 'cloudmersive-convert-api-client', '~> 1.7.8'
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,12 +133,15 @@ 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
130
140
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xls_to_xlsx**](docs/ConvertDocumentApi.md#convert_document_xls_to_xlsx) | **POST** /convert/xls/to/xlsx | Convert Excel XLS (97-03) Spreadsheet to XLSX
131
- *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
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
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
132
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
133
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)
134
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
135
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
@@ -151,6 +163,7 @@ Class | Method | HTTP request | Description
151
163
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_delete_pages**](docs/EditDocumentApi.md#edit_document_docx_delete_pages) | **POST** /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document
152
164
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_delete_table_row**](docs/EditDocumentApi.md#edit_document_docx_delete_table_row) | **POST** /convert/edit/docx/delete-table-row | Deletes a table row in an existing table in a Word DOCX document
153
165
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_delete_table_row_range**](docs/EditDocumentApi.md#edit_document_docx_delete_table_row_range) | **POST** /convert/edit/docx/delete-table-row/range | Deletes a range of multiple table rows in an existing table in a Word DOCX document
166
+ *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_find_paragraph**](docs/EditDocumentApi.md#edit_document_docx_find_paragraph) | **POST** /convert/edit/docx/find/paragraph | Find matching paragraphs in a Word DOCX document
154
167
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_comments**](docs/EditDocumentApi.md#edit_document_docx_get_comments) | **POST** /convert/edit/docx/get-comments/flat-list | Get comments from a Word DOCX document as a flat list
155
168
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_comments_hierarchical**](docs/EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
156
169
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_headers_and_footers**](docs/EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
@@ -169,6 +182,7 @@ Class | Method | HTTP request | Description
169
182
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_remove_headers_and_footers**](docs/EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from Word DOCX document
170
183
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_remove_object**](docs/EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
171
184
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace**](docs/EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
185
+ *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace_paragraph**](docs/EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
172
186
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_footer**](docs/EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
173
187
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_footer_add_page_number**](docs/EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
174
188
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_header**](docs/EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
@@ -243,16 +257,25 @@ Class | Method | HTTP request | Description
243
257
  *CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_txt_by_string**](docs/SplitDocumentApi.md#split_document_txt_by_string) | **POST** /convert/split/txt/by-string | Split a single Text file (txt) by a string delimiter
244
258
  *CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_xlsx**](docs/SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
245
259
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_autodetect_validation**](docs/ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
260
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_csv_validation**](docs/ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
246
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
247
263
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_executable_validation**](docs/ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
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)
248
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
249
267
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pdf_validation**](docs/ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
250
268
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pptx_validation**](docs/ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
269
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_rar_validation**](docs/ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
270
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_tar_validation**](docs/ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
251
271
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xlsx_validation**](docs/ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
252
272
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xml_validation**](docs/ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
273
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_zip_validation**](docs/ValidateDocumentApi.md#validate_document_zip_validation) | **POST** /convert/validate/zip | Validate a Zip Archive file (zip)
253
274
  *CloudmersiveConvertApiClient::ViewerToolsApi* | [**viewer_tools_create_simple**](docs/ViewerToolsApi.md#viewer_tools_create_simple) | **POST** /convert/viewer/create/web/simple | Create a web-based viewer
254
275
  *CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_create**](docs/ZipArchiveApi.md#zip_archive_zip_create) | **POST** /convert/archive/zip/create | Compress files to create a new zip archive
255
276
  *CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_create_advanced**](docs/ZipArchiveApi.md#zip_archive_zip_create_advanced) | **POST** /convert/archive/zip/create/advanced | Compress files and folders to create a new zip archive with advanced options
277
+ *CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_decrypt**](docs/ZipArchiveApi.md#zip_archive_zip_decrypt) | **POST** /convert/archive/zip/decrypt | Decrypt and remove password protection on a zip file
278
+ *CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_encrypt_advanced**](docs/ZipArchiveApi.md#zip_archive_zip_encrypt_advanced) | **POST** /convert/archive/zip/encrypt/advanced | Encrypt and password protect a zip file
256
279
  *CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_extract**](docs/ZipArchiveApi.md#zip_archive_zip_extract) | **POST** /convert/archive/zip/extract | Extract, decompress files and folders from a zip archive
257
280
 
258
281
 
@@ -263,6 +286,7 @@ Class | Method | HTTP request | Description
263
286
  - [CloudmersiveConvertApiClient::AutodetectDocumentValidationResult](docs/AutodetectDocumentValidationResult.md)
264
287
  - [CloudmersiveConvertApiClient::AutodetectGetInfoResult](docs/AutodetectGetInfoResult.md)
265
288
  - [CloudmersiveConvertApiClient::AutodetectToPngResult](docs/AutodetectToPngResult.md)
289
+ - [CloudmersiveConvertApiClient::AutodetectToThumbnailsResult](docs/AutodetectToThumbnailsResult.md)
266
290
  - [CloudmersiveConvertApiClient::Base64DecodeRequest](docs/Base64DecodeRequest.md)
267
291
  - [CloudmersiveConvertApiClient::Base64DecodeResponse](docs/Base64DecodeResponse.md)
268
292
  - [CloudmersiveConvertApiClient::Base64DetectRequest](docs/Base64DetectRequest.md)
@@ -280,6 +304,8 @@ Class | Method | HTTP request | Description
280
304
  - [CloudmersiveConvertApiClient::CreateSpreadsheetFromDataRequest](docs/CreateSpreadsheetFromDataRequest.md)
281
305
  - [CloudmersiveConvertApiClient::CreateSpreadsheetFromDataResponse](docs/CreateSpreadsheetFromDataResponse.md)
282
306
  - [CloudmersiveConvertApiClient::CreateZipArchiveRequest](docs/CreateZipArchiveRequest.md)
307
+ - [CloudmersiveConvertApiClient::CsvCollection](docs/CsvCollection.md)
308
+ - [CloudmersiveConvertApiClient::CsvFileResult](docs/CsvFileResult.md)
283
309
  - [CloudmersiveConvertApiClient::DeleteDocxTableRowRangeRequest](docs/DeleteDocxTableRowRangeRequest.md)
284
310
  - [CloudmersiveConvertApiClient::DeleteDocxTableRowRangeResponse](docs/DeleteDocxTableRowRangeResponse.md)
285
311
  - [CloudmersiveConvertApiClient::DeleteDocxTableRowRequest](docs/DeleteDocxTableRowRequest.md)
@@ -316,10 +342,15 @@ Class | Method | HTTP request | Description
316
342
  - [CloudmersiveConvertApiClient::DocxTemplateApplicationRequest](docs/DocxTemplateApplicationRequest.md)
317
343
  - [CloudmersiveConvertApiClient::DocxTemplateOperation](docs/DocxTemplateOperation.md)
318
344
  - [CloudmersiveConvertApiClient::DocxText](docs/DocxText.md)
345
+ - [CloudmersiveConvertApiClient::DocxToPngResult](docs/DocxToPngResult.md)
319
346
  - [CloudmersiveConvertApiClient::DocxTopLevelComment](docs/DocxTopLevelComment.md)
347
+ - [CloudmersiveConvertApiClient::EmlAttachment](docs/EmlAttachment.md)
348
+ - [CloudmersiveConvertApiClient::EmlToHtmlResult](docs/EmlToHtmlResult.md)
320
349
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookRequest](docs/EnableSharedWorkbookRequest.md)
321
350
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookResponse](docs/EnableSharedWorkbookResponse.md)
322
351
  - [CloudmersiveConvertApiClient::ExifValue](docs/ExifValue.md)
352
+ - [CloudmersiveConvertApiClient::FindDocxParagraphRequest](docs/FindDocxParagraphRequest.md)
353
+ - [CloudmersiveConvertApiClient::FindDocxParagraphResponse](docs/FindDocxParagraphResponse.md)
323
354
  - [CloudmersiveConvertApiClient::FindRegexMatch](docs/FindRegexMatch.md)
324
355
  - [CloudmersiveConvertApiClient::FindStringMatch](docs/FindStringMatch.md)
325
356
  - [CloudmersiveConvertApiClient::FindStringRegexRequest](docs/FindStringRegexRequest.md)
@@ -349,6 +380,7 @@ Class | Method | HTTP request | Description
349
380
  - [CloudmersiveConvertApiClient::GetDocxTableRowResponse](docs/GetDocxTableRowResponse.md)
350
381
  - [CloudmersiveConvertApiClient::GetDocxTablesRequest](docs/GetDocxTablesRequest.md)
351
382
  - [CloudmersiveConvertApiClient::GetDocxTablesResponse](docs/GetDocxTablesResponse.md)
383
+ - [CloudmersiveConvertApiClient::GetFileTypeIconResult](docs/GetFileTypeIconResult.md)
352
384
  - [CloudmersiveConvertApiClient::GetImageInfoResult](docs/GetImageInfoResult.md)
353
385
  - [CloudmersiveConvertApiClient::GetPdfAnnotationsResult](docs/GetPdfAnnotationsResult.md)
354
386
  - [CloudmersiveConvertApiClient::GetXlsxCellByIdentifierRequest](docs/GetXlsxCellByIdentifierRequest.md)
@@ -383,6 +415,8 @@ Class | Method | HTTP request | Description
383
415
  - [CloudmersiveConvertApiClient::InsertDocxTablesResponse](docs/InsertDocxTablesResponse.md)
384
416
  - [CloudmersiveConvertApiClient::InsertXlsxWorksheetRequest](docs/InsertXlsxWorksheetRequest.md)
385
417
  - [CloudmersiveConvertApiClient::InsertXlsxWorksheetResponse](docs/InsertXlsxWorksheetResponse.md)
418
+ - [CloudmersiveConvertApiClient::MsgAttachment](docs/MsgAttachment.md)
419
+ - [CloudmersiveConvertApiClient::MsgToHtmlResult](docs/MsgToHtmlResult.md)
386
420
  - [CloudmersiveConvertApiClient::MultipageImageFormatConversionResult](docs/MultipageImageFormatConversionResult.md)
387
421
  - [CloudmersiveConvertApiClient::PageConversionResult](docs/PageConversionResult.md)
388
422
  - [CloudmersiveConvertApiClient::PdfAnnotation](docs/PdfAnnotation.md)
@@ -393,6 +427,7 @@ Class | Method | HTTP request | Description
393
427
  - [CloudmersiveConvertApiClient::PdfPageText](docs/PdfPageText.md)
394
428
  - [CloudmersiveConvertApiClient::PdfTextByPageResult](docs/PdfTextByPageResult.md)
395
429
  - [CloudmersiveConvertApiClient::PdfToPngResult](docs/PdfToPngResult.md)
430
+ - [CloudmersiveConvertApiClient::PptxToPngResult](docs/PptxToPngResult.md)
396
431
  - [CloudmersiveConvertApiClient::PresentationResult](docs/PresentationResult.md)
397
432
  - [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest](docs/RemoveDocxHeadersAndFootersRequest.md)
398
433
  - [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersResponse](docs/RemoveDocxHeadersAndFootersResponse.md)
@@ -403,6 +438,8 @@ Class | Method | HTTP request | Description
403
438
  - [CloudmersiveConvertApiClient::RemoveWhitespaceFromTextRequest](docs/RemoveWhitespaceFromTextRequest.md)
404
439
  - [CloudmersiveConvertApiClient::RemoveWhitespaceFromTextResponse](docs/RemoveWhitespaceFromTextResponse.md)
405
440
  - [CloudmersiveConvertApiClient::RemoveXlsxWorksheetRequest](docs/RemoveXlsxWorksheetRequest.md)
441
+ - [CloudmersiveConvertApiClient::ReplaceDocxParagraphRequest](docs/ReplaceDocxParagraphRequest.md)
442
+ - [CloudmersiveConvertApiClient::ReplaceDocxParagraphResponse](docs/ReplaceDocxParagraphResponse.md)
406
443
  - [CloudmersiveConvertApiClient::ReplaceStringRegexRequest](docs/ReplaceStringRegexRequest.md)
407
444
  - [CloudmersiveConvertApiClient::ReplaceStringRegexResponse](docs/ReplaceStringRegexResponse.md)
408
445
  - [CloudmersiveConvertApiClient::ReplaceStringRequest](docs/ReplaceStringRequest.md)
@@ -427,6 +464,7 @@ Class | Method | HTTP request | Description
427
464
  - [CloudmersiveConvertApiClient::TextDocumentElement](docs/TextDocumentElement.md)
428
465
  - [CloudmersiveConvertApiClient::TextDocumentLine](docs/TextDocumentLine.md)
429
466
  - [CloudmersiveConvertApiClient::TextEncodingDetectResponse](docs/TextEncodingDetectResponse.md)
467
+ - [CloudmersiveConvertApiClient::Thumbnail](docs/Thumbnail.md)
430
468
  - [CloudmersiveConvertApiClient::UpdateDocxTableCellRequest](docs/UpdateDocxTableCellRequest.md)
431
469
  - [CloudmersiveConvertApiClient::UpdateDocxTableCellResponse](docs/UpdateDocxTableCellResponse.md)
432
470
  - [CloudmersiveConvertApiClient::UpdateDocxTableRowRequest](docs/UpdateDocxTableRowRequest.md)
@@ -440,6 +478,7 @@ Class | Method | HTTP request | Description
440
478
  - [CloudmersiveConvertApiClient::XlsxSpreadsheetCell](docs/XlsxSpreadsheetCell.md)
441
479
  - [CloudmersiveConvertApiClient::XlsxSpreadsheetColumn](docs/XlsxSpreadsheetColumn.md)
442
480
  - [CloudmersiveConvertApiClient::XlsxSpreadsheetRow](docs/XlsxSpreadsheetRow.md)
481
+ - [CloudmersiveConvertApiClient::XlsxToPngResult](docs/XlsxToPngResult.md)
443
482
  - [CloudmersiveConvertApiClient::XlsxWorksheet](docs/XlsxWorksheet.md)
444
483
  - [CloudmersiveConvertApiClient::XmlAddAttributeWithXPathResult](docs/XmlAddAttributeWithXPathResult.md)
445
484
  - [CloudmersiveConvertApiClient::XmlAddChildWithXPathResult](docs/XmlAddChildWithXPathResult.md)
@@ -451,6 +490,7 @@ Class | Method | HTTP request | Description
451
490
  - [CloudmersiveConvertApiClient::XmlReplaceWithXPathResult](docs/XmlReplaceWithXPathResult.md)
452
491
  - [CloudmersiveConvertApiClient::XmlSetValueWithXPathResult](docs/XmlSetValueWithXPathResult.md)
453
492
  - [CloudmersiveConvertApiClient::ZipDirectory](docs/ZipDirectory.md)
493
+ - [CloudmersiveConvertApiClient::ZipEncryptionAdvancedRequest](docs/ZipEncryptionAdvancedRequest.md)
454
494
  - [CloudmersiveConvertApiClient::ZipExtractResponse](docs/ZipExtractResponse.md)
455
495
  - [CloudmersiveConvertApiClient::ZipFile](docs/ZipFile.md)
456
496
 
@@ -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
+
@@ -22,7 +22,7 @@ Method | HTTP request | Description
22
22
 
23
23
 
24
24
  # **convert_data_csv_to_json**
25
- > Object convert_data_csv_to_json(input_file)
25
+ > Object convert_data_csv_to_json(input_file, opts)
26
26
 
27
27
  Convert CSV to JSON conversion
28
28
 
@@ -44,10 +44,13 @@ api_instance = CloudmersiveConvertApiClient::ConvertDataApi.new
44
44
 
45
45
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
46
46
 
47
+ opts = {
48
+ column_names_from_first_row: true # BOOLEAN | Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc. Default is true. Set to false if you are not using column headings, or have an irregular column structure.
49
+ }
47
50
 
48
51
  begin
49
52
  #Convert CSV to JSON conversion
50
- result = api_instance.convert_data_csv_to_json(input_file)
53
+ result = api_instance.convert_data_csv_to_json(input_file, opts)
51
54
  p result
52
55
  rescue CloudmersiveConvertApiClient::ApiError => e
53
56
  puts "Exception when calling ConvertDataApi->convert_data_csv_to_json: #{e}"
@@ -59,6 +62,7 @@ end
59
62
  Name | Type | Description | Notes
60
63
  ------------- | ------------- | ------------- | -------------
61
64
  **input_file** | **File**| Input file to perform the operation on. |
65
+ **column_names_from_first_row** | **BOOLEAN**| Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc. Default is true. Set to false if you are not using column headings, or have an irregular column structure. | [optional]
62
66
 
63
67
  ### Return type
64
68
 
@@ -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,12 +36,15 @@ 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
33
43
  [**convert_document_xls_to_xlsx**](ConvertDocumentApi.md#convert_document_xls_to_xlsx) | **POST** /convert/xls/to/xlsx | Convert Excel XLS (97-03) Spreadsheet to XLSX
34
- [**convert_document_xlsx_to_csv**](ConvertDocumentApi.md#convert_document_xlsx_to_csv) | **POST** /convert/xlsx/to/csv | Convert Excel XLSX Spreadsheet to CSV
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
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
35
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
36
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)
37
49
 
38
50
 
@@ -198,6 +210,132 @@ Name | Type | Description | Notes
198
210
 
199
211
 
200
212
 
213
+ # **convert_document_autodetect_to_thumbnail**
214
+ > String 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
+ **String**
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
+
201
339
  # **convert_document_autodetect_to_txt**
202
340
  > TextConversionResult convert_document_autodetect_to_txt(input_file, opts)
203
341
 
@@ -281,11 +419,397 @@ input_file = File.new("/path/to/file.txt") # File | Input file to perform the op
281
419
 
282
420
 
283
421
  begin
284
- #Convert CSV to Excel XLSX Spreadsheet
285
- result = api_instance.convert_document_csv_to_xlsx(input_file)
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
701
+
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
727
+
728
+ ### Example
729
+ ```ruby
730
+ # load the gem
731
+ require 'cloudmersive-convert-api-client'
732
+ # setup authorization
733
+ CloudmersiveConvertApiClient.configure do |config|
734
+ # Configure API key authorization: Apikey
735
+ config.api_key['Apikey'] = 'YOUR API KEY'
736
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
737
+ #config.api_key_prefix['Apikey'] = 'Bearer'
738
+ end
739
+
740
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
741
+
742
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
743
+
744
+ opts = {
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'.
746
+ }
747
+
748
+ begin
749
+ #Convert Word DOCX Document to Text (txt)
750
+ result = api_instance.convert_document_docx_to_txt(input_file, opts)
751
+ p result
752
+ rescue CloudmersiveConvertApiClient::ApiError => e
753
+ puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_txt: #{e}"
754
+ end
755
+ ```
756
+
757
+ ### Parameters
758
+
759
+ Name | Type | Description | Notes
760
+ ------------- | ------------- | ------------- | -------------
761
+ **input_file** | **File**| Input file to perform the operation on. |
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]
763
+
764
+ ### Return type
765
+
766
+ [**TextConversionResult**](TextConversionResult.md)
767
+
768
+ ### Authorization
769
+
770
+ [Apikey](../README.md#Apikey)
771
+
772
+ ### HTTP request headers
773
+
774
+ - **Content-Type**: multipart/form-data
775
+ - **Accept**: application/json, text/json, application/xml, text/xml
776
+
777
+
778
+
779
+ # **convert_document_eml_to_html**
780
+ > EmlToHtmlResult convert_document_eml_to_html(input_file, opts)
781
+
782
+ Convert Email EML file to HTML string
783
+
784
+ Convert Outlook Email EML file to HTML string and attachments. Supports images if they are base 64 inline.
785
+
786
+ ### Example
787
+ ```ruby
788
+ # load the gem
789
+ require 'cloudmersive-convert-api-client'
790
+ # setup authorization
791
+ CloudmersiveConvertApiClient.configure do |config|
792
+ # Configure API key authorization: Apikey
793
+ config.api_key['Apikey'] = 'YOUR API KEY'
794
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
795
+ #config.api_key_prefix['Apikey'] = 'Bearer'
796
+ end
797
+
798
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
799
+
800
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
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
+ }
806
+
807
+ begin
808
+ #Convert Email EML file to HTML string
809
+ result = api_instance.convert_document_eml_to_html(input_file, opts)
286
810
  p result
287
811
  rescue CloudmersiveConvertApiClient::ApiError => e
288
- puts "Exception when calling ConvertDocumentApi->convert_document_csv_to_xlsx: #{e}"
812
+ puts "Exception when calling ConvertDocumentApi->convert_document_eml_to_html: #{e}"
289
813
  end
290
814
  ```
291
815
 
@@ -294,10 +818,12 @@ end
294
818
  Name | Type | Description | Notes
295
819
  ------------- | ------------- | ------------- | -------------
296
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]
297
823
 
298
824
  ### Return type
299
825
 
300
- **String**
826
+ [**EmlToHtmlResult**](EmlToHtmlResult.md)
301
827
 
302
828
  ### Authorization
303
829
 
@@ -306,16 +832,16 @@ Name | Type | Description | Notes
306
832
  ### HTTP request headers
307
833
 
308
834
  - **Content-Type**: multipart/form-data
309
- - **Accept**: application/octet-stream
835
+ - **Accept**: application/json, text/json, application/xml, text/xml
310
836
 
311
837
 
312
838
 
313
- # **convert_document_doc_to_docx**
314
- > String convert_document_doc_to_docx(input_file)
839
+ # **convert_document_eml_to_pdf**
840
+ > String convert_document_eml_to_pdf(input_file, opts)
315
841
 
316
- Convert Word DOC (97-03) Document to DOCX
842
+ Convert Email EML file to PDF document
317
843
 
318
- 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.
319
845
 
320
846
  ### Example
321
847
  ```ruby
@@ -333,13 +859,16 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
333
859
 
334
860
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
335
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
+ }
336
865
 
337
866
  begin
338
- #Convert Word DOC (97-03) Document to DOCX
339
- 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)
340
869
  p result
341
870
  rescue CloudmersiveConvertApiClient::ApiError => e
342
- puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_docx: #{e}"
871
+ puts "Exception when calling ConvertDocumentApi->convert_document_eml_to_pdf: #{e}"
343
872
  end
344
873
  ```
345
874
 
@@ -348,6 +877,7 @@ end
348
877
  Name | Type | Description | Notes
349
878
  ------------- | ------------- | ------------- | -------------
350
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]
351
881
 
352
882
  ### Return type
353
883
 
@@ -364,12 +894,12 @@ Name | Type | Description | Notes
364
894
 
365
895
 
366
896
 
367
- # **convert_document_doc_to_pdf**
368
- > String convert_document_doc_to_pdf(input_file)
897
+ # **convert_document_get_file_type_icon**
898
+ > String convert_document_get_file_type_icon(file_extension, opts)
369
899
 
370
- Convert Word DOC (97-03) Document to PDF
900
+ Get PNG icon file for the file extension
371
901
 
372
- 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.
373
903
 
374
904
  ### Example
375
905
  ```ruby
@@ -385,15 +915,18 @@ end
385
915
 
386
916
  api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
387
917
 
388
- 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.
389
919
 
920
+ opts = {
921
+ icon_size: 56 # Integer | Optional; The desired width of the icon, preserving its aspect ratio.
922
+ }
390
923
 
391
924
  begin
392
- #Convert Word DOC (97-03) Document to PDF
393
- 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)
394
927
  p result
395
928
  rescue CloudmersiveConvertApiClient::ApiError => e
396
- puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_pdf: #{e}"
929
+ puts "Exception when calling ConvertDocumentApi->convert_document_get_file_type_icon: #{e}"
397
930
  end
398
931
  ```
399
932
 
@@ -401,7 +934,8 @@ end
401
934
 
402
935
  Name | Type | Description | Notes
403
936
  ------------- | ------------- | ------------- | -------------
404
- **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]
405
939
 
406
940
  ### Return type
407
941
 
@@ -413,17 +947,17 @@ Name | Type | Description | Notes
413
947
 
414
948
  ### HTTP request headers
415
949
 
416
- - **Content-Type**: multipart/form-data
950
+ - **Content-Type**: Not defined
417
951
  - **Accept**: application/octet-stream
418
952
 
419
953
 
420
954
 
421
- # **convert_document_doc_to_txt**
422
- > 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)
423
957
 
424
- Convert Word DOC (97-03) Document to Text (txt)
958
+ Get PNG icon byte array for the file extension
425
959
 
426
- 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.
427
961
 
428
962
  ### Example
429
963
  ```ruby
@@ -439,15 +973,18 @@ end
439
973
 
440
974
  api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
441
975
 
442
- 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.
443
977
 
978
+ opts = {
979
+ icon_size: 56 # Integer | Optional; The desired width of the icon, preserving its aspect ratio.
980
+ }
444
981
 
445
982
  begin
446
- #Convert Word DOC (97-03) Document to Text (txt)
447
- 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)
448
985
  p result
449
986
  rescue CloudmersiveConvertApiClient::ApiError => e
450
- 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}"
451
988
  end
452
989
  ```
453
990
 
@@ -455,11 +992,12 @@ end
455
992
 
456
993
  Name | Type | Description | Notes
457
994
  ------------- | ------------- | ------------- | -------------
458
- **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]
459
997
 
460
998
  ### Return type
461
999
 
462
- [**TextConversionResult**](TextConversionResult.md)
1000
+ [**GetFileTypeIconResult**](GetFileTypeIconResult.md)
463
1001
 
464
1002
  ### Authorization
465
1003
 
@@ -467,17 +1005,17 @@ Name | Type | Description | Notes
467
1005
 
468
1006
  ### HTTP request headers
469
1007
 
470
- - **Content-Type**: multipart/form-data
1008
+ - **Content-Type**: Not defined
471
1009
  - **Accept**: application/json, text/json, application/xml, text/xml
472
1010
 
473
1011
 
474
1012
 
475
- # **convert_document_docx_to_pdf**
476
- > String convert_document_docx_to_pdf(input_file)
1013
+ # **convert_document_html_to_pdf**
1014
+ > String convert_document_html_to_pdf(input_file)
477
1015
 
478
- Convert Word DOCX Document to PDF
1016
+ Convert HTML document file to PDF Document
479
1017
 
480
- 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.
481
1019
 
482
1020
  ### Example
483
1021
  ```ruby
@@ -497,11 +1035,11 @@ input_file = File.new("/path/to/file.txt") # File | Input file to perform the op
497
1035
 
498
1036
 
499
1037
  begin
500
- #Convert Word DOCX Document to PDF
501
- 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)
502
1040
  p result
503
1041
  rescue CloudmersiveConvertApiClient::ApiError => e
504
- puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_pdf: #{e}"
1042
+ puts "Exception when calling ConvertDocumentApi->convert_document_html_to_pdf: #{e}"
505
1043
  end
506
1044
  ```
507
1045
 
@@ -526,12 +1064,12 @@ Name | Type | Description | Notes
526
1064
 
527
1065
 
528
1066
 
529
- # **convert_document_docx_to_txt**
530
- > TextConversionResult convert_document_docx_to_txt(input_file, opts)
1067
+ # **convert_document_html_to_png**
1068
+ > PdfToPngResult convert_document_html_to_png(input_file)
531
1069
 
532
- Convert Word DOCX Document to Text (txt)
1070
+ Convert HTML document file to PNG image array
533
1071
 
534
- 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.
535
1073
 
536
1074
  ### Example
537
1075
  ```ruby
@@ -549,16 +1087,13 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
549
1087
 
550
1088
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
551
1089
 
552
- opts = {
553
- 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'.
554
- }
555
1090
 
556
1091
  begin
557
- #Convert Word DOCX Document to Text (txt)
558
- 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)
559
1094
  p result
560
1095
  rescue CloudmersiveConvertApiClient::ApiError => e
561
- puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_txt: #{e}"
1096
+ puts "Exception when calling ConvertDocumentApi->convert_document_html_to_png: #{e}"
562
1097
  end
563
1098
  ```
564
1099
 
@@ -567,11 +1102,10 @@ end
567
1102
  Name | Type | Description | Notes
568
1103
  ------------- | ------------- | ------------- | -------------
569
1104
  **input_file** | **File**| Input file to perform the operation on. |
570
- **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]
571
1105
 
572
1106
  ### Return type
573
1107
 
574
- [**TextConversionResult**](TextConversionResult.md)
1108
+ [**PdfToPngResult**](PdfToPngResult.md)
575
1109
 
576
1110
  ### Authorization
577
1111
 
@@ -584,12 +1118,12 @@ Name | Type | Description | Notes
584
1118
 
585
1119
 
586
1120
 
587
- # **convert_document_html_to_pdf**
588
- > String convert_document_html_to_pdf(input_file)
1121
+ # **convert_document_html_to_txt**
1122
+ > TextConversionResult convert_document_html_to_txt(input_file)
589
1123
 
590
- Convert HTML document file to PDF Document
1124
+ HTML Document file to Text (txt)
591
1125
 
592
- 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
593
1127
 
594
1128
  ### Example
595
1129
  ```ruby
@@ -609,11 +1143,11 @@ input_file = File.new("/path/to/file.txt") # File | Input file to perform the op
609
1143
 
610
1144
 
611
1145
  begin
612
- #Convert HTML document file to PDF Document
613
- 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)
614
1148
  p result
615
1149
  rescue CloudmersiveConvertApiClient::ApiError => e
616
- puts "Exception when calling ConvertDocumentApi->convert_document_html_to_pdf: #{e}"
1150
+ puts "Exception when calling ConvertDocumentApi->convert_document_html_to_txt: #{e}"
617
1151
  end
618
1152
  ```
619
1153
 
@@ -625,7 +1159,7 @@ Name | Type | Description | Notes
625
1159
 
626
1160
  ### Return type
627
1161
 
628
- **String**
1162
+ [**TextConversionResult**](TextConversionResult.md)
629
1163
 
630
1164
  ### Authorization
631
1165
 
@@ -634,16 +1168,16 @@ Name | Type | Description | Notes
634
1168
  ### HTTP request headers
635
1169
 
636
1170
  - **Content-Type**: multipart/form-data
637
- - **Accept**: application/octet-stream
1171
+ - **Accept**: application/json, text/json, application/xml, text/xml
638
1172
 
639
1173
 
640
1174
 
641
- # **convert_document_html_to_png**
642
- > PdfToPngResult convert_document_html_to_png(input_file)
1175
+ # **convert_document_msg_to_html**
1176
+ > MsgToHtmlResult convert_document_msg_to_html(input_file, opts)
643
1177
 
644
- Convert HTML document file to PNG image array
1178
+ Convert Email MSG file to HTML string
645
1179
 
646
- 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.
647
1181
 
648
1182
  ### Example
649
1183
  ```ruby
@@ -661,13 +1195,17 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
661
1195
 
662
1196
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
663
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
+ }
664
1202
 
665
1203
  begin
666
- #Convert HTML document file to PNG image array
667
- 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)
668
1206
  p result
669
1207
  rescue CloudmersiveConvertApiClient::ApiError => e
670
- puts "Exception when calling ConvertDocumentApi->convert_document_html_to_png: #{e}"
1208
+ puts "Exception when calling ConvertDocumentApi->convert_document_msg_to_html: #{e}"
671
1209
  end
672
1210
  ```
673
1211
 
@@ -676,10 +1214,12 @@ end
676
1214
  Name | Type | Description | Notes
677
1215
  ------------- | ------------- | ------------- | -------------
678
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]
679
1219
 
680
1220
  ### Return type
681
1221
 
682
- [**PdfToPngResult**](PdfToPngResult.md)
1222
+ [**MsgToHtmlResult**](MsgToHtmlResult.md)
683
1223
 
684
1224
  ### Authorization
685
1225
 
@@ -692,12 +1232,12 @@ Name | Type | Description | Notes
692
1232
 
693
1233
 
694
1234
 
695
- # **convert_document_html_to_txt**
696
- > TextConversionResult convert_document_html_to_txt(input_file)
1235
+ # **convert_document_msg_to_pdf**
1236
+ > String convert_document_msg_to_pdf(input_file, opts)
697
1237
 
698
- HTML Document file to Text (txt)
1238
+ Convert Email MSG file to PDF document
699
1239
 
700
- 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.
701
1241
 
702
1242
  ### Example
703
1243
  ```ruby
@@ -715,13 +1255,16 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
715
1255
 
716
1256
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
717
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
+ }
718
1261
 
719
1262
  begin
720
- #HTML Document file to Text (txt)
721
- 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)
722
1265
  p result
723
1266
  rescue CloudmersiveConvertApiClient::ApiError => e
724
- puts "Exception when calling ConvertDocumentApi->convert_document_html_to_txt: #{e}"
1267
+ puts "Exception when calling ConvertDocumentApi->convert_document_msg_to_pdf: #{e}"
725
1268
  end
726
1269
  ```
727
1270
 
@@ -730,10 +1273,11 @@ end
730
1273
  Name | Type | Description | Notes
731
1274
  ------------- | ------------- | ------------- | -------------
732
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]
733
1277
 
734
1278
  ### Return type
735
1279
 
736
- [**TextConversionResult**](TextConversionResult.md)
1280
+ **String**
737
1281
 
738
1282
  ### Authorization
739
1283
 
@@ -742,7 +1286,7 @@ Name | Type | Description | Notes
742
1286
  ### HTTP request headers
743
1287
 
744
1288
  - **Content-Type**: multipart/form-data
745
- - **Accept**: application/json, text/json, application/xml, text/xml
1289
+ - **Accept**: application/octet-stream
746
1290
 
747
1291
 
748
1292
 
@@ -1311,6 +1855,60 @@ Name | Type | Description | Notes
1311
1855
 
1312
1856
 
1313
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
+
1314
1912
  # **convert_document_pptx_to_txt**
1315
1913
  > TextConversionResult convert_document_pptx_to_txt(input_file)
1316
1914
 
@@ -1530,9 +2128,9 @@ Name | Type | Description | Notes
1530
2128
  # **convert_document_xlsx_to_csv**
1531
2129
  > String convert_document_xlsx_to_csv(input_file, opts)
1532
2130
 
1533
- Convert Excel XLSX Spreadsheet to CSV
2131
+ Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
1534
2132
 
1535
- Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.
2133
+ Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats. If the input file contains multiple worksheets, the first one is used. If you wish to convert all of the worksheets (not just the first one), be sure to use the xlsx/to/csv/multi API.
1536
2134
 
1537
2135
  ### Example
1538
2136
  ```ruby
@@ -1551,11 +2149,11 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1551
2149
  input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
1552
2150
 
1553
2151
  opts = {
1554
- output_encoding: "output_encoding_example" # String | Optional, set the output text encoding for the result; possible values are UTF-8 and UTF-32. Default is UTF-32.
2152
+ output_encoding: "output_encoding_example" # String | Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
1555
2153
  }
1556
2154
 
1557
2155
  begin
1558
- #Convert Excel XLSX Spreadsheet to CSV
2156
+ #Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
1559
2157
  result = api_instance.convert_document_xlsx_to_csv(input_file, opts)
1560
2158
  p result
1561
2159
  rescue CloudmersiveConvertApiClient::ApiError => e
@@ -1568,7 +2166,7 @@ end
1568
2166
  Name | Type | Description | Notes
1569
2167
  ------------- | ------------- | ------------- | -------------
1570
2168
  **input_file** | **File**| Input file to perform the operation on. |
1571
- **output_encoding** | **String**| Optional, set the output text encoding for the result; possible values are UTF-8 and UTF-32. Default is UTF-32. | [optional]
2169
+ **output_encoding** | **String**| Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8. | [optional]
1572
2170
 
1573
2171
  ### Return type
1574
2172
 
@@ -1585,6 +2183,64 @@ Name | Type | Description | Notes
1585
2183
 
1586
2184
 
1587
2185
 
2186
+ # **convert_document_xlsx_to_csv_multi**
2187
+ > CsvCollection convert_document_xlsx_to_csv_multi(input_file, opts)
2188
+
2189
+ Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
2190
+
2191
+ Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format, with support for multiple worksheets. Supports both XLSX and XLSB file Excel formats. Returns multiple CSV files, one for each worksheet (tab) in the spreadsheet.
2192
+
2193
+ ### Example
2194
+ ```ruby
2195
+ # load the gem
2196
+ require 'cloudmersive-convert-api-client'
2197
+ # setup authorization
2198
+ CloudmersiveConvertApiClient.configure do |config|
2199
+ # Configure API key authorization: Apikey
2200
+ config.api_key['Apikey'] = 'YOUR API KEY'
2201
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2202
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2203
+ end
2204
+
2205
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2206
+
2207
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
2208
+
2209
+ opts = {
2210
+ output_encoding: "output_encoding_example" # String | Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
2211
+ }
2212
+
2213
+ begin
2214
+ #Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
2215
+ result = api_instance.convert_document_xlsx_to_csv_multi(input_file, opts)
2216
+ p result
2217
+ rescue CloudmersiveConvertApiClient::ApiError => e
2218
+ puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_csv_multi: #{e}"
2219
+ end
2220
+ ```
2221
+
2222
+ ### Parameters
2223
+
2224
+ Name | Type | Description | Notes
2225
+ ------------- | ------------- | ------------- | -------------
2226
+ **input_file** | **File**| Input file to perform the operation on. |
2227
+ **output_encoding** | **String**| Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8. | [optional]
2228
+
2229
+ ### Return type
2230
+
2231
+ [**CsvCollection**](CsvCollection.md)
2232
+
2233
+ ### Authorization
2234
+
2235
+ [Apikey](../README.md#Apikey)
2236
+
2237
+ ### HTTP request headers
2238
+
2239
+ - **Content-Type**: multipart/form-data
2240
+ - **Accept**: application/octet-stream
2241
+
2242
+
2243
+
1588
2244
  # **convert_document_xlsx_to_pdf**
1589
2245
  > String convert_document_xlsx_to_pdf(input_file)
1590
2246
 
@@ -1639,6 +2295,60 @@ Name | Type | Description | Notes
1639
2295
 
1640
2296
 
1641
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
+
1642
2352
  # **convert_document_xlsx_to_txt**
1643
2353
  > TextConversionResult convert_document_xlsx_to_txt(input_file)
1644
2354