cloudmersive-convert-api-client 2.1.1 → 2.1.6

data/docs/EditHtmlApi.md

@@ -9,6 +9,7 @@ Method | HTTP request | Description
 [**edit_html_html_append_image_inline**](EditHtmlApi.md#edit_html_html_append_image_inline) | **POST** /convert/edit/html/append/image/inline | Append a Base64 Inline Image to an HTML Document
 [**edit_html_html_append_paragraph**](EditHtmlApi.md#edit_html_html_append_paragraph) | **POST** /convert/edit/html/append/paragraph | Append a Paragraph to an HTML Document
 [**edit_html_html_create_blank_document**](EditHtmlApi.md#edit_html_html_create_blank_document) | **POST** /convert/edit/html/create/blank | Create a Blank HTML Document
+[**edit_html_html_get_links**](EditHtmlApi.md#edit_html_html_get_links) | **POST** /convert/edit/html/extract/links | Extract resolved link URLs from HTML File
 
 
 # **edit_html_html_append_heading**
@@ -327,3 +328,62 @@ Name | Type | Description  | Notes
 
 
 
+# **edit_html_html_get_links**
+> HtmlGetLinksResponse edit_html_html_get_links(opts)
+
+Extract resolved link URLs from HTML File
+
+Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
+
+### 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::EditHtmlApi.new
+
+opts = { 
+  input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
+  input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input.
+  base_url: 'base_url_example' # String | Optional: Base URL of the page, such as https://mydomain.com
+}
+
+begin
+  #Extract resolved link URLs from HTML File
+  result = api_instance.edit_html_html_get_links(opts)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling EditHtmlApi->edit_html_html_get_links: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Optional: Input file to perform the operation on. | [optional] 
+ **input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional] 
+ **base_url** | **String**| Optional: Base URL of the page, such as https://mydomain.com | [optional] 
+
+### Return type
+
+[**HtmlGetLinksResponse**](HtmlGetLinksResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/GetDocxMetadataPropertiesResponse.md

@@ -0,0 +1,16 @@
+# CloudmersiveConvertApiClient::GetDocxMetadataPropertiesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**company** | **String** | Name of the Company that authored the document, if available | [optional] 
+**manager** | **String** | Name of the Manager that authored the document, if available | [optional] 
+**application_version** | **String** | Application version that authored the document, if available | [optional] 
+**word_count** | **Integer** | Word count of the document | [optional] 
+**line_count** | **Integer** | Line count of the document | [optional] 
+**paragraph_count** | **Integer** | Paragraph count of the document | [optional] 
+**page_count** | **Integer** | Page count of the document | [optional] 
+**custom_properties** | [**Array<DocxMetadataCustomProperty>**](DocxMetadataCustomProperty.md) | Custom properties applied to the document | [optional] 
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+
+

data/docs/GetMacrosResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetMacrosResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**contains_vba_macros** | **BOOLEAN** | True if the document contains VBA macros, false otherwise | [optional] 
+
+

data/docs/HtmlGetLinksResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::HtmlGetLinksResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**links** | [**Array<HtmlHyperlink>**](HtmlHyperlink.md) | All hyperlinks in the HTML document | [optional] 
+
+

data/docs/HtmlHyperlink.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::HtmlHyperlink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**anchortext** | **String** | Anchor text of the hyperlink, e.g. Click Here | [optional] 
+**url** | **String** | URL of the hyperlink; fully-qualified if possible, otherwise relative | [optional] 
+
+

data/docs/HtmlSsrfThreatCheckResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::HtmlSsrfThreatCheckResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_valid** | **BOOLEAN** | True if the document is valid and has no errors, false otherwise | [optional] 
+**is_threat** | **BOOLEAN** | True if the document contains an SSRF threat, false otherwise | [optional] 
+**threat_links** | [**Array<HtmlThreatLink>**](HtmlThreatLink.md) | Links found in the input HTML that contains threats | [optional] 
+
+

data/docs/HtmlThreatLink.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::HtmlThreatLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**link_url** | **String** | URL of the link | [optional] 
+**threat_level** | **String** | Threat assessment level; possible values are None, Low, Medium and High | [optional] 
+
+

data/docs/MergeDocumentApi.md

@@ -6,6 +6,8 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**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_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_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_png**](MergeDocumentApi.md#merge_document_png) | **POST** /convert/merge/png/vertical | Merge Two PNG Files Together
@@ -150,6 +152,138 @@ Name | Type | Description  | Notes
 
 
 
+# **merge_document_html**
+> Object merge_document_html(input_file1, input_file2)
+
+Merge Two HTML (HTM) Files Together
+
+Combine two HTML (.HTM) files 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_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 Two HTML (HTM) Files Together
+  result = api_instance.merge_document_html(input_file1, input_file2)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_html: #{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
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/octet-stream
+
+
+
+# **merge_document_html_multi**
+> String merge_document_html_multi(input_file1, input_file2, opts)
+
+Merge Multple HTML (HTM) Files Together
+
+Combine multiple HTML (.HTM) files 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_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.
+
+opts = { 
+  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
+  #Merge Multple HTML (HTM) Files Together
+  result = api_instance.merge_document_html_multi(input_file1, input_file2, opts)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_html_multi: #{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. | 
+ **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
+
+
+
 # **merge_document_pdf**
 > String merge_document_pdf(input_file1, input_file2)
 

data/docs/ValidateDocumentApi.md

@@ -10,14 +10,18 @@ Method | HTTP request | Description
 [**validate_document_eml_validation**](ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
 [**validate_document_executable_validation**](ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
 [**validate_document_g_zip_validation**](ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)
+[**validate_document_html_ssrf_validation**](ValidateDocumentApi.md#validate_document_html_ssrf_validation) | **POST** /convert/validate/html/ssrf-threat-check | Validate an HTML file and checks for SSRF threats
 [**validate_document_html_validation**](ValidateDocumentApi.md#validate_document_html_validation) | **POST** /convert/validate/html | Validate an HTML file
 [**validate_document_image_validation**](ValidateDocumentApi.md#validate_document_image_validation) | **POST** /convert/validate/image | Validate an Image File
+[**validate_document_jpg_validation**](ValidateDocumentApi.md#validate_document_jpg_validation) | **POST** /convert/validate/jpg | Validate a JPG File
 [**validate_document_json_validation**](ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
 [**validate_document_msg_validation**](ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
 [**validate_document_pdf_validation**](ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
+[**validate_document_png_validation**](ValidateDocumentApi.md#validate_document_png_validation) | **POST** /convert/validate/png | Validate a PNG File
 [**validate_document_pptx_validation**](ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
 [**validate_document_rar_validation**](ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
 [**validate_document_tar_validation**](ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
+[**validate_document_txt_validation**](ValidateDocumentApi.md#validate_document_txt_validation) | **POST** /convert/validate/txt | Validate an TXT file
 [**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_zip_validation**](ValidateDocumentApi.md#validate_document_zip_validation) | **POST** /convert/validate/zip | Validate a Zip Archive file (zip)
@@ -347,6 +351,60 @@ Name | Type | Description  | Notes
 
 
 
+# **validate_document_html_ssrf_validation**
+> HtmlSsrfThreatCheckResult validate_document_html_ssrf_validation(input_file)
+
+Validate an HTML file and checks for SSRF threats
+
+Validate an HTML document file and checks for SSRF (Server-side Request Forgery) threats in the 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 HTML file and checks for SSRF threats
+  result = api_instance.validate_document_html_ssrf_validation(input_file)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling ValidateDocumentApi->validate_document_html_ssrf_validation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+
+### Return type
+
+[**HtmlSsrfThreatCheckResult**](HtmlSsrfThreatCheckResult.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_html_validation**
 > DocumentValidationResult validate_document_html_validation(input_file)
 
@@ -455,6 +513,60 @@ Name | Type | Description  | Notes
 
 
 
+# **validate_document_jpg_validation**
+> DocumentValidationResult validate_document_jpg_validation(input_file)
+
+Validate a JPG File
+
+Validate a JPEG image 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 JPG File
+  result = api_instance.validate_document_jpg_validation(input_file)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling ValidateDocumentApi->validate_document_jpg_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)
 
@@ -617,6 +729,60 @@ Name | Type | Description  | Notes
 
 
 
+# **validate_document_png_validation**
+> DocumentValidationResult validate_document_png_validation(input_file)
+
+Validate a PNG File
+
+Validate a PNG image 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 PNG File
+  result = api_instance.validate_document_png_validation(input_file)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling ValidateDocumentApi->validate_document_png_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)
 
@@ -779,6 +945,60 @@ Name | Type | Description  | Notes
 
 
 
+# **validate_document_txt_validation**
+> DocumentValidationResult validate_document_txt_validation(input_file)
+
+Validate an TXT file
+
+Validate an TXT 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 TXT file
+  result = api_instance.validate_document_txt_validation(input_file)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling ValidateDocumentApi->validate_document_txt_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)