cloudmersive-validate-api-client 1.4.1 → 2.0.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +24 -8
- data/cloudmersive-validate-api-client.gemspec +3 -3
- data/docs/AddressApi.md +325 -1
- data/docs/CountryDetails.md +11 -0
- data/docs/CountryListResult.md +9 -0
- data/docs/DomainApi.md +2 -2
- data/docs/EmailApi.md +3 -3
- data/docs/IPAddressApi.md +1 -1
- 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/ValidateCountryResponse.md +1 -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/VatApi.md +4 -4
- data/lib/cloudmersive-validate-api-client.rb +11 -1
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +327 -14
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +14 -18
- data/lib/cloudmersive-validate-api-client/api/email_api.rb +11 -14
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +5 -6
- data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb +5 -8
- data/lib/cloudmersive-validate-api-client/api/name_api.rb +17 -22
- data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +5 -6
- data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +5 -6
- data/lib/cloudmersive-validate-api-client/api/vat_api.rb +9 -10
- data/lib/cloudmersive-validate-api-client/api_client.rb +11 -9
- data/lib/cloudmersive-validate-api-client/api_error.rb +1 -1
- data/lib/cloudmersive-validate-api-client/configuration.rb +2 -2
- data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/check_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/country_details.rb +216 -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 +7 -10
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/get_timezones_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/get_timezones_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/lead_enrichment_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/parse_address_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/parse_address_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/timezone.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +7 -10
- 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 +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_country_response.rb +18 -11
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_response.rb +7 -10
- 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 +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_url_request_syntax_only.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_full.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +7 -11
- data/lib/cloudmersive-validate-api-client/models/whois_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/version.rb +2 -2
- data/spec/api/address_api_spec.rb +76 -5
- data/spec/api/domain_api_spec.rb +5 -5
- data/spec/api/email_api_spec.rb +4 -4
- data/spec/api/ip_address_api_spec.rb +2 -2
- data/spec/api/lead_enrichment_api_spec.rb +2 -3
- data/spec/api/name_api_spec.rb +6 -6
- data/spec/api/phone_number_api_spec.rb +2 -2
- data/spec/api/user_agent_api_spec.rb +2 -2
- data/spec/api/vat_api_spec.rb +4 -4
- data/spec/api_client_spec.rb +52 -35
- data/spec/configuration_spec.rb +9 -9
- data/spec/models/address_get_servers_response_spec.rb +3 -4
- data/spec/models/address_verify_syntax_only_response_spec.rb +5 -6
- data/spec/models/check_response_spec.rb +2 -3
- data/spec/models/country_details_spec.rb +59 -0
- data/spec/models/country_list_result_spec.rb +47 -0
- data/spec/models/first_name_validation_request_spec.rb +2 -3
- data/spec/models/first_name_validation_response_spec.rb +3 -4
- data/spec/models/full_email_validation_response_spec.rb +10 -11
- data/spec/models/full_name_validation_request_spec.rb +2 -3
- data/spec/models/full_name_validation_response_spec.rb +11 -12
- data/spec/models/geolocate_response_spec.rb +10 -11
- data/spec/models/get_gender_request_spec.rb +3 -4
- data/spec/models/get_gender_response_spec.rb +3 -4
- data/spec/models/get_timezones_request_spec.rb +2 -3
- data/spec/models/get_timezones_response_spec.rb +7 -8
- data/spec/models/last_name_validation_request_spec.rb +2 -3
- data/spec/models/last_name_validation_response_spec.rb +3 -4
- data/spec/models/lead_enrichment_request_spec.rb +15 -16
- data/spec/models/lead_enrichment_response_spec.rb +19 -20
- data/spec/models/parse_address_request_spec.rb +3 -4
- data/spec/models/parse_address_response_spec.rb +10 -11
- data/spec/models/phone_number_validate_request_spec.rb +3 -4
- data/spec/models/phone_number_validation_response_spec.rb +9 -10
- data/spec/models/timezone_spec.rb +4 -5
- data/spec/models/user_agent_validate_request_spec.rb +2 -3
- data/spec/models/user_agent_validate_response_spec.rb +15 -16
- 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 +2 -3
- data/spec/models/validate_country_response_spec.rb +13 -8
- data/spec/models/validate_identifier_request_spec.rb +9 -10
- data/spec/models/validate_identifier_response_spec.rb +3 -4
- 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 +2 -3
- data/spec/models/validate_url_request_syntax_only_spec.rb +2 -3
- data/spec/models/validate_url_response_full_spec.rb +6 -7
- data/spec/models/validate_url_response_syntax_only_spec.rb +3 -4
- data/spec/models/vat_lookup_request_spec.rb +2 -3
- data/spec/models/vat_lookup_response_spec.rb +13 -14
- data/spec/models/whois_response_spec.rb +16 -17
- data/spec/spec_helper.rb +1 -1
- metadata +32 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 42848aae92bdab856adfb954183ca89a7c93d0bafc089573773e1dd6bf048f2e
|
4
|
+
data.tar.gz: af8fd461ed08f4a2c34d5a159fef97dc620c52b335d5f7a1161edf492d67aea9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 99104ecbd0706950be75bf090b5585a0286f27001f150c938cb3b003e7a68f59546b29b6e80fcdc866e0c386092786cae8ddd91cdfd2b4721ba1954592262b88
|
7
|
+
data.tar.gz: 86212991b792a4523abc09705b99b705f60fe453d0732310c533dea7b979a7983993e4f7332c098a8bf99259b3dcb31451bf8dc75ca47e45aea37634b25738d1
|
data/Gemfile
CHANGED
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:
|
10
|
+
- Package version: 2.0.4
|
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-
|
26
|
+
gem install ./cloudmersive-validate-api-client-2.0.4.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-validate-api-client-
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.0.4.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', '~>
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 2.0.4'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -68,11 +68,11 @@ input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCoun
|
|
68
68
|
|
69
69
|
|
70
70
|
begin
|
71
|
-
#
|
72
|
-
result = api_instance.
|
71
|
+
#Check if a country is a member of the European Union (EU)
|
72
|
+
result = api_instance.address_check_eu_membership(input)
|
73
73
|
p result
|
74
74
|
rescue CloudmersiveValidateApiClient::ApiError => e
|
75
|
-
puts "Exception when calling AddressApi->
|
75
|
+
puts "Exception when calling AddressApi->address_check_eu_membership: #{e}"
|
76
76
|
end
|
77
77
|
|
78
78
|
```
|
@@ -83,9 +83,15 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
83
83
|
|
84
84
|
Class | Method | HTTP request | Description
|
85
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)
|
86
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
|
87
89
|
*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
|
88
90
|
*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
|
91
|
+
*CloudmersiveValidateApiClient::AddressApi* | [**address_validate_address**](docs/AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
|
92
|
+
*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
|
+
*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
|
+
*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
|
89
95
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
90
96
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
91
97
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
@@ -102,7 +108,7 @@ Class | Method | HTTP request | Description
|
|
102
108
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
103
109
|
*CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
|
104
110
|
*CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
|
105
|
-
*CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup |
|
111
|
+
*CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
|
106
112
|
|
107
113
|
|
108
114
|
## Documentation for Models
|
@@ -110,6 +116,8 @@ Class | Method | HTTP request | Description
|
|
110
116
|
- [CloudmersiveValidateApiClient::AddressGetServersResponse](docs/AddressGetServersResponse.md)
|
111
117
|
- [CloudmersiveValidateApiClient::AddressVerifySyntaxOnlyResponse](docs/AddressVerifySyntaxOnlyResponse.md)
|
112
118
|
- [CloudmersiveValidateApiClient::CheckResponse](docs/CheckResponse.md)
|
119
|
+
- [CloudmersiveValidateApiClient::CountryDetails](docs/CountryDetails.md)
|
120
|
+
- [CloudmersiveValidateApiClient::CountryListResult](docs/CountryListResult.md)
|
113
121
|
- [CloudmersiveValidateApiClient::FirstNameValidationRequest](docs/FirstNameValidationRequest.md)
|
114
122
|
- [CloudmersiveValidateApiClient::FirstNameValidationResponse](docs/FirstNameValidationResponse.md)
|
115
123
|
- [CloudmersiveValidateApiClient::FullEmailValidationResponse](docs/FullEmailValidationResponse.md)
|
@@ -131,10 +139,18 @@ Class | Method | HTTP request | Description
|
|
131
139
|
- [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
|
132
140
|
- [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
|
133
141
|
- [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
|
142
|
+
- [CloudmersiveValidateApiClient::ValidateAddressRequest](docs/ValidateAddressRequest.md)
|
143
|
+
- [CloudmersiveValidateApiClient::ValidateAddressResponse](docs/ValidateAddressResponse.md)
|
144
|
+
- [CloudmersiveValidateApiClient::ValidateCityRequest](docs/ValidateCityRequest.md)
|
145
|
+
- [CloudmersiveValidateApiClient::ValidateCityResponse](docs/ValidateCityResponse.md)
|
134
146
|
- [CloudmersiveValidateApiClient::ValidateCountryRequest](docs/ValidateCountryRequest.md)
|
135
147
|
- [CloudmersiveValidateApiClient::ValidateCountryResponse](docs/ValidateCountryResponse.md)
|
136
148
|
- [CloudmersiveValidateApiClient::ValidateIdentifierRequest](docs/ValidateIdentifierRequest.md)
|
137
149
|
- [CloudmersiveValidateApiClient::ValidateIdentifierResponse](docs/ValidateIdentifierResponse.md)
|
150
|
+
- [CloudmersiveValidateApiClient::ValidatePostalCodeRequest](docs/ValidatePostalCodeRequest.md)
|
151
|
+
- [CloudmersiveValidateApiClient::ValidatePostalCodeResponse](docs/ValidatePostalCodeResponse.md)
|
152
|
+
- [CloudmersiveValidateApiClient::ValidateStateRequest](docs/ValidateStateRequest.md)
|
153
|
+
- [CloudmersiveValidateApiClient::ValidateStateResponse](docs/ValidateStateResponse.md)
|
138
154
|
- [CloudmersiveValidateApiClient::ValidateUrlRequestFull](docs/ValidateUrlRequestFull.md)
|
139
155
|
- [CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly](docs/ValidateUrlRequestSyntaxOnly.md)
|
140
156
|
- [CloudmersiveValidateApiClient::ValidateUrlResponseFull](docs/ValidateUrlResponseFull.md)
|
@@ -1,5 +1,5 @@
|
|
1
1
|
# -*- encoding: utf-8 -*-
|
2
|
-
|
2
|
+
|
3
3
|
=begin
|
4
4
|
#validateapi
|
5
5
|
|
@@ -8,7 +8,7 @@
|
|
8
8
|
OpenAPI spec version: v1
|
9
9
|
|
10
10
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
11
|
-
Swagger Codegen version: 2.
|
11
|
+
Swagger Codegen version: 2.4.14
|
12
12
|
|
13
13
|
=end
|
14
14
|
|
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
|
|
24
24
|
s.homepage = "https://www.cloudmersive.com/validate-api"
|
25
25
|
s.summary = "Validate key business data thoroughly."
|
26
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 =
|
27
|
+
s.license = 'Apache 2.0'
|
28
28
|
s.required_ruby_version = ">= 1.9"
|
29
29
|
|
30
30
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
data/docs/AddressApi.md
CHANGED
@@ -4,9 +4,69 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
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)
|
7
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
|
8
10
|
[**address_get_timezone**](AddressApi.md#address_get_timezone) | **POST** /validate/address/country/get-timezones | Gets IANA/Olsen time zones for a country
|
9
11
|
[**address_parse_string**](AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
|
12
|
+
[**address_validate_address**](AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
|
13
|
+
[**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
|
+
[**address_validate_postal_code**](AddressApi.md#address_validate_postal_code) | **POST** /validate/address/postal-code | Validate a postal code, get location information about it
|
15
|
+
[**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
|
16
|
+
|
17
|
+
|
18
|
+
# **address_check_eu_membership**
|
19
|
+
> ValidateCountryResponse address_check_eu_membership(input)
|
20
|
+
|
21
|
+
Check if a country is a member of the European Union (EU)
|
22
|
+
|
23
|
+
Checks if the input country is a member of the European Union or not.
|
24
|
+
|
25
|
+
### Example
|
26
|
+
```ruby
|
27
|
+
# load the gem
|
28
|
+
require 'cloudmersive-validate-api-client'
|
29
|
+
# setup authorization
|
30
|
+
CloudmersiveValidateApiClient.configure do |config|
|
31
|
+
# Configure API key authorization: Apikey
|
32
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
38
|
+
|
39
|
+
input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
|
40
|
+
|
41
|
+
|
42
|
+
begin
|
43
|
+
#Check if a country is a member of the European Union (EU)
|
44
|
+
result = api_instance.address_check_eu_membership(input)
|
45
|
+
p result
|
46
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
47
|
+
puts "Exception when calling AddressApi->address_check_eu_membership: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
Name | Type | Description | Notes
|
54
|
+
------------- | ------------- | ------------- | -------------
|
55
|
+
**input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
|
56
|
+
|
57
|
+
### Return type
|
58
|
+
|
59
|
+
[**ValidateCountryResponse**](ValidateCountryResponse.md)
|
60
|
+
|
61
|
+
### Authorization
|
62
|
+
|
63
|
+
[Apikey](../README.md#Apikey)
|
64
|
+
|
65
|
+
### HTTP request headers
|
66
|
+
|
67
|
+
- **Content-Type**: application/json, text/json
|
68
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
69
|
+
|
10
70
|
|
11
71
|
|
12
72
|
# **address_country**
|
@@ -14,7 +74,7 @@ Method | HTTP request | Description
|
|
14
74
|
|
15
75
|
Validate and normalize country information, return ISO 3166-1 country codes and country name
|
16
76
|
|
17
|
-
Validates and normalizes country information, and returns key information about a country. Also returns distinct time zones in the country.
|
77
|
+
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.
|
18
78
|
|
19
79
|
### Example
|
20
80
|
```ruby
|
@@ -63,6 +123,54 @@ Name | Type | Description | Notes
|
|
63
123
|
|
64
124
|
|
65
125
|
|
126
|
+
# **address_country_list**
|
127
|
+
> CountryListResult address_country_list
|
128
|
+
|
129
|
+
Get a list of ISO 3166-1 countries
|
130
|
+
|
131
|
+
Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.
|
132
|
+
|
133
|
+
### Example
|
134
|
+
```ruby
|
135
|
+
# load the gem
|
136
|
+
require 'cloudmersive-validate-api-client'
|
137
|
+
# setup authorization
|
138
|
+
CloudmersiveValidateApiClient.configure do |config|
|
139
|
+
# Configure API key authorization: Apikey
|
140
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
141
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
142
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
143
|
+
end
|
144
|
+
|
145
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
146
|
+
|
147
|
+
begin
|
148
|
+
#Get a list of ISO 3166-1 countries
|
149
|
+
result = api_instance.address_country_list
|
150
|
+
p result
|
151
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
152
|
+
puts "Exception when calling AddressApi->address_country_list: #{e}"
|
153
|
+
end
|
154
|
+
```
|
155
|
+
|
156
|
+
### Parameters
|
157
|
+
This endpoint does not need any parameter.
|
158
|
+
|
159
|
+
### Return type
|
160
|
+
|
161
|
+
[**CountryListResult**](CountryListResult.md)
|
162
|
+
|
163
|
+
### Authorization
|
164
|
+
|
165
|
+
[Apikey](../README.md#Apikey)
|
166
|
+
|
167
|
+
### HTTP request headers
|
168
|
+
|
169
|
+
- **Content-Type**: Not defined
|
170
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
171
|
+
|
172
|
+
|
173
|
+
|
66
174
|
# **address_get_timezone**
|
67
175
|
> GetTimezonesResponse address_get_timezone(input)
|
68
176
|
|
@@ -171,3 +279,219 @@ Name | Type | Description | Notes
|
|
171
279
|
|
172
280
|
|
173
281
|
|
282
|
+
# **address_validate_address**
|
283
|
+
> ValidateAddressResponse address_validate_address(input)
|
284
|
+
|
285
|
+
Validate a street address
|
286
|
+
|
287
|
+
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.
|
288
|
+
|
289
|
+
### Example
|
290
|
+
```ruby
|
291
|
+
# load the gem
|
292
|
+
require 'cloudmersive-validate-api-client'
|
293
|
+
# setup authorization
|
294
|
+
CloudmersiveValidateApiClient.configure do |config|
|
295
|
+
# Configure API key authorization: Apikey
|
296
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
297
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
298
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
299
|
+
end
|
300
|
+
|
301
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
302
|
+
|
303
|
+
input = CloudmersiveValidateApiClient::ValidateAddressRequest.new # ValidateAddressRequest | Input parse request
|
304
|
+
|
305
|
+
|
306
|
+
begin
|
307
|
+
#Validate a street address
|
308
|
+
result = api_instance.address_validate_address(input)
|
309
|
+
p result
|
310
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
311
|
+
puts "Exception when calling AddressApi->address_validate_address: #{e}"
|
312
|
+
end
|
313
|
+
```
|
314
|
+
|
315
|
+
### Parameters
|
316
|
+
|
317
|
+
Name | Type | Description | Notes
|
318
|
+
------------- | ------------- | ------------- | -------------
|
319
|
+
**input** | [**ValidateAddressRequest**](ValidateAddressRequest.md)| Input parse request |
|
320
|
+
|
321
|
+
### Return type
|
322
|
+
|
323
|
+
[**ValidateAddressResponse**](ValidateAddressResponse.md)
|
324
|
+
|
325
|
+
### Authorization
|
326
|
+
|
327
|
+
[Apikey](../README.md#Apikey)
|
328
|
+
|
329
|
+
### HTTP request headers
|
330
|
+
|
331
|
+
- **Content-Type**: application/json, text/json
|
332
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
# **address_validate_city**
|
337
|
+
> ValidateCityResponse address_validate_city(input)
|
338
|
+
|
339
|
+
Validate a City and State/Province combination, get location information about it
|
340
|
+
|
341
|
+
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.
|
342
|
+
|
343
|
+
### Example
|
344
|
+
```ruby
|
345
|
+
# load the gem
|
346
|
+
require 'cloudmersive-validate-api-client'
|
347
|
+
# setup authorization
|
348
|
+
CloudmersiveValidateApiClient.configure do |config|
|
349
|
+
# Configure API key authorization: Apikey
|
350
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
351
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
352
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
353
|
+
end
|
354
|
+
|
355
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
356
|
+
|
357
|
+
input = CloudmersiveValidateApiClient::ValidateCityRequest.new # ValidateCityRequest | Input parse request
|
358
|
+
|
359
|
+
|
360
|
+
begin
|
361
|
+
#Validate a City and State/Province combination, get location information about it
|
362
|
+
result = api_instance.address_validate_city(input)
|
363
|
+
p result
|
364
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
365
|
+
puts "Exception when calling AddressApi->address_validate_city: #{e}"
|
366
|
+
end
|
367
|
+
```
|
368
|
+
|
369
|
+
### Parameters
|
370
|
+
|
371
|
+
Name | Type | Description | Notes
|
372
|
+
------------- | ------------- | ------------- | -------------
|
373
|
+
**input** | [**ValidateCityRequest**](ValidateCityRequest.md)| Input parse request |
|
374
|
+
|
375
|
+
### Return type
|
376
|
+
|
377
|
+
[**ValidateCityResponse**](ValidateCityResponse.md)
|
378
|
+
|
379
|
+
### Authorization
|
380
|
+
|
381
|
+
[Apikey](../README.md#Apikey)
|
382
|
+
|
383
|
+
### HTTP request headers
|
384
|
+
|
385
|
+
- **Content-Type**: application/json, text/json
|
386
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
# **address_validate_postal_code**
|
391
|
+
> ValidatePostalCodeResponse address_validate_postal_code(input)
|
392
|
+
|
393
|
+
Validate a postal code, get location information about it
|
394
|
+
|
395
|
+
Checks if the input postal code is valid, and returns information about it such as City, State and more.
|
396
|
+
|
397
|
+
### Example
|
398
|
+
```ruby
|
399
|
+
# load the gem
|
400
|
+
require 'cloudmersive-validate-api-client'
|
401
|
+
# setup authorization
|
402
|
+
CloudmersiveValidateApiClient.configure do |config|
|
403
|
+
# Configure API key authorization: Apikey
|
404
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
405
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
406
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
407
|
+
end
|
408
|
+
|
409
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
410
|
+
|
411
|
+
input = CloudmersiveValidateApiClient::ValidatePostalCodeRequest.new # ValidatePostalCodeRequest | Input parse request
|
412
|
+
|
413
|
+
|
414
|
+
begin
|
415
|
+
#Validate a postal code, get location information about it
|
416
|
+
result = api_instance.address_validate_postal_code(input)
|
417
|
+
p result
|
418
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
419
|
+
puts "Exception when calling AddressApi->address_validate_postal_code: #{e}"
|
420
|
+
end
|
421
|
+
```
|
422
|
+
|
423
|
+
### Parameters
|
424
|
+
|
425
|
+
Name | Type | Description | Notes
|
426
|
+
------------- | ------------- | ------------- | -------------
|
427
|
+
**input** | [**ValidatePostalCodeRequest**](ValidatePostalCodeRequest.md)| Input parse request |
|
428
|
+
|
429
|
+
### Return type
|
430
|
+
|
431
|
+
[**ValidatePostalCodeResponse**](ValidatePostalCodeResponse.md)
|
432
|
+
|
433
|
+
### Authorization
|
434
|
+
|
435
|
+
[Apikey](../README.md#Apikey)
|
436
|
+
|
437
|
+
### HTTP request headers
|
438
|
+
|
439
|
+
- **Content-Type**: application/json, text/json
|
440
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
441
|
+
|
442
|
+
|
443
|
+
|
444
|
+
# **address_validate_state**
|
445
|
+
> ValidateStateResponse address_validate_state(input)
|
446
|
+
|
447
|
+
Validate a state or province, name or abbreviation, get location information about it
|
448
|
+
|
449
|
+
Checks if the input state name or code is valid, and returns information about it such as normalized State name and more.
|
450
|
+
|
451
|
+
### Example
|
452
|
+
```ruby
|
453
|
+
# load the gem
|
454
|
+
require 'cloudmersive-validate-api-client'
|
455
|
+
# setup authorization
|
456
|
+
CloudmersiveValidateApiClient.configure do |config|
|
457
|
+
# Configure API key authorization: Apikey
|
458
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
459
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
460
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
461
|
+
end
|
462
|
+
|
463
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
464
|
+
|
465
|
+
input = CloudmersiveValidateApiClient::ValidateStateRequest.new # ValidateStateRequest | Input parse request
|
466
|
+
|
467
|
+
|
468
|
+
begin
|
469
|
+
#Validate a state or province, name or abbreviation, get location information about it
|
470
|
+
result = api_instance.address_validate_state(input)
|
471
|
+
p result
|
472
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
473
|
+
puts "Exception when calling AddressApi->address_validate_state: #{e}"
|
474
|
+
end
|
475
|
+
```
|
476
|
+
|
477
|
+
### Parameters
|
478
|
+
|
479
|
+
Name | Type | Description | Notes
|
480
|
+
------------- | ------------- | ------------- | -------------
|
481
|
+
**input** | [**ValidateStateRequest**](ValidateStateRequest.md)| Input parse request |
|
482
|
+
|
483
|
+
### Return type
|
484
|
+
|
485
|
+
[**ValidateStateResponse**](ValidateStateResponse.md)
|
486
|
+
|
487
|
+
### Authorization
|
488
|
+
|
489
|
+
[Apikey](../README.md#Apikey)
|
490
|
+
|
491
|
+
### HTTP request headers
|
492
|
+
|
493
|
+
- **Content-Type**: application/json, text/json
|
494
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
495
|
+
|
496
|
+
|
497
|
+
|