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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b14865010ef033e3b2eb06a1ead269e3e1282f68298cc426469d6b05308f5101
|
4
|
+
data.tar.gz: 2cebdb3e846f47bb3fa2e8d5c9c346271d3418c82d79507a622ea74e9cbdeb71
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7aa827e35f6d854d22b9b50d2276f0ccc51ca5f2446a2ff0e5fd0e50d6837ea57ef1dc4beb4e2f8cafeda2a3bb5f40a24b2a55d6af01e86bbe851b0061319f09
|
7
|
+
data.tar.gz: 76cec04103d7d4818c83bcc518daa22c8ba71fb3bc33ac9c19806d82a1aee4e12985d80ed720b8847da27a623fa5dc36d60252219cac5761e95f23f21c5122c8
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 2.1.
|
10
|
+
- Package version: 2.1.9
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-validate-api-client-2.1.
|
26
|
+
gem install ./cloudmersive-validate-api-client-2.1.9.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.1.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.1.9.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-validate-api-client', '~> 2.1.
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 2.1.9'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -102,17 +102,25 @@ Class | Method | HTTP request | Description
|
|
102
102
|
*CloudmersiveValidateApiClient::DateTimeApi* | [**date_time_parse_natural_language_date_time**](docs/DateTimeApi.md#date_time_parse_natural_language_date_time) | **POST** /validate/date-time/parse/date-time/natural-language | Parses a free-form natural language date and time string into a date and time
|
103
103
|
*CloudmersiveValidateApiClient::DateTimeApi* | [**date_time_parse_standard_date_time**](docs/DateTimeApi.md#date_time_parse_standard_date_time) | **POST** /validate/date-time/parse/date-time/structured | Parses a standardized date and time string into a date and time
|
104
104
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
105
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_get_top_level_domain_from_url**](docs/DomainApi.md#domain_get_top_level_domain_from_url) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
|
106
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_phishing_check**](docs/DomainApi.md#domain_phishing_check) | **POST** /validate/domain/url/phishing-threat-check | Check a URL for Phishing threats
|
105
107
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
106
108
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_quality_score**](docs/DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
|
109
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_safety_check**](docs/DomainApi.md#domain_safety_check) | **POST** /validate/domain/url/safety-threat-check | Check a URL for safety threats
|
110
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_ssrf_check**](docs/DomainApi.md#domain_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
|
111
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_ssrf_check_batch**](docs/DomainApi.md#domain_ssrf_check_batch) | **POST** /validate/domain/url/ssrf-threat-check/batch | Check a URL for SSRF threats in batches
|
107
112
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
108
113
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_syntax_only**](docs/DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
109
114
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_address_get_servers**](docs/EmailApi.md#email_address_get_servers) | **POST** /validate/email/address/servers | Partially check whether an email address is valid
|
110
115
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
|
111
116
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
|
112
117
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_geolocate_street_address**](docs/IPAddressApi.md#i_p_address_geolocate_street_address) | **POST** /validate/ip/geolocate/street-address | Geolocate an IP address to a street address
|
118
|
+
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_ip_intelligence**](docs/IPAddressApi.md#i_p_address_ip_intelligence) | **POST** /validate/ip/intelligence | Get intelligence on an IP address
|
119
|
+
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_is_bot**](docs/IPAddressApi.md#i_p_address_is_bot) | **POST** /validate/ip/is-bot | Check if IP address is a Bot client
|
113
120
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_is_threat**](docs/IPAddressApi.md#i_p_address_is_threat) | **POST** /validate/ip/is-threat | Check if IP address is a known threat
|
114
121
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_is_tor_node**](docs/IPAddressApi.md#i_p_address_is_tor_node) | **POST** /validate/ip/is-tor-node | Check if IP address is a Tor node server
|
115
122
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
123
|
+
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_reverse_domain_lookup**](docs/IPAddressApi.md#i_p_address_reverse_domain_lookup) | **POST** /validate/ip/reverse-domain-lookup | Perform a reverse domain name (DNS) lookup on an IP address
|
116
124
|
*CloudmersiveValidateApiClient::LeadEnrichmentApi* | [**lead_enrichment_enrich_lead**](docs/LeadEnrichmentApi.md#lead_enrichment_enrich_lead) | **POST** /validate/lead-enrichment/lead/enrich | Enrich an input lead with additional fields of data
|
117
125
|
*CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
|
118
126
|
*CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
|
@@ -120,6 +128,8 @@ Class | Method | HTTP request | Description
|
|
120
128
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
121
129
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
122
130
|
*CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
|
131
|
+
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_sql_injection**](docs/TextInputApi.md#text_input_check_sql_injection) | **POST** /validate/text-input/check/sql-injection | Check text input for SQL Injection (SQLI) attacks
|
132
|
+
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_sql_injection_batch**](docs/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
|
123
133
|
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xss**](docs/TextInputApi.md#text_input_check_xss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
|
124
134
|
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xss_batch**](docs/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
|
125
135
|
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_protect_xss**](docs/TextInputApi.md#text_input_protect_xss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
|
@@ -131,6 +141,7 @@ Class | Method | HTTP request | Description
|
|
131
141
|
|
132
142
|
- [CloudmersiveValidateApiClient::AddressGetServersResponse](docs/AddressGetServersResponse.md)
|
133
143
|
- [CloudmersiveValidateApiClient::AddressVerifySyntaxOnlyResponse](docs/AddressVerifySyntaxOnlyResponse.md)
|
144
|
+
- [CloudmersiveValidateApiClient::BotCheckResponse](docs/BotCheckResponse.md)
|
134
145
|
- [CloudmersiveValidateApiClient::CheckResponse](docs/CheckResponse.md)
|
135
146
|
- [CloudmersiveValidateApiClient::CountryDetails](docs/CountryDetails.md)
|
136
147
|
- [CloudmersiveValidateApiClient::CountryListResult](docs/CountryListResult.md)
|
@@ -151,6 +162,8 @@ Class | Method | HTTP request | Description
|
|
151
162
|
- [CloudmersiveValidateApiClient::GetPublicHolidaysRequest](docs/GetPublicHolidaysRequest.md)
|
152
163
|
- [CloudmersiveValidateApiClient::GetTimezonesRequest](docs/GetTimezonesRequest.md)
|
153
164
|
- [CloudmersiveValidateApiClient::GetTimezonesResponse](docs/GetTimezonesResponse.md)
|
165
|
+
- [CloudmersiveValidateApiClient::IPIntelligenceResponse](docs/IPIntelligenceResponse.md)
|
166
|
+
- [CloudmersiveValidateApiClient::IPReverseDNSLookupResponse](docs/IPReverseDNSLookupResponse.md)
|
154
167
|
- [CloudmersiveValidateApiClient::IPThreatResponse](docs/IPThreatResponse.md)
|
155
168
|
- [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
|
156
169
|
- [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
|
@@ -159,14 +172,26 @@ Class | Method | HTTP request | Description
|
|
159
172
|
- [CloudmersiveValidateApiClient::NormalizeAddressResponse](docs/NormalizeAddressResponse.md)
|
160
173
|
- [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
|
161
174
|
- [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
|
175
|
+
- [CloudmersiveValidateApiClient::PhishingCheckRequest](docs/PhishingCheckRequest.md)
|
176
|
+
- [CloudmersiveValidateApiClient::PhishingCheckResponse](docs/PhishingCheckResponse.md)
|
162
177
|
- [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
|
163
178
|
- [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
|
164
179
|
- [CloudmersiveValidateApiClient::PublicHolidayOccurrence](docs/PublicHolidayOccurrence.md)
|
165
180
|
- [CloudmersiveValidateApiClient::PublicHolidaysResponse](docs/PublicHolidaysResponse.md)
|
166
181
|
- [CloudmersiveValidateApiClient::ReverseGeocodeAddressRequest](docs/ReverseGeocodeAddressRequest.md)
|
167
182
|
- [CloudmersiveValidateApiClient::ReverseGeocodeAddressResponse](docs/ReverseGeocodeAddressResponse.md)
|
183
|
+
- [CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest](docs/SqlInjectionCheckBatchRequest.md)
|
184
|
+
- [CloudmersiveValidateApiClient::SqlInjectionCheckBatchResponse](docs/SqlInjectionCheckBatchResponse.md)
|
185
|
+
- [CloudmersiveValidateApiClient::SqlInjectionCheckRequestItem](docs/SqlInjectionCheckRequestItem.md)
|
186
|
+
- [CloudmersiveValidateApiClient::SqlInjectionDetectionResult](docs/SqlInjectionDetectionResult.md)
|
168
187
|
- [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
|
169
188
|
- [CloudmersiveValidateApiClient::TorNodeResponse](docs/TorNodeResponse.md)
|
189
|
+
- [CloudmersiveValidateApiClient::UrlSafetyCheckRequestFull](docs/UrlSafetyCheckRequestFull.md)
|
190
|
+
- [CloudmersiveValidateApiClient::UrlSafetyCheckResponseFull](docs/UrlSafetyCheckResponseFull.md)
|
191
|
+
- [CloudmersiveValidateApiClient::UrlSsrfRequestBatch](docs/UrlSsrfRequestBatch.md)
|
192
|
+
- [CloudmersiveValidateApiClient::UrlSsrfRequestFull](docs/UrlSsrfRequestFull.md)
|
193
|
+
- [CloudmersiveValidateApiClient::UrlSsrfResponseBatch](docs/UrlSsrfResponseBatch.md)
|
194
|
+
- [CloudmersiveValidateApiClient::UrlSsrfResponseFull](docs/UrlSsrfResponseFull.md)
|
170
195
|
- [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
|
171
196
|
- [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
|
172
197
|
- [CloudmersiveValidateApiClient::ValidateAddressRequest](docs/ValidateAddressRequest.md)
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::BotCheckResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**is_bot** | **BOOLEAN** | True if the input IP address is a Bot or Robot, false otherwise | [optional]
|
7
|
+
|
8
|
+
|
data/docs/DomainApi.md
CHANGED
@@ -5,8 +5,13 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**domain_check**](DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
8
|
+
[**domain_get_top_level_domain_from_url**](DomainApi.md#domain_get_top_level_domain_from_url) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
|
9
|
+
[**domain_phishing_check**](DomainApi.md#domain_phishing_check) | **POST** /validate/domain/url/phishing-threat-check | Check a URL for Phishing threats
|
8
10
|
[**domain_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
9
11
|
[**domain_quality_score**](DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
|
12
|
+
[**domain_safety_check**](DomainApi.md#domain_safety_check) | **POST** /validate/domain/url/safety-threat-check | Check a URL for safety threats
|
13
|
+
[**domain_ssrf_check**](DomainApi.md#domain_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
|
14
|
+
[**domain_ssrf_check_batch**](DomainApi.md#domain_ssrf_check_batch) | **POST** /validate/domain/url/ssrf-threat-check/batch | Check a URL for SSRF threats in batches
|
10
15
|
[**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
11
16
|
[**domain_url_syntax_only**](DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
12
17
|
|
@@ -65,6 +70,114 @@ Name | Type | Description | Notes
|
|
65
70
|
|
66
71
|
|
67
72
|
|
73
|
+
# **domain_get_top_level_domain_from_url**
|
74
|
+
> ValidateUrlResponseSyntaxOnly domain_get_top_level_domain_from_url(request)
|
75
|
+
|
76
|
+
Get top-level domain name from URL
|
77
|
+
|
78
|
+
Gets the top-level domain name from a URL, such as mydomain.com.
|
79
|
+
|
80
|
+
### Example
|
81
|
+
```ruby
|
82
|
+
# load the gem
|
83
|
+
require 'cloudmersive-validate-api-client'
|
84
|
+
# setup authorization
|
85
|
+
CloudmersiveValidateApiClient.configure do |config|
|
86
|
+
# Configure API key authorization: Apikey
|
87
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
88
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
89
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
90
|
+
end
|
91
|
+
|
92
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
93
|
+
|
94
|
+
request = CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly.new # ValidateUrlRequestSyntaxOnly | Input URL information
|
95
|
+
|
96
|
+
|
97
|
+
begin
|
98
|
+
#Get top-level domain name from URL
|
99
|
+
result = api_instance.domain_get_top_level_domain_from_url(request)
|
100
|
+
p result
|
101
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
102
|
+
puts "Exception when calling DomainApi->domain_get_top_level_domain_from_url: #{e}"
|
103
|
+
end
|
104
|
+
```
|
105
|
+
|
106
|
+
### Parameters
|
107
|
+
|
108
|
+
Name | Type | Description | Notes
|
109
|
+
------------- | ------------- | ------------- | -------------
|
110
|
+
**request** | [**ValidateUrlRequestSyntaxOnly**](ValidateUrlRequestSyntaxOnly.md)| Input URL information |
|
111
|
+
|
112
|
+
### Return type
|
113
|
+
|
114
|
+
[**ValidateUrlResponseSyntaxOnly**](ValidateUrlResponseSyntaxOnly.md)
|
115
|
+
|
116
|
+
### Authorization
|
117
|
+
|
118
|
+
[Apikey](../README.md#Apikey)
|
119
|
+
|
120
|
+
### HTTP request headers
|
121
|
+
|
122
|
+
- **Content-Type**: application/json, text/json
|
123
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
# **domain_phishing_check**
|
128
|
+
> PhishingCheckResponse domain_phishing_check(request)
|
129
|
+
|
130
|
+
Check a URL for Phishing threats
|
131
|
+
|
132
|
+
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.
|
133
|
+
|
134
|
+
### Example
|
135
|
+
```ruby
|
136
|
+
# load the gem
|
137
|
+
require 'cloudmersive-validate-api-client'
|
138
|
+
# setup authorization
|
139
|
+
CloudmersiveValidateApiClient.configure do |config|
|
140
|
+
# Configure API key authorization: Apikey
|
141
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
142
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
143
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
144
|
+
end
|
145
|
+
|
146
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
147
|
+
|
148
|
+
request = CloudmersiveValidateApiClient::PhishingCheckRequest.new # PhishingCheckRequest | Input URL request
|
149
|
+
|
150
|
+
|
151
|
+
begin
|
152
|
+
#Check a URL for Phishing threats
|
153
|
+
result = api_instance.domain_phishing_check(request)
|
154
|
+
p result
|
155
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
156
|
+
puts "Exception when calling DomainApi->domain_phishing_check: #{e}"
|
157
|
+
end
|
158
|
+
```
|
159
|
+
|
160
|
+
### Parameters
|
161
|
+
|
162
|
+
Name | Type | Description | Notes
|
163
|
+
------------- | ------------- | ------------- | -------------
|
164
|
+
**request** | [**PhishingCheckRequest**](PhishingCheckRequest.md)| Input URL request |
|
165
|
+
|
166
|
+
### Return type
|
167
|
+
|
168
|
+
[**PhishingCheckResponse**](PhishingCheckResponse.md)
|
169
|
+
|
170
|
+
### Authorization
|
171
|
+
|
172
|
+
[Apikey](../README.md#Apikey)
|
173
|
+
|
174
|
+
### HTTP request headers
|
175
|
+
|
176
|
+
- **Content-Type**: application/json, text/json
|
177
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
178
|
+
|
179
|
+
|
180
|
+
|
68
181
|
# **domain_post**
|
69
182
|
> WhoisResponse domain_post(domain)
|
70
183
|
|
@@ -173,6 +286,168 @@ Name | Type | Description | Notes
|
|
173
286
|
|
174
287
|
|
175
288
|
|
289
|
+
# **domain_safety_check**
|
290
|
+
> UrlSafetyCheckResponseFull domain_safety_check(request)
|
291
|
+
|
292
|
+
Check a URL for safety threats
|
293
|
+
|
294
|
+
Checks if an input URL is at risk of being a safety threat through malware, unwanted software, or social engineering threats.
|
295
|
+
|
296
|
+
### Example
|
297
|
+
```ruby
|
298
|
+
# load the gem
|
299
|
+
require 'cloudmersive-validate-api-client'
|
300
|
+
# setup authorization
|
301
|
+
CloudmersiveValidateApiClient.configure do |config|
|
302
|
+
# Configure API key authorization: Apikey
|
303
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
304
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
305
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
306
|
+
end
|
307
|
+
|
308
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
309
|
+
|
310
|
+
request = CloudmersiveValidateApiClient::UrlSafetyCheckRequestFull.new # UrlSafetyCheckRequestFull | Input URL request
|
311
|
+
|
312
|
+
|
313
|
+
begin
|
314
|
+
#Check a URL for safety threats
|
315
|
+
result = api_instance.domain_safety_check(request)
|
316
|
+
p result
|
317
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
318
|
+
puts "Exception when calling DomainApi->domain_safety_check: #{e}"
|
319
|
+
end
|
320
|
+
```
|
321
|
+
|
322
|
+
### Parameters
|
323
|
+
|
324
|
+
Name | Type | Description | Notes
|
325
|
+
------------- | ------------- | ------------- | -------------
|
326
|
+
**request** | [**UrlSafetyCheckRequestFull**](UrlSafetyCheckRequestFull.md)| Input URL request |
|
327
|
+
|
328
|
+
### Return type
|
329
|
+
|
330
|
+
[**UrlSafetyCheckResponseFull**](UrlSafetyCheckResponseFull.md)
|
331
|
+
|
332
|
+
### Authorization
|
333
|
+
|
334
|
+
[Apikey](../README.md#Apikey)
|
335
|
+
|
336
|
+
### HTTP request headers
|
337
|
+
|
338
|
+
- **Content-Type**: application/json, text/json
|
339
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
# **domain_ssrf_check**
|
344
|
+
> UrlSsrfResponseFull domain_ssrf_check(request)
|
345
|
+
|
346
|
+
Check a URL for SSRF threats
|
347
|
+
|
348
|
+
Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.
|
349
|
+
|
350
|
+
### Example
|
351
|
+
```ruby
|
352
|
+
# load the gem
|
353
|
+
require 'cloudmersive-validate-api-client'
|
354
|
+
# setup authorization
|
355
|
+
CloudmersiveValidateApiClient.configure do |config|
|
356
|
+
# Configure API key authorization: Apikey
|
357
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
358
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
359
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
360
|
+
end
|
361
|
+
|
362
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
363
|
+
|
364
|
+
request = CloudmersiveValidateApiClient::UrlSsrfRequestFull.new # UrlSsrfRequestFull | Input URL request
|
365
|
+
|
366
|
+
|
367
|
+
begin
|
368
|
+
#Check a URL for SSRF threats
|
369
|
+
result = api_instance.domain_ssrf_check(request)
|
370
|
+
p result
|
371
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
372
|
+
puts "Exception when calling DomainApi->domain_ssrf_check: #{e}"
|
373
|
+
end
|
374
|
+
```
|
375
|
+
|
376
|
+
### Parameters
|
377
|
+
|
378
|
+
Name | Type | Description | Notes
|
379
|
+
------------- | ------------- | ------------- | -------------
|
380
|
+
**request** | [**UrlSsrfRequestFull**](UrlSsrfRequestFull.md)| Input URL request |
|
381
|
+
|
382
|
+
### Return type
|
383
|
+
|
384
|
+
[**UrlSsrfResponseFull**](UrlSsrfResponseFull.md)
|
385
|
+
|
386
|
+
### Authorization
|
387
|
+
|
388
|
+
[Apikey](../README.md#Apikey)
|
389
|
+
|
390
|
+
### HTTP request headers
|
391
|
+
|
392
|
+
- **Content-Type**: application/json, text/json
|
393
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
394
|
+
|
395
|
+
|
396
|
+
|
397
|
+
# **domain_ssrf_check_batch**
|
398
|
+
> UrlSsrfResponseBatch domain_ssrf_check_batch(request)
|
399
|
+
|
400
|
+
Check a URL for SSRF threats in batches
|
401
|
+
|
402
|
+
Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.
|
403
|
+
|
404
|
+
### Example
|
405
|
+
```ruby
|
406
|
+
# load the gem
|
407
|
+
require 'cloudmersive-validate-api-client'
|
408
|
+
# setup authorization
|
409
|
+
CloudmersiveValidateApiClient.configure do |config|
|
410
|
+
# Configure API key authorization: Apikey
|
411
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
412
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
413
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
414
|
+
end
|
415
|
+
|
416
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
417
|
+
|
418
|
+
request = CloudmersiveValidateApiClient::UrlSsrfRequestBatch.new # UrlSsrfRequestBatch | Input URL request as a batch of multiple URLs
|
419
|
+
|
420
|
+
|
421
|
+
begin
|
422
|
+
#Check a URL for SSRF threats in batches
|
423
|
+
result = api_instance.domain_ssrf_check_batch(request)
|
424
|
+
p result
|
425
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
426
|
+
puts "Exception when calling DomainApi->domain_ssrf_check_batch: #{e}"
|
427
|
+
end
|
428
|
+
```
|
429
|
+
|
430
|
+
### Parameters
|
431
|
+
|
432
|
+
Name | Type | Description | Notes
|
433
|
+
------------- | ------------- | ------------- | -------------
|
434
|
+
**request** | [**UrlSsrfRequestBatch**](UrlSsrfRequestBatch.md)| Input URL request as a batch of multiple URLs |
|
435
|
+
|
436
|
+
### Return type
|
437
|
+
|
438
|
+
[**UrlSsrfResponseBatch**](UrlSsrfResponseBatch.md)
|
439
|
+
|
440
|
+
### Authorization
|
441
|
+
|
442
|
+
[Apikey](../README.md#Apikey)
|
443
|
+
|
444
|
+
### HTTP request headers
|
445
|
+
|
446
|
+
- **Content-Type**: application/json, text/json
|
447
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
448
|
+
|
449
|
+
|
450
|
+
|
176
451
|
# **domain_url_full**
|
177
452
|
> ValidateUrlResponseFull domain_url_full(request)
|
178
453
|
|
data/docs/IPAddressApi.md
CHANGED
@@ -5,9 +5,12 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**i_p_address_geolocate_street_address**](IPAddressApi.md#i_p_address_geolocate_street_address) | **POST** /validate/ip/geolocate/street-address | Geolocate an IP address to a street address
|
8
|
+
[**i_p_address_ip_intelligence**](IPAddressApi.md#i_p_address_ip_intelligence) | **POST** /validate/ip/intelligence | Get intelligence on an IP address
|
9
|
+
[**i_p_address_is_bot**](IPAddressApi.md#i_p_address_is_bot) | **POST** /validate/ip/is-bot | Check if IP address is a Bot client
|
8
10
|
[**i_p_address_is_threat**](IPAddressApi.md#i_p_address_is_threat) | **POST** /validate/ip/is-threat | Check if IP address is a known threat
|
9
11
|
[**i_p_address_is_tor_node**](IPAddressApi.md#i_p_address_is_tor_node) | **POST** /validate/ip/is-tor-node | Check if IP address is a Tor node server
|
10
12
|
[**i_p_address_post**](IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
13
|
+
[**i_p_address_reverse_domain_lookup**](IPAddressApi.md#i_p_address_reverse_domain_lookup) | **POST** /validate/ip/reverse-domain-lookup | Perform a reverse domain name (DNS) lookup on an IP address
|
11
14
|
|
12
15
|
|
13
16
|
# **i_p_address_geolocate_street_address**
|
@@ -64,6 +67,114 @@ Name | Type | Description | Notes
|
|
64
67
|
|
65
68
|
|
66
69
|
|
70
|
+
# **i_p_address_ip_intelligence**
|
71
|
+
> IPIntelligenceResponse i_p_address_ip_intelligence(value)
|
72
|
+
|
73
|
+
Get intelligence on an IP address
|
74
|
+
|
75
|
+
Identify key intelligence about an IP address, including if it is a known threat IP, known bot, Tor exit node, as well as the location of the IP address.
|
76
|
+
|
77
|
+
### Example
|
78
|
+
```ruby
|
79
|
+
# load the gem
|
80
|
+
require 'cloudmersive-validate-api-client'
|
81
|
+
# setup authorization
|
82
|
+
CloudmersiveValidateApiClient.configure do |config|
|
83
|
+
# Configure API key authorization: Apikey
|
84
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
85
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
86
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
87
|
+
end
|
88
|
+
|
89
|
+
api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
|
90
|
+
|
91
|
+
value = 'value_example' # String | IP address to process, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes.
|
92
|
+
|
93
|
+
|
94
|
+
begin
|
95
|
+
#Get intelligence on an IP address
|
96
|
+
result = api_instance.i_p_address_ip_intelligence(value)
|
97
|
+
p result
|
98
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
99
|
+
puts "Exception when calling IPAddressApi->i_p_address_ip_intelligence: #{e}"
|
100
|
+
end
|
101
|
+
```
|
102
|
+
|
103
|
+
### Parameters
|
104
|
+
|
105
|
+
Name | Type | Description | Notes
|
106
|
+
------------- | ------------- | ------------- | -------------
|
107
|
+
**value** | **String**| IP address to process, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes. |
|
108
|
+
|
109
|
+
### Return type
|
110
|
+
|
111
|
+
[**IPIntelligenceResponse**](IPIntelligenceResponse.md)
|
112
|
+
|
113
|
+
### Authorization
|
114
|
+
|
115
|
+
[Apikey](../README.md#Apikey)
|
116
|
+
|
117
|
+
### HTTP request headers
|
118
|
+
|
119
|
+
- **Content-Type**: application/json, text/json
|
120
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
# **i_p_address_is_bot**
|
125
|
+
> BotCheckResponse i_p_address_is_bot(value)
|
126
|
+
|
127
|
+
Check if IP address is a Bot client
|
128
|
+
|
129
|
+
Check if the input IP address is a Bot, robot, or otherwise a non-user entity. Leverages real-time signals to check against known high-probability bots..
|
130
|
+
|
131
|
+
### Example
|
132
|
+
```ruby
|
133
|
+
# load the gem
|
134
|
+
require 'cloudmersive-validate-api-client'
|
135
|
+
# setup authorization
|
136
|
+
CloudmersiveValidateApiClient.configure do |config|
|
137
|
+
# Configure API key authorization: Apikey
|
138
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
139
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
140
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
141
|
+
end
|
142
|
+
|
143
|
+
api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
|
144
|
+
|
145
|
+
value = 'value_example' # String | IP address to check, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes.
|
146
|
+
|
147
|
+
|
148
|
+
begin
|
149
|
+
#Check if IP address is a Bot client
|
150
|
+
result = api_instance.i_p_address_is_bot(value)
|
151
|
+
p result
|
152
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
153
|
+
puts "Exception when calling IPAddressApi->i_p_address_is_bot: #{e}"
|
154
|
+
end
|
155
|
+
```
|
156
|
+
|
157
|
+
### Parameters
|
158
|
+
|
159
|
+
Name | Type | Description | Notes
|
160
|
+
------------- | ------------- | ------------- | -------------
|
161
|
+
**value** | **String**| IP address to check, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes. |
|
162
|
+
|
163
|
+
### Return type
|
164
|
+
|
165
|
+
[**BotCheckResponse**](BotCheckResponse.md)
|
166
|
+
|
167
|
+
### Authorization
|
168
|
+
|
169
|
+
[Apikey](../README.md#Apikey)
|
170
|
+
|
171
|
+
### HTTP request headers
|
172
|
+
|
173
|
+
- **Content-Type**: application/json, text/json
|
174
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
175
|
+
|
176
|
+
|
177
|
+
|
67
178
|
# **i_p_address_is_threat**
|
68
179
|
> IPThreatResponse i_p_address_is_threat(value)
|
69
180
|
|
@@ -226,3 +337,57 @@ Name | Type | Description | Notes
|
|
226
337
|
|
227
338
|
|
228
339
|
|
340
|
+
# **i_p_address_reverse_domain_lookup**
|
341
|
+
> IPReverseDNSLookupResponse i_p_address_reverse_domain_lookup(value)
|
342
|
+
|
343
|
+
Perform a reverse domain name (DNS) lookup on an IP address
|
344
|
+
|
345
|
+
Gets the domain name, if any, associated with the IP address.
|
346
|
+
|
347
|
+
### Example
|
348
|
+
```ruby
|
349
|
+
# load the gem
|
350
|
+
require 'cloudmersive-validate-api-client'
|
351
|
+
# setup authorization
|
352
|
+
CloudmersiveValidateApiClient.configure do |config|
|
353
|
+
# Configure API key authorization: Apikey
|
354
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
355
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
356
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
357
|
+
end
|
358
|
+
|
359
|
+
api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
|
360
|
+
|
361
|
+
value = 'value_example' # String | IP address to check, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes.
|
362
|
+
|
363
|
+
|
364
|
+
begin
|
365
|
+
#Perform a reverse domain name (DNS) lookup on an IP address
|
366
|
+
result = api_instance.i_p_address_reverse_domain_lookup(value)
|
367
|
+
p result
|
368
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
369
|
+
puts "Exception when calling IPAddressApi->i_p_address_reverse_domain_lookup: #{e}"
|
370
|
+
end
|
371
|
+
```
|
372
|
+
|
373
|
+
### Parameters
|
374
|
+
|
375
|
+
Name | Type | Description | Notes
|
376
|
+
------------- | ------------- | ------------- | -------------
|
377
|
+
**value** | **String**| IP address to check, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes. |
|
378
|
+
|
379
|
+
### Return type
|
380
|
+
|
381
|
+
[**IPReverseDNSLookupResponse**](IPReverseDNSLookupResponse.md)
|
382
|
+
|
383
|
+
### Authorization
|
384
|
+
|
385
|
+
[Apikey](../README.md#Apikey)
|
386
|
+
|
387
|
+
### HTTP request headers
|
388
|
+
|
389
|
+
- **Content-Type**: application/json, text/json
|
390
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
391
|
+
|
392
|
+
|
393
|
+
|