cloudmersive-convert-api-client 1.7.4 → 2.0.1

data/docs/SplitDocumentResult.md

@@ -1,10 +0,0 @@
-# CloudmersiveConvertApiClient::SplitDocumentResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**page_number** | **Integer** | Page number of the converted page, starting with 1 for the first page | [optional] 
-**url** | **String** | URL to the DOCX file of this slide; file is stored in an in-memory cache and will be deleted | [optional] 
-**document_contents** | **String** | Contents of the document in bytes | [optional] 
-
-

data/docs/SplitDocxDocumentResult.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::SplitDocxDocumentResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**result_documents** | [**Array<SplitDocumentResult>**](SplitDocumentResult.md) |  | [optional] 
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-
-

data/docs/SplitPdfResult.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::SplitPdfResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**documents** | [**Array<PdfDocument>**](PdfDocument.md) | PDF documents as output | [optional] 
-
-

data/docs/SplitPptxPresentationResult.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::SplitPptxPresentationResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**result_presentations** | [**Array<PresentationResult>**](PresentationResult.md) |  | [optional] 
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-
-

data/docs/SplitTextDocumentByLinesResult.md

@@ -1,10 +0,0 @@
-# CloudmersiveConvertApiClient::SplitTextDocumentByLinesResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**result_lines** | [**Array<TextDocumentLine>**](TextDocumentLine.md) |  | [optional] 
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**line_count** | **Integer** | The count of lines in the text file | [optional] 
-
-

data/docs/SplitTextDocumentByStringResult.md

@@ -1,10 +0,0 @@
-# CloudmersiveConvertApiClient::SplitTextDocumentByStringResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**result_elements** | [**Array<TextDocumentElement>**](TextDocumentElement.md) |  | [optional] 
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**element_count** | **Integer** | The count of elements in the text file | [optional] 
-
-

data/docs/SplitXlsxWorksheetResult.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::SplitXlsxWorksheetResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**result_worksheets** | [**Array<WorksheetResult>**](WorksheetResult.md) |  | [optional] 
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-
-

data/docs/TextConversionResult.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::TextConversionResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**text_result** | **String** | Plain Text (TXT) format conversion result of the input document.  The text result is returned as a string. | [optional] 
-
-

data/docs/TextDocumentElement.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::TextDocumentElement
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**element_number** | **Integer** | The 1-based line index of the element | [optional] 
-**element_contents** | **String** | The text contents of a single element of a text file | [optional] 
-
-

data/docs/TextDocumentLine.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::TextDocumentLine
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**line_number** | **Integer** | The 1-based line index of the line | [optional] 
-**line_contents** | **String** | The text contents of a single line of a text file | [optional] 
-
-

data/docs/TextEncodingDetectResponse.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::TextEncodingDetectResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
-**text_encoding** | **String** | Text encoding used in file; possible values are ASCII, UTF7, UTF8, UTF16, BigEndianUnicode and UTF32 | [optional] 
-
-

data/docs/UpdateDocxTableCellRequest.md

@@ -1,13 +0,0 @@
-# CloudmersiveConvertApiClient::UpdateDocxTableCellRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional] 
-**input_file_url** | **String** | Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional] 
-**cell_to_update** | [**DocxTableCell**](DocxTableCell.md) | Table cell contents you would like to update the cell with | [optional] 
-**table_row_index** | **Integer** | 0-based index of the Table Row to update | [optional] 
-**table_cell_index** | **Integer** | 0-based index of the Table Cell (within the row) to update | [optional] 
-**existing_table_path** | **String** | Required; the path to the existing table to modify | [optional] 
-
-

data/docs/UpdateDocxTableCellResponse.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::UpdateDocxTableCellResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
-**edited_document_url** | **String** | URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents. | [optional] 
-
-

data/docs/UpdateDocxTableRowRequest.md

@@ -1,12 +0,0 @@
-# CloudmersiveConvertApiClient::UpdateDocxTableRowRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional] 
-**input_file_url** | **String** | Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional] 
-**row_to_update** | [**DocxTableRow**](DocxTableRow.md) | Table row contents you would like to update the row with | [optional] 
-**table_row_index** | **Integer** | 0-based index of the Table Row to update | [optional] 
-**existing_table_path** | **String** | Required; the path to the existing table to modify | [optional] 
-
-

data/docs/UpdateDocxTableRowResponse.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::UpdateDocxTableRowResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
-**edited_document_url** | **String** | URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents. | [optional] 
-
-

data/docs/UrlToPdfRequest.md

