cloudmersive-convert-api-client

CloudmersiveConvertApiClient - the Ruby gem for the convertapi

Convert API lets you effortlessly convert file formats and types.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: 1.5.2
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build cloudmersive-convert-api-client.gemspec

Then either install the gem locally:

gem install ./cloudmersive-convert-api-client-1.5.2.gem

(for development, run gem install --dev ./cloudmersive-convert-api-client-1.5.2.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'cloudmersive-convert-api-client', '~> 1.5.2'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'cloudmersive-convert-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# 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::CompareDocumentApi.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 (more than 2 can be supplied).


begin
  #Compare Two Word DOCX
  result = api_instance.compare_document_docx(input_file1, input_file2)
  p result
rescue CloudmersiveConvertApiClient::ApiError => e
  puts "Exception when calling CompareDocumentApi->compare_document_docx: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Class Method HTTP request Description
CloudmersiveConvertApiClient::CompareDocumentApi compare_document_docx POST /convert/compare/docx Compare Two Word DOCX
CloudmersiveConvertApiClient::ConvertDataApi convert_data_csv_to_json POST /convert/csv/to/json Convert CSV to JSON conversion
CloudmersiveConvertApiClient::ConvertDataApi convert_data_xls_to_json POST /convert/xls/to/json Convert Excel (97-2003) XLS to JSON conversion
CloudmersiveConvertApiClient::ConvertDataApi convert_data_xlsx_to_json POST /convert/xlsx/to/json Convert Excel XLSX to JSON conversion
CloudmersiveConvertApiClient::ConvertDataApi convert_data_xml_to_json POST /convert/xml/to/json Convert XML to JSON conversion
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_autodetect_get_info POST /convert/autodetect/get-info Get document type information
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_autodetect_to_pdf POST /convert/autodetect/to/pdf Convert Document to PDF
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_autodetect_to_png_array POST /convert/autodetect/to/png Convert Document to PNG array
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_autodetect_to_txt POST /convert/autodetect/to/txt Convert Document to Text
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_csv_to_xlsx POST /convert/csv/to/xlsx Convert CSV to Excel XLSX Spreadsheet
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_doc_to_docx POST /convert/doc/to/docx Convert Word DOC (97-03) Document to DOCX
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_doc_to_pdf POST /convert/doc/to/pdf Convert Word DOC (97-03) Document to PDF
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_docx_to_pdf POST /convert/docx/to/pdf Convert Word DOCX Document to PDF
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_docx_to_txt POST /convert/docx/to/txt Convert Word DOCX Document to Text
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_html_to_pdf POST /convert/html/to/pdf Convert HTML to PDF Document
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_html_to_png POST /convert/html/to/png Convert HTML to PNG image array
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_pdf_to_docx POST /convert/pdf/to/docx Convert PDF to Word DOCX Document
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_pdf_to_png_array POST /convert/pdf/to/png Convert PDF to PNG Image Array
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_pdf_to_png_single POST /convert/pdf/to/png/merge-single Convert PDF to Single PNG image
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_pdf_to_pptx POST /convert/pdf/to/pptx Convert PDF to PowerPoint PPTX Presentation
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_pdf_to_txt POST /convert/pdf/to/txt Convert PDF Document to Text
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_png_array_to_pdf POST /convert/png/to/pdf Convert PNG Array to PDF
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_ppt_to_pdf POST /convert/ppt/to/pdf Convert PowerPoint PPT (97-03) Presentation to PDF
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_ppt_to_pptx POST /convert/ppt/to/pptx Convert PowerPoint PPT (97-03) Presentation to PPTX
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_pptx_to_pdf POST /convert/pptx/to/pdf Convert PowerPoint PPTX Presentation to PDF
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_pptx_to_txt POST /convert/pptx/to/txt Convert PowerPoint PPTX Presentation to Text
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_xls_to_csv POST /convert/xls/to/csv Convert Excel XLS (97-03) Spreadsheet to CSV
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_xls_to_pdf POST /convert/xls/to/pdf Convert Excel XLS (97-03) Spreadsheet to PDF
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_xls_to_xlsx POST /convert/xls/to/xlsx Convert Excel XLS (97-03) Spreadsheet to XLSX
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_xlsx_to_csv POST /convert/xlsx/to/csv Convert Excel XLSX Spreadsheet to CSV
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_xlsx_to_pdf POST /convert/xlsx/to/pdf Convert Excel XLSX Spreadsheet to PDF
CloudmersiveConvertApiClient::ConvertDocumentApi convert_document_xlsx_to_txt POST /convert/xlsx/to/txt Convert Excel XLSX Spreadsheet to Text
CloudmersiveConvertApiClient::ConvertImageApi convert_image_get_image_info POST /convert/image/get-info Get information about an image
CloudmersiveConvertApiClient::ConvertImageApi convert_image_image_format_convert POST /convert/image/format1/to/format2 Image format conversion
CloudmersiveConvertApiClient::ConvertImageApi convert_image_image_set_dpi POST /convert/image/set-dpi/dpi Change image DPI
CloudmersiveConvertApiClient::ConvertImageApi convert_image_multipage_image_format_convert POST /convert/image-multipage/format1/to/format2 Multi-page image format conversion
CloudmersiveConvertApiClient::ConvertTemplateApi convert_template_apply_docx_template POST /convert/template/docx/apply Apply Word DOCX template
CloudmersiveConvertApiClient::ConvertTemplateApi convert_template_apply_html_template POST /convert/template/html/apply Apply HTML template
CloudmersiveConvertApiClient::ConvertWebApi convert_web_html_to_docx POST /convert/html/to/docx Convert HTML to Word DOCX Document
CloudmersiveConvertApiClient::ConvertWebApi convert_web_html_to_pdf POST /convert/web/html/to/pdf Convert HTML string to PDF
CloudmersiveConvertApiClient::ConvertWebApi convert_web_html_to_png POST /convert/web/html/to/png Convert HTML string to PNG
CloudmersiveConvertApiClient::ConvertWebApi convert_web_md_to_html POST /convert/web/md/to/html Convert Markdown to HTML
CloudmersiveConvertApiClient::ConvertWebApi convert_web_url_to_pdf POST /convert/web/url/to/pdf Convert a URL to PDF
CloudmersiveConvertApiClient::ConvertWebApi convert_web_url_to_screenshot POST /convert/web/url/to/screenshot Take screenshot of URL
CloudmersiveConvertApiClient::EditDocumentApi edit_document_begin_editing POST /convert/edit/begin-editing Begin editing a document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_body POST /convert/edit/docx/get-body Get body from a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_delete_pages POST /convert/edit/docx/delete-pages Delete, remove pages from a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_get_headers_and_footers POST /convert/edit/docx/get-headers-and-footers Get content of a footer from a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_get_images POST /convert/edit/docx/get-images Get images from a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_get_sections POST /convert/edit/docx/get-sections Get sections from a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_get_styles POST /convert/edit/docx/get-styles Get styles from a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_get_tables POST /convert/edit/docx/get-tables Get tables in Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_insert_image POST /convert/edit/docx/insert-image Insert image into a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_insert_paragraph POST /convert/edit/docx/insert-paragraph Insert a new paragraph into a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_insert_table POST /convert/edit/docx/insert-table Insert a new table into a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_insert_table_row POST /convert/edit/docx/insert-table-row Insert a new row into an existing table in a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_pages POST /convert/edit/docx/get-pages Get pages and content from a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_remove_headers_and_footers POST /convert/edit/docx/remove-headers-and-footers Remove headers and footers from Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_remove_object POST /convert/edit/docx/remove-object Delete any object in a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_replace POST /convert/edit/docx/replace-all Replace string in Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_set_footer POST /convert/edit/docx/set-footer Set the footer in a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_set_footer_add_page_number POST /convert/edit/docx/set-footer/add-page-number Add page number to footer in a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_docx_set_header POST /convert/edit/docx/set-header Set the header in a Word DOCX document
CloudmersiveConvertApiClient::EditDocumentApi edit_document_finish_editing POST /convert/edit/finish-editing Download result from document editing
CloudmersiveConvertApiClient::EditDocumentApi edit_document_pptx_replace POST /convert/edit/pptx/replace-all Replace string in PowerPoint PPTX presentation
CloudmersiveConvertApiClient::EditDocumentApi edit_document_xlsx_get_columns POST /convert/edit/xlsx/get-columns Get rows and cells from a Excel XLSX spreadsheet, worksheet
CloudmersiveConvertApiClient::EditDocumentApi edit_document_xlsx_get_images POST /convert/edit/xlsx/get-images Get images from a Excel XLSX spreadsheet, worksheet
CloudmersiveConvertApiClient::EditDocumentApi edit_document_xlsx_get_rows_and_cells POST /convert/edit/xlsx/get-rows-and-cells Get rows and cells from a Word XLSX spreadsheet, worksheet
CloudmersiveConvertApiClient::EditDocumentApi edit_document_xlsx_get_styles POST /convert/edit/xlsx/get-styles Get styles from a Excel XLSX spreadsheet, worksheet
CloudmersiveConvertApiClient::EditDocumentApi edit_document_xlsx_get_worksheets POST /convert/edit/xlsx/get-worksheets Get worksheets from a Excel XLSX spreadsheet
CloudmersiveConvertApiClient::EditDocumentApi edit_document_xlsx_insert_worksheet POST /convert/edit/xlsx/insert-worksheet Insert a new worksheet into an Excel XLSX spreadsheet
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_decrypt POST /convert/edit/pdf/decrypt Decrypt and password-protect a PDF
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_delete_pages POST /convert/edit/pdf/pages/delete Remove / delete pages from a PDF document
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_encrypt POST /convert/edit/pdf/encrypt Encrypt and password-protect a PDF
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_get_form_fields POST /convert/edit/pdf/form/get-fields Gets PDF Form fields and values
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_get_metadata POST /convert/edit/pdf/get-metadata Get PDF document metadata
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_get_pdf_text_by_pages POST /convert/edit/pdf/pages/get-text Get text in a PDF document by page
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_insert_pages POST /convert/edit/pdf/pages/insert Insert / copy pages from one PDF document into another
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_rasterize POST /convert/edit/pdf/rasterize Rasterize a PDF to an image-based PDF
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_set_form_fields POST /convert/edit/pdf/form/set-fields Sets ands fills PDF Form field values
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_set_metadata POST /convert/edit/pdf/set-metadata Sets PDF document metadata
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_set_permissions POST /convert/edit/pdf/encrypt/set-permissions Encrypt, password-protect and set restricted permissions on a PDF
CloudmersiveConvertApiClient::EditPdfApi edit_pdf_watermark_text POST /convert/edit/pdf/watermark/text Add a text watermark to a PDF
CloudmersiveConvertApiClient::MergeDocumentApi merge_document_docx POST /convert/merge/docx Merge Two Word DOCX Together
CloudmersiveConvertApiClient::MergeDocumentApi merge_document_docx_multi POST /convert/merge/docx/multi Merge Multple Word DOCX Together
CloudmersiveConvertApiClient::MergeDocumentApi merge_document_pdf POST /convert/merge/pdf Merge Two PDF Files Together
CloudmersiveConvertApiClient::MergeDocumentApi merge_document_pdf_multi POST /convert/merge/pdf/multi Merge Multple PDF Files Together
CloudmersiveConvertApiClient::MergeDocumentApi merge_document_png POST /convert/merge/png/vertical Merge Multple PNG Files Together
CloudmersiveConvertApiClient::MergeDocumentApi merge_document_pptx POST /convert/merge/pptx Merge Two PowerPoint PPTX Together
CloudmersiveConvertApiClient::MergeDocumentApi merge_document_pptx_multi POST /convert/merge/pptx/multi Merge Multple PowerPoint PPTX Together
CloudmersiveConvertApiClient::MergeDocumentApi merge_document_xlsx POST /convert/merge/xlsx Merge Two Excel XLSX Together
CloudmersiveConvertApiClient::MergeDocumentApi merge_document_xlsx_multi POST /convert/merge/xlsx/multi Merge Multple Excel XLSX Together
CloudmersiveConvertApiClient::SplitDocumentApi split_document_pdf_by_page POST /convert/split/pdf Split a PDF file into separate PDF files, one per page
CloudmersiveConvertApiClient::SplitDocumentApi split_document_xlsx POST /convert/split/xlsx Split a single Excel XLSX into Separate Worksheets
CloudmersiveConvertApiClient::ValidateDocumentApi validate_document_autodetect_validation POST /convert/validate/autodetect Autodetect content type and validate
CloudmersiveConvertApiClient::ValidateDocumentApi validate_document_docx_validation POST /convert/validate/docx Validate a Word document (DOCX)
CloudmersiveConvertApiClient::ValidateDocumentApi validate_document_executable_validation POST /convert/validate/executable Validate if a file is executable
CloudmersiveConvertApiClient::ValidateDocumentApi validate_document_json_validation POST /convert/validate/json Validate a JSON file
CloudmersiveConvertApiClient::ValidateDocumentApi validate_document_pdf_validation POST /convert/validate/pdf Validate a PDF document file
CloudmersiveConvertApiClient::ValidateDocumentApi validate_document_pptx_validation POST /convert/validate/pptx Validate a PowerPoint presentation (PPTX)
CloudmersiveConvertApiClient::ValidateDocumentApi validate_document_xlsx_validation POST /convert/validate/xlsx Validate a Excel document (XLSX)
CloudmersiveConvertApiClient::ValidateDocumentApi validate_document_xml_validation POST /convert/validate/xml Validate an XML file
CloudmersiveConvertApiClient::ViewerToolsApi viewer_tools_create_simple POST /convert/viewer/create/web/simple Create a web-based viewer

Documentation for Models

Documentation for Authorization

Apikey

  • Type: API key
  • API key parameter name: Apikey
  • Location: HTTP header