cloudmersive-validate-api-client 2.0.6 → 2.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +17 -4
- data/docs/AddressApi.md +220 -0
- data/docs/CountryDetails.md +5 -0
- data/docs/DomainApi.md +55 -0
- data/docs/DomainQualityResponse.md +8 -0
- data/docs/GeolocateStreetAddressResponse.md +13 -0
- data/docs/IPAddressApi.md +55 -0
- data/docs/ReverseGeocodeAddressRequest.md +9 -0
- data/docs/ReverseGeocodeAddressResponse.md +14 -0
- data/docs/TextInputApi.md +118 -0
- data/docs/ValidateCountryResponse.md +5 -0
- data/docs/XssProtectionResult.md +11 -0
- data/lib/cloudmersive-validate-api-client.rb +6 -0
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +216 -0
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +54 -0
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +54 -0
- data/lib/cloudmersive-validate-api-client/api/text_input_api.rb +131 -0
- data/lib/cloudmersive-validate-api-client/models/country_details.rb +54 -4
- data/lib/cloudmersive-validate-api-client/models/domain_quality_response.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/geolocate_street_address_response.rb +236 -0
- data/lib/cloudmersive-validate-api-client/models/reverse_geocode_address_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/reverse_geocode_address_response.rb +246 -0
- data/lib/cloudmersive-validate-api-client/models/validate_country_response.rb +54 -4
- 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 +48 -0
- data/spec/api/domain_api_spec.rb +12 -0
- data/spec/api/ip_address_api_spec.rb +12 -0
- data/spec/api/text_input_api_spec.rb +59 -0
- data/spec/models/country_details_spec.rb +30 -0
- data/spec/models/domain_quality_response_spec.rb +41 -0
- data/spec/models/geolocate_street_address_response_spec.rb +71 -0
- data/spec/models/reverse_geocode_address_request_spec.rb +47 -0
- data/spec/models/reverse_geocode_address_response_spec.rb +77 -0
- data/spec/models/validate_country_response_spec.rb +30 -0
- data/spec/models/xss_protection_result_spec.rb +59 -0
- metadata +20 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: af976c8119e72adb285d9be4eeac657cf36266303727a89d71af599237c9030e
|
4
|
+
data.tar.gz: fa9de07603fd5982bd7936f055302926abaa5307c53995ecff1a89bff0e944f4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6d39dc860c9ab1c9460e7c165967c1b57b505fbace518aed79f15a71f93b323ff0d0fba9a1aee5fea8eef774a314a2d2a6e8f716773259df74b1114d4afc98dc
|
7
|
+
data.tar.gz: f2cea25c3c298c97928f5dcfb400e52d0b6d19628997e2c3c5b4896437fac8dcf767c4338224696f2bec76b0e5318151e9abed2fb52c65074b4288733586a9ca
|
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.
|
10
|
+
- Package version: 2.1.1
|
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.
|
26
|
+
gem install ./cloudmersive-validate-api-client-2.1.1.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.1.1.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.
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 2.1.1'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -86,19 +86,25 @@ Class | Method | HTTP request | Description
|
|
86
86
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_check_eu_membership**](docs/AddressApi.md#address_check_eu_membership) | **POST** /validate/address/country/check-eu-membership | Check if a country is a member of the European Union (EU)
|
87
87
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_country**](docs/AddressApi.md#address_country) | **POST** /validate/address/country | Validate and normalize country information, return ISO 3166-1 country codes and country name
|
88
88
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_country_list**](docs/AddressApi.md#address_country_list) | **POST** /validate/address/country/list | Get a list of ISO 3166-1 countries
|
89
|
+
*CloudmersiveValidateApiClient::AddressApi* | [**address_geocode**](docs/AddressApi.md#address_geocode) | **POST** /validate/address/geocode | Geocode a street address into latitude and longitude
|
90
|
+
*CloudmersiveValidateApiClient::AddressApi* | [**address_get_country_currency**](docs/AddressApi.md#address_get_country_currency) | **POST** /validate/address/country/get-currency | Get the currency of the input country
|
91
|
+
*CloudmersiveValidateApiClient::AddressApi* | [**address_get_country_region**](docs/AddressApi.md#address_get_country_region) | **POST** /validate/address/country/get-region | Get the region, subregion and continent of the country
|
89
92
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_get_timezone**](docs/AddressApi.md#address_get_timezone) | **POST** /validate/address/country/get-timezones | Gets IANA/Olsen time zones for a country
|
90
93
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_parse_string**](docs/AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
|
94
|
+
*CloudmersiveValidateApiClient::AddressApi* | [**address_reverse_geocode_address**](docs/AddressApi.md#address_reverse_geocode_address) | **POST** /validate/address/geocode/reverse | Reverse geocode a lattitude and longitude into an address
|
91
95
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_validate_address**](docs/AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
|
92
96
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_validate_city**](docs/AddressApi.md#address_validate_city) | **POST** /validate/address/city | Validate a City and State/Province combination, get location information about it
|
93
97
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_validate_postal_code**](docs/AddressApi.md#address_validate_postal_code) | **POST** /validate/address/postal-code | Validate a postal code, get location information about it
|
94
98
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_validate_state**](docs/AddressApi.md#address_validate_state) | **POST** /validate/address/state | Validate a state or province, name or abbreviation, get location information about it
|
95
99
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
96
100
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
101
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_quality_score**](docs/DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
|
97
102
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
98
103
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_syntax_only**](docs/DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
99
104
|
*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
|
100
105
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
|
101
106
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
|
107
|
+
*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
|
102
108
|
*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
|
103
109
|
*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
|
104
110
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
@@ -109,6 +115,8 @@ Class | Method | HTTP request | Description
|
|
109
115
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
110
116
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
111
117
|
*CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
|
118
|
+
*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
|
119
|
+
*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
|
112
120
|
*CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
|
113
121
|
*CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
|
114
122
|
|
@@ -120,12 +128,14 @@ Class | Method | HTTP request | Description
|
|
120
128
|
- [CloudmersiveValidateApiClient::CheckResponse](docs/CheckResponse.md)
|
121
129
|
- [CloudmersiveValidateApiClient::CountryDetails](docs/CountryDetails.md)
|
122
130
|
- [CloudmersiveValidateApiClient::CountryListResult](docs/CountryListResult.md)
|
131
|
+
- [CloudmersiveValidateApiClient::DomainQualityResponse](docs/DomainQualityResponse.md)
|
123
132
|
- [CloudmersiveValidateApiClient::FirstNameValidationRequest](docs/FirstNameValidationRequest.md)
|
124
133
|
- [CloudmersiveValidateApiClient::FirstNameValidationResponse](docs/FirstNameValidationResponse.md)
|
125
134
|
- [CloudmersiveValidateApiClient::FullEmailValidationResponse](docs/FullEmailValidationResponse.md)
|
126
135
|
- [CloudmersiveValidateApiClient::FullNameValidationRequest](docs/FullNameValidationRequest.md)
|
127
136
|
- [CloudmersiveValidateApiClient::FullNameValidationResponse](docs/FullNameValidationResponse.md)
|
128
137
|
- [CloudmersiveValidateApiClient::GeolocateResponse](docs/GeolocateResponse.md)
|
138
|
+
- [CloudmersiveValidateApiClient::GeolocateStreetAddressResponse](docs/GeolocateStreetAddressResponse.md)
|
129
139
|
- [CloudmersiveValidateApiClient::GetGenderRequest](docs/GetGenderRequest.md)
|
130
140
|
- [CloudmersiveValidateApiClient::GetGenderResponse](docs/GetGenderResponse.md)
|
131
141
|
- [CloudmersiveValidateApiClient::GetTimezonesRequest](docs/GetTimezonesRequest.md)
|
@@ -139,6 +149,8 @@ Class | Method | HTTP request | Description
|
|
139
149
|
- [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
|
140
150
|
- [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
|
141
151
|
- [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
|
152
|
+
- [CloudmersiveValidateApiClient::ReverseGeocodeAddressRequest](docs/ReverseGeocodeAddressRequest.md)
|
153
|
+
- [CloudmersiveValidateApiClient::ReverseGeocodeAddressResponse](docs/ReverseGeocodeAddressResponse.md)
|
142
154
|
- [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
|
143
155
|
- [CloudmersiveValidateApiClient::TorNodeResponse](docs/TorNodeResponse.md)
|
144
156
|
- [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
|
@@ -162,6 +174,7 @@ Class | Method | HTTP request | Description
|
|
162
174
|
- [CloudmersiveValidateApiClient::VatLookupRequest](docs/VatLookupRequest.md)
|
163
175
|
- [CloudmersiveValidateApiClient::VatLookupResponse](docs/VatLookupResponse.md)
|
164
176
|
- [CloudmersiveValidateApiClient::WhoisResponse](docs/WhoisResponse.md)
|
177
|
+
- [CloudmersiveValidateApiClient::XssProtectionResult](docs/XssProtectionResult.md)
|
165
178
|
|
166
179
|
|
167
180
|
## Documentation for Authorization
|
data/docs/AddressApi.md
CHANGED
@@ -7,8 +7,12 @@ Method | HTTP request | Description
|
|
7
7
|
[**address_check_eu_membership**](AddressApi.md#address_check_eu_membership) | **POST** /validate/address/country/check-eu-membership | Check if a country is a member of the European Union (EU)
|
8
8
|
[**address_country**](AddressApi.md#address_country) | **POST** /validate/address/country | Validate and normalize country information, return ISO 3166-1 country codes and country name
|
9
9
|
[**address_country_list**](AddressApi.md#address_country_list) | **POST** /validate/address/country/list | Get a list of ISO 3166-1 countries
|
10
|
+
[**address_geocode**](AddressApi.md#address_geocode) | **POST** /validate/address/geocode | Geocode a street address into latitude and longitude
|
11
|
+
[**address_get_country_currency**](AddressApi.md#address_get_country_currency) | **POST** /validate/address/country/get-currency | Get the currency of the input country
|
12
|
+
[**address_get_country_region**](AddressApi.md#address_get_country_region) | **POST** /validate/address/country/get-region | Get the region, subregion and continent of the country
|
10
13
|
[**address_get_timezone**](AddressApi.md#address_get_timezone) | **POST** /validate/address/country/get-timezones | Gets IANA/Olsen time zones for a country
|
11
14
|
[**address_parse_string**](AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
|
15
|
+
[**address_reverse_geocode_address**](AddressApi.md#address_reverse_geocode_address) | **POST** /validate/address/geocode/reverse | Reverse geocode a lattitude and longitude into an address
|
12
16
|
[**address_validate_address**](AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
|
13
17
|
[**address_validate_city**](AddressApi.md#address_validate_city) | **POST** /validate/address/city | Validate a City and State/Province combination, get location information about it
|
14
18
|
[**address_validate_postal_code**](AddressApi.md#address_validate_postal_code) | **POST** /validate/address/postal-code | Validate a postal code, get location information about it
|
@@ -171,6 +175,168 @@ This endpoint does not need any parameter.
|
|
171
175
|
|
172
176
|
|
173
177
|
|
178
|
+
# **address_geocode**
|
179
|
+
> ValidateAddressResponse address_geocode(input)
|
180
|
+
|
181
|
+
Geocode a street address into latitude and longitude
|
182
|
+
|
183
|
+
Geocodes a street address into latitude and longitude.
|
184
|
+
|
185
|
+
### Example
|
186
|
+
```ruby
|
187
|
+
# load the gem
|
188
|
+
require 'cloudmersive-validate-api-client'
|
189
|
+
# setup authorization
|
190
|
+
CloudmersiveValidateApiClient.configure do |config|
|
191
|
+
# Configure API key authorization: Apikey
|
192
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
193
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
194
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
195
|
+
end
|
196
|
+
|
197
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
198
|
+
|
199
|
+
input = CloudmersiveValidateApiClient::ValidateAddressRequest.new # ValidateAddressRequest | Input parse request
|
200
|
+
|
201
|
+
|
202
|
+
begin
|
203
|
+
#Geocode a street address into latitude and longitude
|
204
|
+
result = api_instance.address_geocode(input)
|
205
|
+
p result
|
206
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
207
|
+
puts "Exception when calling AddressApi->address_geocode: #{e}"
|
208
|
+
end
|
209
|
+
```
|
210
|
+
|
211
|
+
### Parameters
|
212
|
+
|
213
|
+
Name | Type | Description | Notes
|
214
|
+
------------- | ------------- | ------------- | -------------
|
215
|
+
**input** | [**ValidateAddressRequest**](ValidateAddressRequest.md)| Input parse request |
|
216
|
+
|
217
|
+
### Return type
|
218
|
+
|
219
|
+
[**ValidateAddressResponse**](ValidateAddressResponse.md)
|
220
|
+
|
221
|
+
### Authorization
|
222
|
+
|
223
|
+
[Apikey](../README.md#Apikey)
|
224
|
+
|
225
|
+
### HTTP request headers
|
226
|
+
|
227
|
+
- **Content-Type**: application/json, text/json
|
228
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
# **address_get_country_currency**
|
233
|
+
> ValidateCountryResponse address_get_country_currency(input)
|
234
|
+
|
235
|
+
Get the currency of the input country
|
236
|
+
|
237
|
+
Gets the currency information for the input country, including the ISO three-letter country code, currency symbol, and English currency name.
|
238
|
+
|
239
|
+
### Example
|
240
|
+
```ruby
|
241
|
+
# load the gem
|
242
|
+
require 'cloudmersive-validate-api-client'
|
243
|
+
# setup authorization
|
244
|
+
CloudmersiveValidateApiClient.configure do |config|
|
245
|
+
# Configure API key authorization: Apikey
|
246
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
247
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
248
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
249
|
+
end
|
250
|
+
|
251
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
252
|
+
|
253
|
+
input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
|
254
|
+
|
255
|
+
|
256
|
+
begin
|
257
|
+
#Get the currency of the input country
|
258
|
+
result = api_instance.address_get_country_currency(input)
|
259
|
+
p result
|
260
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
261
|
+
puts "Exception when calling AddressApi->address_get_country_currency: #{e}"
|
262
|
+
end
|
263
|
+
```
|
264
|
+
|
265
|
+
### Parameters
|
266
|
+
|
267
|
+
Name | Type | Description | Notes
|
268
|
+
------------- | ------------- | ------------- | -------------
|
269
|
+
**input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
|
270
|
+
|
271
|
+
### Return type
|
272
|
+
|
273
|
+
[**ValidateCountryResponse**](ValidateCountryResponse.md)
|
274
|
+
|
275
|
+
### Authorization
|
276
|
+
|
277
|
+
[Apikey](../README.md#Apikey)
|
278
|
+
|
279
|
+
### HTTP request headers
|
280
|
+
|
281
|
+
- **Content-Type**: application/json, text/json
|
282
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
# **address_get_country_region**
|
287
|
+
> ValidateCountryResponse address_get_country_region(input)
|
288
|
+
|
289
|
+
Get the region, subregion and continent of the country
|
290
|
+
|
291
|
+
Gets the continent information including region and subregion for the input country.
|
292
|
+
|
293
|
+
### Example
|
294
|
+
```ruby
|
295
|
+
# load the gem
|
296
|
+
require 'cloudmersive-validate-api-client'
|
297
|
+
# setup authorization
|
298
|
+
CloudmersiveValidateApiClient.configure do |config|
|
299
|
+
# Configure API key authorization: Apikey
|
300
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
301
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
302
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
303
|
+
end
|
304
|
+
|
305
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
306
|
+
|
307
|
+
input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
|
308
|
+
|
309
|
+
|
310
|
+
begin
|
311
|
+
#Get the region, subregion and continent of the country
|
312
|
+
result = api_instance.address_get_country_region(input)
|
313
|
+
p result
|
314
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
315
|
+
puts "Exception when calling AddressApi->address_get_country_region: #{e}"
|
316
|
+
end
|
317
|
+
```
|
318
|
+
|
319
|
+
### Parameters
|
320
|
+
|
321
|
+
Name | Type | Description | Notes
|
322
|
+
------------- | ------------- | ------------- | -------------
|
323
|
+
**input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
|
324
|
+
|
325
|
+
### Return type
|
326
|
+
|
327
|
+
[**ValidateCountryResponse**](ValidateCountryResponse.md)
|
328
|
+
|
329
|
+
### Authorization
|
330
|
+
|
331
|
+
[Apikey](../README.md#Apikey)
|
332
|
+
|
333
|
+
### HTTP request headers
|
334
|
+
|
335
|
+
- **Content-Type**: application/json, text/json
|
336
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
337
|
+
|
338
|
+
|
339
|
+
|
174
340
|
# **address_get_timezone**
|
175
341
|
> GetTimezonesResponse address_get_timezone(input)
|
176
342
|
|
@@ -279,6 +445,60 @@ Name | Type | Description | Notes
|
|
279
445
|
|
280
446
|
|
281
447
|
|
448
|
+
# **address_reverse_geocode_address**
|
449
|
+
> ReverseGeocodeAddressResponse address_reverse_geocode_address(input)
|
450
|
+
|
451
|
+
Reverse geocode a lattitude and longitude into an address
|
452
|
+
|
453
|
+
Converts lattitude and longitude coordinates into an address through reverse-geocoding.
|
454
|
+
|
455
|
+
### Example
|
456
|
+
```ruby
|
457
|
+
# load the gem
|
458
|
+
require 'cloudmersive-validate-api-client'
|
459
|
+
# setup authorization
|
460
|
+
CloudmersiveValidateApiClient.configure do |config|
|
461
|
+
# Configure API key authorization: Apikey
|
462
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
463
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
464
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
465
|
+
end
|
466
|
+
|
467
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
468
|
+
|
469
|
+
input = CloudmersiveValidateApiClient::ReverseGeocodeAddressRequest.new # ReverseGeocodeAddressRequest | Input reverse geocoding request
|
470
|
+
|
471
|
+
|
472
|
+
begin
|
473
|
+
#Reverse geocode a lattitude and longitude into an address
|
474
|
+
result = api_instance.address_reverse_geocode_address(input)
|
475
|
+
p result
|
476
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
477
|
+
puts "Exception when calling AddressApi->address_reverse_geocode_address: #{e}"
|
478
|
+
end
|
479
|
+
```
|
480
|
+
|
481
|
+
### Parameters
|
482
|
+
|
483
|
+
Name | Type | Description | Notes
|
484
|
+
------------- | ------------- | ------------- | -------------
|
485
|
+
**input** | [**ReverseGeocodeAddressRequest**](ReverseGeocodeAddressRequest.md)| Input reverse geocoding request |
|
486
|
+
|
487
|
+
### Return type
|
488
|
+
|
489
|
+
[**ReverseGeocodeAddressResponse**](ReverseGeocodeAddressResponse.md)
|
490
|
+
|
491
|
+
### Authorization
|
492
|
+
|
493
|
+
[Apikey](../README.md#Apikey)
|
494
|
+
|
495
|
+
### HTTP request headers
|
496
|
+
|
497
|
+
- **Content-Type**: application/json, text/json
|
498
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
499
|
+
|
500
|
+
|
501
|
+
|
282
502
|
# **address_validate_address**
|
283
503
|
> ValidateAddressResponse address_validate_address(input)
|
284
504
|
|
data/docs/CountryDetails.md
CHANGED
@@ -7,5 +7,10 @@ Name | Type | Description | Notes
|
|
7
7
|
**three_letter_code** | **String** | Three-letter ISO 3166-1 country code | [optional]
|
8
8
|
**iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional]
|
9
9
|
**is_european_union_member** | **BOOLEAN** | True if this country is currently a member of the European Union (EU), false otherwise | [optional]
|
10
|
+
**iso_currency_code** | **String** | ISO 4217 currency three-letter code associated with the country | [optional]
|
11
|
+
**currency_symbol** | **String** | Symbol associated with the currency | [optional]
|
12
|
+
**currency_english_name** | **String** | Full name of the currency | [optional]
|
13
|
+
**region** | **String** | Region (continent) in which the country is located; possible values are None, Europe, Americas, Asia, Africa, Oceania | [optional]
|
14
|
+
**subregion** | **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]
|
10
15
|
|
11
16
|
|
data/docs/DomainApi.md
CHANGED
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**domain_check**](DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
8
8
|
[**domain_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
9
|
+
[**domain_quality_score**](DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
|
9
10
|
[**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
10
11
|
[**domain_url_syntax_only**](DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
11
12
|
|
@@ -118,6 +119,60 @@ Name | Type | Description | Notes
|
|
118
119
|
|
119
120
|
|
120
121
|
|
122
|
+
# **domain_quality_score**
|
123
|
+
> DomainQualityResponse domain_quality_score(domain)
|
124
|
+
|
125
|
+
Validate a domain name's quality score
|
126
|
+
|
127
|
+
Check the quality of a domain name. Supports over 9 million domain names. Higher quality scores indicate more trust and authority in the domain name, with values ranging from 0.0 (low quality) to 10.0 (maximum quality).
|
128
|
+
|
129
|
+
### Example
|
130
|
+
```ruby
|
131
|
+
# load the gem
|
132
|
+
require 'cloudmersive-validate-api-client'
|
133
|
+
# setup authorization
|
134
|
+
CloudmersiveValidateApiClient.configure do |config|
|
135
|
+
# Configure API key authorization: Apikey
|
136
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
137
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
138
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
139
|
+
end
|
140
|
+
|
141
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
142
|
+
|
143
|
+
domain = 'domain_example' # String | Domain name to check, for example \"cloudmersive.com\".
|
144
|
+
|
145
|
+
|
146
|
+
begin
|
147
|
+
#Validate a domain name's quality score
|
148
|
+
result = api_instance.domain_quality_score(domain)
|
149
|
+
p result
|
150
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
151
|
+
puts "Exception when calling DomainApi->domain_quality_score: #{e}"
|
152
|
+
end
|
153
|
+
```
|
154
|
+
|
155
|
+
### Parameters
|
156
|
+
|
157
|
+
Name | Type | Description | Notes
|
158
|
+
------------- | ------------- | ------------- | -------------
|
159
|
+
**domain** | **String**| Domain name to check, for example \"cloudmersive.com\". |
|
160
|
+
|
161
|
+
### Return type
|
162
|
+
|
163
|
+
[**DomainQualityResponse**](DomainQualityResponse.md)
|
164
|
+
|
165
|
+
### Authorization
|
166
|
+
|
167
|
+
[Apikey](../README.md#Apikey)
|
168
|
+
|
169
|
+
### HTTP request headers
|
170
|
+
|
171
|
+
- **Content-Type**: text/javascript, application/json, text/json
|
172
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
173
|
+
|
174
|
+
|
175
|
+
|
121
176
|
# **domain_url_full**
|
122
177
|
> ValidateUrlResponseFull domain_url_full(request)
|
123
178
|
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::DomainQualityResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**domain_quality_score** | **Float** | The quality score of the domain name; possible values are 0.0 to 10.0 with 10.0 being the highest and 0.0 being the lowest quality. | [optional]
|
7
|
+
|
8
|
+
|
@@ -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
|
+
|