cloudmersive-convert-api-client 1.2.3 → 1.2.8

data/client/docs/FinishEditingRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveConvertApiClient::FinishEditingRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file_url** | **String** | URL of a document being edited to get the contents of. | [optional] 
+
+

data/client/docs/GetDocxHeadersAndFootersRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest
+
+## 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] 
+
+

data/client/docs/GetDocxHeadersAndFootersResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::GetDocxHeadersAndFootersResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**headers** | [**Array<DocxHeader>**](DocxHeader.md) |  | [optional] 
+**footers** | [**Array<DocxFooter>**](DocxFooter.md) |  | [optional] 
+
+

data/client/docs/GetDocxStylesRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxStylesRequest
+
+## 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] 
+
+

data/client/docs/GetDocxStylesResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxStylesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**styles** | [**Array<DocxStyle>**](DocxStyle.md) | Styles in the DOCX document | [optional] 
+
+

data/client/docs/GetDocxTablesRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxTablesRequest
+
+## 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] 
+
+

data/client/docs/GetDocxTablesResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxTablesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**tables** | [**Array<DocxTable>**](DocxTable.md) | Tables in the DOCX file | [optional] 
+
+

data/client/docs/HtmlMdResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::HtmlMdResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if operation was successful, false otherwise | [optional] 
+**html** | **String** | Resulting HTML from the conversion | [optional] 
+
+

data/client/docs/HtmlTemplateApplicationRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::HtmlTemplateApplicationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**html_template** | **String** |  | [optional] 
+**html_template_url** | **String** |  | [optional] 
+**operations** | [**Array<HtmlTemplateOperation>**](HtmlTemplateOperation.md) |  | [optional] 
+
+

data/client/docs/HtmlTemplateApplicationResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::HtmlTemplateApplicationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** |  | [optional] 
+**final_html** | **String** |  | [optional] 
+
+

data/client/docs/HtmlTemplateOperation.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::HtmlTemplateOperation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **Integer** |  | [optional] 
+**match_agsint** | **String** |  | [optional] 
+**replace_with** | **String** |  | [optional] 
+
+

data/client/docs/HtmlToOfficeRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveConvertApiClient::HtmlToOfficeRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**html** | **String** |  | [optional] 
+
+

data/client/docs/HtmlToPdfRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::HtmlToPdfRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**html** | **String** |  | [optional] 
+**extra_loading_wait** | **Integer** |  | [optional] 
+
+

data/client/docs/InsertDocxTablesRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::InsertDocxTablesRequest
+
+## 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] 
+**table_to_insert** | [**DocxTable**](DocxTable.md) | Table you would like to insert | [optional] 
+
+

data/client/docs/InsertDocxTablesResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::InsertDocxTablesResponse
+
+## 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/client/docs/MergeDocumentApi.md

@@ -0,0 +1,182 @@
+# CloudmersiveConvertApiClient::MergeDocumentApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**merge_document_docx**](MergeDocumentApi.md#merge_document_docx) | **POST** /convert/merge/docx | Merge Multple Word DOCX Together
+[**merge_document_pptx**](MergeDocumentApi.md#merge_document_pptx) | **POST** /convert/merge/pptx | Merge Multple PowerPoint PPTX Together
+[**merge_document_xlsx**](MergeDocumentApi.md#merge_document_xlsx) | **POST** /convert/merge/xlsx | Merge Multple Excel XLSX Together
+
+
+# **merge_document_docx**
+> String merge_document_docx(input_file1, input_file2)
+
+Merge Multple Word DOCX Together
+
+Combine multiple Office Word Documents (docx) into one single Office Word 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::MergeDocumentApi.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
+  #Merge Multple Word DOCX Together
+  result = api_instance.merge_document_docx(input_file1, input_file2)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_docx: #{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 (more than 2 can be supplied). | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/octet-stream
+
+
+
+# **merge_document_pptx**
+> String merge_document_pptx(input_file1, input_file2)
+
+Merge Multple PowerPoint PPTX Together
+
+Combine multiple Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation
+
+### 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::MergeDocumentApi.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
+  #Merge Multple PowerPoint PPTX Together
+  result = api_instance.merge_document_pptx(input_file1, input_file2)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_pptx: #{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 (more than 2 can be supplied). | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/octet-stream
+
+
+
+# **merge_document_xlsx**
+> String merge_document_xlsx(input_file1, input_file2)
+
+Merge Multple Excel XLSX Together
+
+Combine multiple Office Excel spreadsheets (xlsx) into a single Office Excel 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::MergeDocumentApi.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
+  #Merge Multple Excel XLSX Together
+  result = api_instance.merge_document_xlsx(input_file1, input_file2)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_xlsx: #{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 (more than 2 can be supplied). | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/octet-stream
+
+
+

data/client/docs/PdfToPngResult.md

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

data/client/docs/RemoveDocxHeadersAndFootersRequest.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest
+
+## 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] 
+**remove_headers** | **BOOLEAN** | True if you would like to remove all headers from the input document, false otherwise | [optional] 
+**remove_footers** | **BOOLEAN** | True if you would like to remove all footers from the input document, false otherwise | [optional] 
+
+

data/client/docs/RemoveDocxHeadersAndFootersResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**edited_document_url** | **String** | URL of the resulting edited document; this is a secure URL and cannot be downloaded without adding the Apikey header; it is also temporary, stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents. | [optional] 
+
+

data/client/docs/ReplaceStringRequest.md

@@ -0,0 +1,12 @@
+# CloudmersiveConvertApiClient::ReplaceStringRequest
+
+## 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] 
+**match_string** | **String** | String to search for and match against, to be replaced | [optional] 
+**replace_string** | **String** | String to replace the matched values with | [optional] 
+**match_case** | **BOOLEAN** | True if the case should be matched, false for case insensitive match | [optional] 
+
+

data/client/docs/ScreenshotRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::ScreenshotRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | [optional] 
+**extra_loading_wait** | **Integer** |  | [optional] 
+
+

data/client/docs/ValidateDocumentApi.md

@@ -0,0 +1,173 @@
+# CloudmersiveConvertApiClient::ValidateDocumentApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**validate_document_docx_validation**](ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
+[**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_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/octet-stream
+
+
+
+# **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/octet-stream
+
+
+
+# **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/octet-stream
+
+
+