cloudmersive-validate-api-client 2.1.4 → 2.2.0

data/docs/IPIntelligenceResponse.md

@@ -0,0 +1,16 @@
+# CloudmersiveValidateApiClient::IPIntelligenceResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_bot** | **BOOLEAN** | True if the IP address is a known bot, otherwise false | [optional] 
+**is_tor_node** | **BOOLEAN** | True if the IP address is a known Tor exit node, otherwise false | [optional] 
+**is_threat** | **BOOLEAN** | True if the IP address is a known threat IP, otherwise false | [optional] 
+**is_eu** | **BOOLEAN** | True if the IP address is in the European Union, otherwise false | [optional] 
+**location** | [**GeolocateResponse**](GeolocateResponse.md) | Returns the location of the IP address | [optional] 
+**currency_code** | **String** | ISO 4217 currency code for the IP address location | [optional] 
+**currency_name** | **String** | Name of the currency in English | [optional] 
+**region_area** | **String** | Region (continent) in which the country is located; possible values are None, Europe, Americas, Asia, Africa, Oceania | [optional] 
+**subregion_area** | **String** | Subregion in which the country is located; possible values are None, NorthernEurope, WesternEurope, SouthernEurope, EasternEurope, CentralAmerica, NorthernAmerica, SouthAmerica, EasternAfrica, MiddleAfrica, NorthernAfrica , SouthernAfrica , WesternAfrica , CentralAsia , EasternAsia , SouthernAsia , SouthEasternAsia , WesternAsia , Southern , Middle , AustraliaandNewZealand , Melanesia , Polynesia , Micronesia , Caribbean, | [optional] 
+
+

data/docs/PhishingCheckRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::PhishingCheckRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL to validate | [optional] 
+
+

data/docs/PhishingCheckResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::PhishingCheckResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_url** | **BOOLEAN** | True if the URL is clean, false if it is at risk of containing a Phishing threat or attack | [optional] 
+**threat_type** | **String** | Threat type of the Phishing threat; possible values are VerifiedPhishingURL, UnverifiedPhishingURL, or VerifiedPhishingDomain | [optional] 
+
+

data/docs/SqlInjectionCheckBatchRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_items** | [**Array<SqlInjectionCheckRequestItem>**](SqlInjectionCheckRequestItem.md) | Multiple items to detect for SQL Injection | [optional] 
+**detection_level** | **String** | Set to Normal to target a high-security SQL Injection detection level with a very low false positive rate; select High to target a very-high security SQL Injection detection level with higher false positives.  Default is Normal (recommended). | [optional] 
+
+

data/docs/SqlInjectionCheckBatchResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::SqlInjectionCheckBatchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result_items** | [**Array<SqlInjectionDetectionResult>**](SqlInjectionDetectionResult.md) | Results from performing a batch SQL Injection detection operation; order is preserved from input data | [optional] 
+
+

data/docs/SqlInjectionCheckRequestItem.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::SqlInjectionCheckRequestItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_text** | **String** | Individual input text item to check for SQL Injection | [optional] 
+
+

data/docs/SqlInjectionDetectionResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveValidateApiClient::SqlInjectionDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**contained_sql_injection_attack** | **BOOLEAN** | True if the input contained SQL Injection attacks, false otherwise | [optional] 
+**original_input** | **String** | Original input string | [optional] 
+
+

data/docs/TextInputApi.md

