cloudmersive-validate-api-client 2.1.3 → 2.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +29 -4
- data/docs/BotCheckResponse.md +8 -0
- data/docs/DomainApi.md +275 -0
- data/docs/IPAddressApi.md +165 -0
- data/docs/IPIntelligenceResponse.md +16 -0
- data/docs/IPReverseDNSLookupResponse.md +9 -0
- data/docs/PhishingCheckRequest.md +8 -0
- data/docs/PhishingCheckResponse.md +9 -0
- data/docs/SqlInjectionCheckBatchRequest.md +9 -0
- data/docs/SqlInjectionCheckBatchResponse.md +8 -0
- data/docs/SqlInjectionCheckRequestItem.md +8 -0
- data/docs/SqlInjectionDetectionResult.md +10 -0
- data/docs/TextInputApi.md +115 -1
- data/docs/UrlSafetyCheckRequestFull.md +8 -0
- data/docs/UrlSafetyCheckResponseFull.md +9 -0
- data/docs/UrlSsrfRequestBatch.md +8 -0
- data/docs/UrlSsrfRequestFull.md +9 -0
- data/docs/UrlSsrfResponseBatch.md +8 -0
- data/docs/UrlSsrfResponseFull.md +9 -0
- data/docs/ValidateUrlResponseSyntaxOnly.md +1 -0
- data/lib/cloudmersive-validate-api-client.rb +15 -0
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +270 -0
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +162 -0
- data/lib/cloudmersive-validate-api-client/api/text_input_api.rb +113 -2
- data/lib/cloudmersive-validate-api-client/models/bot_check_response.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/ip_intelligence_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/ip_reverse_dns_lookup_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/phishing_check_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/phishing_check_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_request.rb +198 -0
- data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_response.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/sql_injection_check_request_item.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/sql_injection_detection_result.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/url_safety_check_request_full.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/url_safety_check_response_full.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/url_ssrf_request_batch.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/url_ssrf_request_full.rb +198 -0
- data/lib/cloudmersive-validate-api-client/models/url_ssrf_response_batch.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/url_ssrf_response_full.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +14 -4
- data/lib/cloudmersive-validate-api-client/version.rb +1 -1
- data/spec/api/domain_api_spec.rb +60 -0
- data/spec/api/ip_address_api_spec.rb +36 -0
- data/spec/api/text_input_api_spec.rb +26 -1
- data/spec/models/bot_check_response_spec.rb +41 -0
- data/spec/models/ip_intelligence_response_spec.rb +89 -0
- data/spec/models/ip_reverse_dns_lookup_response_spec.rb +47 -0
- data/spec/models/phishing_check_request_spec.rb +41 -0
- data/spec/models/phishing_check_response_spec.rb +47 -0
- data/spec/models/sql_injection_check_batch_request_spec.rb +47 -0
- data/spec/models/sql_injection_check_batch_response_spec.rb +41 -0
- data/spec/models/sql_injection_check_request_item_spec.rb +41 -0
- data/spec/models/sql_injection_detection_result_spec.rb +53 -0
- data/spec/models/url_safety_check_request_full_spec.rb +41 -0
- data/spec/models/url_safety_check_response_full_spec.rb +47 -0
- data/spec/models/url_ssrf_request_batch_spec.rb +41 -0
- data/spec/models/url_ssrf_request_full_spec.rb +47 -0
- data/spec/models/url_ssrf_response_batch_spec.rb +41 -0
- data/spec/models/url_ssrf_response_full_spec.rb +47 -0
- data/spec/models/validate_url_response_syntax_only_spec.rb +6 -0
- metadata +47 -2
@@ -0,0 +1,16 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::IPIntelligenceResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**is_bot** | **BOOLEAN** | True if the IP address is a known bot, otherwise false | [optional]
|
7
|
+
**is_tor_node** | **BOOLEAN** | True if the IP address is a known Tor exit node, otherwise false | [optional]
|
8
|
+
**is_threat** | **BOOLEAN** | True if the IP address is a known threat IP, otherwise false | [optional]
|
9
|
+
**is_eu** | **BOOLEAN** | True if the IP address is in the European Union, otherwise false | [optional]
|
10
|
+
**location** | [**GeolocateResponse**](GeolocateResponse.md) | Returns the location of the IP address | [optional]
|
11
|
+
**currency_code** | **String** | ISO 4217 currency code for the IP address location | [optional]
|
12
|
+
**currency_name** | **String** | Name of the currency in English | [optional]
|
13
|
+
**region_area** | **String** | Region (continent) in which the country is located; possible values are None, Europe, Americas, Asia, Africa, Oceania | [optional]
|
14
|
+
**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]
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::IPReverseDNSLookupResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if a domain was found, false otherwise | [optional]
|
7
|
+
**host_name** | **String** | Host name (fully-qualified) associated with the IP address, if any | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::PhishingCheckResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**clean_url** | **BOOLEAN** | True if the URL is clean, false if it is at risk of containing a Phishing threat or attack | [optional]
|
7
|
+
**threat_type** | **String** | Threat type of the Phishing threat; possible values are VerifiedPhishingURL, UnverifiedPhishingURL, or VerifiedPhishingDomain | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**request_items** | [**Array<SqlInjectionCheckRequestItem>**](SqlInjectionCheckRequestItem.md) | Multiple items to detect for SQL Injection | [optional]
|
7
|
+
**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]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::SqlInjectionCheckBatchResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**result_items** | [**Array<SqlInjectionDetectionResult>**](SqlInjectionDetectionResult.md) | Results from performing a batch SQL Injection detection operation; order is preserved from input data | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::SqlInjectionCheckRequestItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**input_text** | **String** | Individual input text item to check for SQL Injection | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::SqlInjectionDetectionResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**contained_sql_injection_attack** | **BOOLEAN** | True if the input contained SQL Injection attacks, false otherwise | [optional]
|
8
|
+
**original_input** | **String** | Original input string | [optional]
|
9
|
+
|
10
|
+
|
data/docs/TextInputApi.md
CHANGED
@@ -4,11 +4,125 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**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
|
8
|
+
[**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
|
7
9
|
[**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
|
8
10
|
[**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
|
9
11
|
[**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
|
10
12
|
|
11
13
|
|
14
|
+
# **text_input_check_sql_injection**
|
15
|
+
> SqlInjectionDetectionResult text_input_check_sql_injection(value, opts)
|
16
|
+
|
17
|
+
Check text input for SQL Injection (SQLI) attacks
|
18
|
+
|
19
|
+
Detects SQL Injection (SQLI) attacks from text input.
|
20
|
+
|
21
|
+
### Example
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'cloudmersive-validate-api-client'
|
25
|
+
# setup authorization
|
26
|
+
CloudmersiveValidateApiClient.configure do |config|
|
27
|
+
# Configure API key authorization: Apikey
|
28
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
29
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = CloudmersiveValidateApiClient::TextInputApi.new
|
34
|
+
|
35
|
+
value = 'value_example' # String | User-facing text input.
|
36
|
+
|
37
|
+
opts = {
|
38
|
+
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).
|
39
|
+
}
|
40
|
+
|
41
|
+
begin
|
42
|
+
#Check text input for SQL Injection (SQLI) attacks
|
43
|
+
result = api_instance.text_input_check_sql_injection(value, opts)
|
44
|
+
p result
|
45
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
46
|
+
puts "Exception when calling TextInputApi->text_input_check_sql_injection: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
### Parameters
|
51
|
+
|
52
|
+
Name | Type | Description | Notes
|
53
|
+
------------- | ------------- | ------------- | -------------
|
54
|
+
**value** | **String**| User-facing text input. |
|
55
|
+
**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]
|
56
|
+
|
57
|
+
### Return type
|
58
|
+
|
59
|
+
[**SqlInjectionDetectionResult**](SqlInjectionDetectionResult.md)
|
60
|
+
|
61
|
+
### Authorization
|
62
|
+
|
63
|
+
[Apikey](../README.md#Apikey)
|
64
|
+
|
65
|
+
### HTTP request headers
|
66
|
+
|
67
|
+
- **Content-Type**: application/json, text/json
|
68
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
# **text_input_check_sql_injection_batch**
|
73
|
+
> SqlInjectionCheckBatchResponse text_input_check_sql_injection_batch(value)
|
74
|
+
|
75
|
+
Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
|
76
|
+
|
77
|
+
Detects SQL Injection (SQLI) attacks from multiple text inputs. Output preverses order of input items.
|
78
|
+
|
79
|
+
### Example
|
80
|
+
```ruby
|
81
|
+
# load the gem
|
82
|
+
require 'cloudmersive-validate-api-client'
|
83
|
+
# setup authorization
|
84
|
+
CloudmersiveValidateApiClient.configure do |config|
|
85
|
+
# Configure API key authorization: Apikey
|
86
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
87
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
88
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
89
|
+
end
|
90
|
+
|
91
|
+
api_instance = CloudmersiveValidateApiClient::TextInputApi.new
|
92
|
+
|
93
|
+
value = CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest.new # SqlInjectionCheckBatchRequest | User-facing text input.
|
94
|
+
|
95
|
+
|
96
|
+
begin
|
97
|
+
#Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
|
98
|
+
result = api_instance.text_input_check_sql_injection_batch(value)
|
99
|
+
p result
|
100
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
101
|
+
puts "Exception when calling TextInputApi->text_input_check_sql_injection_batch: #{e}"
|
102
|
+
end
|
103
|
+
```
|
104
|
+
|
105
|
+
### Parameters
|
106
|
+
|
107
|
+
Name | Type | Description | Notes
|
108
|
+
------------- | ------------- | ------------- | -------------
|
109
|
+
**value** | [**SqlInjectionCheckBatchRequest**](SqlInjectionCheckBatchRequest.md)| User-facing text input. |
|
110
|
+
|
111
|
+
### Return type
|
112
|
+
|
113
|
+
[**SqlInjectionCheckBatchResponse**](SqlInjectionCheckBatchResponse.md)
|
114
|
+
|
115
|
+
### Authorization
|
116
|
+
|
117
|
+
[Apikey](../README.md#Apikey)
|
118
|
+
|
119
|
+
### HTTP request headers
|
120
|
+
|
121
|
+
- **Content-Type**: application/json, text/json
|
122
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
123
|
+
|
124
|
+
|
125
|
+
|
12
126
|
# **text_input_check_xss**
|
13
127
|
> XssProtectionResult text_input_check_xss(value)
|
14
128
|
|
@@ -68,7 +182,7 @@ Name | Type | Description | Notes
|
|
68
182
|
|
69
183
|
Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
|
70
184
|
|
71
|
-
Detects XSS (Cross-Site-Scripting) attacks from multiple text
|
185
|
+
Detects XSS (Cross-Site-Scripting) attacks from multiple text inputs. Output preverses order of input items.
|
72
186
|
|
73
187
|
### Example
|
74
188
|
```ruby
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::UrlSafetyCheckResponseFull
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**clean_url** | **BOOLEAN** | True if the URL is clean, false if it is at risk of containing a safety threat or attack | [optional]
|
7
|
+
**threat_type** | **String** | Threat type identified, if any; possible values are \"ForcedDownload\", \"VirusesAndMalware\", \"Phishing\" | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::UrlSsrfRequestBatch
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**input_items** | [**Array<UrlSsrfRequestFull>**](UrlSsrfRequestFull.md) | Input URLs to check for SSRF threats | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::UrlSsrfRequestFull
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**url** | **String** | URL to validate | [optional]
|
7
|
+
**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]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::UrlSsrfResponseBatch
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**output_items** | [**Array<UrlSsrfResponseFull>**](UrlSsrfResponseFull.md) | Results of the operation, with indexes matched to input values | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::UrlSsrfResponseFull
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**clean_url** | **BOOLEAN** | True if the URL is clean, false if it is at risk of containing an SSRF threat or attack | [optional]
|
7
|
+
**threat_level** | **String** | Threat level of the URL; possible values are High, Medium, Low and None | [optional]
|
8
|
+
|
9
|
+
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**valid_url** | **BOOLEAN** | True if the URL is valid, false otherwise | [optional]
|
7
7
|
**well_formed_url** | **String** | Well-formed version of the URL | [optional]
|
8
|
+
**top_level_domain_name** | **String** | The top-level domain name of the URL, e.g. mydomain.com | [optional]
|
8
9
|
|
9
10
|
|
@@ -19,6 +19,7 @@ require 'cloudmersive-validate-api-client/configuration'
|
|
19
19
|
# Models
|
20
20
|
require 'cloudmersive-validate-api-client/models/address_get_servers_response'
|
21
21
|
require 'cloudmersive-validate-api-client/models/address_verify_syntax_only_response'
|
22
|
+
require 'cloudmersive-validate-api-client/models/bot_check_response'
|
22
23
|
require 'cloudmersive-validate-api-client/models/check_response'
|
23
24
|
require 'cloudmersive-validate-api-client/models/country_details'
|
24
25
|
require 'cloudmersive-validate-api-client/models/country_list_result'
|
@@ -39,6 +40,8 @@ require 'cloudmersive-validate-api-client/models/get_gender_response'
|
|
39
40
|
require 'cloudmersive-validate-api-client/models/get_public_holidays_request'
|
40
41
|
require 'cloudmersive-validate-api-client/models/get_timezones_request'
|
41
42
|
require 'cloudmersive-validate-api-client/models/get_timezones_response'
|
43
|
+
require 'cloudmersive-validate-api-client/models/ip_intelligence_response'
|
44
|
+
require 'cloudmersive-validate-api-client/models/ip_reverse_dns_lookup_response'
|
42
45
|
require 'cloudmersive-validate-api-client/models/ip_threat_response'
|
43
46
|
require 'cloudmersive-validate-api-client/models/last_name_validation_request'
|
44
47
|
require 'cloudmersive-validate-api-client/models/last_name_validation_response'
|
@@ -47,14 +50,26 @@ require 'cloudmersive-validate-api-client/models/lead_enrichment_response'
|
|
47
50
|
require 'cloudmersive-validate-api-client/models/normalize_address_response'
|
48
51
|
require 'cloudmersive-validate-api-client/models/parse_address_request'
|
49
52
|
require 'cloudmersive-validate-api-client/models/parse_address_response'
|
53
|
+
require 'cloudmersive-validate-api-client/models/phishing_check_request'
|
54
|
+
require 'cloudmersive-validate-api-client/models/phishing_check_response'
|
50
55
|
require 'cloudmersive-validate-api-client/models/phone_number_validate_request'
|
51
56
|
require 'cloudmersive-validate-api-client/models/phone_number_validation_response'
|
52
57
|
require 'cloudmersive-validate-api-client/models/public_holiday_occurrence'
|
53
58
|
require 'cloudmersive-validate-api-client/models/public_holidays_response'
|
54
59
|
require 'cloudmersive-validate-api-client/models/reverse_geocode_address_request'
|
55
60
|
require 'cloudmersive-validate-api-client/models/reverse_geocode_address_response'
|
61
|
+
require 'cloudmersive-validate-api-client/models/sql_injection_check_batch_request'
|
62
|
+
require 'cloudmersive-validate-api-client/models/sql_injection_check_batch_response'
|
63
|
+
require 'cloudmersive-validate-api-client/models/sql_injection_check_request_item'
|
64
|
+
require 'cloudmersive-validate-api-client/models/sql_injection_detection_result'
|
56
65
|
require 'cloudmersive-validate-api-client/models/timezone'
|
57
66
|
require 'cloudmersive-validate-api-client/models/tor_node_response'
|
67
|
+
require 'cloudmersive-validate-api-client/models/url_safety_check_request_full'
|
68
|
+
require 'cloudmersive-validate-api-client/models/url_safety_check_response_full'
|
69
|
+
require 'cloudmersive-validate-api-client/models/url_ssrf_request_batch'
|
70
|
+
require 'cloudmersive-validate-api-client/models/url_ssrf_request_full'
|
71
|
+
require 'cloudmersive-validate-api-client/models/url_ssrf_response_batch'
|
72
|
+
require 'cloudmersive-validate-api-client/models/url_ssrf_response_full'
|
58
73
|
require 'cloudmersive-validate-api-client/models/user_agent_validate_request'
|
59
74
|
require 'cloudmersive-validate-api-client/models/user_agent_validate_response'
|
60
75
|
require 'cloudmersive-validate-api-client/models/validate_address_request'
|
@@ -73,6 +73,114 @@ module CloudmersiveValidateApiClient
|
|
73
73
|
end
|
74
74
|
return data, status_code, headers
|
75
75
|
end
|
76
|
+
# Get top-level domain name from URL
|
77
|
+
# Gets the top-level domain name from a URL, such as mydomain.com.
|
78
|
+
# @param request Input URL information
|
79
|
+
# @param [Hash] opts the optional parameters
|
80
|
+
# @return [ValidateUrlResponseSyntaxOnly]
|
81
|
+
def domain_get_top_level_domain_from_url(request, opts = {})
|
82
|
+
data, _status_code, _headers = domain_get_top_level_domain_from_url_with_http_info(request, opts)
|
83
|
+
data
|
84
|
+
end
|
85
|
+
|
86
|
+
# Get top-level domain name from URL
|
87
|
+
# Gets the top-level domain name from a URL, such as mydomain.com.
|
88
|
+
# @param request Input URL information
|
89
|
+
# @param [Hash] opts the optional parameters
|
90
|
+
# @return [Array<(ValidateUrlResponseSyntaxOnly, Fixnum, Hash)>] ValidateUrlResponseSyntaxOnly data, response status code and response headers
|
91
|
+
def domain_get_top_level_domain_from_url_with_http_info(request, opts = {})
|
92
|
+
if @api_client.config.debugging
|
93
|
+
@api_client.config.logger.debug 'Calling API: DomainApi.domain_get_top_level_domain_from_url ...'
|
94
|
+
end
|
95
|
+
# verify the required parameter 'request' is set
|
96
|
+
if @api_client.config.client_side_validation && request.nil?
|
97
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_get_top_level_domain_from_url"
|
98
|
+
end
|
99
|
+
# resource path
|
100
|
+
local_var_path = '/validate/domain/url/get-top-level-domain'
|
101
|
+
|
102
|
+
# query parameters
|
103
|
+
query_params = {}
|
104
|
+
|
105
|
+
# header parameters
|
106
|
+
header_params = {}
|
107
|
+
# HTTP header 'Accept' (if needed)
|
108
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
109
|
+
# HTTP header 'Content-Type'
|
110
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
|
111
|
+
|
112
|
+
# form parameters
|
113
|
+
form_params = {}
|
114
|
+
|
115
|
+
# http body (model)
|
116
|
+
post_body = @api_client.object_to_http_body(request)
|
117
|
+
auth_names = ['Apikey']
|
118
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
119
|
+
:header_params => header_params,
|
120
|
+
:query_params => query_params,
|
121
|
+
:form_params => form_params,
|
122
|
+
:body => post_body,
|
123
|
+
:auth_names => auth_names,
|
124
|
+
:return_type => 'ValidateUrlResponseSyntaxOnly')
|
125
|
+
if @api_client.config.debugging
|
126
|
+
@api_client.config.logger.debug "API called: DomainApi#domain_get_top_level_domain_from_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
127
|
+
end
|
128
|
+
return data, status_code, headers
|
129
|
+
end
|
130
|
+
# Check a URL for Phishing threats
|
131
|
+
# Checks if an input URL is at risk of being an Phishing (fake login page, or other page designed to collect information via social engineering) threat or attack.
|
132
|
+
# @param request Input URL request
|
133
|
+
# @param [Hash] opts the optional parameters
|
134
|
+
# @return [PhishingCheckResponse]
|
135
|
+
def domain_phishing_check(request, opts = {})
|
136
|
+
data, _status_code, _headers = domain_phishing_check_with_http_info(request, opts)
|
137
|
+
data
|
138
|
+
end
|
139
|
+
|
140
|
+
# Check a URL for Phishing threats
|
141
|
+
# Checks if an input URL is at risk of being an Phishing (fake login page, or other page designed to collect information via social engineering) threat or attack.
|
142
|
+
# @param request Input URL request
|
143
|
+
# @param [Hash] opts the optional parameters
|
144
|
+
# @return [Array<(PhishingCheckResponse, Fixnum, Hash)>] PhishingCheckResponse data, response status code and response headers
|
145
|
+
def domain_phishing_check_with_http_info(request, opts = {})
|
146
|
+
if @api_client.config.debugging
|
147
|
+
@api_client.config.logger.debug 'Calling API: DomainApi.domain_phishing_check ...'
|
148
|
+
end
|
149
|
+
# verify the required parameter 'request' is set
|
150
|
+
if @api_client.config.client_side_validation && request.nil?
|
151
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_phishing_check"
|
152
|
+
end
|
153
|
+
# resource path
|
154
|
+
local_var_path = '/validate/domain/url/phishing-threat-check'
|
155
|
+
|
156
|
+
# query parameters
|
157
|
+
query_params = {}
|
158
|
+
|
159
|
+
# header parameters
|
160
|
+
header_params = {}
|
161
|
+
# HTTP header 'Accept' (if needed)
|
162
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
163
|
+
# HTTP header 'Content-Type'
|
164
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
|
165
|
+
|
166
|
+
# form parameters
|
167
|
+
form_params = {}
|
168
|
+
|
169
|
+
# http body (model)
|
170
|
+
post_body = @api_client.object_to_http_body(request)
|
171
|
+
auth_names = ['Apikey']
|
172
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
173
|
+
:header_params => header_params,
|
174
|
+
:query_params => query_params,
|
175
|
+
:form_params => form_params,
|
176
|
+
:body => post_body,
|
177
|
+
:auth_names => auth_names,
|
178
|
+
:return_type => 'PhishingCheckResponse')
|
179
|
+
if @api_client.config.debugging
|
180
|
+
@api_client.config.logger.debug "API called: DomainApi#domain_phishing_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
181
|
+
end
|
182
|
+
return data, status_code, headers
|
183
|
+
end
|
76
184
|
# Get WHOIS information for a domain
|
77
185
|
# Validate whether a domain name exists, and also return the full WHOIS record for that domain name. WHOIS records include all the registration details of the domain name, such as information about the domain's owners.
|
78
186
|
# @param domain Domain name to check, for example \"cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes.
|
@@ -181,6 +289,168 @@ module CloudmersiveValidateApiClient
|
|
181
289
|
end
|
182
290
|
return data, status_code, headers
|
183
291
|
end
|
292
|
+
# Check a URL for safety threats
|
293
|
+
# Checks if an input URL is at risk of being a safety threat through malware, unwanted software, or social engineering threats.
|
294
|
+
# @param request Input URL request
|
295
|
+
# @param [Hash] opts the optional parameters
|
296
|
+
# @return [UrlSafetyCheckResponseFull]
|
297
|
+
def domain_safety_check(request, opts = {})
|
298
|
+
data, _status_code, _headers = domain_safety_check_with_http_info(request, opts)
|
299
|
+
data
|
300
|
+
end
|
301
|
+
|
302
|
+
# Check a URL for safety threats
|
303
|
+
# Checks if an input URL is at risk of being a safety threat through malware, unwanted software, or social engineering threats.
|
304
|
+
# @param request Input URL request
|
305
|
+
# @param [Hash] opts the optional parameters
|
306
|
+
# @return [Array<(UrlSafetyCheckResponseFull, Fixnum, Hash)>] UrlSafetyCheckResponseFull data, response status code and response headers
|
307
|
+
def domain_safety_check_with_http_info(request, opts = {})
|
308
|
+
if @api_client.config.debugging
|
309
|
+
@api_client.config.logger.debug 'Calling API: DomainApi.domain_safety_check ...'
|
310
|
+
end
|
311
|
+
# verify the required parameter 'request' is set
|
312
|
+
if @api_client.config.client_side_validation && request.nil?
|
313
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_safety_check"
|
314
|
+
end
|
315
|
+
# resource path
|
316
|
+
local_var_path = '/validate/domain/url/safety-threat-check'
|
317
|
+
|
318
|
+
# query parameters
|
319
|
+
query_params = {}
|
320
|
+
|
321
|
+
# header parameters
|
322
|
+
header_params = {}
|
323
|
+
# HTTP header 'Accept' (if needed)
|
324
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
325
|
+
# HTTP header 'Content-Type'
|
326
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
|
327
|
+
|
328
|
+
# form parameters
|
329
|
+
form_params = {}
|
330
|
+
|
331
|
+
# http body (model)
|
332
|
+
post_body = @api_client.object_to_http_body(request)
|
333
|
+
auth_names = ['Apikey']
|
334
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
335
|
+
:header_params => header_params,
|
336
|
+
:query_params => query_params,
|
337
|
+
:form_params => form_params,
|
338
|
+
:body => post_body,
|
339
|
+
:auth_names => auth_names,
|
340
|
+
:return_type => 'UrlSafetyCheckResponseFull')
|
341
|
+
if @api_client.config.debugging
|
342
|
+
@api_client.config.logger.debug "API called: DomainApi#domain_safety_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
343
|
+
end
|
344
|
+
return data, status_code, headers
|
345
|
+
end
|
346
|
+
# Check a URL for SSRF threats
|
347
|
+
# Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.
|
348
|
+
# @param request Input URL request
|
349
|
+
# @param [Hash] opts the optional parameters
|
350
|
+
# @return [UrlSsrfResponseFull]
|
351
|
+
def domain_ssrf_check(request, opts = {})
|
352
|
+
data, _status_code, _headers = domain_ssrf_check_with_http_info(request, opts)
|
353
|
+
data
|
354
|
+
end
|
355
|
+
|
356
|
+
# Check a URL for SSRF threats
|
357
|
+
# Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.
|
358
|
+
# @param request Input URL request
|
359
|
+
# @param [Hash] opts the optional parameters
|
360
|
+
# @return [Array<(UrlSsrfResponseFull, Fixnum, Hash)>] UrlSsrfResponseFull data, response status code and response headers
|
361
|
+
def domain_ssrf_check_with_http_info(request, opts = {})
|
362
|
+
if @api_client.config.debugging
|
363
|
+
@api_client.config.logger.debug 'Calling API: DomainApi.domain_ssrf_check ...'
|
364
|
+
end
|
365
|
+
# verify the required parameter 'request' is set
|
366
|
+
if @api_client.config.client_side_validation && request.nil?
|
367
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_ssrf_check"
|
368
|
+
end
|
369
|
+
# resource path
|
370
|
+
local_var_path = '/validate/domain/url/ssrf-threat-check'
|
371
|
+
|
372
|
+
# query parameters
|
373
|
+
query_params = {}
|
374
|
+
|
375
|
+
# header parameters
|
376
|
+
header_params = {}
|
377
|
+
# HTTP header 'Accept' (if needed)
|
378
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
379
|
+
# HTTP header 'Content-Type'
|
380
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
|
381
|
+
|
382
|
+
# form parameters
|
383
|
+
form_params = {}
|
384
|
+
|
385
|
+
# http body (model)
|
386
|
+
post_body = @api_client.object_to_http_body(request)
|
387
|
+
auth_names = ['Apikey']
|
388
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
389
|
+
:header_params => header_params,
|
390
|
+
:query_params => query_params,
|
391
|
+
:form_params => form_params,
|
392
|
+
:body => post_body,
|
393
|
+
:auth_names => auth_names,
|
394
|
+
:return_type => 'UrlSsrfResponseFull')
|
395
|
+
if @api_client.config.debugging
|
396
|
+
@api_client.config.logger.debug "API called: DomainApi#domain_ssrf_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
397
|
+
end
|
398
|
+
return data, status_code, headers
|
399
|
+
end
|
400
|
+
# Check a URL for SSRF threats in batches
|
401
|
+
# Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.
|
402
|
+
# @param request Input URL request as a batch of multiple URLs
|
403
|
+
# @param [Hash] opts the optional parameters
|
404
|
+
# @return [UrlSsrfResponseBatch]
|
405
|
+
def domain_ssrf_check_batch(request, opts = {})
|
406
|
+
data, _status_code, _headers = domain_ssrf_check_batch_with_http_info(request, opts)
|
407
|
+
data
|
408
|
+
end
|
409
|
+
|
410
|
+
# Check a URL for SSRF threats in batches
|
411
|
+
# Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.
|
412
|
+
# @param request Input URL request as a batch of multiple URLs
|
413
|
+
# @param [Hash] opts the optional parameters
|
414
|
+
# @return [Array<(UrlSsrfResponseBatch, Fixnum, Hash)>] UrlSsrfResponseBatch data, response status code and response headers
|
415
|
+
def domain_ssrf_check_batch_with_http_info(request, opts = {})
|
416
|
+
if @api_client.config.debugging
|
417
|
+
@api_client.config.logger.debug 'Calling API: DomainApi.domain_ssrf_check_batch ...'
|
418
|
+
end
|
419
|
+
# verify the required parameter 'request' is set
|
420
|
+
if @api_client.config.client_side_validation && request.nil?
|
421
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_ssrf_check_batch"
|
422
|
+
end
|
423
|
+
# resource path
|
424
|
+
local_var_path = '/validate/domain/url/ssrf-threat-check/batch'
|
425
|
+
|
426
|
+
# query parameters
|
427
|
+
query_params = {}
|
428
|
+
|
429
|
+
# header parameters
|
430
|
+
header_params = {}
|
431
|
+
# HTTP header 'Accept' (if needed)
|
432
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
433
|
+
# HTTP header 'Content-Type'
|
434
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
|
435
|
+
|
436
|
+
# form parameters
|
437
|
+
form_params = {}
|
438
|
+
|
439
|
+
# http body (model)
|
440
|
+
post_body = @api_client.object_to_http_body(request)
|
441
|
+
auth_names = ['Apikey']
|
442
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
443
|
+
:header_params => header_params,
|
444
|
+
:query_params => query_params,
|
445
|
+
:form_params => form_params,
|
446
|
+
:body => post_body,
|
447
|
+
:auth_names => auth_names,
|
448
|
+
:return_type => 'UrlSsrfResponseBatch')
|
449
|
+
if @api_client.config.debugging
|
450
|
+
@api_client.config.logger.debug "API called: DomainApi#domain_ssrf_check_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
451
|
+
end
|
452
|
+
return data, status_code, headers
|
453
|
+
end
|
184
454
|
# Validate a URL fully
|
185
455
|
# Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks. Accepts various types of input and produces a well-formed URL as output.
|
186
456
|
# @param request Input URL request
|