cloudmersive-convert-api-client 1.7.3 → 1.7.8

data/lib/cloudmersive-convert-api-client/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.3.1
 =end
 
 module CloudmersiveConvertApiClient
-  VERSION = "1.7.3"
+  VERSION = "1.7.8"
 end

data/spec/api/convert_data_api_spec.rb

@@ -37,6 +37,7 @@ describe 'ConvertDataApi' do
   # Convert a CSV file to a JSON object array
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :column_names_from_first_row Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc.  Default is true.  Set to false if you are not using column headings, or have an irregular column structure.
   # @return [Object]
   describe 'convert_data_csv_to_json test' do
     it "should work" do

data/spec/api/convert_document_api_spec.rb

@@ -68,6 +68,37 @@ describe 'ConvertDocumentApi' do
     end
   end
 
+  # unit tests for convert_document_autodetect_to_thumbnail
+  # 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.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :max_width Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
+  # @option opts [Integer] :max_height Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
+  # @option opts [String] :extension Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon.
+  # @return [String]
+  describe 'convert_document_autodetect_to_thumbnail test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for convert_document_autodetect_to_thumbnails_advanced
+  # 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.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :pages Optional; Specify how many pages of the document will be converted to thumbnails. Default is 1 page.
+  # @option opts [Integer] :max_width Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
+  # @option opts [Integer] :max_height Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
+  # @option opts [String] :extension Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon.
+  # @return [AutodetectToThumbnailsResult]
+  describe 'convert_document_autodetect_to_thumbnails_advanced test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for convert_document_autodetect_to_txt
   # 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.
@@ -141,6 +172,18 @@ describe 'ConvertDocumentApi' do
     end
   end
 
+  # unit tests for convert_document_docx_to_png
+  # Convert DOCX document to PNG image array
+  # Converts an Office Word Document (DOCX) file to an array of PNG images, one for each page.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DocxToPngResult]
+  describe 'convert_document_docx_to_png test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for convert_document_docx_to_txt
   # Convert Word DOCX Document to Text (txt)
   # Convert Office Word Documents (docx) to text
@@ -154,6 +197,59 @@ describe 'ConvertDocumentApi' do
     end
   end
 
+  # unit tests for convert_document_eml_to_html
+  # 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.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
+  # @option opts [BOOLEAN] :include_attachments Optional; If false, the response object will not include any attachment files from the input file. Default is true.
+  # @return [EmlToHtmlResult]
+  describe 'convert_document_eml_to_html test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for convert_document_eml_to_pdf
+  # Convert Email EML file to PDF document
+  # Convert Outlook Email EML file to PDF document. Supports images if they are base 64 inline.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
+  # @return [String]
+  describe 'convert_document_eml_to_pdf test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for convert_document_get_file_type_icon
+  # 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.
+  # @param file_extension Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :icon_size Optional; The desired width of the icon, preserving its aspect ratio.
+  # @return [String]
+  describe 'convert_document_get_file_type_icon test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for convert_document_get_file_type_icon_advanced
+  # 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.
+  # @param file_extension Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :icon_size Optional; The desired width of the icon, preserving its aspect ratio.
+  # @return [GetFileTypeIconResult]
+  describe 'convert_document_get_file_type_icon_advanced test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for convert_document_html_to_pdf
   # 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.
@@ -190,6 +286,33 @@ describe 'ConvertDocumentApi' do
     end
   end
 
+  # unit tests for convert_document_msg_to_html
+  # 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.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the MSG. Other information such as subject will still be given as properties in the response object. Default is false.
+  # @option opts [BOOLEAN] :include_attachments Optional; If false, the response object will not include any attachment files from the input file. Default is true.
+  # @return [MsgToHtmlResult]
+  describe 'convert_document_msg_to_html test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for convert_document_msg_to_pdf
+  # 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.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :body_only Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
+  # @return [String]
+  describe 'convert_document_msg_to_pdf test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for convert_document_pdf_to_docx
   # 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.
