Metadata-Version: 2.1
Name: cloudmersive_convert_api_client
Version: 2.0.6
Summary: convertapi
Home-page: https://www.cloudmersive.com/convert-api
Author-email: 
License: UNKNOWN
Description: # cloudmersive_convert_api_client
        Convert API lets you effortlessly convert file formats and types.
        
        This Python package provides a native API client for [Cloudmersive Document Conversion](https://www.cloudmersive.com/convert-api)
        
        - API version: v1
        - Package version: 2.0.6
        - Build package: io.swagger.codegen.languages.PythonClientCodegen
        
        ## Requirements.
        
        Python 2.7 and 3.4+
        
        ## Installation & Usage
        ### pip install
        
        If the python package is hosted on Github, you can install directly from Github
        
        ```sh
        pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
        ```
        (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
        
        Then import the package:
        ```python
        import cloudmersive_convert_api_client 
        ```
        
        ### Setuptools
        
        Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
        
        ```sh
        python setup.py install --user
        ```
        (or `sudo python setup.py install` to install the package for all users)
        
        Then import the package:
        ```python
        import cloudmersive_convert_api_client
        ```
        
        ## Getting Started
        
        Please follow the [installation procedure](#installation--usage) and then run the following:
        
        ```python
        from __future__ import print_function
        import time
        import cloudmersive_convert_api_client
        from cloudmersive_convert_api_client.rest import ApiException
        from pprint import pprint
        
        # Configure API key authorization: Apikey
        configuration = cloudmersive_convert_api_client.Configuration()
        configuration.api_key['Apikey'] = 'YOUR_API_KEY'
        # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        # configuration.api_key_prefix['Apikey'] = 'Bearer'
        
        # create an instance of the API class
        api_instance = cloudmersive_convert_api_client.CompareDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
        input_file1 = '/path/to/file.txt' # file | First input file to perform the operation on.
        input_file2 = '/path/to/file.txt' # file | Second input file to perform the operation on (more than 2 can be supplied).
        
        try:
            # Compare Two Word DOCX
            api_response = api_instance.compare_document_docx(input_file1, input_file2)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling CompareDocumentApi->compare_document_docx: %s\n" % e)
        
        ```
        
        ## Documentation for API Endpoints
        
        All URIs are relative to *https://api.cloudmersive.com*
        
        Class | Method | HTTP request | Description
        ------------ | ------------- | ------------- | -------------
        *CompareDocumentApi* | [**compare_document_docx**](docs/CompareDocumentApi.md#compare_document_docx) | **POST** /convert/compare/docx | Compare Two Word DOCX
        *ConvertDataApi* | [**convert_data_csv_to_json**](docs/ConvertDataApi.md#convert_data_csv_to_json) | **POST** /convert/csv/to/json | CSV to JSON conversion
        *ConvertDataApi* | [**convert_data_xls_to_json**](docs/ConvertDataApi.md#convert_data_xls_to_json) | **POST** /convert/xls/to/json | Excel (97-2003) XLS to JSON conversion
        *ConvertDataApi* | [**convert_data_xlsx_to_json**](docs/ConvertDataApi.md#convert_data_xlsx_to_json) | **POST** /convert/xlsx/to/json | Excel XLSX to JSON conversion
        *ConvertDataApi* | [**convert_data_xml_to_json**](docs/ConvertDataApi.md#convert_data_xml_to_json) | **POST** /convert/xml/to/json | XML to JSON conversion
        *ConvertDocumentApi* | [**convert_document_autodetect_get_info**](docs/ConvertDocumentApi.md#convert_document_autodetect_get_info) | **POST** /convert/autodetect/get-info | Get document type information
        *ConvertDocumentApi* | [**convert_document_autodetect_to_pdf**](docs/ConvertDocumentApi.md#convert_document_autodetect_to_pdf) | **POST** /convert/autodetect/to/pdf | Convert Document to PDF
        *ConvertDocumentApi* | [**convert_document_autodetect_to_png_array**](docs/ConvertDocumentApi.md#convert_document_autodetect_to_png_array) | **POST** /convert/autodetect/to/png | Convert Document to PNG array
        *ConvertDocumentApi* | [**convert_document_csv_to_xlsx**](docs/ConvertDocumentApi.md#convert_document_csv_to_xlsx) | **POST** /convert/csv/to/xlsx | CSV to Excel XLSX
        *ConvertDocumentApi* | [**convert_document_doc_to_docx**](docs/ConvertDocumentApi.md#convert_document_doc_to_docx) | **POST** /convert/doc/to/docx | Word DOC (97-03) to DOCX
        *ConvertDocumentApi* | [**convert_document_doc_to_pdf**](docs/ConvertDocumentApi.md#convert_document_doc_to_pdf) | **POST** /convert/doc/to/pdf | Word DOC (97-03) to PDF
        *ConvertDocumentApi* | [**convert_document_docx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_docx_to_pdf) | **POST** /convert/docx/to/pdf | Word DOCX to PDF
        *ConvertDocumentApi* | [**convert_document_html_to_pdf**](docs/ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | HTML to PDF
        *ConvertDocumentApi* | [**convert_document_html_to_png**](docs/ConvertDocumentApi.md#convert_document_html_to_png) | **POST** /convert/html/to/png | HTML to PNG array
        *ConvertDocumentApi* | [**convert_document_pdf_to_docx**](docs/ConvertDocumentApi.md#convert_document_pdf_to_docx) | **POST** /convert/pdf/to/docx | PDF to Word DOCX
        *ConvertDocumentApi* | [**convert_document_pdf_to_png_array**](docs/ConvertDocumentApi.md#convert_document_pdf_to_png_array) | **POST** /convert/pdf/to/png | PDF to PNG Array
        *ConvertDocumentApi* | [**convert_document_pdf_to_pptx**](docs/ConvertDocumentApi.md#convert_document_pdf_to_pptx) | **POST** /convert/pdf/to/pptx | PDF to PowerPoint PPTX
        *ConvertDocumentApi* | [**convert_document_ppt_to_pdf**](docs/ConvertDocumentApi.md#convert_document_ppt_to_pdf) | **POST** /convert/ppt/to/pdf | PowerPoint PPT (97-03) to PDF
        *ConvertDocumentApi* | [**convert_document_ppt_to_pptx**](docs/ConvertDocumentApi.md#convert_document_ppt_to_pptx) | **POST** /convert/ppt/to/pptx | PowerPoint PPT (97-03) to PPTX
        *ConvertDocumentApi* | [**convert_document_pptx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_pptx_to_pdf) | **POST** /convert/pptx/to/pdf | PowerPoint PPTX to PDF
        *ConvertDocumentApi* | [**convert_document_xls_to_pdf**](docs/ConvertDocumentApi.md#convert_document_xls_to_pdf) | **POST** /convert/xls/to/pdf | Excel XLS (97-03) to PDF
        *ConvertDocumentApi* | [**convert_document_xls_to_xlsx**](docs/ConvertDocumentApi.md#convert_document_xls_to_xlsx) | **POST** /convert/xls/to/xlsx | Excel XLS (97-03) to XLSX
        *ConvertDocumentApi* | [**convert_document_xlsx_to_csv**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_csv) | **POST** /convert/xlsx/to/csv | Excel XLSX to CSV
        *ConvertDocumentApi* | [**convert_document_xlsx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_pdf) | **POST** /convert/xlsx/to/pdf | Excel XLSX to PDF
        *ConvertImageApi* | [**convert_image_get_image_info**](docs/ConvertImageApi.md#convert_image_get_image_info) | **POST** /convert/image/get-info | Get information about an image
        *ConvertImageApi* | [**convert_image_image_format_convert**](docs/ConvertImageApi.md#convert_image_image_format_convert) | **POST** /convert/image/{format1}/to/{format2} | Image format conversion
        *ConvertImageApi* | [**convert_image_image_set_dpi**](docs/ConvertImageApi.md#convert_image_image_set_dpi) | **POST** /convert/image/set-dpi/{dpi} | Change image DPI
        *ConvertImageApi* | [**convert_image_multipage_image_format_convert**](docs/ConvertImageApi.md#convert_image_multipage_image_format_convert) | **POST** /convert/image-multipage/{format1}/to/{format2} | Multi-page format conversion
        *ConvertTemplateApi* | [**convert_template_apply_html_template**](docs/ConvertTemplateApi.md#convert_template_apply_html_template) | **POST** /convert/template/html/apply | Apply HTML template
        *ConvertWebApi* | [**convert_web_html_to_docx**](docs/ConvertWebApi.md#convert_web_html_to_docx) | **POST** /convert/html/to/docx | HTML to DOCX
        *ConvertWebApi* | [**convert_web_html_to_pdf**](docs/ConvertWebApi.md#convert_web_html_to_pdf) | **POST** /convert/web/html/to/pdf | Convert HTML string to PDF
        *ConvertWebApi* | [**convert_web_md_to_html**](docs/ConvertWebApi.md#convert_web_md_to_html) | **POST** /convert/web/md/to/html | Convert Markdown to HTML
        *ConvertWebApi* | [**convert_web_url_to_pdf**](docs/ConvertWebApi.md#convert_web_url_to_pdf) | **POST** /convert/web/url/to/pdf | Convert a URL to PDF
        *ConvertWebApi* | [**convert_web_url_to_screenshot**](docs/ConvertWebApi.md#convert_web_url_to_screenshot) | **POST** /convert/web/url/to/screenshot | Take screenshot of URL
        *EditDocumentApi* | [**edit_document_begin_editing**](docs/EditDocumentApi.md#edit_document_begin_editing) | **POST** /convert/edit/begin-editing | Begin editing a document
        *EditDocumentApi* | [**edit_document_docx_body**](docs/EditDocumentApi.md#edit_document_docx_body) | **POST** /convert/edit/docx/get-body | Get body from a DOCX
        *EditDocumentApi* | [**edit_document_docx_get_headers_and_footers**](docs/EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a DOCX
        *EditDocumentApi* | [**edit_document_docx_get_images**](docs/EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a DOCX
        *EditDocumentApi* | [**edit_document_docx_get_sections**](docs/EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a DOCX
        *EditDocumentApi* | [**edit_document_docx_get_styles**](docs/EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a DOCX
        *EditDocumentApi* | [**edit_document_docx_get_tables**](docs/EditDocumentApi.md#edit_document_docx_get_tables) | **POST** /convert/edit/docx/get-tables | Get tables in DOCX
        *EditDocumentApi* | [**edit_document_docx_insert_image**](docs/EditDocumentApi.md#edit_document_docx_insert_image) | **POST** /convert/edit/docx/insert-image | Insert image into a DOCX
        *EditDocumentApi* | [**edit_document_docx_insert_paragraph**](docs/EditDocumentApi.md#edit_document_docx_insert_paragraph) | **POST** /convert/edit/docx/insert-paragraph | Insert a new paragraph into a DOCX
        *EditDocumentApi* | [**edit_document_docx_insert_table**](docs/EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a DOCX
        *EditDocumentApi* | [**edit_document_docx_remove_headers_and_footers**](docs/EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from DOCX
        *EditDocumentApi* | [**edit_document_docx_remove_object**](docs/EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a DOCX
        *EditDocumentApi* | [**edit_document_docx_replace**](docs/EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in DOCX
        *EditDocumentApi* | [**edit_document_docx_set_footer**](docs/EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a DOCX
        *EditDocumentApi* | [**edit_document_docx_set_header**](docs/EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a DOCX
        *EditDocumentApi* | [**edit_document_finish_editing**](docs/EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Download result from document editing
        *EditDocumentApi* | [**edit_document_pptx_replace**](docs/EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PPTX
        *EditDocumentApi* | [**edit_document_xlsx_get_columns**](docs/EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get rows and cells from a XLSX worksheet
        *EditDocumentApi* | [**edit_document_xlsx_get_images**](docs/EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a XLSX worksheet
        *EditDocumentApi* | [**edit_document_xlsx_get_rows_and_cells**](docs/EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a XLSX worksheet
        *EditDocumentApi* | [**edit_document_xlsx_get_styles**](docs/EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a XLSX worksheet
        *EditDocumentApi* | [**edit_document_xlsx_get_worksheets**](docs/EditDocumentApi.md#edit_document_xlsx_get_worksheets) | **POST** /convert/edit/xlsx/get-worksheets | Get worksheets from a XLSX
        *EditDocumentApi* | [**edit_document_xlsx_insert_worksheet**](docs/EditDocumentApi.md#edit_document_xlsx_insert_worksheet) | **POST** /convert/edit/xlsx/insert-worksheet | Insert a new worksheet into an XLSX spreadsheet
        *MergeDocumentApi* | [**merge_document_docx**](docs/MergeDocumentApi.md#merge_document_docx) | **POST** /convert/merge/docx | Merge Multple Word DOCX Together
        *MergeDocumentApi* | [**merge_document_pdf**](docs/MergeDocumentApi.md#merge_document_pdf) | **POST** /convert/merge/pdf | Merge Multple PDF Files Together
        *MergeDocumentApi* | [**merge_document_pptx**](docs/MergeDocumentApi.md#merge_document_pptx) | **POST** /convert/merge/pptx | Merge Multple PowerPoint PPTX Together
        *MergeDocumentApi* | [**merge_document_xlsx**](docs/MergeDocumentApi.md#merge_document_xlsx) | **POST** /convert/merge/xlsx | Merge Multple Excel XLSX Together
        *ValidateDocumentApi* | [**validate_document_docx_validation**](docs/ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
        *ValidateDocumentApi* | [**validate_document_pptx_validation**](docs/ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
        *ValidateDocumentApi* | [**validate_document_xlsx_validation**](docs/ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
        *ViewerToolsApi* | [**viewer_tools_create_simple**](docs/ViewerToolsApi.md#viewer_tools_create_simple) | **POST** /convert/viewer/create/web/simple | Create a web-based viewer
        
        
        ## Documentation For Models
        
         - [AlternateFileFormatCandidate](docs/AlternateFileFormatCandidate.md)
         - [AutodetectGetInfoResult](docs/AutodetectGetInfoResult.md)
         - [AutodetectToPngResult](docs/AutodetectToPngResult.md)
         - [ConvertedPngPage](docs/ConvertedPngPage.md)
         - [DocumentValidationError](docs/DocumentValidationError.md)
         - [DocumentValidationResult](docs/DocumentValidationResult.md)
         - [DocxBody](docs/DocxBody.md)
         - [DocxCellStyle](docs/DocxCellStyle.md)
         - [DocxFooter](docs/DocxFooter.md)
         - [DocxHeader](docs/DocxHeader.md)
         - [DocxImage](docs/DocxImage.md)
         - [DocxInsertImageRequest](docs/DocxInsertImageRequest.md)
         - [DocxInsertImageResponse](docs/DocxInsertImageResponse.md)
         - [DocxParagraph](docs/DocxParagraph.md)
         - [DocxRemoveObjectRequest](docs/DocxRemoveObjectRequest.md)
         - [DocxRemoveObjectResponse](docs/DocxRemoveObjectResponse.md)
         - [DocxRun](docs/DocxRun.md)
         - [DocxSection](docs/DocxSection.md)
         - [DocxSetFooterRequest](docs/DocxSetFooterRequest.md)
         - [DocxSetFooterResponse](docs/DocxSetFooterResponse.md)
         - [DocxSetHeaderRequest](docs/DocxSetHeaderRequest.md)
         - [DocxSetHeaderResponse](docs/DocxSetHeaderResponse.md)
         - [DocxStyle](docs/DocxStyle.md)
         - [DocxTable](docs/DocxTable.md)
         - [DocxTableCell](docs/DocxTableCell.md)
         - [DocxTableRow](docs/DocxTableRow.md)
         - [DocxText](docs/DocxText.md)
         - [ExifValue](docs/ExifValue.md)
         - [FinishEditingRequest](docs/FinishEditingRequest.md)
         - [GetDocxBodyRequest](docs/GetDocxBodyRequest.md)
         - [GetDocxBodyResponse](docs/GetDocxBodyResponse.md)
         - [GetDocxHeadersAndFootersRequest](docs/GetDocxHeadersAndFootersRequest.md)
         - [GetDocxHeadersAndFootersResponse](docs/GetDocxHeadersAndFootersResponse.md)
         - [GetDocxImagesRequest](docs/GetDocxImagesRequest.md)
         - [GetDocxImagesResponse](docs/GetDocxImagesResponse.md)
         - [GetDocxSectionsRequest](docs/GetDocxSectionsRequest.md)
         - [GetDocxSectionsResponse](docs/GetDocxSectionsResponse.md)
         - [GetDocxStylesRequest](docs/GetDocxStylesRequest.md)
         - [GetDocxStylesResponse](docs/GetDocxStylesResponse.md)
         - [GetDocxTablesRequest](docs/GetDocxTablesRequest.md)
         - [GetDocxTablesResponse](docs/GetDocxTablesResponse.md)
         - [GetImageInfoResult](docs/GetImageInfoResult.md)
         - [GetXlsxColumnsRequest](docs/GetXlsxColumnsRequest.md)
         - [GetXlsxColumnsResponse](docs/GetXlsxColumnsResponse.md)
         - [GetXlsxImagesRequest](docs/GetXlsxImagesRequest.md)
         - [GetXlsxImagesResponse](docs/GetXlsxImagesResponse.md)
         - [GetXlsxRowsAndCellsRequest](docs/GetXlsxRowsAndCellsRequest.md)
         - [GetXlsxRowsAndCellsResponse](docs/GetXlsxRowsAndCellsResponse.md)
         - [GetXlsxStylesRequest](docs/GetXlsxStylesRequest.md)
         - [GetXlsxStylesResponse](docs/GetXlsxStylesResponse.md)
         - [GetXlsxWorksheetsRequest](docs/GetXlsxWorksheetsRequest.md)
         - [GetXlsxWorksheetsResponse](docs/GetXlsxWorksheetsResponse.md)
         - [HtmlMdResult](docs/HtmlMdResult.md)
         - [HtmlTemplateApplicationRequest](docs/HtmlTemplateApplicationRequest.md)
         - [HtmlTemplateApplicationResponse](docs/HtmlTemplateApplicationResponse.md)
         - [HtmlTemplateOperation](docs/HtmlTemplateOperation.md)
         - [HtmlToOfficeRequest](docs/HtmlToOfficeRequest.md)
         - [HtmlToPdfRequest](docs/HtmlToPdfRequest.md)
         - [InsertDocxInsertParagraphRequest](docs/InsertDocxInsertParagraphRequest.md)
         - [InsertDocxInsertParagraphResponse](docs/InsertDocxInsertParagraphResponse.md)
         - [InsertDocxTablesRequest](docs/InsertDocxTablesRequest.md)
         - [InsertDocxTablesResponse](docs/InsertDocxTablesResponse.md)
         - [InsertXlsxWorksheetRequest](docs/InsertXlsxWorksheetRequest.md)
         - [InsertXlsxWorksheetResponse](docs/InsertXlsxWorksheetResponse.md)
         - [MultipageImageFormatConversionResult](docs/MultipageImageFormatConversionResult.md)
         - [PageConversionResult](docs/PageConversionResult.md)
         - [PdfToPngResult](docs/PdfToPngResult.md)
         - [RemoveDocxHeadersAndFootersRequest](docs/RemoveDocxHeadersAndFootersRequest.md)
         - [RemoveDocxHeadersAndFootersResponse](docs/RemoveDocxHeadersAndFootersResponse.md)
         - [ReplaceStringRequest](docs/ReplaceStringRequest.md)
         - [ScreenshotRequest](docs/ScreenshotRequest.md)
         - [ViewerResponse](docs/ViewerResponse.md)
         - [XlsxImage](docs/XlsxImage.md)
         - [XlsxSpreadsheetCell](docs/XlsxSpreadsheetCell.md)
         - [XlsxSpreadsheetColumn](docs/XlsxSpreadsheetColumn.md)
         - [XlsxSpreadsheetRow](docs/XlsxSpreadsheetRow.md)
         - [XlsxWorksheet](docs/XlsxWorksheet.md)
        
        
        ## Documentation For Authorization
        
        
        ## Apikey
        
        - **Type**: API key
        - **API key parameter name**: Apikey
        - **Location**: HTTP header
        
        
        ## Author
        
        
        
        
Keywords: Swagger,convertapi
Platform: UNKNOWN
Description-Content-Type: text/markdown