@@ -1,11 +0,0 @@
-# CloudmersiveConvertApiClient::UrlToPdfRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url** | **String** | URL address of the website to screenshot.  HTTP and HTTPS are both supported, as are custom ports. | [optional] 
-**extra_loading_wait** | **Integer** | Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites.  Provide a value of 0 for the default of 5000 milliseconds (5 seconds) | [optional] 
-**include_background_graphics** | **BOOLEAN** | Optional: Set to true to include background graphics in the PDF, or false to not include.  Default is true. | [optional] 
-**scale_factor** | **Integer** | Optional: Set to 100 to scale at 100%, set to 50% to scale down to 50% scale, set to 200% to scale up to 200% scale, etc.  Default is 100% | [optional] 
-
-

data/docs/UrlToTextRequest.md

@@ -1,8 +0,0 @@
-# CloudmersiveConvertApiClient::UrlToTextRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url** | **String** | URL of the website to extract the text from | [optional] 
-
-

data/docs/UrlToTextResponse.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::UrlToTextResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
-**text_content_result** | **String** | Text content result from the URL website input | [optional] 
-
-

data/docs/ValidateDocumentApi.md

@@ -1,448 +0,0 @@
-# CloudmersiveConvertApiClient::ValidateDocumentApi
-
-All URIs are relative to *https://api.cloudmersive.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**validate_document_autodetect_validation**](ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
-[**validate_document_docx_validation**](ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
-[**validate_document_executable_validation**](ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
-[**validate_document_json_validation**](ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
-[**validate_document_pdf_validation**](ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
-[**validate_document_pptx_validation**](ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
-[**validate_document_xlsx_validation**](ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
-[**validate_document_xml_validation**](ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
-
-
-# **validate_document_autodetect_validation**
-> AutodetectDocumentValidationResult validate_document_autodetect_validation(input_file)
-
-Autodetect content type and validate
-
-Automatically detect the type of content, verify and validate that the content is indeed fully valid at depth, and then report the validation result.
-
-### 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::ValidateDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Autodetect content type and validate
-  result = api_instance.validate_document_autodetect_validation(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ValidateDocumentApi->validate_document_autodetect_validation: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**AutodetectDocumentValidationResult**](AutodetectDocumentValidationResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **validate_document_docx_validation**
-> DocumentValidationResult validate_document_docx_validation(input_file)
-
-Validate a Word document (DOCX)
-
-Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document
-
-### 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::ValidateDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Validate a Word document (DOCX)
-  result = api_instance.validate_document_docx_validation(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ValidateDocumentApi->validate_document_docx_validation: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**DocumentValidationResult**](DocumentValidationResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **validate_document_executable_validation**
-> DocumentValidationResult validate_document_executable_validation(input_file)
-
-Validate if a file is executable
-
-Validate if an input file is a binary executable file; if the document is not valid
-
-### 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::ValidateDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Validate if a file is executable
-  result = api_instance.validate_document_executable_validation(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ValidateDocumentApi->validate_document_executable_validation: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**DocumentValidationResult**](DocumentValidationResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **validate_document_json_validation**
-> DocumentValidationResult validate_document_json_validation(input_file)
-
-Validate a JSON file
-
-Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document
-
-### 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::ValidateDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Validate a JSON file
-  result = api_instance.validate_document_json_validation(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ValidateDocumentApi->validate_document_json_validation: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**DocumentValidationResult**](DocumentValidationResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **validate_document_pdf_validation**
-> DocumentValidationResult validate_document_pdf_validation(input_file)
-
-Validate a PDF document file
-
-Validate a PDF document; if the document is not valid, identifies the errors in the document.  Also checks if the PDF is password protected.
-
-### 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::ValidateDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Validate a PDF document file
-  result = api_instance.validate_document_pdf_validation(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ValidateDocumentApi->validate_document_pdf_validation: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**DocumentValidationResult**](DocumentValidationResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **validate_document_pptx_validation**
-> DocumentValidationResult validate_document_pptx_validation(input_file)
-
-Validate a PowerPoint presentation (PPTX)
-
-Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document
-
-### 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::ValidateDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Validate a PowerPoint presentation (PPTX)
-  result = api_instance.validate_document_pptx_validation(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ValidateDocumentApi->validate_document_pptx_validation: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**DocumentValidationResult**](DocumentValidationResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **validate_document_xlsx_validation**
-> DocumentValidationResult validate_document_xlsx_validation(input_file)
-
-Validate a Excel document (XLSX)
-
-Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document
-
-### 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::ValidateDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Validate a Excel document (XLSX)
-  result = api_instance.validate_document_xlsx_validation(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ValidateDocumentApi->validate_document_xlsx_validation: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**DocumentValidationResult**](DocumentValidationResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **validate_document_xml_validation**
-> DocumentValidationResult validate_document_xml_validation(input_file)
-
-Validate an XML file
-
-Validate an XML document file; if the document is not valid, identifies the errors in the document
-
-### 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::ValidateDocumentApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Validate an XML file
-  result = api_instance.validate_document_xml_validation(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ValidateDocumentApi->validate_document_xml_validation: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**DocumentValidationResult**](DocumentValidationResult.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-