@@ -320,6 +443,18 @@ describe 'ConvertDocumentApi' do
     end
   end
 
+  # unit tests for convert_document_pptx_to_png
+  # Convert PowerPoint PPTX to PNG image array
+  # Converts a PowerPoint Presentation (PPTX) file to an array of PNG images, one for each page.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [PptxToPngResult]
+  describe 'convert_document_pptx_to_png test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for convert_document_pptx_to_txt
   # Convert PowerPoint PPTX Presentation to Text (txt)
   # Convert Office PowerPoint Documents (pptx) to standard Text
@@ -369,11 +504,11 @@ describe 'ConvertDocumentApi' do
   end
 
   # unit tests for convert_document_xlsx_to_csv
-  # Convert Excel XLSX Spreadsheet to CSV
-  # Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format.  Supports both XLSX and XLSB file Excel formats.
+  # 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.
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8 and UTF-32.  Default is UTF-32.
+  # @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32.  Default is UTF-8.
   # @return [String]
   describe 'convert_document_xlsx_to_csv test' do
     it "should work" do
@@ -381,6 +516,19 @@ describe 'ConvertDocumentApi' do
     end
   end
 
+  # unit tests for convert_document_xlsx_to_csv_multi
+  # 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.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32.  Default is UTF-8.
+  # @return [CsvCollection]
+  describe 'convert_document_xlsx_to_csv_multi test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for convert_document_xlsx_to_pdf
   # 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.
@@ -393,6 +541,18 @@ describe 'ConvertDocumentApi' do
     end
   end
 
+  # unit tests for convert_document_xlsx_to_png
+  # Convert Excel XLSX spreadsheet to PNG image array
+  # Converts an Excel Spreadsheet (XLSX) file to an array of PNG images, one for each page.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [XlsxToPngResult]
+  describe 'convert_document_xlsx_to_png test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for convert_document_xlsx_to_txt
   # 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.

data/spec/api/edit_document_api_spec.rb

@@ -104,6 +104,18 @@ describe 'EditDocumentApi' do
     end
   end
 
+  # unit tests for edit_document_docx_find_paragraph
+  # Find matching paragraphs in a Word DOCX document
+  # Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria
+  # @param req_config Document input request
+  # @param [Hash] opts the optional parameters
+  # @return [FindDocxParagraphResponse]
+  describe 'edit_document_docx_find_paragraph test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for edit_document_docx_get_comments
   # Get comments from a Word DOCX document as a flat list
   # Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).
@@ -320,6 +332,18 @@ describe 'EditDocumentApi' do
     end
   end
 
+  # unit tests for edit_document_docx_replace_paragraph
+  # Replace matching paragraphs in a Word DOCX document
+  # Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested.  Replace a paragraph with another object such as an image.  Useful for performing templating operations.
+  # @param req_config Document input request
+  # @param [Hash] opts the optional parameters
+  # @return [ReplaceDocxParagraphResponse]
+  describe 'edit_document_docx_replace_paragraph test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for edit_document_docx_set_footer
   # Set the footer in a Word DOCX document
   # Set the footer in a Word Document (DOCX).  Call Finish Editing on the output URL to complete the operation.

data/spec/api/validate_document_api_spec.rb

@@ -44,6 +44,18 @@ describe 'ValidateDocumentApi' do
     end
   end
 
+  # unit tests for validate_document_csv_validation
+  # Validate a CSV file document (CSV)
+  # Validate a CSV file document (CSV); if the document is not valid, identifies the errors in the document
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentValidationResult]
+  describe 'validate_document_csv_validation test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for validate_document_docx_validation
   # Validate a Word document (DOCX)
   # Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document
@@ -56,6 +68,18 @@ describe 'ValidateDocumentApi' do
     end
   end
 
+  # unit tests for validate_document_eml_validation
+  # Validate if an EML file is executable
+  # Validate if an input file is an EML email file; if the document is not valid
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentValidationResult]
+  describe 'validate_document_eml_validation test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for validate_document_executable_validation
   # Validate if a file is executable
   # Validate if an input file is a binary executable file; if the document is not valid
