cloudmersive-validate-api-client 2.0.2 → 2.0.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +7 -0
- data/README.md +176 -0
- data/Rakefile +8 -0
- data/cloudmersive-validate-api-client.gemspec +45 -0
- data/docs/AddressApi.md +552 -0
- data/docs/AddressGetServersResponse.md +9 -0
- data/docs/AddressVerifySyntaxOnlyResponse.md +11 -0
- data/docs/CheckResponse.md +8 -0
- data/docs/CountryDetails.md +14 -0
- data/docs/CountryListResult.md +9 -0
- data/docs/DomainApi.md +228 -0
- data/docs/EmailApi.md +173 -0
- data/docs/FirstNameValidationRequest.md +8 -0
- data/docs/FirstNameValidationResponse.md +9 -0
- data/docs/FullEmailValidationResponse.md +16 -0
- data/docs/FullNameValidationRequest.md +8 -0
- data/docs/FullNameValidationResponse.md +17 -0
- data/docs/GeolocateResponse.md +16 -0
- data/docs/GetGenderRequest.md +9 -0
- data/docs/GetGenderResponse.md +9 -0
- data/docs/GetTimezonesRequest.md +8 -0
- data/docs/GetTimezonesResponse.md +13 -0
- data/docs/IPAddressApi.md +173 -0
- data/docs/IPThreatResponse.md +9 -0
- data/docs/LastNameValidationRequest.md +8 -0
- data/docs/LastNameValidationResponse.md +9 -0
- data/docs/LeadEnrichmentApi.md +61 -0
- data/docs/LeadEnrichmentRequest.md +21 -0
- data/docs/LeadEnrichmentResponse.md +25 -0
- data/docs/NameApi.md +283 -0
- data/docs/ParseAddressRequest.md +9 -0
- data/docs/ParseAddressResponse.md +16 -0
- data/docs/PhoneNumberApi.md +63 -0
- data/docs/PhoneNumberValidateRequest.md +9 -0
- data/docs/PhoneNumberValidationResponse.md +15 -0
- data/docs/Timezone.md +10 -0
- data/docs/TorNodeResponse.md +8 -0
- data/docs/UserAgentApi.md +63 -0
- data/docs/UserAgentValidateRequest.md +8 -0
- data/docs/UserAgentValidateResponse.md +21 -0
- data/docs/ValidateAddressRequest.md +13 -0
- data/docs/ValidateAddressResponse.md +10 -0
- data/docs/ValidateCityRequest.md +11 -0
- data/docs/ValidateCityResponse.md +12 -0
- data/docs/ValidateCountryRequest.md +8 -0
- data/docs/ValidateCountryResponse.md +17 -0
- data/docs/ValidateIdentifierRequest.md +15 -0
- data/docs/ValidateIdentifierResponse.md +9 -0
- data/docs/ValidatePostalCodeRequest.md +10 -0
- data/docs/ValidatePostalCodeResponse.md +12 -0
- data/docs/ValidateStateRequest.md +10 -0
- data/docs/ValidateStateResponse.md +11 -0
- data/docs/ValidateUrlRequestFull.md +8 -0
- data/docs/ValidateUrlRequestSyntaxOnly.md +8 -0
- data/docs/ValidateUrlResponseFull.md +12 -0
- data/docs/ValidateUrlResponseSyntaxOnly.md +9 -0
- data/docs/VatApi.md +63 -0
- data/docs/VatLookupRequest.md +8 -0
- data/docs/VatLookupResponse.md +19 -0
- data/docs/WhoisResponse.md +22 -0
- data/git_push.sh +55 -0
- data/lib/cloudmersive-validate-api-client.rb +95 -0
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +555 -0
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +239 -0
- data/lib/cloudmersive-validate-api-client/api/email_api.rb +185 -0
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +185 -0
- data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb +75 -0
- data/lib/cloudmersive-validate-api-client/api/name_api.rb +293 -0
- data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +77 -0
- data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +77 -0
- data/lib/cloudmersive-validate-api-client/api/vat_api.rb +77 -0
- data/lib/cloudmersive-validate-api-client/api_client.rb +391 -0
- data/lib/cloudmersive-validate-api-client/api_error.rb +38 -0
- data/lib/cloudmersive-validate-api-client/configuration.rb +209 -0
- data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +198 -0
- data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +216 -0
- data/lib/cloudmersive-validate-api-client/models/check_response.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/country_details.rb +246 -0
- data/lib/cloudmersive-validate-api-client/models/country_list_result.rb +198 -0
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +276 -0
- data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/get_timezones_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/get_timezones_response.rb +238 -0
- data/lib/cloudmersive-validate-api-client/models/ip_threat_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/lead_enrichment_request.rb +316 -0
- data/lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb +356 -0
- data/lib/cloudmersive-validate-api-client/models/parse_address_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/parse_address_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +256 -0
- data/lib/cloudmersive-validate-api-client/models/timezone.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/tor_node_response.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +316 -0
- data/lib/cloudmersive-validate-api-client/models/validate_address_request.rb +236 -0
- data/lib/cloudmersive-validate-api-client/models/validate_address_response.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/validate_city_request.rb +216 -0
- data/lib/cloudmersive-validate-api-client/models/validate_city_response.rb +226 -0
- data/lib/cloudmersive-validate-api-client/models/validate_country_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/validate_country_response.rb +278 -0
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb +256 -0
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/validate_postal_code_request.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/validate_postal_code_response.rb +226 -0
- data/lib/cloudmersive-validate-api-client/models/validate_state_request.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/validate_state_response.rb +216 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_request_full.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_request_syntax_only.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_full.rb +226 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +295 -0
- data/lib/cloudmersive-validate-api-client/models/whois_response.rb +326 -0
- data/lib/cloudmersive-validate-api-client/version.rb +15 -0
- data/spec/api/address_api_spec.rb +154 -0
- data/spec/api/domain_api_spec.rb +83 -0
- data/spec/api/email_api_spec.rb +71 -0
- data/spec/api/ip_address_api_spec.rb +71 -0
- data/spec/api/lead_enrichment_api_spec.rb +46 -0
- data/spec/api/name_api_spec.rb +95 -0
- data/spec/api/phone_number_api_spec.rb +47 -0
- data/spec/api/user_agent_api_spec.rb +47 -0
- data/spec/api/vat_api_spec.rb +47 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/address_get_servers_response_spec.rb +47 -0
- data/spec/models/address_verify_syntax_only_response_spec.rb +59 -0
- data/spec/models/check_response_spec.rb +41 -0
- data/spec/models/country_details_spec.rb +77 -0
- data/spec/models/country_list_result_spec.rb +47 -0
- data/spec/models/first_name_validation_request_spec.rb +41 -0
- data/spec/models/first_name_validation_response_spec.rb +47 -0
- data/spec/models/full_email_validation_response_spec.rb +89 -0
- data/spec/models/full_name_validation_request_spec.rb +41 -0
- data/spec/models/full_name_validation_response_spec.rb +95 -0
- data/spec/models/geolocate_response_spec.rb +89 -0
- data/spec/models/get_gender_request_spec.rb +47 -0
- data/spec/models/get_gender_response_spec.rb +47 -0
- data/spec/models/get_timezones_request_spec.rb +41 -0
- data/spec/models/get_timezones_response_spec.rb +71 -0
- data/spec/models/ip_threat_response_spec.rb +47 -0
- data/spec/models/last_name_validation_request_spec.rb +41 -0
- data/spec/models/last_name_validation_response_spec.rb +47 -0
- data/spec/models/lead_enrichment_request_spec.rb +119 -0
- data/spec/models/lead_enrichment_response_spec.rb +143 -0
- data/spec/models/parse_address_request_spec.rb +47 -0
- data/spec/models/parse_address_response_spec.rb +89 -0
- data/spec/models/phone_number_validate_request_spec.rb +47 -0
- data/spec/models/phone_number_validation_response_spec.rb +83 -0
- data/spec/models/timezone_spec.rb +53 -0
- data/spec/models/tor_node_response_spec.rb +41 -0
- data/spec/models/user_agent_validate_request_spec.rb +41 -0
- data/spec/models/user_agent_validate_response_spec.rb +119 -0
- data/spec/models/validate_address_request_spec.rb +71 -0
- data/spec/models/validate_address_response_spec.rb +53 -0
- data/spec/models/validate_city_request_spec.rb +59 -0
- data/spec/models/validate_city_response_spec.rb +65 -0
- data/spec/models/validate_country_request_spec.rb +41 -0
- data/spec/models/validate_country_response_spec.rb +95 -0
- data/spec/models/validate_identifier_request_spec.rb +83 -0
- data/spec/models/validate_identifier_response_spec.rb +47 -0
- data/spec/models/validate_postal_code_request_spec.rb +53 -0
- data/spec/models/validate_postal_code_response_spec.rb +65 -0
- data/spec/models/validate_state_request_spec.rb +53 -0
- data/spec/models/validate_state_response_spec.rb +59 -0
- data/spec/models/validate_url_request_full_spec.rb +41 -0
- data/spec/models/validate_url_request_syntax_only_spec.rb +41 -0
- data/spec/models/validate_url_response_full_spec.rb +65 -0
- data/spec/models/validate_url_response_syntax_only_spec.rb +47 -0
- data/spec/models/vat_lookup_request_spec.rb +41 -0
- data/spec/models/vat_lookup_response_spec.rb +107 -0
- data/spec/models/whois_response_spec.rb +125 -0
- data/spec/spec_helper.rb +111 -0
- metadata +184 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d14d3b1a082f8d1d2ae4b50a65512242ca9b152d4b29c5e42ba42473e71f2996
|
4
|
+
data.tar.gz: 5f569c749b74e3d990631780d331f8cefeb120becfe22b64adf24f7dfb9c01ed
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2a5e2ca62a6ff43f583cd766070f99f965049e91c0d3641b7a28353cb6d9713988742cffb7adbfd92cf18da3226fd9d87abe6a0d6431a726c8b40c9cd43c20fc
|
7
|
+
data.tar.gz: 4e3e9e3bf3784121b61b33181e12e50bf1fd5844882ff14665ea59283d6ce1df2387c0d4ce701e3eb9af8137b9abe987dbfbf9940d422e468a1c49b26a323850
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,176 @@
|
|
1
|
+
# cloudmersive-validate-api-client
|
2
|
+
|
3
|
+
CloudmersiveValidateApiClient - the Ruby gem for the validateapi
|
4
|
+
|
5
|
+
The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
|
+
|
9
|
+
- API version: v1
|
10
|
+
- Package version: 2.0.7
|
11
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
### Build a gem
|
16
|
+
|
17
|
+
To build the Ruby code into a gem:
|
18
|
+
|
19
|
+
```shell
|
20
|
+
gem build cloudmersive-validate-api-client.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./cloudmersive-validate-api-client-2.0.7.gem
|
27
|
+
```
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.0.7.gem` to install the development dependencies)
|
29
|
+
|
30
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
|
+
|
32
|
+
Finally add this to the Gemfile:
|
33
|
+
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 2.0.7'
|
35
|
+
|
36
|
+
### Install from Git
|
37
|
+
|
38
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
39
|
+
|
40
|
+
gem 'cloudmersive-validate-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
41
|
+
|
42
|
+
### Include the Ruby code directly
|
43
|
+
|
44
|
+
Include the Ruby code directly using `-I` as follows:
|
45
|
+
|
46
|
+
```shell
|
47
|
+
ruby -Ilib script.rb
|
48
|
+
```
|
49
|
+
|
50
|
+
## Getting Started
|
51
|
+
|
52
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
53
|
+
```ruby
|
54
|
+
# Load the gem
|
55
|
+
require 'cloudmersive-validate-api-client'
|
56
|
+
|
57
|
+
# Setup authorization
|
58
|
+
CloudmersiveValidateApiClient.configure do |config|
|
59
|
+
# Configure API key authorization: Apikey
|
60
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
61
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
62
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
63
|
+
end
|
64
|
+
|
65
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
66
|
+
|
67
|
+
input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
|
68
|
+
|
69
|
+
|
70
|
+
begin
|
71
|
+
#Check if a country is a member of the European Union (EU)
|
72
|
+
result = api_instance.address_check_eu_membership(input)
|
73
|
+
p result
|
74
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
75
|
+
puts "Exception when calling AddressApi->address_check_eu_membership: #{e}"
|
76
|
+
end
|
77
|
+
|
78
|
+
```
|
79
|
+
|
80
|
+
## Documentation for API Endpoints
|
81
|
+
|
82
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
83
|
+
|
84
|
+
Class | Method | HTTP request | Description
|
85
|
+
------------ | ------------- | ------------- | -------------
|
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
|
+
*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
|
+
*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_get_country_currency**](docs/AddressApi.md#address_get_country_currency) | **POST** /validate/address/country/get-currency | Get the currency of the input country
|
90
|
+
*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
|
91
|
+
*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
|
92
|
+
*CloudmersiveValidateApiClient::AddressApi* | [**address_validate_address**](docs/AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
|
93
|
+
*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
|
94
|
+
*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
|
95
|
+
*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
|
96
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
97
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
98
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
99
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_syntax_only**](docs/DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
100
|
+
*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
|
101
|
+
*CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
|
102
|
+
*CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
|
103
|
+
*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
|
104
|
+
*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
|
105
|
+
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
106
|
+
*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
|
107
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
|
108
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
|
109
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_first_name**](docs/NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
|
110
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
111
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
112
|
+
*CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
|
113
|
+
*CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
|
114
|
+
*CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
|
115
|
+
|
116
|
+
|
117
|
+
## Documentation for Models
|
118
|
+
|
119
|
+
- [CloudmersiveValidateApiClient::AddressGetServersResponse](docs/AddressGetServersResponse.md)
|
120
|
+
- [CloudmersiveValidateApiClient::AddressVerifySyntaxOnlyResponse](docs/AddressVerifySyntaxOnlyResponse.md)
|
121
|
+
- [CloudmersiveValidateApiClient::CheckResponse](docs/CheckResponse.md)
|
122
|
+
- [CloudmersiveValidateApiClient::CountryDetails](docs/CountryDetails.md)
|
123
|
+
- [CloudmersiveValidateApiClient::CountryListResult](docs/CountryListResult.md)
|
124
|
+
- [CloudmersiveValidateApiClient::FirstNameValidationRequest](docs/FirstNameValidationRequest.md)
|
125
|
+
- [CloudmersiveValidateApiClient::FirstNameValidationResponse](docs/FirstNameValidationResponse.md)
|
126
|
+
- [CloudmersiveValidateApiClient::FullEmailValidationResponse](docs/FullEmailValidationResponse.md)
|
127
|
+
- [CloudmersiveValidateApiClient::FullNameValidationRequest](docs/FullNameValidationRequest.md)
|
128
|
+
- [CloudmersiveValidateApiClient::FullNameValidationResponse](docs/FullNameValidationResponse.md)
|
129
|
+
- [CloudmersiveValidateApiClient::GeolocateResponse](docs/GeolocateResponse.md)
|
130
|
+
- [CloudmersiveValidateApiClient::GetGenderRequest](docs/GetGenderRequest.md)
|
131
|
+
- [CloudmersiveValidateApiClient::GetGenderResponse](docs/GetGenderResponse.md)
|
132
|
+
- [CloudmersiveValidateApiClient::GetTimezonesRequest](docs/GetTimezonesRequest.md)
|
133
|
+
- [CloudmersiveValidateApiClient::GetTimezonesResponse](docs/GetTimezonesResponse.md)
|
134
|
+
- [CloudmersiveValidateApiClient::IPThreatResponse](docs/IPThreatResponse.md)
|
135
|
+
- [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
|
136
|
+
- [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
|
137
|
+
- [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.md)
|
138
|
+
- [CloudmersiveValidateApiClient::LeadEnrichmentResponse](docs/LeadEnrichmentResponse.md)
|
139
|
+
- [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
|
140
|
+
- [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
|
141
|
+
- [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
|
142
|
+
- [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
|
143
|
+
- [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
|
144
|
+
- [CloudmersiveValidateApiClient::TorNodeResponse](docs/TorNodeResponse.md)
|
145
|
+
- [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
|
146
|
+
- [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
|
147
|
+
- [CloudmersiveValidateApiClient::ValidateAddressRequest](docs/ValidateAddressRequest.md)
|
148
|
+
- [CloudmersiveValidateApiClient::ValidateAddressResponse](docs/ValidateAddressResponse.md)
|
149
|
+
- [CloudmersiveValidateApiClient::ValidateCityRequest](docs/ValidateCityRequest.md)
|
150
|
+
- [CloudmersiveValidateApiClient::ValidateCityResponse](docs/ValidateCityResponse.md)
|
151
|
+
- [CloudmersiveValidateApiClient::ValidateCountryRequest](docs/ValidateCountryRequest.md)
|
152
|
+
- [CloudmersiveValidateApiClient::ValidateCountryResponse](docs/ValidateCountryResponse.md)
|
153
|
+
- [CloudmersiveValidateApiClient::ValidateIdentifierRequest](docs/ValidateIdentifierRequest.md)
|
154
|
+
- [CloudmersiveValidateApiClient::ValidateIdentifierResponse](docs/ValidateIdentifierResponse.md)
|
155
|
+
- [CloudmersiveValidateApiClient::ValidatePostalCodeRequest](docs/ValidatePostalCodeRequest.md)
|
156
|
+
- [CloudmersiveValidateApiClient::ValidatePostalCodeResponse](docs/ValidatePostalCodeResponse.md)
|
157
|
+
- [CloudmersiveValidateApiClient::ValidateStateRequest](docs/ValidateStateRequest.md)
|
158
|
+
- [CloudmersiveValidateApiClient::ValidateStateResponse](docs/ValidateStateResponse.md)
|
159
|
+
- [CloudmersiveValidateApiClient::ValidateUrlRequestFull](docs/ValidateUrlRequestFull.md)
|
160
|
+
- [CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly](docs/ValidateUrlRequestSyntaxOnly.md)
|
161
|
+
- [CloudmersiveValidateApiClient::ValidateUrlResponseFull](docs/ValidateUrlResponseFull.md)
|
162
|
+
- [CloudmersiveValidateApiClient::ValidateUrlResponseSyntaxOnly](docs/ValidateUrlResponseSyntaxOnly.md)
|
163
|
+
- [CloudmersiveValidateApiClient::VatLookupRequest](docs/VatLookupRequest.md)
|
164
|
+
- [CloudmersiveValidateApiClient::VatLookupResponse](docs/VatLookupResponse.md)
|
165
|
+
- [CloudmersiveValidateApiClient::WhoisResponse](docs/WhoisResponse.md)
|
166
|
+
|
167
|
+
|
168
|
+
## Documentation for Authorization
|
169
|
+
|
170
|
+
|
171
|
+
### Apikey
|
172
|
+
|
173
|
+
- **Type**: API key
|
174
|
+
- **API key parameter name**: Apikey
|
175
|
+
- **Location**: HTTP header
|
176
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
=begin
|
4
|
+
#validateapi
|
5
|
+
|
6
|
+
#The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
|
7
|
+
|
8
|
+
OpenAPI spec version: v1
|
9
|
+
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
11
|
+
Swagger Codegen version: 2.4.14
|
12
|
+
|
13
|
+
=end
|
14
|
+
|
15
|
+
$:.push File.expand_path("../lib", __FILE__)
|
16
|
+
require "cloudmersive-validate-api-client/version"
|
17
|
+
|
18
|
+
Gem::Specification.new do |s|
|
19
|
+
s.name = "cloudmersive-validate-api-client"
|
20
|
+
s.version = CloudmersiveValidateApiClient::VERSION
|
21
|
+
s.platform = Gem::Platform::RUBY
|
22
|
+
s.authors = ["Cloudmersive"]
|
23
|
+
s.email = [""]
|
24
|
+
s.homepage = "https://www.cloudmersive.com/validate-api"
|
25
|
+
s.summary = "Validate key business data thoroughly."
|
26
|
+
s.description = "The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API."
|
27
|
+
s.license = 'Apache 2.0'
|
28
|
+
s.required_ruby_version = ">= 1.9"
|
29
|
+
|
30
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
|
+
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
32
|
+
|
33
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
34
|
+
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
35
|
+
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
36
|
+
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
37
|
+
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
38
|
+
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
39
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
|
40
|
+
|
41
|
+
s.files = Dir['./**/*']
|
42
|
+
s.test_files = `find spec/*`.split("\n")
|
43
|
+
s.executables = []
|
44
|
+
s.require_paths = ["lib"]
|
45
|
+
end
|
data/docs/AddressApi.md
ADDED
@@ -0,0 +1,552 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::AddressApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
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
|
+
[**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
|
+
[**address_country_list**](AddressApi.md#address_country_list) | **POST** /validate/address/country/list | Get a list of ISO 3166-1 countries
|
10
|
+
[**address_get_country_currency**](AddressApi.md#address_get_country_currency) | **POST** /validate/address/country/get-currency | Get the currency of the input country
|
11
|
+
[**address_get_timezone**](AddressApi.md#address_get_timezone) | **POST** /validate/address/country/get-timezones | Gets IANA/Olsen time zones for a country
|
12
|
+
[**address_parse_string**](AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
|
13
|
+
[**address_validate_address**](AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
|
14
|
+
[**address_validate_city**](AddressApi.md#address_validate_city) | **POST** /validate/address/city | Validate a City and State/Province combination, get location information about it
|
15
|
+
[**address_validate_postal_code**](AddressApi.md#address_validate_postal_code) | **POST** /validate/address/postal-code | Validate a postal code, get location information about it
|
16
|
+
[**address_validate_state**](AddressApi.md#address_validate_state) | **POST** /validate/address/state | Validate a state or province, name or abbreviation, get location information about it
|
17
|
+
|
18
|
+
|
19
|
+
# **address_check_eu_membership**
|
20
|
+
> ValidateCountryResponse address_check_eu_membership(input)
|
21
|
+
|
22
|
+
Check if a country is a member of the European Union (EU)
|
23
|
+
|
24
|
+
Checks if the input country is a member of the European Union or not.
|
25
|
+
|
26
|
+
### Example
|
27
|
+
```ruby
|
28
|
+
# load the gem
|
29
|
+
require 'cloudmersive-validate-api-client'
|
30
|
+
# setup authorization
|
31
|
+
CloudmersiveValidateApiClient.configure do |config|
|
32
|
+
# Configure API key authorization: Apikey
|
33
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
34
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
35
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
36
|
+
end
|
37
|
+
|
38
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
39
|
+
|
40
|
+
input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
|
41
|
+
|
42
|
+
|
43
|
+
begin
|
44
|
+
#Check if a country is a member of the European Union (EU)
|
45
|
+
result = api_instance.address_check_eu_membership(input)
|
46
|
+
p result
|
47
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
48
|
+
puts "Exception when calling AddressApi->address_check_eu_membership: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
### Parameters
|
53
|
+
|
54
|
+
Name | Type | Description | Notes
|
55
|
+
------------- | ------------- | ------------- | -------------
|
56
|
+
**input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
|
57
|
+
|
58
|
+
### Return type
|
59
|
+
|
60
|
+
[**ValidateCountryResponse**](ValidateCountryResponse.md)
|
61
|
+
|
62
|
+
### Authorization
|
63
|
+
|
64
|
+
[Apikey](../README.md#Apikey)
|
65
|
+
|
66
|
+
### HTTP request headers
|
67
|
+
|
68
|
+
- **Content-Type**: application/json, text/json
|
69
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
# **address_country**
|
74
|
+
> ValidateCountryResponse address_country(input)
|
75
|
+
|
76
|
+
Validate and normalize country information, return ISO 3166-1 country codes and country name
|
77
|
+
|
78
|
+
Validates and normalizes country information, and returns key information about a country, as well as whether it is a member of the European Union. Also returns distinct time zones in the country.
|
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::AddressApi.new
|
93
|
+
|
94
|
+
input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
|
95
|
+
|
96
|
+
|
97
|
+
begin
|
98
|
+
#Validate and normalize country information, return ISO 3166-1 country codes and country name
|
99
|
+
result = api_instance.address_country(input)
|
100
|
+
p result
|
101
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
102
|
+
puts "Exception when calling AddressApi->address_country: #{e}"
|
103
|
+
end
|
104
|
+
```
|
105
|
+
|
106
|
+
### Parameters
|
107
|
+
|
108
|
+
Name | Type | Description | Notes
|
109
|
+
------------- | ------------- | ------------- | -------------
|
110
|
+
**input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
|
111
|
+
|
112
|
+
### Return type
|
113
|
+
|
114
|
+
[**ValidateCountryResponse**](ValidateCountryResponse.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
|
+
# **address_country_list**
|
128
|
+
> CountryListResult address_country_list
|
129
|
+
|
130
|
+
Get a list of ISO 3166-1 countries
|
131
|
+
|
132
|
+
Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.
|
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::AddressApi.new
|
147
|
+
|
148
|
+
begin
|
149
|
+
#Get a list of ISO 3166-1 countries
|
150
|
+
result = api_instance.address_country_list
|
151
|
+
p result
|
152
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
153
|
+
puts "Exception when calling AddressApi->address_country_list: #{e}"
|
154
|
+
end
|
155
|
+
```
|
156
|
+
|
157
|
+
### Parameters
|
158
|
+
This endpoint does not need any parameter.
|
159
|
+
|
160
|
+
### Return type
|
161
|
+
|
162
|
+
[**CountryListResult**](CountryListResult.md)
|
163
|
+
|
164
|
+
### Authorization
|
165
|
+
|
166
|
+
[Apikey](../README.md#Apikey)
|
167
|
+
|
168
|
+
### HTTP request headers
|
169
|
+
|
170
|
+
- **Content-Type**: Not defined
|
171
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
# **address_get_country_currency**
|
176
|
+
> ValidateCountryResponse address_get_country_currency(input)
|
177
|
+
|
178
|
+
Get the currency of the input country
|
179
|
+
|
180
|
+
Gets the currency information for the input country, including the ISO three-letter country code, currency symbol, and English currency name.
|
181
|
+
|
182
|
+
### Example
|
183
|
+
```ruby
|
184
|
+
# load the gem
|
185
|
+
require 'cloudmersive-validate-api-client'
|
186
|
+
# setup authorization
|
187
|
+
CloudmersiveValidateApiClient.configure do |config|
|
188
|
+
# Configure API key authorization: Apikey
|
189
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
190
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
191
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
192
|
+
end
|
193
|
+
|
194
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
195
|
+
|
196
|
+
input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
|
197
|
+
|
198
|
+
|
199
|
+
begin
|
200
|
+
#Get the currency of the input country
|
201
|
+
result = api_instance.address_get_country_currency(input)
|
202
|
+
p result
|
203
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
204
|
+
puts "Exception when calling AddressApi->address_get_country_currency: #{e}"
|
205
|
+
end
|
206
|
+
```
|
207
|
+
|
208
|
+
### Parameters
|
209
|
+
|
210
|
+
Name | Type | Description | Notes
|
211
|
+
------------- | ------------- | ------------- | -------------
|
212
|
+
**input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
|
213
|
+
|
214
|
+
### Return type
|
215
|
+
|
216
|
+
[**ValidateCountryResponse**](ValidateCountryResponse.md)
|
217
|
+
|
218
|
+
### Authorization
|
219
|
+
|
220
|
+
[Apikey](../README.md#Apikey)
|
221
|
+
|
222
|
+
### HTTP request headers
|
223
|
+
|
224
|
+
- **Content-Type**: application/json, text/json
|
225
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
# **address_get_timezone**
|
230
|
+
> GetTimezonesResponse address_get_timezone(input)
|
231
|
+
|
232
|
+
Gets IANA/Olsen time zones for a country
|
233
|
+
|
234
|
+
Gets the IANA/Olsen time zones for a country.
|
235
|
+
|
236
|
+
### Example
|
237
|
+
```ruby
|
238
|
+
# load the gem
|
239
|
+
require 'cloudmersive-validate-api-client'
|
240
|
+
# setup authorization
|
241
|
+
CloudmersiveValidateApiClient.configure do |config|
|
242
|
+
# Configure API key authorization: Apikey
|
243
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
244
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
245
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
246
|
+
end
|
247
|
+
|
248
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
249
|
+
|
250
|
+
input = CloudmersiveValidateApiClient::GetTimezonesRequest.new # GetTimezonesRequest | Input request
|
251
|
+
|
252
|
+
|
253
|
+
begin
|
254
|
+
#Gets IANA/Olsen time zones for a country
|
255
|
+
result = api_instance.address_get_timezone(input)
|
256
|
+
p result
|
257
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
258
|
+
puts "Exception when calling AddressApi->address_get_timezone: #{e}"
|
259
|
+
end
|
260
|
+
```
|
261
|
+
|
262
|
+
### Parameters
|
263
|
+
|
264
|
+
Name | Type | Description | Notes
|
265
|
+
------------- | ------------- | ------------- | -------------
|
266
|
+
**input** | [**GetTimezonesRequest**](GetTimezonesRequest.md)| Input request |
|
267
|
+
|
268
|
+
### Return type
|
269
|
+
|
270
|
+
[**GetTimezonesResponse**](GetTimezonesResponse.md)
|
271
|
+
|
272
|
+
### Authorization
|
273
|
+
|
274
|
+
[Apikey](../README.md#Apikey)
|
275
|
+
|
276
|
+
### HTTP request headers
|
277
|
+
|
278
|
+
- **Content-Type**: application/json, text/json
|
279
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
# **address_parse_string**
|
284
|
+
> ParseAddressResponse address_parse_string(input)
|
285
|
+
|
286
|
+
Parse an unstructured input text string into an international, formatted address
|
287
|
+
|
288
|
+
Uses machine learning and Natural Language Processing (NLP) to handle a wide array of cases, including non-standard and unstructured address strings across a wide array of countries and address formatting norms.
|
289
|
+
|
290
|
+
### Example
|
291
|
+
```ruby
|
292
|
+
# load the gem
|
293
|
+
require 'cloudmersive-validate-api-client'
|
294
|
+
# setup authorization
|
295
|
+
CloudmersiveValidateApiClient.configure do |config|
|
296
|
+
# Configure API key authorization: Apikey
|
297
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
298
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
299
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
300
|
+
end
|
301
|
+
|
302
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
303
|
+
|
304
|
+
input = CloudmersiveValidateApiClient::ParseAddressRequest.new # ParseAddressRequest | Input parse request
|
305
|
+
|
306
|
+
|
307
|
+
begin
|
308
|
+
#Parse an unstructured input text string into an international, formatted address
|
309
|
+
result = api_instance.address_parse_string(input)
|
310
|
+
p result
|
311
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
312
|
+
puts "Exception when calling AddressApi->address_parse_string: #{e}"
|
313
|
+
end
|
314
|
+
```
|
315
|
+
|
316
|
+
### Parameters
|
317
|
+
|
318
|
+
Name | Type | Description | Notes
|
319
|
+
------------- | ------------- | ------------- | -------------
|
320
|
+
**input** | [**ParseAddressRequest**](ParseAddressRequest.md)| Input parse request |
|
321
|
+
|
322
|
+
### Return type
|
323
|
+
|
324
|
+
[**ParseAddressResponse**](ParseAddressResponse.md)
|
325
|
+
|
326
|
+
### Authorization
|
327
|
+
|
328
|
+
[Apikey](../README.md#Apikey)
|
329
|
+
|
330
|
+
### HTTP request headers
|
331
|
+
|
332
|
+
- **Content-Type**: application/json, text/json
|
333
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
# **address_validate_address**
|
338
|
+
> ValidateAddressResponse address_validate_address(input)
|
339
|
+
|
340
|
+
Validate a street address
|
341
|
+
|
342
|
+
Determines if an input structured street address is valid or invalid. If the address is valid, also returns the latitude and longitude of the address. Supports all major international addresses.
|
343
|
+
|
344
|
+
### Example
|
345
|
+
```ruby
|
346
|
+
# load the gem
|
347
|
+
require 'cloudmersive-validate-api-client'
|
348
|
+
# setup authorization
|
349
|
+
CloudmersiveValidateApiClient.configure do |config|
|
350
|
+
# Configure API key authorization: Apikey
|
351
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
352
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
353
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
354
|
+
end
|
355
|
+
|
356
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
357
|
+
|
358
|
+
input = CloudmersiveValidateApiClient::ValidateAddressRequest.new # ValidateAddressRequest | Input parse request
|
359
|
+
|
360
|
+
|
361
|
+
begin
|
362
|
+
#Validate a street address
|
363
|
+
result = api_instance.address_validate_address(input)
|
364
|
+
p result
|
365
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
366
|
+
puts "Exception when calling AddressApi->address_validate_address: #{e}"
|
367
|
+
end
|
368
|
+
```
|
369
|
+
|
370
|
+
### Parameters
|
371
|
+
|
372
|
+
Name | Type | Description | Notes
|
373
|
+
------------- | ------------- | ------------- | -------------
|
374
|
+
**input** | [**ValidateAddressRequest**](ValidateAddressRequest.md)| Input parse request |
|
375
|
+
|
376
|
+
### Return type
|
377
|
+
|
378
|
+
[**ValidateAddressResponse**](ValidateAddressResponse.md)
|
379
|
+
|
380
|
+
### Authorization
|
381
|
+
|
382
|
+
[Apikey](../README.md#Apikey)
|
383
|
+
|
384
|
+
### HTTP request headers
|
385
|
+
|
386
|
+
- **Content-Type**: application/json, text/json
|
387
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
# **address_validate_city**
|
392
|
+
> ValidateCityResponse address_validate_city(input)
|
393
|
+
|
394
|
+
Validate a City and State/Province combination, get location information about it
|
395
|
+
|
396
|
+
Checks if the input city and state name or code is valid, and returns information about it such as normalized City name, State name and more. Supports all major international addresses.
|
397
|
+
|
398
|
+
### Example
|
399
|
+
```ruby
|
400
|
+
# load the gem
|
401
|
+
require 'cloudmersive-validate-api-client'
|
402
|
+
# setup authorization
|
403
|
+
CloudmersiveValidateApiClient.configure do |config|
|
404
|
+
# Configure API key authorization: Apikey
|
405
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
406
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
407
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
408
|
+
end
|
409
|
+
|
410
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
411
|
+
|
412
|
+
input = CloudmersiveValidateApiClient::ValidateCityRequest.new # ValidateCityRequest | Input parse request
|
413
|
+
|
414
|
+
|
415
|
+
begin
|
416
|
+
#Validate a City and State/Province combination, get location information about it
|
417
|
+
result = api_instance.address_validate_city(input)
|
418
|
+
p result
|
419
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
420
|
+
puts "Exception when calling AddressApi->address_validate_city: #{e}"
|
421
|
+
end
|
422
|
+
```
|
423
|
+
|
424
|
+
### Parameters
|
425
|
+
|
426
|
+
Name | Type | Description | Notes
|
427
|
+
------------- | ------------- | ------------- | -------------
|
428
|
+
**input** | [**ValidateCityRequest**](ValidateCityRequest.md)| Input parse request |
|
429
|
+
|
430
|
+
### Return type
|
431
|
+
|
432
|
+
[**ValidateCityResponse**](ValidateCityResponse.md)
|
433
|
+
|
434
|
+
### Authorization
|
435
|
+
|
436
|
+
[Apikey](../README.md#Apikey)
|
437
|
+
|
438
|
+
### HTTP request headers
|
439
|
+
|
440
|
+
- **Content-Type**: application/json, text/json
|
441
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
442
|
+
|
443
|
+
|
444
|
+
|
445
|
+
# **address_validate_postal_code**
|
446
|
+
> ValidatePostalCodeResponse address_validate_postal_code(input)
|
447
|
+
|
448
|
+
Validate a postal code, get location information about it
|
449
|
+
|
450
|
+
Checks if the input postal code is valid, and returns information about it such as City, State and more. Supports all major countries.
|
451
|
+
|
452
|
+
### Example
|
453
|
+
```ruby
|
454
|
+
# load the gem
|
455
|
+
require 'cloudmersive-validate-api-client'
|
456
|
+
# setup authorization
|
457
|
+
CloudmersiveValidateApiClient.configure do |config|
|
458
|
+
# Configure API key authorization: Apikey
|
459
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
460
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
461
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
462
|
+
end
|
463
|
+
|
464
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
465
|
+
|
466
|
+
input = CloudmersiveValidateApiClient::ValidatePostalCodeRequest.new # ValidatePostalCodeRequest | Input parse request
|
467
|
+
|
468
|
+
|
469
|
+
begin
|
470
|
+
#Validate a postal code, get location information about it
|
471
|
+
result = api_instance.address_validate_postal_code(input)
|
472
|
+
p result
|
473
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
474
|
+
puts "Exception when calling AddressApi->address_validate_postal_code: #{e}"
|
475
|
+
end
|
476
|
+
```
|
477
|
+
|
478
|
+
### Parameters
|
479
|
+
|
480
|
+
Name | Type | Description | Notes
|
481
|
+
------------- | ------------- | ------------- | -------------
|
482
|
+
**input** | [**ValidatePostalCodeRequest**](ValidatePostalCodeRequest.md)| Input parse request |
|
483
|
+
|
484
|
+
### Return type
|
485
|
+
|
486
|
+
[**ValidatePostalCodeResponse**](ValidatePostalCodeResponse.md)
|
487
|
+
|
488
|
+
### Authorization
|
489
|
+
|
490
|
+
[Apikey](../README.md#Apikey)
|
491
|
+
|
492
|
+
### HTTP request headers
|
493
|
+
|
494
|
+
- **Content-Type**: application/json, text/json
|
495
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
496
|
+
|
497
|
+
|
498
|
+
|
499
|
+
# **address_validate_state**
|
500
|
+
> ValidateStateResponse address_validate_state(input)
|
501
|
+
|
502
|
+
Validate a state or province, name or abbreviation, get location information about it
|
503
|
+
|
504
|
+
Checks if the input state name or code is valid, and returns information about it such as normalized State name and more. Supports all major countries.
|
505
|
+
|
506
|
+
### Example
|
507
|
+
```ruby
|
508
|
+
# load the gem
|
509
|
+
require 'cloudmersive-validate-api-client'
|
510
|
+
# setup authorization
|
511
|
+
CloudmersiveValidateApiClient.configure do |config|
|
512
|
+
# Configure API key authorization: Apikey
|
513
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
514
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
515
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
516
|
+
end
|
517
|
+
|
518
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
519
|
+
|
520
|
+
input = CloudmersiveValidateApiClient::ValidateStateRequest.new # ValidateStateRequest | Input parse request
|
521
|
+
|
522
|
+
|
523
|
+
begin
|
524
|
+
#Validate a state or province, name or abbreviation, get location information about it
|
525
|
+
result = api_instance.address_validate_state(input)
|
526
|
+
p result
|
527
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
528
|
+
puts "Exception when calling AddressApi->address_validate_state: #{e}"
|
529
|
+
end
|
530
|
+
```
|
531
|
+
|
532
|
+
### Parameters
|
533
|
+
|
534
|
+
Name | Type | Description | Notes
|
535
|
+
------------- | ------------- | ------------- | -------------
|
536
|
+
**input** | [**ValidateStateRequest**](ValidateStateRequest.md)| Input parse request |
|
537
|
+
|
538
|
+
### Return type
|
539
|
+
|
540
|
+
[**ValidateStateResponse**](ValidateStateResponse.md)
|
541
|
+
|
542
|
+
### Authorization
|
543
|
+
|
544
|
+
[Apikey](../README.md#Apikey)
|
545
|
+
|
546
|
+
### HTTP request headers
|
547
|
+
|
548
|
+
- **Content-Type**: application/json, text/json
|
549
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
550
|
+
|
551
|
+
|
552
|
+
|