cloudmersive-validate-api-client 2.1.0 → 2.1.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +32 -4
- data/docs/AddressApi.md +55 -0
- data/docs/BotCheckResponse.md +8 -0
- data/docs/DateTimeApi.md +222 -0
- data/docs/DateTimeNaturalLanguageParseRequest.md +8 -0
- data/docs/DateTimeNowResult.md +10 -0
- data/docs/DateTimeStandardizedParseRequest.md +9 -0
- data/docs/DateTimeStandardizedParseResponse.md +16 -0
- data/docs/DomainApi.md +3 -3
- data/docs/EmailApi.md +3 -3
- data/docs/GeolocateStreetAddressResponse.md +13 -0
- data/docs/GetPublicHolidaysRequest.md +9 -0
- data/docs/IPAddressApi.md +223 -3
- data/docs/IPIntelligenceResponse.md +16 -0
- data/docs/IPReverseDNSLookupResponse.md +9 -0
- data/docs/NormalizeAddressResponse.md +18 -0
- data/docs/PublicHolidayOccurrence.md +12 -0
- data/docs/PublicHolidaysResponse.md +9 -0
- data/docs/TextInputApi.md +173 -0
- data/docs/XssProtectionBatchRequest.md +8 -0
- data/docs/XssProtectionBatchResponse.md +8 -0
- data/docs/XssProtectionRequestItem.md +8 -0
- data/docs/XssProtectionResult.md +11 -0
- data/lib/cloudmersive-validate-api-client.rb +18 -0
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +54 -0
- data/lib/cloudmersive-validate-api-client/api/date_time_api.rb +231 -0
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +3 -3
- data/lib/cloudmersive-validate-api-client/api/email_api.rb +3 -3
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +219 -3
- data/lib/cloudmersive-validate-api-client/api/text_input_api.rb +185 -0
- data/lib/cloudmersive-validate-api-client/models/bot_check_response.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_natural_language_parse_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_now_result.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_standardized_parse_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_standardized_parse_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/geolocate_street_address_response.rb +236 -0
- data/lib/cloudmersive-validate-api-client/models/get_public_holidays_request.rb +196 -0
- 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/normalize_address_response.rb +286 -0
- data/lib/cloudmersive-validate-api-client/models/public_holiday_occurrence.rb +226 -0
- data/lib/cloudmersive-validate-api-client/models/public_holidays_response.rb +198 -0
- data/lib/cloudmersive-validate-api-client/models/xss_protection_batch_request.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/xss_protection_batch_response.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/xss_protection_request_item.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/xss_protection_result.rb +216 -0
- data/lib/cloudmersive-validate-api-client/version.rb +1 -1
- data/spec/api/address_api_spec.rb +12 -0
- data/spec/api/date_time_api_spec.rb +82 -0
- data/spec/api/ip_address_api_spec.rb +48 -0
- data/spec/api/text_input_api_spec.rb +71 -0
- data/spec/models/bot_check_response_spec.rb +41 -0
- data/spec/models/date_time_natural_language_parse_request_spec.rb +41 -0
- data/spec/models/date_time_now_result_spec.rb +53 -0
- data/spec/models/date_time_standardized_parse_request_spec.rb +47 -0
- data/spec/models/date_time_standardized_parse_response_spec.rb +89 -0
- data/spec/models/geolocate_street_address_response_spec.rb +71 -0
- data/spec/models/get_public_holidays_request_spec.rb +47 -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/normalize_address_response_spec.rb +101 -0
- data/spec/models/public_holiday_occurrence_spec.rb +65 -0
- data/spec/models/public_holidays_response_spec.rb +47 -0
- data/spec/models/xss_protection_batch_request_spec.rb +41 -0
- data/spec/models/xss_protection_batch_response_spec.rb +41 -0
- data/spec/models/xss_protection_request_item_spec.rb +41 -0
- data/spec/models/xss_protection_result_spec.rb +59 -0
- metadata +56 -2
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::DateTimeStandardizedParseRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**raw_date_time_input** | **String** | Raw string input of a standard-formatted date and time for parsing | [optional]
|
7
|
+
**country_code** | **String** | Optional: specify the two-letter country code to optimzie date formatting; default is US | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::DateTimeStandardizedParseResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**parsed_date_result** | **DateTime** | Result of performing a date time parsing | [optional]
|
8
|
+
**year** | **Integer** | Year of the parsed date time result | [optional]
|
9
|
+
**month** | **Integer** | Month of the parsed date time result | [optional]
|
10
|
+
**day** | **Integer** | Day of the parsed date time result | [optional]
|
11
|
+
**hour** | **Integer** | Hour of the parsed date time result (24-hour) | [optional]
|
12
|
+
**minute** | **Integer** | Minute of the parsed date time result | [optional]
|
13
|
+
**second** | **Integer** | Second of the parsed date time result | [optional]
|
14
|
+
**day_of_week** | **String** | Day of week | [optional]
|
15
|
+
|
16
|
+
|
data/docs/DomainApi.md
CHANGED
@@ -60,7 +60,7 @@ Name | Type | Description | Notes
|
|
60
60
|
|
61
61
|
### HTTP request headers
|
62
62
|
|
63
|
-
- **Content-Type**:
|
63
|
+
- **Content-Type**: application/json, text/json
|
64
64
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
65
65
|
|
66
66
|
|
@@ -114,7 +114,7 @@ Name | Type | Description | Notes
|
|
114
114
|
|
115
115
|
### HTTP request headers
|
116
116
|
|
117
|
-
- **Content-Type**:
|
117
|
+
- **Content-Type**: application/json, text/json
|
118
118
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
119
119
|
|
120
120
|
|
@@ -168,7 +168,7 @@ Name | Type | Description | Notes
|
|
168
168
|
|
169
169
|
### HTTP request headers
|
170
170
|
|
171
|
-
- **Content-Type**:
|
171
|
+
- **Content-Type**: application/json, text/json
|
172
172
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
173
173
|
|
174
174
|
|
data/docs/EmailApi.md
CHANGED
@@ -58,7 +58,7 @@ Name | Type | Description | Notes
|
|
58
58
|
|
59
59
|
### HTTP request headers
|
60
60
|
|
61
|
-
- **Content-Type**:
|
61
|
+
- **Content-Type**: application/json, text/json
|
62
62
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
63
63
|
|
64
64
|
|
@@ -112,7 +112,7 @@ Name | Type | Description | Notes
|
|
112
112
|
|
113
113
|
### HTTP request headers
|
114
114
|
|
115
|
-
- **Content-Type**:
|
115
|
+
- **Content-Type**: application/json, text/json
|
116
116
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
117
117
|
|
118
118
|
|
@@ -166,7 +166,7 @@ Name | Type | Description | Notes
|
|
166
166
|
|
167
167
|
### HTTP request headers
|
168
168
|
|
169
|
-
- **Content-Type**:
|
169
|
+
- **Content-Type**: application/json, text/json
|
170
170
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
171
171
|
|
172
172
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::GeolocateStreetAddressResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**country_code** | **String** | Two-letter country code of IP address | [optional]
|
7
|
+
**country_name** | **String** | Country name of IP address | [optional]
|
8
|
+
**street_address** | **String** | Street address of IP address | [optional]
|
9
|
+
**city** | **String** | City of IP address | [optional]
|
10
|
+
**region_name** | **String** | State/region of IP address | [optional]
|
11
|
+
**zip_code** | **String** | Zip or postal code of IP address | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::GetPublicHolidaysRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**raw_country_input** | **String** | Two-letter code (FIPS 10-4 or ISO 3166-1) of the country; if not specified, defaults to United States | [optional]
|
7
|
+
**year** | **Integer** | Optional - the year in which to retrieve the holidays; if left blank (0) it will default to the current year | [optional]
|
8
|
+
|
9
|
+
|
data/docs/IPAddressApi.md
CHANGED
@@ -4,9 +4,175 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
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
|
7
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
|
8
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
|
9
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
|
14
|
+
|
15
|
+
|
16
|
+
# **i_p_address_geolocate_street_address**
|
17
|
+
> GeolocateStreetAddressResponse i_p_address_geolocate_street_address(value)
|
18
|
+
|
19
|
+
Geolocate an IP address to a street address
|
20
|
+
|
21
|
+
Identify an IP address's street address. Useful for security and UX applications.
|
22
|
+
|
23
|
+
### Example
|
24
|
+
```ruby
|
25
|
+
# load the gem
|
26
|
+
require 'cloudmersive-validate-api-client'
|
27
|
+
# setup authorization
|
28
|
+
CloudmersiveValidateApiClient.configure do |config|
|
29
|
+
# Configure API key authorization: Apikey
|
30
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
31
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
|
36
|
+
|
37
|
+
value = 'value_example' # String | IP address to geolocate, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes.
|
38
|
+
|
39
|
+
|
40
|
+
begin
|
41
|
+
#Geolocate an IP address to a street address
|
42
|
+
result = api_instance.i_p_address_geolocate_street_address(value)
|
43
|
+
p result
|
44
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
45
|
+
puts "Exception when calling IPAddressApi->i_p_address_geolocate_street_address: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
### Parameters
|
50
|
+
|
51
|
+
Name | Type | Description | Notes
|
52
|
+
------------- | ------------- | ------------- | -------------
|
53
|
+
**value** | **String**| IP address to geolocate, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes. |
|
54
|
+
|
55
|
+
### Return type
|
56
|
+
|
57
|
+
[**GeolocateStreetAddressResponse**](GeolocateStreetAddressResponse.md)
|
58
|
+
|
59
|
+
### Authorization
|
60
|
+
|
61
|
+
[Apikey](../README.md#Apikey)
|
62
|
+
|
63
|
+
### HTTP request headers
|
64
|
+
|
65
|
+
- **Content-Type**: application/json, text/json
|
66
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
67
|
+
|
68
|
+
|
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
|
+
|
10
176
|
|
11
177
|
|
12
178
|
# **i_p_address_is_threat**
|
@@ -58,7 +224,7 @@ Name | Type | Description | Notes
|
|
58
224
|
|
59
225
|
### HTTP request headers
|
60
226
|
|
61
|
-
- **Content-Type**:
|
227
|
+
- **Content-Type**: application/json, text/json
|
62
228
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
63
229
|
|
64
230
|
|
@@ -112,7 +278,7 @@ Name | Type | Description | Notes
|
|
112
278
|
|
113
279
|
### HTTP request headers
|
114
280
|
|
115
|
-
- **Content-Type**:
|
281
|
+
- **Content-Type**: application/json, text/json
|
116
282
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
117
283
|
|
118
284
|
|
@@ -166,7 +332,61 @@ Name | Type | Description | Notes
|
|
166
332
|
|
167
333
|
### HTTP request headers
|
168
334
|
|
169
|
-
- **Content-Type**:
|
335
|
+
- **Content-Type**: application/json, text/json
|
336
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
337
|
+
|
338
|
+
|
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
|
170
390
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
171
391
|
|
172
392
|
|
@@ -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,18 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::NormalizeAddressResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**valid_address** | **BOOLEAN** | True if the address is valid, false otherwise | [optional]
|
7
|
+
**building** | **String** | The name of the building, house or structure if applicable, such as \"Cloudmersive Building 2\". This will often by null. | [optional]
|
8
|
+
**street_number** | **String** | The street number or house number of the address. For example, in the address \"1600 Pennsylvania Avenue NW\" the street number would be \"1600\". This value will typically be populated for most addresses. | [optional]
|
9
|
+
**street** | **String** | The name of the street or road of the address. For example, in the address \"1600 Pennsylvania Avenue NW\" the street number would be \"Pennsylvania Avenue NW\". | [optional]
|
10
|
+
**city** | **String** | The city of the address. | [optional]
|
11
|
+
**state_or_province** | **String** | The state or province of the address. | [optional]
|
12
|
+
**postal_code** | **String** | The postal code or zip code of the address. | [optional]
|
13
|
+
**country_full_name** | **String** | Country of the address, if present in the address. If not included in the address it will be null. | [optional]
|
14
|
+
**iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional]
|
15
|
+
**latitude** | **Float** | If the address is valid, the degrees latitude of the validated address, null otherwise | [optional]
|
16
|
+
**longitude** | **Float** | If the address is valid, the degrees longitude of the validated address, null otherwise | [optional]
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::PublicHolidayOccurrence
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**english_name** | **String** | Name of the holiday in English | [optional]
|
7
|
+
**local_name** | **String** | Local name of the holiday | [optional]
|
8
|
+
**occurrence_date** | **DateTime** | Date of the holiday (start time) | [optional]
|
9
|
+
**holiday_type** | **String** | Type of the holiday; possible values are: Public, Bank, School, Authorities, Optional, Observance | [optional]
|
10
|
+
**nationwaide** | **BOOLEAN** | True if the holiday is celebrated in all locales in the country, false otherwise | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::PublicHolidaysResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**public_holidays** | [**Array<PublicHolidayOccurrence>**](PublicHolidayOccurrence.md) | Public holidays in the requested country and year | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,173 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::TextInputApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**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
|
+
[**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
|
+
[**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
|
+
|
11
|
+
|
12
|
+
# **text_input_check_xss**
|
13
|
+
> XssProtectionResult text_input_check_xss(value)
|
14
|
+
|
15
|
+
Check text input for Cross-Site-Scripting (XSS) attacks
|
16
|
+
|
17
|
+
Detects XSS (Cross-Site-Scripting) attacks from text input.
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'cloudmersive-validate-api-client'
|
23
|
+
# setup authorization
|
24
|
+
CloudmersiveValidateApiClient.configure do |config|
|
25
|
+
# Configure API key authorization: Apikey
|
26
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = CloudmersiveValidateApiClient::TextInputApi.new
|
32
|
+
|
33
|
+
value = 'value_example' # String | User-facing text input.
|
34
|
+
|
35
|
+
|
36
|
+
begin
|
37
|
+
#Check text input for Cross-Site-Scripting (XSS) attacks
|
38
|
+
result = api_instance.text_input_check_xss(value)
|
39
|
+
p result
|
40
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
41
|
+
puts "Exception when calling TextInputApi->text_input_check_xss: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
Name | Type | Description | Notes
|
48
|
+
------------- | ------------- | ------------- | -------------
|
49
|
+
**value** | **String**| User-facing text input. |
|
50
|
+
|
51
|
+
### Return type
|
52
|
+
|
53
|
+
[**XssProtectionResult**](XssProtectionResult.md)
|
54
|
+
|
55
|
+
### Authorization
|
56
|
+
|
57
|
+
[Apikey](../README.md#Apikey)
|
58
|
+
|
59
|
+
### HTTP request headers
|
60
|
+
|
61
|
+
- **Content-Type**: application/json, text/json
|
62
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
# **text_input_check_xss_batch**
|
67
|
+
> XssProtectionBatchResponse text_input_check_xss_batch(value)
|
68
|
+
|
69
|
+
Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
|
70
|
+
|
71
|
+
Detects XSS (Cross-Site-Scripting) attacks from multiple text input. Output preverses order of input items.
|
72
|
+
|
73
|
+
### Example
|
74
|
+
```ruby
|
75
|
+
# load the gem
|
76
|
+
require 'cloudmersive-validate-api-client'
|
77
|
+
# setup authorization
|
78
|
+
CloudmersiveValidateApiClient.configure do |config|
|
79
|
+
# Configure API key authorization: Apikey
|
80
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
81
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
82
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
83
|
+
end
|
84
|
+
|
85
|
+
api_instance = CloudmersiveValidateApiClient::TextInputApi.new
|
86
|
+
|
87
|
+
value = CloudmersiveValidateApiClient::XssProtectionBatchRequest.new # XssProtectionBatchRequest | User-facing text input.
|
88
|
+
|
89
|
+
|
90
|
+
begin
|
91
|
+
#Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
|
92
|
+
result = api_instance.text_input_check_xss_batch(value)
|
93
|
+
p result
|
94
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
95
|
+
puts "Exception when calling TextInputApi->text_input_check_xss_batch: #{e}"
|
96
|
+
end
|
97
|
+
```
|
98
|
+
|
99
|
+
### Parameters
|
100
|
+
|
101
|
+
Name | Type | Description | Notes
|
102
|
+
------------- | ------------- | ------------- | -------------
|
103
|
+
**value** | [**XssProtectionBatchRequest**](XssProtectionBatchRequest.md)| User-facing text input. |
|
104
|
+
|
105
|
+
### Return type
|
106
|
+
|
107
|
+
[**XssProtectionBatchResponse**](XssProtectionBatchResponse.md)
|
108
|
+
|
109
|
+
### Authorization
|
110
|
+
|
111
|
+
[Apikey](../README.md#Apikey)
|
112
|
+
|
113
|
+
### HTTP request headers
|
114
|
+
|
115
|
+
- **Content-Type**: application/json, text/json
|
116
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
# **text_input_protect_xss**
|
121
|
+
> XssProtectionResult text_input_protect_xss(value)
|
122
|
+
|
123
|
+
Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
|
124
|
+
|
125
|
+
Detects and removes XSS (Cross-Site-Scripting) attacks from text input through normalization. Returns the normalized result, as well as information on whether the original input contained an XSS risk.
|
126
|
+
|
127
|
+
### Example
|
128
|
+
```ruby
|
129
|
+
# load the gem
|
130
|
+
require 'cloudmersive-validate-api-client'
|
131
|
+
# setup authorization
|
132
|
+
CloudmersiveValidateApiClient.configure do |config|
|
133
|
+
# Configure API key authorization: Apikey
|
134
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
135
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
136
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
137
|
+
end
|
138
|
+
|
139
|
+
api_instance = CloudmersiveValidateApiClient::TextInputApi.new
|
140
|
+
|
141
|
+
value = 'value_example' # String | User-facing text input.
|
142
|
+
|
143
|
+
|
144
|
+
begin
|
145
|
+
#Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
|
146
|
+
result = api_instance.text_input_protect_xss(value)
|
147
|
+
p result
|
148
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
149
|
+
puts "Exception when calling TextInputApi->text_input_protect_xss: #{e}"
|
150
|
+
end
|
151
|
+
```
|
152
|
+
|
153
|
+
### Parameters
|
154
|
+
|
155
|
+
Name | Type | Description | Notes
|
156
|
+
------------- | ------------- | ------------- | -------------
|
157
|
+
**value** | **String**| User-facing text input. |
|
158
|
+
|
159
|
+
### Return type
|
160
|
+
|
161
|
+
[**XssProtectionResult**](XssProtectionResult.md)
|
162
|
+
|
163
|
+
### Authorization
|
164
|
+
|
165
|
+
[Apikey](../README.md#Apikey)
|
166
|
+
|
167
|
+
### HTTP request headers
|
168
|
+
|
169
|
+
- **Content-Type**: application/json, text/json
|
170
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
171
|
+
|
172
|
+
|
173
|
+
|