@@ -4,11 +4,127 @@ All URIs are relative to *https://api.cloudmersive.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**text_input_check_sql_injection**](TextInputApi.md#text_input_check_sql_injection) | **POST** /validate/text-input/check/sql-injection | Check text input for SQL Injection (SQLI) attacks
+[**text_input_check_sql_injection_batch**](TextInputApi.md#text_input_check_sql_injection_batch) | **POST** /validate/text-input/check/sql-injection/batch | Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
 [**text_input_check_xss**](TextInputApi.md#text_input_check_xss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
 [**text_input_check_xss_batch**](TextInputApi.md#text_input_check_xss_batch) | **POST** /validate/text-input/check-and-protect/xss/batch | Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
+[**text_input_check_xxe**](TextInputApi.md#text_input_check_xxe) | **POST** /validate/text-input/check/xxe | Protect text input from XML External Entity (XXE) attacks
+[**text_input_check_xxe_batch**](TextInputApi.md#text_input_check_xxe_batch) | **POST** /validate/text-input/check/xxe/batch | Protect text input from XML External Entity (XXE) attacks
 [**text_input_protect_xss**](TextInputApi.md#text_input_protect_xss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
 
 
+# **text_input_check_sql_injection**
+> SqlInjectionDetectionResult text_input_check_sql_injection(value, opts)
+
+Check text input for SQL Injection (SQLI) attacks
+
+Detects SQL Injection (SQLI) attacks from text input.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.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 = CloudmersiveValidateApiClient::TextInputApi.new
+
+value = 'value_example' # String | User-facing text input.
+
+opts = { 
+  detection_level: 'detection_level_example' # String | Set to Normal to target a high-security SQL Injection detection level with a very low false positive rate; select High to target a very-high security SQL Injection detection level with higher false positives.  Default is Normal (recommended).
+}
+
+begin
+  #Check text input for SQL Injection (SQLI) attacks
+  result = api_instance.text_input_check_sql_injection(value, opts)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling TextInputApi->text_input_check_sql_injection: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| User-facing text input. | 
+ **detection_level** | **String**| Set to Normal to target a high-security SQL Injection detection level with a very low false positive rate; select High to target a very-high security SQL Injection detection level with higher false positives.  Default is Normal (recommended). | [optional] 
+
+### Return type
+
+[**SqlInjectionDetectionResult**](SqlInjectionDetectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **text_input_check_sql_injection_batch**
+> SqlInjectionCheckBatchResponse text_input_check_sql_injection_batch(value)
+
+Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
+
+Detects SQL Injection (SQLI) attacks from multiple text inputs.  Output preverses order of input items.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.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 = CloudmersiveValidateApiClient::TextInputApi.new
+
+value = CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest.new # SqlInjectionCheckBatchRequest | User-facing text input.
+
+
+begin
+  #Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
+  result = api_instance.text_input_check_sql_injection_batch(value)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling TextInputApi->text_input_check_sql_injection_batch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | [**SqlInjectionCheckBatchRequest**](SqlInjectionCheckBatchRequest.md)| User-facing text input. | 
+
+### Return type
+
+[**SqlInjectionCheckBatchResponse**](SqlInjectionCheckBatchResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **text_input_check_xss**
 > XssProtectionResult text_input_check_xss(value)
 
@@ -68,7 +184,7 @@ Name | Type | Description  | Notes
 
 Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
 
-Detects XSS (Cross-Site-Scripting) attacks from multiple text input.  Output preverses order of input items.
+Detects XSS (Cross-Site-Scripting) attacks from multiple text inputs.  Output preverses order of input items.
 
 ### Example
 ```ruby
@@ -117,6 +233,122 @@ Name | Type | Description  | Notes
 
 
 
+# **text_input_check_xxe**
+> XxeDetectionResult text_input_check_xxe(value, opts)
+
+Protect text input from XML External Entity (XXE) attacks
+
+Detects XXE (XML External Entity) attacks from text input.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.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 = CloudmersiveValidateApiClient::TextInputApi.new
+
+value = 'value_example' # String | User-facing text input.
+
+opts = { 
+  allow_internet_urls: true, # BOOLEAN | Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block.  Default is false.
+  known_safe_urls: 'known_safe_urls_example', # String | Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe.
+  known_unsafe_urls: 'known_unsafe_urls_example' # String | Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe.
+}
+
+begin
+  #Protect text input from XML External Entity (XXE) attacks
+  result = api_instance.text_input_check_xxe(value, opts)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling TextInputApi->text_input_check_xxe: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| User-facing text input. | 
+ **allow_internet_urls** | **BOOLEAN**| Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block.  Default is false. | [optional] 
+ **known_safe_urls** | **String**| Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe. | [optional] 
+ **known_unsafe_urls** | **String**| Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe. | [optional] 
+
+### Return type
+
+[**XxeDetectionResult**](XxeDetectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **text_input_check_xxe_batch**
+> XxeDetectionBatchResponse text_input_check_xxe_batch(request)
+
+Protect text input from XML External Entity (XXE) attacks
+
+Detects XXE (XML External Entity) attacks from text input.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.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 = CloudmersiveValidateApiClient::TextInputApi.new
+
+request = CloudmersiveValidateApiClient::XxeDetectionBatchRequest.new # XxeDetectionBatchRequest | 
+
+
+begin
+  #Protect text input from XML External Entity (XXE) attacks
+  result = api_instance.text_input_check_xxe_batch(request)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling TextInputApi->text_input_check_xxe_batch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**XxeDetectionBatchRequest**](XxeDetectionBatchRequest.md)|  | 
+
+### Return type
+
+[**XxeDetectionBatchResponse**](XxeDetectionBatchResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **text_input_protect_xss**
 > XssProtectionResult text_input_protect_xss(value)
 

data/docs/UrlSafetyCheckRequestFull.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::UrlSafetyCheckRequestFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL to validate | [optional] 
+
+

data/docs/UrlSafetyCheckResponseFull.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::UrlSafetyCheckResponseFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_url** | **BOOLEAN** | True if the URL is clean, false if it is at risk of containing a safety threat or attack | [optional] 
+**threat_type** | **String** | Threat type identified, if any; possible values are \"ForcedDownload\", \"VirusesAndMalware\", \"Phishing\" | [optional] 
+
+

data/docs/UrlSsrfRequestBatch.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::UrlSsrfRequestBatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_items** | [**Array<UrlSsrfRequestFull>**](UrlSsrfRequestFull.md) | Input URLs to check for SSRF threats | [optional] 
+
+

data/docs/UrlSsrfRequestFull.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::UrlSsrfRequestFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL to validate | [optional] 
+**blocked_domains** | **Array<String>** | Top level domains that you do not want to allow access to, e.g. mydomain.com - will block all subdomains as well | [optional] 
+
+

data/docs/UrlSsrfResponseBatch.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::UrlSsrfResponseBatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**output_items** | [**Array<UrlSsrfResponseFull>**](UrlSsrfResponseFull.md) | Results of the operation, with indexes matched to input values | [optional] 
+
+

data/docs/UrlSsrfResponseFull.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::UrlSsrfResponseFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_url** | **BOOLEAN** | True if the URL is clean, false if it is at risk of containing an SSRF threat or attack | [optional] 
+**threat_level** | **String** | Threat level of the URL; possible values are High, Medium, Low and None | [optional] 
+
+

data/docs/ValidateUrlResponseSyntaxOnly.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **valid_url** | **BOOLEAN** | True if the URL is valid, false otherwise | [optional] 
 **well_formed_url** | **String** | Well-formed version of the URL | [optional] 
+**top_level_domain_name** | **String** | The top-level domain name of the URL, e.g. mydomain.com | [optional] 
 
 

data/docs/XxeDetectionBatchRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::XxeDetectionBatchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_items** | [**Array<XxeDetectionRequestItem>**](XxeDetectionRequestItem.md) | Multiple items to protect for XXE | [optional] 
+
+

data/docs/XxeDetectionBatchResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::XxeDetectionBatchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result_items** | [**Array<XxeDetectionResult>**](XxeDetectionResult.md) | Results from performing a batch XSS protection operation | [optional] 
+
+

data/docs/XxeDetectionRequestItem.md

@@ -0,0 +1,11 @@
+# CloudmersiveValidateApiClient::XxeDetectionRequestItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_text** | **String** | Individual input text item to protect from XXE | [optional] 
+**allow_internet_urls** | **BOOLEAN** | Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block.  Default is false. | [optional] 
+**known_safe_urls** | **Array<String>** | Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe. | [optional] 
+**known_unsafe_urls** | **Array<String>** | Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe. | [optional] 
+
+

data/docs/XxeDetectionResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::XxeDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**contained_xxe** | **BOOLEAN** | True if the input contained XXE threats, false otherwise | [optional] 
+
+