@@ -68,6 +92,18 @@ describe 'ValidateDocumentApi' do
     end
   end
 
+  # unit tests for validate_document_g_zip_validation
+  # Validate a GZip Archive file (gzip or gz)
+  # Validate a GZip archive file (GZIP or GZ)
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentValidationResult]
+  describe 'validate_document_g_zip_validation test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for validate_document_json_validation
   # Validate a JSON file
   # Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document
@@ -80,9 +116,21 @@ describe 'ValidateDocumentApi' do
     end
   end
 
+  # unit tests for validate_document_msg_validation
+  # Validate if an MSG file is executable
+  # Validate if an input file is an MSG email file; if the document is not valid
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentValidationResult]
+  describe 'validate_document_msg_validation test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for validate_document_pdf_validation
   # Validate a PDF document file
-  # Validate a PDF document; if the document is not valid, identifies the errors in the document
+  # Validate a PDF document; if the document is not valid, identifies the errors in the document.  Also checks if the PDF is password protected.
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
   # @return [DocumentValidationResult]
@@ -104,6 +152,30 @@ describe 'ValidateDocumentApi' do
     end
   end
 
+  # unit tests for validate_document_rar_validation
+  # Validate a RAR Archive file (RAR)
+  # Validate a RAR archive file (RAR)
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentValidationResult]
+  describe 'validate_document_rar_validation test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for validate_document_tar_validation
+  # Validate a TAR Tarball Archive file (TAR)
+  # Validate a TAR tarball archive file (TAR)
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentValidationResult]
+  describe 'validate_document_tar_validation test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for validate_document_xlsx_validation
   # Validate a Excel document (XLSX)
   # Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document
@@ -128,4 +200,16 @@ describe 'ValidateDocumentApi' do
     end
   end
 
+  # unit tests for validate_document_zip_validation
+  # Validate a Zip Archive file (zip)
+  # Validate a Zip archive file (ZIP)
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentValidationResult]
+  describe 'validate_document_zip_validation test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/api/zip_archive_api_spec.rb

@@ -35,8 +35,18 @@ describe 'ZipArchiveApi' do
   # unit tests for zip_archive_zip_create
   # Compress files to create a new zip archive
   # Create a new zip archive by compressing input files.
+  # @param input_file1 First input file to perform the operation on.
   # @param [Hash] opts the optional parameters
-  # @return [Object]
+  # @option opts [File] :input_file2 Second input file to perform the operation on.
+  # @option opts [File] :input_file3 Third input file to perform the operation on.
+  # @option opts [File] :input_file4 Fourth input file to perform the operation on.
+  # @option opts [File] :input_file5 Fifth input file to perform the operation on.
+  # @option opts [File] :input_file6 Sixth input file to perform the operation on.
+  # @option opts [File] :input_file7 Seventh input file to perform the operation on.
+  # @option opts [File] :input_file8 Eighth input file to perform the operation on.
+  # @option opts [File] :input_file9 Ninth input file to perform the operation on.
+  # @option opts [File] :input_file10 Tenth input file to perform the operation on.
+  # @return [String]
   describe 'zip_archive_zip_create test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -55,6 +65,31 @@ describe 'ZipArchiveApi' do
     end
   end
 
+  # unit tests for zip_archive_zip_decrypt
+  # Decrypt and remove password protection on a zip file
+  # Decrypts and removes password protection from an encrypted zip file with the specified password
+  # @param input_file Input file to perform the operation on.
+  # @param zip_password Required; Password for the input archive
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'zip_archive_zip_decrypt test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for zip_archive_zip_encrypt_advanced
+  # Encrypt and password protect a zip file
+  # Encrypts and password protects an existing zip file with the specified password and encryption algorithm
+  # @param encryption_request Encryption request
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'zip_archive_zip_encrypt_advanced test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for zip_archive_zip_extract
   # Extract, decompress files and folders from a zip archive
   # Extracts a zip archive by decompressing files, and folders.