cloudmersive-convert-api-client 2.2.6 → 2.3.0

data/docs/MergeDocumentApi.md

@@ -4,20 +4,82 @@ All URIs are relative to *https://api.cloudmersive.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**merge_document_batch_job_create**](MergeDocumentApi.md#merge_document_batch_job_create) | **POST** /convert/merge/batch-job/create | Merge an array of Documents into a Single Document by Page as a Batch Job
 [**merge_document_docx**](MergeDocumentApi.md#merge_document_docx) | **POST** /convert/merge/docx | Merge Two Word DOCX Together
 [**merge_document_docx_multi**](MergeDocumentApi.md#merge_document_docx_multi) | **POST** /convert/merge/docx/multi | Merge Multple Word DOCX Together
+[**merge_document_docx_multi_array**](MergeDocumentApi.md#merge_document_docx_multi_array) | **POST** /convert/merge/docx/multi/array | Merge Multple Word DOCX Together from an array
+[**merge_document_get_async_job_status**](MergeDocumentApi.md#merge_document_get_async_job_status) | **GET** /convert/merge/batch-job/status | Get the status and result of a Merge Document Batch Job
 [**merge_document_html**](MergeDocumentApi.md#merge_document_html) | **POST** /convert/merge/html | Merge Two HTML (HTM) Files Together
 [**merge_document_html_multi**](MergeDocumentApi.md#merge_document_html_multi) | **POST** /convert/merge/html/multi | Merge Multple HTML (HTM) Files Together
+[**merge_document_html_multi_array**](MergeDocumentApi.md#merge_document_html_multi_array) | **POST** /convert/merge/html/multi/array | Merge Multple HTML (HTM) Files Together from an array
 [**merge_document_pdf**](MergeDocumentApi.md#merge_document_pdf) | **POST** /convert/merge/pdf | Merge Two PDF Files Together
 [**merge_document_pdf_multi**](MergeDocumentApi.md#merge_document_pdf_multi) | **POST** /convert/merge/pdf/multi | Merge Multple PDF Files Together
+[**merge_document_pdf_multi_array**](MergeDocumentApi.md#merge_document_pdf_multi_array) | **POST** /convert/merge/pdf/multi/array | Merge Multple PDF Files Together from an array
 [**merge_document_png**](MergeDocumentApi.md#merge_document_png) | **POST** /convert/merge/png/vertical | Merge Two PNG Files Together
 [**merge_document_png_multi**](MergeDocumentApi.md#merge_document_png_multi) | **POST** /convert/merge/png/vertical/multi | Merge Multple PNG Files Together
+[**merge_document_png_multi_array**](MergeDocumentApi.md#merge_document_png_multi_array) | **POST** /convert/merge/png/vertical/multi/array | Merge Multple PNG Files Together from an array
 [**merge_document_pptx**](MergeDocumentApi.md#merge_document_pptx) | **POST** /convert/merge/pptx | Merge Two PowerPoint PPTX Together
 [**merge_document_pptx_multi**](MergeDocumentApi.md#merge_document_pptx_multi) | **POST** /convert/merge/pptx/multi | Merge Multple PowerPoint PPTX Together
+[**merge_document_pptx_multi_array**](MergeDocumentApi.md#merge_document_pptx_multi_array) | **POST** /convert/merge/pptx/multi/array | Merge Multple PowerPoint PPTX Together from an array
 [**merge_document_txt**](MergeDocumentApi.md#merge_document_txt) | **POST** /convert/merge/txt | Merge Two Text (TXT) Files Together
 [**merge_document_txt_multi**](MergeDocumentApi.md#merge_document_txt_multi) | **POST** /convert/merge/txt/multi | Merge Multple Text (TXT) Files Together
 [**merge_document_xlsx**](MergeDocumentApi.md#merge_document_xlsx) | **POST** /convert/merge/xlsx | Merge Two Excel XLSX Together
 [**merge_document_xlsx_multi**](MergeDocumentApi.md#merge_document_xlsx_multi) | **POST** /convert/merge/xlsx/multi | Merge Multple Excel XLSX Together
+[**merge_document_xlsx_multi_array**](MergeDocumentApi.md#merge_document_xlsx_multi_array) | **POST** /convert/merge/xlsx/multi/array | Merge Multple Excel XLSX Together from an Array
+
+
+# **merge_document_batch_job_create**
+> MergeBatchJobCreateResult merge_document_batch_job_create(input)
+
+Merge an array of Documents into a Single Document by Page as a Batch Job
+
+Merge an array of Documents (PDF supported), into a single document.  This API is designed for large jobs that could take a long time to create and so runs as a batch job that returns a Job ID that you can use with the GetAsyncJobStatus API to check on the status of the Job and ultimately get the output result.  This API automatically detects the document type and then performs the split by using the document type-specific API needed to perform the split.  This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.
+
+### 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 = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | 
+
+
+begin
+  #Merge an array of Documents into a Single Document by Page as a Batch Job
+  result = api_instance.merge_document_batch_job_create(input)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_batch_job_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)|  | 
+
+### Return type
+
+[**MergeBatchJobCreateResult**](MergeBatchJobCreateResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
 
 
 # **merge_document_docx**
@@ -152,6 +214,114 @@ Name | Type | Description  | Notes
 
 
 
+# **merge_document_docx_multi_array**
+> Object merge_document_docx_multi_array(input)
+
+Merge Multple Word DOCX Together from an array
+
+Combine multiple Office Word Documents (docx), stored in an array, 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 = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
+
+
+begin
+  #Merge Multple Word DOCX Together from an array
+  result = api_instance.merge_document_docx_multi_array(input)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_docx_multi_array: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/octet-stream
+
+
+
+# **merge_document_get_async_job_status**
+> MergeJobStatusResult merge_document_get_async_job_status(async_job_id)
+
+Get the status and result of a Merge Document Batch Job
+
+Returns the result of the Async Job - possible states can be STARTED or COMPLETED.  This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.
+
+### 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
+
+async_job_id = 'async_job_id_example' # String | 
+
+
+begin
+  #Get the status and result of a Merge Document Batch Job
+  result = api_instance.merge_document_get_async_job_status(async_job_id)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_get_async_job_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **async_job_id** | **String**|  | 
+
+### Return type
+
+[**MergeJobStatusResult**](MergeJobStatusResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **merge_document_html**
 > String merge_document_html(input_file1, input_file2)
 
@@ -284,6 +454,60 @@ Name | Type | Description  | Notes
 
 
 
+# **merge_document_html_multi_array**
+> Object merge_document_html_multi_array(input)
+
+Merge Multple HTML (HTM) Files Together from an array
+
+Combine multiple HTML (.HTM) files, from an array, into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.  The title will be taken from the first 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 = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
+
+
+begin
+  #Merge Multple HTML (HTM) Files Together from an array
+  result = api_instance.merge_document_html_multi_array(input)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_html_multi_array: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/octet-stream
+
+
+
 # **merge_document_pdf**
 > String merge_document_pdf(input_file1, input_file2)
 
@@ -416,6 +640,60 @@ Name | Type | Description  | Notes
 
 
 
+# **merge_document_pdf_multi_array**
+> Object merge_document_pdf_multi_array(input)
+
+Merge Multple PDF Files Together from an array
+
+Combine multiple PDF files (pdf), as an array, into a single PDF document, preserving the order of the input documents in the combined 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 = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
+
+
+begin
+  #Merge Multple PDF Files Together from an array
+  result = api_instance.merge_document_pdf_multi_array(input)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_pdf_multi_array: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/octet-stream
+
+
+
 # **merge_document_png**
 > String merge_document_png(input_file1, input_file2)
 
@@ -548,6 +826,60 @@ Name | Type | Description  | Notes
 
 
 
+# **merge_document_png_multi_array**
+> Object merge_document_png_multi_array(input)
+
+Merge Multple PNG Files Together from an array
+
+Combine multiple PNG files, from an array, into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically
+
+### 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 = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
+
+
+begin
+  #Merge Multple PNG Files Together from an array
+  result = api_instance.merge_document_png_multi_array(input)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_png_multi_array: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/octet-stream
+
+
+
 # **merge_document_pptx**
 > String merge_document_pptx(input_file1, input_file2)
 
@@ -680,6 +1012,60 @@ Name | Type | Description  | Notes
 
 
 
+# **merge_document_pptx_multi_array**
+> Object merge_document_pptx_multi_array(input)
+
+Merge Multple PowerPoint PPTX Together from an array
+
+Combine multiple Office PowerPoint presentations (pptx), from an array, 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 = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
+
+
+begin
+  #Merge Multple PowerPoint PPTX Together from an array
+  result = api_instance.merge_document_pptx_multi_array(input)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_pptx_multi_array: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/octet-stream
+
+
+
 # **merge_document_txt**
 > Object merge_document_txt(input_file1, input_file2)
 
@@ -944,3 +1330,57 @@ Name | Type | Description  | Notes
 
 
 
+# **merge_document_xlsx_multi_array**
+> Object merge_document_xlsx_multi_array(input)
+
+Merge Multple Excel XLSX Together from an Array
+
+Combine multiple Office Excel spreadsheets (xlsx), as an array, 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 = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
+
+
+begin
+  #Merge Multple Excel XLSX Together from an Array
+  result = api_instance.merge_document_xlsx_multi_array(input)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_xlsx_multi_array: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/octet-stream
+
+
+

data/docs/MergeJobStatusResult.md

@@ -0,0 +1,12 @@
+# CloudmersiveConvertApiClient::MergeJobStatusResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation to check the status of the job was successful, false otherwise | [optional] 
+**async_job_status** | **String** | Returns the job status of the Async Job, if applicable.  Possible states are STARTED and COMPLETED | [optional] 
+**async_job_id** | **String** | When the job exceeds 25 pages, an Async Job ID is returned.  Use the CheckPdfOcrJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes | [optional] 
+**file_output_result** | **String** | Resulting file output (if applicable) | [optional] 
+**error_message** | **String** | Error message (if any) | [optional] 
+
+

data/docs/PdfMetadata.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**error_details** | **String** | Details of any errors if the operation was unsucessful | [optional] 
 **title** | **String** | Title of the document | [optional] 
 **keywords** | **String** | Keywords of the document | [optional] 
 **subject** | **String** | Subject of the document | [optional] 
@@ -12,5 +13,6 @@ Name | Type | Description | Notes
 **date_modified** | **DateTime** | The timestamp that the document was last modified, if available, null if not available | [optional] 
 **date_created** | **DateTime** | The timestamp that the document was created, if available, null if not available | [optional] 
 **page_count** | **Integer** | The number of pages in the document | [optional] 
+**encrypted** | **BOOLEAN** | True if the PDF document is encrypted, false otherwise | [optional] 
 
 

data/docs/PdfToPngDirectResult.md

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

data/docs/PptxPageLayoutInformation.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::PptxPageLayoutInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**orientation** | **String** | Orientation of the presentation, either portrait or landscape | [optional] 
+**width** | **Integer** | Width of the presentation in Emu, where 1 inch equals 914400 emu. | [optional] 
+**height** | **Integer** | Height of the presentation in Emu, where 1 inch equals 914400 emu. | [optional] 
+
+

data/docs/PptxSplitAdvancedRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::PptxSplitAdvancedRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file** | **String** | Input file | [optional] 
+**slides_per_presentation** | **Integer** | Slides per presentation for result | [optional] 
+
+

data/docs/PptxSplitAdvancedResponse.md

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

data/docs/PresentationAdvancedResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::PresentationAdvancedResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**slide_number** | **Integer** | Presentation number of the converted page, starting with 1 for the left-most worksheet | [optional] 
+**presentation_contents** | **String** | Contents of the presentation in bytes | [optional] 
+
+

data/docs/SplitBatchJobCreateResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::SplitBatchJobCreateResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**async_job_id** | **String** | When creating a job, an Async Job ID is returned.  Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes | [optional] 
+
+