cloudmersive-convert-api-client 1.7.7 → 2.0.4

data/docs/ViewerResponse.md

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

data/docs/ViewerToolsApi.md

@@ -1,63 +0,0 @@
-# CloudmersiveConvertApiClient::ViewerToolsApi
-
-All URIs are relative to *https://api.cloudmersive.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**viewer_tools_create_simple**](ViewerToolsApi.md#viewer_tools_create_simple) | **POST** /convert/viewer/create/web/simple | Create a web-based viewer
-
-
-# **viewer_tools_create_simple**
-> ViewerResponse viewer_tools_create_simple(input_file)
-
-Create a web-based viewer
-
-Creates an HTML embed code for a simple web-based viewer of a document; supports Office document types and PDF.
-
-### 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::ViewerToolsApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Create a web-based viewer
-  result = api_instance.viewer_tools_create_simple(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ViewerToolsApi->viewer_tools_create_simple: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**ViewerResponse**](ViewerResponse.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-

data/docs/WorksheetResult.md

@@ -1,11 +0,0 @@
-# CloudmersiveConvertApiClient::WorksheetResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**worksheet_number** | **Integer** | Worksheet number of the converted page, starting with 1 for the left-most worksheet | [optional] 
-**worksheet_name** | **String** | The name of the worksheet | [optional] 
-**url** | **String** | URL to the XLSX file of this worksheet; file is stored in an in-memory cache and will be deleted | [optional] 
-**worksheet_contents** | **String** | Contents of the worksheet in bytes | [optional] 
-
-

data/docs/XlsxImage.md

@@ -1,12 +0,0 @@
-# CloudmersiveConvertApiClient::XlsxImage
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**path** | **String** | The Path of the location of this object; leave blank for new rows | [optional] 
-**image_data_embed_id** | **String** | Read-only; internal ID for the image contents | [optional] 
-**image_data_content_type** | **String** | Read-only; image data MIME content-type | [optional] 
-**image_internal_file_name** | **String** | Read-only; internal file name/path for the image | [optional] 
-**image_contents_url** | **String** | URL to the image contents; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the contents. | [optional] 
-
-

data/docs/XlsxSpreadsheetCell.md

@@ -1,12 +0,0 @@
-# CloudmersiveConvertApiClient::XlsxSpreadsheetCell
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**path** | **String** | The Path of the location of this object; leave blank for new rows | [optional] 
-**text_value** | **String** | Text value of the cell | [optional] 
-**cell_identifier** | **String** | Cell reference of the cell, e.g. A1, Z22, etc. | [optional] 
-**style_index** | **Integer** | Identifier for the style to apply to this style | [optional] 
-**formula** | **String** |  | [optional] 
-
-

data/docs/XlsxSpreadsheetColumn.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::XlsxSpreadsheetColumn
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**path** | **String** | The Path of the location of this object; leave blank for new rows | [optional] 
-**heading_cell** | [**XlsxSpreadsheetCell**](XlsxSpreadsheetCell.md) | Heading cell for this column | [optional] 
-
-

data/docs/XlsxSpreadsheetRow.md

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::XlsxSpreadsheetRow
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**path** | **String** | The Path of the location of this object; leave blank for new rows | [optional] 
-**cells** | [**Array<XlsxSpreadsheetCell>**](XlsxSpreadsheetCell.md) | Spreadsheet Cells in the spreadsheet row | [optional] 
-
-

data/docs/XlsxToPngResult.md

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

@@ -1,9 +0,0 @@
-# CloudmersiveConvertApiClient::XlsxWorksheet
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**path** | **String** | The Path of the location of this object; leave blank for new worksheets | [optional] 
-**worksheet_name** | **String** | User-facing name of the worksheet tab | [optional] 
-
-

data/docs/XmlAddAttributeWithXPathResult.md

@@ -1,10 +0,0 @@
-# CloudmersiveConvertApiClient::XmlAddAttributeWithXPathResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**resulting_xml_document** | **String** | Resulting, modified XML document | [optional] 
-**nodes_edited_count** | **Integer** | Count of the matching results | [optional] 
-
-

data/docs/XmlAddChildWithXPathResult.md

@@ -1,10 +0,0 @@
-# CloudmersiveConvertApiClient::XmlAddChildWithXPathResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**resulting_xml_document** | **String** | Resulting, modified XML document | [optional] 
-**nodes_edited_count** | **Integer** | Count of the matching results | [optional] 
-
-

data/docs/XmlFilterWithXPathResult.md

@@ -1,10 +0,0 @@
-# CloudmersiveConvertApiClient::XmlFilterWithXPathResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**xml_nodes** | **Array<String>** | Matching selected XML nodes as strings | [optional] 
-**result_count** | **Integer** | Count of the matching results | [optional] 
-
-

data/docs/XmlQueryWithXQueryMultiResult.md

@@ -1,10 +0,0 @@
-# CloudmersiveConvertApiClient::XmlQueryWithXQueryMultiResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**resulting_xml** | **String** | Resulting XML result output | [optional] 
-**error_message** | **String** | If an error occurs, additional details on the error | [optional] 
-
-

data/docs/XmlQueryWithXQueryResult.md

@@ -1,10 +0,0 @@
-# CloudmersiveConvertApiClient::XmlQueryWithXQueryResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**resulting_xml** | **String** | Resulting XML result output | [optional] 
-**error_message** | **String** | If an error occurs, additional details on the error | [optional] 
-
-

data/docs/XmlRemoveAllChildrenWithXPathResult.md

@@ -1,10 +0,0 @@
-# CloudmersiveConvertApiClient::XmlRemoveAllChildrenWithXPathResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**resulting_xml_document** | **String** | Resulting, modified XML document | [optional] 
-**nodes_edited_count** | **Integer** | Count of the matching results | [optional] 
-
-

data/docs/XmlRemoveWithXPathResult.md

@@ -1,11 +0,0 @@
-# CloudmersiveConvertApiClient::XmlRemoveWithXPathResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**resulting_xml_document** | **String** | Resulting, modified XML document with matching nodes removed as a string | [optional] 
-**xml_nodes_removed** | **Array<String>** | Matching selected XML nodes as strings | [optional] 
-**nodes_removed_count** | **Integer** | Count of the matching results | [optional] 
-
-

data/docs/XmlReplaceWithXPathResult.md

@@ -1,10 +0,0 @@
-# CloudmersiveConvertApiClient::XmlReplaceWithXPathResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**resulting_xml_document** | **String** | Resulting, modified XML document | [optional] 
-**nodes_edited_count** | **Integer** | Count of the matching results | [optional] 
-
-

data/docs/XmlSetValueWithXPathResult.md

@@ -1,10 +0,0 @@
-# CloudmersiveConvertApiClient::XmlSetValueWithXPathResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
-**resulting_xml_document** | **String** | Resulting, modified XML document | [optional] 
-**nodes_edited_count** | **Integer** | Count of the matching results | [optional] 
-
-

data/docs/ZipArchiveApi.md

@@ -1,306 +0,0 @@
-# CloudmersiveConvertApiClient::ZipArchiveApi
-
-All URIs are relative to *https://api.cloudmersive.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**zip_archive_zip_create**](ZipArchiveApi.md#zip_archive_zip_create) | **POST** /convert/archive/zip/create | Compress files to create a new zip archive
-[**zip_archive_zip_create_advanced**](ZipArchiveApi.md#zip_archive_zip_create_advanced) | **POST** /convert/archive/zip/create/advanced | Compress files and folders to create a new zip archive with advanced options
-[**zip_archive_zip_decrypt**](ZipArchiveApi.md#zip_archive_zip_decrypt) | **POST** /convert/archive/zip/decrypt | Decrypt and remove password protection on a zip file
-[**zip_archive_zip_encrypt_advanced**](ZipArchiveApi.md#zip_archive_zip_encrypt_advanced) | **POST** /convert/archive/zip/encrypt/advanced | Encrypt and password protect a zip file
-[**zip_archive_zip_extract**](ZipArchiveApi.md#zip_archive_zip_extract) | **POST** /convert/archive/zip/extract | Extract, decompress files and folders from a zip archive
-
-
-# **zip_archive_zip_create**
-> String zip_archive_zip_create(input_file1, opts)
-
-Compress files to create a new zip archive
-
-Create a new zip archive by compressing input files.
-
-### 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::ZipArchiveApi.new
-
-input_file1 = File.new("/path/to/file.txt") # File | First input file to perform the operation on.
-
-opts = { 
-  input_file2: File.new("/path/to/file.txt"), # File | Second input file to perform the operation on.
-  input_file3: File.new("/path/to/file.txt"), # File | Third input file to perform the operation on.
-  input_file4: File.new("/path/to/file.txt"), # File | Fourth input file to perform the operation on.
-  input_file5: File.new("/path/to/file.txt"), # File | Fifth input file to perform the operation on.
-  input_file6: File.new("/path/to/file.txt"), # File | Sixth input file to perform the operation on.
-  input_file7: File.new("/path/to/file.txt"), # File | Seventh input file to perform the operation on.
-  input_file8: File.new("/path/to/file.txt"), # File | Eighth input file to perform the operation on.
-  input_file9: File.new("/path/to/file.txt"), # File | Ninth input file to perform the operation on.
-  input_file10: File.new("/path/to/file.txt") # File | Tenth input file to perform the operation on.
-}
-
-begin
-  #Compress files to create a new zip archive
-  result = api_instance.zip_archive_zip_create(input_file1, opts)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ZipArchiveApi->zip_archive_zip_create: #{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. | [optional] 
- **input_file3** | **File**| Third input file to perform the operation on. | [optional] 
- **input_file4** | **File**| Fourth input file to perform the operation on. | [optional] 
- **input_file5** | **File**| Fifth input file to perform the operation on. | [optional] 
- **input_file6** | **File**| Sixth input file to perform the operation on. | [optional] 
- **input_file7** | **File**| Seventh input file to perform the operation on. | [optional] 
- **input_file8** | **File**| Eighth input file to perform the operation on. | [optional] 
- **input_file9** | **File**| Ninth input file to perform the operation on. | [optional] 
- **input_file10** | **File**| Tenth input file to perform the operation on. | [optional] 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/octet-stream
-
-
-
-# **zip_archive_zip_create_advanced**
-> Object zip_archive_zip_create_advanced(request)
-
-Compress files and folders to create a new zip archive with advanced options
-
-Create a new zip archive by compressing input files, folders and leverage advanced options to control the structure of the resulting zip archive.
-
-### 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::ZipArchiveApi.new
-
-request = CloudmersiveConvertApiClient::CreateZipArchiveRequest.new # CreateZipArchiveRequest | Input request
-
-
-begin
-  #Compress files and folders to create a new zip archive with advanced options
-  result = api_instance.zip_archive_zip_create_advanced(request)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ZipArchiveApi->zip_archive_zip_create_advanced: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **request** | [**CreateZipArchiveRequest**](CreateZipArchiveRequest.md)| Input request | 
-
-### 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
-
-
-
-# **zip_archive_zip_decrypt**
-> Object zip_archive_zip_decrypt(input_file, zip_password)
-
-Decrypt and remove password protection on a zip file
-
-Decrypts and removes password protection from an encrypted zip file with the specified password
-
-### 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::ZipArchiveApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-zip_password = "zip_password_example" # String | Required; Password for the input archive
-
-
-begin
-  #Decrypt and remove password protection on a zip file
-  result = api_instance.zip_archive_zip_decrypt(input_file, zip_password)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ZipArchiveApi->zip_archive_zip_decrypt: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
- **zip_password** | **String**| Required; Password for the input archive | 
-
-### Return type
-
-**Object**
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **zip_archive_zip_encrypt_advanced**
-> Object zip_archive_zip_encrypt_advanced(encryption_request)
-
-Encrypt and password protect a zip file
-
-Encrypts and password protects an existing zip file with the specified password and encryption algorithm
-
-### 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::ZipArchiveApi.new
-
-encryption_request = CloudmersiveConvertApiClient::ZipEncryptionAdvancedRequest.new # ZipEncryptionAdvancedRequest | Encryption request
-
-
-begin
-  #Encrypt and password protect a zip file
-  result = api_instance.zip_archive_zip_encrypt_advanced(encryption_request)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ZipArchiveApi->zip_archive_zip_encrypt_advanced: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **encryption_request** | [**ZipEncryptionAdvancedRequest**](ZipEncryptionAdvancedRequest.md)| Encryption request | 
-
-### 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/json, text/json, application/xml, text/xml
-
-
-
-# **zip_archive_zip_extract**
-> ZipExtractResponse zip_archive_zip_extract(input_file)
-
-Extract, decompress files and folders from a zip archive
-
-Extracts a zip archive by decompressing files, and folders.
-
-### 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::ZipArchiveApi.new
-
-input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
-
-
-begin
-  #Extract, decompress files and folders from a zip archive
-  result = api_instance.zip_archive_zip_extract(input_file)
-  p result
-rescue CloudmersiveConvertApiClient::ApiError => e
-  puts "Exception when calling ZipArchiveApi->zip_archive_zip_extract: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input_file** | **File**| Input file to perform the operation on. | 
-
-### Return type
-
-[**ZipExtractResponse**](ZipExtractResponse.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-