cloudmersive-convert-api-client 1.7.8 → 2.0.1

data/docs/ConvertDocumentApi.md

@@ -1,2405 +0,0 @@
-# CloudmersiveConvertApiClient::ConvertDocumentApi
-
-All URIs are relative to *https://api.cloudmersive.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**convert_document_autodetect_get_info**](ConvertDocumentApi.md#convert_document_autodetect_get_info) | **POST** /convert/autodetect/get-info | Get document type information
-[**convert_document_autodetect_to_pdf**](ConvertDocumentApi.md#convert_document_autodetect_to_pdf) | **POST** /convert/autodetect/to/pdf | Convert Document to PDF
-[**convert_document_autodetect_to_png_array**](ConvertDocumentApi.md#convert_document_autodetect_to_png_array) | **POST** /convert/autodetect/to/png | Convert Document to PNG array
-[**convert_document_autodetect_to_thumbnail**](ConvertDocumentApi.md#convert_document_autodetect_to_thumbnail) | **POST** /convert/autodetect/to/thumbnail | Convert File to Thumbnail Image
-[**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
-[**convert_document_autodetect_to_txt**](ConvertDocumentApi.md#convert_document_autodetect_to_txt) | **POST** /convert/autodetect/to/txt | Convert Document to Text (txt)
-[**convert_document_csv_to_xlsx**](ConvertDocumentApi.md#convert_document_csv_to_xlsx) | **POST** /convert/csv/to/xlsx | Convert CSV to Excel XLSX Spreadsheet
-[**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
-[**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
-[**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)
-[**convert_document_docx_to_pdf**](ConvertDocumentApi.md#convert_document_docx_to_pdf) | **POST** /convert/docx/to/pdf | Convert Word DOCX Document to PDF
-[**convert_document_docx_to_png**](ConvertDocumentApi.md#convert_document_docx_to_png) | **POST** /convert/docx/to/png | Convert DOCX document to PNG image array
-[**convert_document_docx_to_txt**](ConvertDocumentApi.md#convert_document_docx_to_txt) | **POST** /convert/docx/to/txt | Convert Word DOCX Document to Text (txt)
-[**convert_document_eml_to_html**](ConvertDocumentApi.md#convert_document_eml_to_html) | **POST** /convert/eml/to/html | Convert Email EML file to HTML string
-[**convert_document_eml_to_pdf**](ConvertDocumentApi.md#convert_document_eml_to_pdf) | **POST** /convert/eml/to/pdf | Convert Email EML file to PDF document
-[**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
-[**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
-[**convert_document_html_to_pdf**](ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | Convert HTML document file to PDF Document
-[**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
-[**convert_document_html_to_txt**](ConvertDocumentApi.md#convert_document_html_to_txt) | **POST** /convert/html/to/txt | HTML Document file to Text (txt)
-[**convert_document_msg_to_html**](ConvertDocumentApi.md#convert_document_msg_to_html) | **POST** /convert/msg/to/html | Convert Email MSG file to HTML string
-[**convert_document_msg_to_pdf**](ConvertDocumentApi.md#convert_document_msg_to_pdf) | **POST** /convert/msg/to/pdf | Convert Email MSG file to PDF document
-[**convert_document_pdf_to_docx**](ConvertDocumentApi.md#convert_document_pdf_to_docx) | **POST** /convert/pdf/to/docx | Convert PDF to Word DOCX Document
-[**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
-[**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
-[**convert_document_pdf_to_png_single**](ConvertDocumentApi.md#convert_document_pdf_to_png_single) | **POST** /convert/pdf/to/png/merge-single | Convert PDF to Single PNG image
-[**convert_document_pdf_to_pptx**](ConvertDocumentApi.md#convert_document_pdf_to_pptx) | **POST** /convert/pdf/to/pptx | Convert PDF to PowerPoint PPTX Presentation
-[**convert_document_pdf_to_txt**](ConvertDocumentApi.md#convert_document_pdf_to_txt) | **POST** /convert/pdf/to/txt | Convert PDF Document to Text (txt)
-[**convert_document_png_array_to_pdf**](ConvertDocumentApi.md#convert_document_png_array_to_pdf) | **POST** /convert/png/to/pdf | Convert PNG Array to PDF
-[**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
-[**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
-[**convert_document_pptx_to_pdf**](ConvertDocumentApi.md#convert_document_pptx_to_pdf) | **POST** /convert/pptx/to/pdf | Convert PowerPoint PPTX Presentation to PDF
-[**convert_document_pptx_to_png**](ConvertDocumentApi.md#convert_document_pptx_to_png) | **POST** /convert/pptx/to/png | Convert PowerPoint PPTX to PNG image array
-[**convert_document_pptx_to_txt**](ConvertDocumentApi.md#convert_document_pptx_to_txt) | **POST** /convert/pptx/to/txt | Convert PowerPoint PPTX Presentation to Text (txt)
-[**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
-[**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
-[**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
-[**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
-[**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
-[**convert_document_xlsx_to_pdf**](ConvertDocumentApi.md#convert_document_xlsx_to_pdf) | **POST** /convert/xlsx/to/pdf | Convert Excel XLSX Spreadsheet to PDF
-[**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
-[**convert_document_xlsx_to_txt**](ConvertDocumentApi.md#convert_document_xlsx_to_txt) | **POST** /convert/xlsx/to/txt | Convert Excel XLSX Spreadsheet to Text (txt)
-
-
-# **convert_document_autodetect_get_info**
-> AutodetectGetInfoResult convert_document_autodetect_get_info(input_file)
-
-Get document type information
-
-Auto-detects a document's type information; does not require file extension.  Analyzes file contents to confirm file type.  Even if no file extension is present, the auto-detect system will reliably analyze the contents of the file and identify its file type.  Supports over 100 image file formats, Office document file formats, PDF, and more.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Get document type information
-  result = api_instance.convert_document_autodetect_get_info(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_get_info: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**AutodetectGetInfoResult**](AutodetectGetInfoResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_autodetect_to_pdf**
-> String convert_document_autodetect_to_pdf(input_file)
-
-Convert Document to PDF
-
-Automatically detect file type and convert it to PDF.  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.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Document to PDF
-  result = api_instance.convert_document_autodetect_to_pdf(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_autodetect_to_png_array**
-> AutodetectToPngResult convert_document_autodetect_to_png_array(input_file)
-
-Convert Document to PNG array
-
-Automatically detect file type and convert it to an array of PNG images.  Supports all of the major Office document file formats, over 100 image formats, and even multi-page TIFF files.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Document to PNG array
-  result = api_instance.convert_document_autodetect_to_png_array(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_png_array: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**AutodetectToPngResult**](AutodetectToPngResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_autodetect_to_thumbnail**
-> String convert_document_autodetect_to_thumbnail(input_file, opts)
-
-Convert File to Thumbnail Image
-
-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.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-opts = { 
-  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.
-  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.
-  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.
-}
-
-begin
-  #Convert File to Thumbnail Image
-  result = api_instance.convert_document_autodetect_to_thumbnail(input_file, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_thumbnail: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **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] 
- **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] 
- **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] 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_autodetect_to_thumbnails_advanced**
-> AutodetectToThumbnailsResult convert_document_autodetect_to_thumbnails_advanced(input_file, opts)
-
-Convert File to Thumbnail Image Object
-
-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.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-opts = { 
-  pages: 56, # Integer | Optional; Specify how many pages of the document will be converted to thumbnails. Default is 1 page.
-  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.
-  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.
-  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.
-}
-
-begin
-  #Convert File to Thumbnail Image Object
-  result = api_instance.convert_document_autodetect_to_thumbnails_advanced(input_file, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_thumbnails_advanced: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **pages** | **Integer**| Optional; Specify how many pages of the document will be converted to thumbnails. Default is 1 page. | [optional] 
- **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] 
- **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] 
- **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] 
-
-### Return type
-
-[**AutodetectToThumbnailsResult**](AutodetectToThumbnailsResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_autodetect_to_txt**
-> TextConversionResult convert_document_autodetect_to_txt(input_file, opts)
-
-Convert Document to Text (txt)
-
-Automatically detect file type and convert it to Text.  Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files.  For spreadsheets, all worksheets will be included.  If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-opts = { 
-  text_formatting_mode: "text_formatting_mode_example" # String | Optional; specify how whitespace should be handled when converting the document to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'.
-}
-
-begin
-  #Convert Document to Text (txt)
-  result = api_instance.convert_document_autodetect_to_txt(input_file, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_txt: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting the document to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'. | [optional] 
-
-### Return type
-
-[**TextConversionResult**](TextConversionResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_csv_to_xlsx**
-> String convert_document_csv_to_xlsx(input_file)
-
-Convert CSV to Excel XLSX Spreadsheet
-
-Convert CSV file to Office Excel XLSX Workbooks file format.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert CSV to Excel XLSX Spreadsheet
-  result = api_instance.convert_document_csv_to_xlsx(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_csv_to_xlsx: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_doc_to_docx**
-> String convert_document_doc_to_docx(input_file)
-
-Convert Word DOC (97-03) Document to DOCX
-
-Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Word DOC (97-03) Document to DOCX
-  result = api_instance.convert_document_doc_to_docx(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_docx: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_doc_to_pdf**
-> String convert_document_doc_to_pdf(input_file)
-
-Convert Word DOC (97-03) Document to PDF
-
-Convert Office Word (97-2003 Format) Documents (doc) to standard PDF
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Word DOC (97-03) Document to PDF
-  result = api_instance.convert_document_doc_to_pdf(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_doc_to_txt**
-> TextConversionResult convert_document_doc_to_txt(input_file)
-
-Convert Word DOC (97-03) Document to Text (txt)
-
-Convert Office Word DOC (97-03) Document (doc) to text
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Word DOC (97-03) Document to Text (txt)
-  result = api_instance.convert_document_doc_to_txt(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_txt: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**TextConversionResult**](TextConversionResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_docx_to_pdf**
-> String convert_document_docx_to_pdf(input_file)
-
-Convert Word DOCX Document to PDF
-
-Convert Office Word Documents (docx) to standard PDF
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Word DOCX Document to PDF
-  result = api_instance.convert_document_docx_to_pdf(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_docx_to_png**
-> DocxToPngResult convert_document_docx_to_png(input_file)
-
-Convert DOCX document to PNG image array
-
-Converts an Office Word Document (DOCX) file to an array of PNG images, one for each page.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert DOCX document to PNG image array
-  result = api_instance.convert_document_docx_to_png(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_png: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**DocxToPngResult**](DocxToPngResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_docx_to_txt**
-> TextConversionResult convert_document_docx_to_txt(input_file, opts)
-
-Convert Word DOCX Document to Text (txt)
-
-Convert Office Word Documents (docx) to text
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-opts = { 
-  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'.
-}
-
-begin
-  #Convert Word DOCX Document to Text (txt)
-  result = api_instance.convert_document_docx_to_txt(input_file, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_txt: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **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] 
-
-### Return type
-
-[**TextConversionResult**](TextConversionResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_eml_to_html**
-> EmlToHtmlResult convert_document_eml_to_html(input_file, opts)
-
-Convert Email EML file to HTML string
-
-Convert Outlook Email EML file to HTML string and attachments. Supports images if they are base 64 inline.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-opts = { 
-  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.
-  include_attachments: true # BOOLEAN | Optional; If false, the response object will not include any attachment files from the input file. Default is true.
-}
-
-begin
-  #Convert Email EML file to HTML string
-  result = api_instance.convert_document_eml_to_html(input_file, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_eml_to_html: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **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] 
- **include_attachments** | **BOOLEAN**| Optional; If false, the response object will not include any attachment files from the input file. Default is true. | [optional] 
-
-### Return type
-
-[**EmlToHtmlResult**](EmlToHtmlResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_eml_to_pdf**
-> String convert_document_eml_to_pdf(input_file, opts)
-
-Convert Email EML file to PDF document
-
-Convert Outlook Email EML file to PDF document. Supports images if they are base 64 inline.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-opts = { 
-  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.
-}
-
-begin
-  #Convert Email EML file to PDF document
-  result = api_instance.convert_document_eml_to_pdf(input_file, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_eml_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **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] 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_get_file_type_icon**
-> String convert_document_get_file_type_icon(file_extension, opts)
-
-Get PNG icon file for the file extension
-
-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.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-file_extension = "file_extension_example" # String | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
-
-opts = { 
-  icon_size: 56 # Integer | Optional; The desired width of the icon, preserving its aspect ratio.
-}
-
-begin
-  #Get PNG icon file for the file extension
-  result = api_instance.convert_document_get_file_type_icon(file_extension, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_get_file_type_icon: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **file_extension** | **String**| Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters. | 
- **icon_size** | **Integer**| Optional; The desired width of the icon, preserving its aspect ratio. | [optional] 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_get_file_type_icon_advanced**
-> GetFileTypeIconResult convert_document_get_file_type_icon_advanced(file_extension, opts)
-
-Get PNG icon byte array for the file extension
-
-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.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-file_extension = "file_extension_example" # String | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
-
-opts = { 
-  icon_size: 56 # Integer | Optional; The desired width of the icon, preserving its aspect ratio.
-}
-
-begin
-  #Get PNG icon byte array for the file extension
-  result = api_instance.convert_document_get_file_type_icon_advanced(file_extension, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_get_file_type_icon_advanced: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **file_extension** | **String**| Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters. | 
- **icon_size** | **Integer**| Optional; The desired width of the icon, preserving its aspect ratio. | [optional] 
-
-### Return type
-
-[**GetFileTypeIconResult**](GetFileTypeIconResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_html_to_pdf**
-> String convert_document_html_to_pdf(input_file)
-
-Convert HTML document file to PDF Document
-
-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.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert HTML document file to PDF Document
-  result = api_instance.convert_document_html_to_pdf(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_html_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_html_to_png**
-> PdfToPngResult convert_document_html_to_png(input_file)
-
-Convert HTML document file to PNG image array
-
-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.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert HTML document file to PNG image array
-  result = api_instance.convert_document_html_to_png(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_html_to_png: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**PdfToPngResult**](PdfToPngResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_html_to_txt**
-> TextConversionResult convert_document_html_to_txt(input_file)
-
-HTML Document file to Text (txt)
-
-HTML document to text
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #HTML Document file to Text (txt)
-  result = api_instance.convert_document_html_to_txt(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_html_to_txt: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**TextConversionResult**](TextConversionResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_msg_to_html**
-> MsgToHtmlResult convert_document_msg_to_html(input_file, opts)
-
-Convert Email MSG file to HTML string
-
-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.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-opts = { 
-  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.
-  include_attachments: true # BOOLEAN | Optional; If false, the response object will not include any attachment files from the input file. Default is true.
-}
-
-begin
-  #Convert Email MSG file to HTML string
-  result = api_instance.convert_document_msg_to_html(input_file, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_msg_to_html: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **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] 
- **include_attachments** | **BOOLEAN**| Optional; If false, the response object will not include any attachment files from the input file. Default is true. | [optional] 
-
-### Return type
-
-[**MsgToHtmlResult**](MsgToHtmlResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_msg_to_pdf**
-> String convert_document_msg_to_pdf(input_file, opts)
-
-Convert Email MSG file to PDF document
-
-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.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-opts = { 
-  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.
-}
-
-begin
-  #Convert Email MSG file to PDF document
-  result = api_instance.convert_document_msg_to_pdf(input_file, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_msg_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **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] 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_pdf_to_docx**
-> String convert_document_pdf_to_docx(input_file)
-
-Convert PDF to Word DOCX Document
-
-Convert standard PDF to Office Word Documents (docx).    Converts a PDF at high fidelity into Word format, where it can be easily edited and processed.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert PDF to Word DOCX Document
-  result = api_instance.convert_document_pdf_to_docx(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_docx: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_pdf_to_docx_rasterize**
-> String convert_document_pdf_to_docx_rasterize(input_file)
-
-Convert PDF to Word DOCX Document based on rasterized version of the PDF
-
-Convert standard PDF to Office Word Documents (docx), but first rasterize the PDF.    Converts a PDF at high fidelity into Word format.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert PDF to Word DOCX Document based on rasterized version of the PDF
-  result = api_instance.convert_document_pdf_to_docx_rasterize(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_docx_rasterize: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_pdf_to_png_array**
-> PdfToPngResult convert_document_pdf_to_png_array(input_file)
-
-Convert PDF to PNG Image Array
-
-Convert PDF document to PNG array, one image per page.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert PDF to PNG Image Array
-  result = api_instance.convert_document_pdf_to_png_array(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_png_array: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**PdfToPngResult**](PdfToPngResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_pdf_to_png_single**
-> String convert_document_pdf_to_png_single(input_file)
-
-Convert PDF to Single PNG image
-
-Convert PDF document to a single tall PNG image, by stacking/concatenating the images vertically into a single \"tall\" image
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert PDF to Single PNG image
-  result = api_instance.convert_document_pdf_to_png_single(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_png_single: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_pdf_to_pptx**
-> String convert_document_pdf_to_pptx(input_file)
-
-Convert PDF to PowerPoint PPTX Presentation
-
-Convert standard PDF to Office PowerPoint Presentation (pptx).  Converts a PDF file at high fidelity into PowerPoint format, where it can be easily edited and processed.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert PDF to PowerPoint PPTX Presentation
-  result = api_instance.convert_document_pdf_to_pptx(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_pptx: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_pdf_to_txt**
-> TextConversionResult convert_document_pdf_to_txt(input_file, opts)
-
-Convert PDF Document to Text (txt)
-
-PDF document to text
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-opts = { 
-  text_formatting_mode: "text_formatting_mode_example" # String | Optional; specify how whitespace should be handled when converting PDF to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'.
-}
-
-begin
-  #Convert PDF Document to Text (txt)
-  result = api_instance.convert_document_pdf_to_txt(input_file, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_txt: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting PDF to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'. | [optional] 
-
-### Return type
-
-[**TextConversionResult**](TextConversionResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_png_array_to_pdf**
-> String convert_document_png_array_to_pdf(input_file1, input_file2, opts)
-
-Convert PNG Array to PDF
-
-Convert an array of PNG images, one image per page, into a newly-created PDF.  Supports images of different sizes as input.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file1 = File.new("/path/to/file.txt") # File | First input file to perform the operation on.
-
-input_file2 = File.new("/path/to/file.txt") # File | Second input file to perform the operation on.
-
-opts = { 
-  input_file3: File.new("/path/to/file.txt"), # File | Third input file to perform the operation on.
-  input_file4: File.new("/path/to/file.txt"), # File | Fourth input file to perform the operation on.
-  input_file5: File.new("/path/to/file.txt"), # File | Fifth input file to perform the operation on.
-  input_file6: File.new("/path/to/file.txt"), # File | Sixth input file to perform the operation on.
-  input_file7: File.new("/path/to/file.txt"), # File | Seventh input file to perform the operation on.
-  input_file8: File.new("/path/to/file.txt"), # File | Eighth input file to perform the operation on.
-  input_file9: File.new("/path/to/file.txt"), # File | Ninth input file to perform the operation on.
-  input_file10: File.new("/path/to/file.txt") # File | Tenth input file to perform the operation on.
-}
-
-begin
-  #Convert PNG Array to PDF
-  result = api_instance.convert_document_png_array_to_pdf(input_file1, input_file2, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_png_array_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file1** | **File**| First input file to perform the operation on. | 
- **input_file2** | **File**| Second input file to perform the operation on. | 
- **input_file3** | **File**| Third input file to perform the operation on. | [optional] 
- **input_file4** | **File**| Fourth input file to perform the operation on. | [optional] 
- **input_file5** | **File**| Fifth input file to perform the operation on. | [optional] 
- **input_file6** | **File**| Sixth input file to perform the operation on. | [optional] 
- **input_file7** | **File**| Seventh input file to perform the operation on. | [optional] 
- **input_file8** | **File**| Eighth input file to perform the operation on. | [optional] 
- **input_file9** | **File**| Ninth input file to perform the operation on. | [optional] 
- **input_file10** | **File**| Tenth input file to perform the operation on. | [optional] 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_ppt_to_pdf**
-> String convert_document_ppt_to_pdf(input_file)
-
-Convert PowerPoint PPT (97-03) Presentation to PDF
-
-Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert PowerPoint PPT (97-03) Presentation to PDF
-  result = api_instance.convert_document_ppt_to_pdf(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_ppt_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_ppt_to_pptx**
-> String convert_document_ppt_to_pptx(input_file)
-
-Convert PowerPoint PPT (97-03) Presentation to PPTX
-
-Convert/upgrade Office PowerPoint (97-2003) Documents (ppt) to modern PPTX
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert PowerPoint PPT (97-03) Presentation to PPTX
-  result = api_instance.convert_document_ppt_to_pptx(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_ppt_to_pptx: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_pptx_to_pdf**
-> String convert_document_pptx_to_pdf(input_file)
-
-Convert PowerPoint PPTX Presentation to PDF
-
-Convert Office PowerPoint Documents (pptx) to standard PDF
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert PowerPoint PPTX Presentation to PDF
-  result = api_instance.convert_document_pptx_to_pdf(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_pptx_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_pptx_to_png**
-> PptxToPngResult convert_document_pptx_to_png(input_file)
-
-Convert PowerPoint PPTX to PNG image array
-
-Converts a PowerPoint Presentation (PPTX) file to an array of PNG images, one for each page.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert PowerPoint PPTX to PNG image array
-  result = api_instance.convert_document_pptx_to_png(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_pptx_to_png: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**PptxToPngResult**](PptxToPngResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_pptx_to_txt**
-> TextConversionResult convert_document_pptx_to_txt(input_file)
-
-Convert PowerPoint PPTX Presentation to Text (txt)
-
-Convert Office PowerPoint Documents (pptx) to standard Text
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert PowerPoint PPTX Presentation to Text (txt)
-  result = api_instance.convert_document_pptx_to_txt(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_pptx_to_txt: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**TextConversionResult**](TextConversionResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_xls_to_csv**
-> String convert_document_xls_to_csv(input_file)
-
-Convert Excel XLS (97-03) Spreadsheet to CSV
-
-Convert/upgrade Office Excel (97-2003) Workbooks (xls) to standard CSV format.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Excel XLS (97-03) Spreadsheet to CSV
-  result = api_instance.convert_document_xls_to_csv(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_xls_to_csv: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_xls_to_pdf**
-> String convert_document_xls_to_pdf(input_file)
-
-Convert Excel XLS (97-03) Spreadsheet to PDF
-
-Convert Office Excel (97-2003) Workbooks (xls) to standard PDF.  Converts all worksheets in the workbook to PDF.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Excel XLS (97-03) Spreadsheet to PDF
-  result = api_instance.convert_document_xls_to_pdf(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_xls_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_xls_to_xlsx**
-> String convert_document_xls_to_xlsx(input_file)
-
-Convert Excel XLS (97-03) Spreadsheet to XLSX
-
-Convert/upgrade Office Excel (97-2003) Workbooks (xls) to modern XLSX format.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Excel XLS (97-03) Spreadsheet to XLSX
-  result = api_instance.convert_document_xls_to_xlsx(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_xls_to_xlsx: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_xlsx_to_csv**
-> String convert_document_xlsx_to_csv(input_file, opts)
-
-Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
-
-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.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-opts = { 
-  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.
-}
-
-begin
-  #Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
-  result = api_instance.convert_document_xlsx_to_csv(input_file, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_csv: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **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] 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_xlsx_to_csv_multi**
-> CsvCollection convert_document_xlsx_to_csv_multi(input_file, opts)
-
-Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
-
-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.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-opts = { 
-  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.
-}
-
-begin
-  #Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
-  result = api_instance.convert_document_xlsx_to_csv_multi(input_file, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_csv_multi: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **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] 
-
-### Return type
-
-[**CsvCollection**](CsvCollection.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_xlsx_to_pdf**
-> String convert_document_xlsx_to_pdf(input_file)
-
-Convert Excel XLSX Spreadsheet to PDF
-
-Convert Office Excel Workbooks (XLSX) to standard PDF.  Converts all worksheets in the workbook to PDF.  Supports both XLSX and XLSB Excel file formats.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Excel XLSX Spreadsheet to PDF
-  result = api_instance.convert_document_xlsx_to_pdf(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **convert_document_xlsx_to_png**
-> XlsxToPngResult convert_document_xlsx_to_png(input_file)
-
-Convert Excel XLSX spreadsheet to PNG image array
-
-Converts an Excel Spreadsheet (XLSX) file to an array of PNG images, one for each page.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Excel XLSX spreadsheet to PNG image array
-  result = api_instance.convert_document_xlsx_to_png(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_png: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**XlsxToPngResult**](XlsxToPngResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **convert_document_xlsx_to_txt**
-> TextConversionResult convert_document_xlsx_to_txt(input_file)
-
-Convert Excel XLSX Spreadsheet to Text (txt)
-
-Convert Office Excel Workbooks (XLSX) to standard Text.  Converts all worksheets in the workbook to Text.  Supports both XLSX and XLSB file formats.  When a spreadsheet contains multiple worksheets, will export all of the text from all of the worksheets.  If you wish to export the text from only one worksheet, try using the Split XLSX API to split the spreadsheet into multiple worksheet files, and then run XLSX to Text on the individual worksheet file that you need to extract the text from.
-
-### Example
-```ruby
-# load the gem
-require 'cloudmersive-convert-api-client'
-# setup authorization
-CloudmersiveConvertApiClient.configure do |config|
-  # Configure API key authorization: Apikey
-  config.api_key['Apikey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Apikey'] = 'Bearer'
-end
-
-api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Convert Excel XLSX Spreadsheet to Text (txt)
-  result = api_instance.convert_document_xlsx_to_txt(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_txt: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**TextConversionResult**](TextConversionResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-